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.

Sign up for GitHub

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

doc: --skip-flag in the upgrade workflow #2313

Merged
merged 3 commits into from
Sep 9, 2023
Merged

doc: --skip-flag in the upgrade workflow #2313

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8bbba8
doc skip flag
elchead Sep 6, 2023
93d81e5
Update docs/docs/workflows/upgrade.md
elchead Sep 8, 2023
532e7b9
Update docs/docs/workflows/upgrade.md
elchead Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/docs/workflows/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,13 @@ When applying an upgrade, backup files of Constellation-managed Custom Resource
You can use the Terraform state backup to restore previous resources in case an upgrade misconfigured or erroneously deleted a resource.
You can use the Custom Resource (Definition) backup files to restore Custom Resources and Definitions manually (e.g., via `kubectl apply`) if the automatic migration of those resources fails.

::note
elchead marked this conversation as resolved.
Show resolved Hide resolved

For advanced users: the upgrade consists of several phases that can be individually skipped through the `--skip-phases` flag.
The phases are `infrastracture` for the cloud resource management through Terraform, `helm` for the chart management of the microservices, `node` for OS image upgrades, and `k8s` for Kubernetes version upgrades.
elchead marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

If we expect users to mostly do this after consultation with us, I think this is okay. But if this is meant for self-service, a more detailed explanation of the phases and when it could make sense to skip them would be needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe @malt3 had some concrete use cases in mind. I think this behavior shouldn't be necessary if you use Constellation within the supported configuration.


:::

## Check the status

Upgrades are asynchronous operations.
Expand Down