Skip to content

Commit

Permalink
[version-4-0] Self-hosted Palette upgrade guides (#2303) (#2655)
Browse files Browse the repository at this point in the history
* Self-hosted Palette upgrade guides (#2303)

* docs: Initial setup for platform upgrades doc

* docs: Some progress on the upgrade paths

* docs: Interim to switch branches

* docs: Restructure based on SME feedback

* docs: K8s non-airgap draft

* docs: K8s airgap draft

* docs: VMware non-airgap draft

* docs: VMware non-airgap (added validation)

* chore: Fix broken anchor

* docs: VMware airgap draft WIP

* docs: Finish updating the K8s airgap and non-airgap guides; restructure to acommodate for dedicated upgrade notes

* docs: Finish the VMware airgap upgrade guide

* docs: Continue merge with master

* docs: Implement Vale feedback

* chore: Fix image formats

* chore: Missed some Vale stuff

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: Implement peer review

* docs: Implement peer review

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Apply suggestions from code review (missed some)

Co-authored-by: Karl Cardenas <[email protected]>

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix formatting and alignment

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* chore: Fix a typo from PR#2640

* chore: Fix wording in an admonition and fix indentation

* docs: Adapt self-hosted upgrade guides for VerteX

* docs: Remove the upgrade-notes page from VerteX content

* core: Fix a broken link

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>

* chore: Fix broken links

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
  • Loading branch information
3 people authored Apr 15, 2024
1 parent 83bff16 commit 9f30bcc
Show file tree
Hide file tree
Showing 29 changed files with 2,079 additions and 50 deletions.
8 changes: 4 additions & 4 deletions docs/docs-content/clusters/pcg/manage-pcg/pcg-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ cluster profile updates after upgrading your self-hosted Palette instance to a n

The table below outlines a high-level overview of the upgrade process for a PCG and each of its components.

| Component | User Action Required? | Expected PCG Downtime? | Supported PCG Type? | Description |
| --------------- | --------------------- | ---------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Palette Agent | No | No | All | Automatically updated unless platform updates or cluster updates are paused. Refer to the [Pause Platform Upgrades](../../cluster-management/palette-lock-cluster.md) to learn more about pausing updates. |
| Cluster Profile | Yes | Potentially | Only PCG clusters installed through Palette CLI | Manually approve the cluster profile update to apply the latest cluster profile changes. Not all Palette version updates introduce cluster profile changes. PCG clusters installed on an existing Kubernetes cluster is not eligble for cluster profile updates. Refer to the [Cluster Profile Updates](#cluster-profile-updates) to learn more. |
| Component | User Action Required? | Expected PCG Downtime? | Supported PCG Type? | Description |
| --------------- | --------------------- | ---------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Palette Agent | No | No | All | Automatically updated unless platform updates or cluster updates are paused. Refer to the [Pause Platform Upgrades](../../cluster-management/palette-lock-cluster.md) to learn more about pausing updates. |
| Cluster Profile | Yes | Potentially | Only PCG clusters installed through Palette CLI | Manually approve the cluster profile update to apply the latest cluster profile changes. Not all Palette version updates introduce cluster profile changes. PCG clusters installed on an existing Kubernetes cluster is not eligible for cluster profile updates. Refer to the [Cluster Profile Updates](#cluster-profile-updates) to learn more. |

Review the following sections to learn more about the upgrade process for a PCG.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/enterprise-version/enterprise-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ required to get started with self-hosted Palette.

- [System Management](system-management/system-management.md)

- [Upgrade Notes](upgrade.md)
- [Upgrade Notes](upgrade/upgrade.md)

- [Enterprise Install Troubleshooting](../troubleshooting/enterprise-install.md)
3 changes: 3 additions & 0 deletions docs/docs-content/enterprise-version/upgrade/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"position": 100
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Kubernetes",
"position": 10
}
Loading

0 comments on commit 9f30bcc

Please sign in to comment.