Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Self-hosted Palette upgrade guides #2303

Merged
merged 37 commits into from
Apr 15, 2024
Merged

Self-hosted Palette upgrade guides #2303

merged 37 commits into from
Apr 15, 2024

Conversation

yuliiiah
Copy link
Contributor

@yuliiiah yuliiiah commented Feb 27, 2024

Describe the Change

This PR documents the process of upgrading self-hosted Palette instances installed on Kubernetes and VMware.

Review Changes

💻 Preview URLs:

🎫 DOC-1045
🎫 DOC-1088

Copy link

netlify bot commented Feb 27, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 2feb483
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/661d8f5bcffcca00089fbb58
😎 Deploy Preview https://deploy-preview-2303--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yuliiiah yuliiiah marked this pull request as ready for review April 5, 2024 20:33
@yuliiiah yuliiiah requested a review from a team as a code owner April 5, 2024 20:33
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md|235 col 55| [Vale.Spelling] Did you really mean 'separetely'?
docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md|270 col 21| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'zip -d' with the corresponding long form flag.
docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md|415 col 22| [spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
docs/docs-content/troubleshooting/palette-upgrade.md|13 col 1| [Vale.Terms] Use 'we' instead of 'We'.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 64.6%, saving 283.62 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/enterprise-version_upgrade-upgrade_vmware_non-airgap_copy_configurations.webp 138.35 KB 37.92 KB -72.6% View diff
static/assets/docs/images/enterprise-version_upgrade-upgrade_vmware_non-airgap_update.webp 19.43 KB 18.96 KB -2.4% View diff
static/assets/docs/images/enterprise-version_upgrade-upgrade_vmware_non-airgap_upgrade-preview.webp 207.04 KB 83.09 KB -59.9% View diff
static/assets/docs/images/enterprise-version_upgrade-upgrade_vmware_non-airgap_upgraded.webp 74.07 KB 15.32 KB -79.3% View diff

668 images did not require optimisation.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 4.2%, saving 5.79 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/enterprise-version_upgrade-upgrade_vmware_non-airgap_copy_configurations.webp 37.92 KB 36.09 KB -4.8% View diff
static/assets/docs/images/enterprise-version_upgrade-upgrade_vmware_non-airgap_upgrade-preview.webp 83.09 KB 79.40 KB -4.4% View diff
static/assets/docs/images/enterprise-version_upgrade-upgrade_vmware_non-airgap_upgraded.webp 15.32 KB 15.05 KB -1.8% View diff

669 images did not require optimisation.

@karl-cardenas-coding karl-cardenas-coding mentioned this pull request Apr 15, 2024
2 tasks
@yuliiiah yuliiiah merged commit e84de36 into master Apr 15, 2024
17 checks passed
@yuliiiah yuliiiah deleted the doc-1045-new branch April 15, 2024 20:52
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 15, 2024
* 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]>
(cherry picked from commit e84de36)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 15, 2024
* 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]>
(cherry picked from commit e84de36)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts
version-3-4 Backport failed because of merge conflicts

You might need to backport the following PRs to version-3-4:
- docs: refactor for self-hosted Palette DOC-465 (#1597)
- docs: updated URLs to use file path context
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- docs: DOC-1118 Image Conversion to webp (#2439)
version-4-2
version-4-3

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 2303

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

yuliiiah added a commit that referenced this pull request Apr 15, 2024
* 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]>
yuliiiah added a commit that referenced this pull request Apr 15, 2024
* 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]>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Apr 15, 2024
* 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]>
(cherry picked from commit e84de36)

Co-authored-by: Yuliia Horbenko <[email protected]>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Apr 15, 2024
* 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]>
(cherry picked from commit e84de36)

Co-authored-by: Yuliia Horbenko <[email protected]>
yuliiiah added a commit that referenced this pull request Apr 15, 2024
* 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 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]>
yuliiiah added a commit that referenced this pull request Apr 15, 2024
* 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]>
@vault-token-factory-spectrocloud vault-token-factory-spectrocloud bot mentioned this pull request Apr 24, 2024
2 tasks
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.3.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants