Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-09-20 00:06:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: refine instructions for upgrade process (#1865)

Browse Source 
Incorporate customer feedback regarding the recommended commands when upgrading a Constellation cluster.
Showing the full command "constellation upgrade check --write-config" is important to ensure only valid, safe upgrades are applied.

Co-authored-by: Otto Bittner <cobittner@posteo.net>
This commit is contained in:
Malte Poll 2023-06-05 09:10:20 +02:00 committed by GitHub
parent 620bb45330
commit eb9bea1cff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/workflows/upgrade.md
View File

@ -32,11 +32,15 @@ Use [`constellation config migrate`](../reference/cli.md#constellation-config-mi
To learn which versions the current CLI can upgrade to and what's installed in your cluster, run: To learn which versions the current CLI can upgrade to and what's installed in your cluster, run:
```bash ```bash
# Show possible upgrades
constellation upgrade check constellation upgrade check
# Show possible upgrades and write them to config file
constellation upgrade check --write-config
``` ```
You can either enter the reported target versions into your config manually or run the above command with the `--write-config` flag. You can either enter the reported target versions into your config manually or run the above command with the `--write-config` flag.
When using this flag, the `kubernetesVersion`, `image`, and `microserviceVersion` fields are overwritten with the smallest available upgrade. When using this flag, the `kubernetesVersion`, `image`, `microserviceVersion` and `attestation` fields are overwritten with the smallest available upgrade.
## Apply the upgrade ## Apply the upgrade
@ -87,3 +91,7 @@ Cluster status: Some node versions are out of date
This output indicates that the cluster is running Kubernetes version `1.25.8`, and all nodes have the appropriate binaries installed. This output indicates that the cluster is running Kubernetes version `1.25.8`, and all nodes have the appropriate binaries installed.
23 out of 25 nodes have already upgraded to the targeted image version of `2.6.0`, while two are still in progress. 23 out of 25 nodes have already upgraded to the targeted image version of `2.6.0`, while two are still in progress.
## Apply further upgrades
After the upgrade is finished, you can run `constellation upgrade check` again to see if there are more upgrades available. If so, repeat the process.