Configure Kubernetes Multi-Version Upgrade Cloud Orchestration for AIO-SX¶
You can configure Kubernetes multi-version upgrade orchestration strategy using the sw-manager command. This feature is enabled from StarlingX release 8.0 and is supported only for the AIO-SX system.
Note
You require administrator privileges to use the sw-manager command. You must log in to the active controller as user sysadmin and source the script by using the source /etc/platform/openrc command to obtain administrator privileges. Do not use sudo.
Note
Management-affecting alarms cannot be ignored using relaxed alarm rules during an orchestrated Kubernetes version upgrade operation. For a list of management-affecting alarms, see StarlingX Fault Management: 100 Series Alarm Messages. To display management-affecting active alarms, use the fm alarm-list --mgmt_affecting command.
During an orchestrated Kubernetes version upgrade operation, the following alarms are ignored even when the default strict restrictions are selected:
100.103: Memory threshold exceeded
200.001: Locked host
280.001: Subcloud resource off-line
280.002: Subcloud resource out-of-sync
700.004: VM stopped
750.006: Configuration change requires reapply of cert-manager
900.001: Patch in progress
900.007: Kube upgrade in progress
900.401: kube-upgrade-auto-apply-inprogress
You can use help for the overall commands and also for each sub-command.
For example:
~(keystone_admin)$ sw-manager kube-upgrade-strategy –help
usage: sw-manager kube-upgrade-strategy [-h] ...
optional arguments:
-h, --help show this help message and exit
Kubernetes Update Commands:
create Create a strategy
delete Delete a strategy
apply Apply a strategy
abort Abort a strategy
show Show a strategy
Prerequisites
Hosts that need to be upgraded must be in the unlocked-enabled state.
If you are using NetApp Trident, ensure that your NetApp version is compatible with Trident 22.07 before upgrading Kubernetes to version 1.23.1 and after updating StarlingX to version r9.0. For more information, see Upgrade the NetApp Trident Software.
Procedure
List available upgrades.
~(keystone_admin)$ system kube-version-list +-----------------+--------+-------------+ | Version | Target | State | +-----------------+--------+-------------+ | v1.21.8 | True | active | | v1.22.5 | False | available | | v1.23.1 | False | available | | v1.24.4 | False | available | +-----------------+--------+-------------+
Confirm that the system is healthy.
Check the current system health status, resolve any alarms and other issues reported by the system health-query-kube-upgrade command. Then, recheck the system health status to confirm that all System Health fields are set to OK.
By default, the upgrade process cannot be run and is not recommended to be run with active alarms present. Use the system kube-upgrade-start --force command to force the upgrade process to start and ignore non-management-affecting alarms.
Note
It is strongly recommended that you clear your system of all alarms before doing an upgrade. While the --force option is available to run the upgrade, it is a best practice to clear any alarms.
~(keystone_admin)]$ system health-query-kube-upgrade System Health: All hosts are provisioned: [OK] All hosts are unlocked/enabled: [OK] All hosts have current configurations: [OK] All hosts are patch current: [OK] No alarms: [OK] All kubernetes nodes are ready: [OK] All kubernetes control plane pods are ready: [OK] All kubernetes applications are in a valid state: [OK]Create the strategy.
The Kubernetes multi-version upgrade orchestration strategy create command creates a series of stages with steps that apply the Kubernetes version upgrade.
Specify the desired Kubernetes version in
--to-version(usually the highest version available in the system).~(keystone_admin)$ sw-manager kube-upgrade-strategy create --to-version v1.24.4 Strategy Kubernetes Upgrade Strategy: strategy-uuid: f03f5944-ee79-4047-8d2e-68bfa6775210 controller-apply-type: serial storage-apply-type: serial worker-apply-type: serial default-instance-action: stop-start alarm-restrictions: strict current-phase: build current-phase-completion: 0% state: building inprogress: true
where:
--to-versionThe version of Kubernetes to upgrade to, for example,
v1.24.4. This argument is required.--controller-apply-typeand--storage-apply-typeThese options cannot be changed from
serialbecause Kubernetes upgrade concurrency is only supported for worker hosts.Note
Setting the Kubernetes version upgrade apply type is supported only for hosts with the worker function. Any attempt to modify the controller or storage apply type will be rejected.
--worker-apply-typeThis option specifies the host concurrency of the Kubernetes version upgrade strategy:
serial (default): worker hosts will be patched one at a time
parallel: worker hosts will be upgraded in parallel
At most,
parallelwill be upgraded at the same timeAt most, half of the hosts in a host aggregate will be upgraded at the same time
ignore: worker hosts will not be upgraded; strategy create will fail
Worker hosts with no instances are upgraded before worker hosts with instances.
--max-parallel-worker-hostsThis option applies to the parallel worker apply type selection to specify the maximum worker hosts to upgrade in parallel (minimum: 2, maximum: 10).
--alarm-restrictionsThis option sets how the Kubernetes version upgrade orchestration behaves when alarms are present.
To display management-affecting active alarms, use the fm alarm-list --mgmt_affecting command.
strict(default)The default strict option will result in the failure of patch orchestration if there are any alarms present in the system (except for a small list of alarms).
relaxedThis option allows orchestration to proceed even if alarms are present, as long as none of these alarms are management affecting.
~(keystone_admin)]$ sw-manager kube-upgrade-strategy create --help usage:sw-manager kube-upgrade-strategy [-h] --to-version <kubernetesVersion> [--controller-apply-type {ignore}] [--storage-apply-type {ignore}] [--worker-apply-type {serial,parallel,ignore}] [--max-parallel-worker-hosts {2,3,4,5,6,7,8,9,10}] [--instance-action {migrate,stop-start}] [--alarm-restrictions {strict,relaxed}] optional arguments: -h, --help show this help message and exit --controller-apply-type {serial,ignore} defaults to serial --storage-apply-type {serial,ignore} defaults to serial --worker-apply-type {serial,parallel,ignore} defaults to serial --max-parallel-worker-hosts {2,3,4,5,6,7,8,9,10} maximum worker hosts to update in parallel --instance-action {migrate,stop-start} defaults to stop-start --alarm-restrictions {strict,relaxed} defaults to strictOptional step: Display the strategy in summary, if required. The Kubernetes upgrade strategy show command displays the strategy in a summary.
~(keystone_admin)$ sw-manager kube-upgrade-strategy show Strategy Kubernetes Upgrade Strategy: strategy-uuid: f03f5944-ee79-4047-8d2e-68bfa6775210 controller-apply-type: serial storage-apply-type: serial worker-apply-type: serial default-instance-action: stop-start alarm-restrictions: strict current-phase: build current-phase-completion: 100% state: ready-to-apply build-result: success build-reason:
The show strategy subcommand displays a summary of the current state of the strategy. A complete view of the strategy can be shown using the
--detailsoption.The strategy steps and stages are displayed using the
--detailsoption.Apply the strategy.
Kubernetes multi-version upgrade orchestration strategy apply command runs the strategy stages and steps consecutively until the Kubernetes upgrade on all the hosts in the strategy is completed.
Use the
-stage-idoption to specify a specific stage to apply one at a time.Note
When applying a single stage, only the next stage will be applied. You cannot skip stages.
~(keystone_admin)$ sw-manager kube-upgrade-strategy apply Strategy Kubernetes upgrade Strategy: strategy-uuid: f03f5944-ee79-4047-8d2e-68bfa6775210 controller-apply-type: serial storage-apply-type: serial worker-apply-type: serial default-instance-action: stop-start alarm-restrictions: strict current-phase: apply current-phase-completion: 0% state: applying inprogress: true
Use the kube-upgrade-show command to monitor Kubernetes upgrade state and percentage completion.
~(keystone_admin)$ system kube-upgrade-show +--------------+--------------------------------------+ | Property | Value | +--------------+--------------------------------------+ | uuid | 1272e9cc-1a15-4a53-bb5a-d47494729068 | | from_version | v1.21.8 | | to_version | v1.24.4 | | state | downloading-images | | created_at | 2023-09-25T18:32:10.820488+00:00 | | updated_at | 2023-09-25T18:32:10.885709+00:00 | +--------------+--------------------------------------+
You will see the
stateproperty transition through values, such asdownloading-images,downloaded-images,upgraded-networking, andupgraded-first-master.Optional step: Abort the strategy, if required. This is only used to stop and abort the entire strategy.
The Kubernetes version upgrade strategy abort command can be used to abort the Kubernetes version upgrade strategy after the current step of the currently applying stage is completed.
Confirm that the upgrade has completed successfully.
~(keystone_admin)$ system kube-upgrade-show +--------------+--------------------------------------+ | Property | Value | +--------------+--------------------------------------+ | uuid | 1272e9cc-1a15-4a53-bb5a-d47494729068 | | from_version | v1.21.8 | | to_version | v1.24.4 | | state | upgrade-complete | | created_at | 2023-09-25T18:52:10.885709+00:00 | | updated_at | 2023-09-25T18:52:11.673259+00:00 | +--------------+--------------------------------------+ ~(keystone_admin)$ system kube-version-list +-----------------+--------+-------------+ | Version | Target | State | +-----------------+--------+-------------+ | v1.21.8 | False | unavailable | | v1.22.5 | False | unavailable | | v1.23.1 | False | unavailable | | v1.24.4 | True | active | +-----------------+--------+-------------+
Delete the strategy.
Note
After the Kubernetes multi-version upgrade orchestration strategy has been applied (or aborted), it must be deleted before another Kubernetes version upgrade strategy can be created. If a Kubernetes version upgrade strategy application fails, you must address the issue that caused the failure, then delete and re-create the strategy before attempting to apply it again.
~(keystone_admin)$ sw-manager kube-upgrade-strategy delete Strategy deleted.
