Package Upgrades
Scope
The Wayfinder GUI supports upgrades at the cluster level for packages that are shipped with Wayfinder's installation. Information on how to upgrade Wayfinder's control planes and node pools can be found here. Support for using the CLI for package upgrades can be found here.
User Actions:
- Navigate to the upgrade area within the Wayfinder GUI
- Approve upgrades when needed
- View the available upgrade information within the Wayfinder GUI
- View additional package information or to enable/disable packages
Administrative Checklist:
- Review similarities between package upgrades and control plane / node pool (K8s) upgrades:
- Review user access requirements
- Decide which upgrade method to use
- Configure auto-approval settings for the chosen upgrade method
- View support for upcoming functionality
- Contact us if you have any questions or if you need support
FAQs:
- How do I get to the package upgrades tab?
- How do I approve a package upgrade?
- How similar are package upgrades to control plane / node pool upgrades?
User Actions
Navigation
Package upgrades take place at a cluster level. To access the upgrade information in Wayfinder's GUI, navigate to Infrastructure > Clusters > [Cluster Name].
Use the Upgrades tab to view and approve package upgrades. Use the Packages tab to enable/disable packages and to view additional package information.
Approve upgrades
- Navigate to the upgrades tab
- Expand the upgrade accordions to view relevant upgrade information such as the version number and the upgrade's status
- When the upgrade status is in
Awaiting Approval
, click on the icon to open the 'approval dialogue' box, then click on approve.
View upgrade information
The upgrade overview section advertises which package upgrade versions are available for each cluster. The upgrade overview information is outlined below.
Column name | Column description | Values |
---|---|---|
Type | Signifies what type of upgrade it is | Packages: Signifies that the target upgrade applies to a package |
Name | Name of the upgrade target | [Name of package]: Name of the target package to be upgraded |
Current Version | The current version of the upgrade target | Version number |
Detailed package upgrade information is available from the respective accordions in the upgrade overview section. Users can click on the black triangle in the Type column to expand or close the accordion. Each row in the accordion is an upgradeable version, and Wayfinder will apply the upgrades from earliest to latest release date. The upgrade detailed information is outlined below.
Column name | Column description | Values |
---|---|---|
Version | Signifies the version number that the target is going to be upgraded to | Version number |
Released | Date that the upgrade was released by the cloud provider | yyyy-mm-dd |
Status | The status of the upgrade process |
|
View additional package information
The packages tab shows additional information as outlined below:
Column name | Column description | Values |
---|---|---|
Package | The name of the package | Type:String |
Description | A short description of the package | Type:String |
Chart version | Version of the underlying Helm chart used for deploying the package | Version number |
WF package version | Wayfinder's package version is the same version as the chart version. The package iteration version is shown after the dash. | Version number - version iteration |
Status | The status of the package |
|
Administrative Checklist
Similarities with K8s upgrades
Some of the package upgrade concepts are the same as the control plane and node pool (K8s) upgrades and they are listed below:
- User access permissions
- Upgrade method
- Steps to configure auto-approval settings. Once auto-approval settings are specified, then they apply to package upgrades as well as the control plane / node pool upgrades.
- Upgrade schedule
- Upgrade process
- Upgrade progress indicators
Upgrade strategy
The upgrade strategy defines how the upgrade should be applied and package upgrades use the in-place upgrade strategy. This strategy applies the package in-place and the management of the upgrade/reconcilliation process is left to the FluxCD helm-controller within the cluster.
Upcoming Functionality
CLI Support
Support for upgrading packages from the Wayfinder CLI will be announced in the release section as soon as it becomes available. Appvia recommends that users use the Wayfinder GUI until the CLI functionality is supported. Using the Wayfinder GUI will avoid unexpected system behaviour.
Support
If you have any questions or if you need help with your Wayfinder instance, then please contact us via the Appvia Support Portal.
Also see the Support and Maintenance Terms of Service.