docs/doc/source/updates/kubernetes/update-orchestration-cli.rst
Ron Stone c3444e384d Implement alarm parsing
Configure tox+content to fetch event and convert alarms and logs
to rst for use in build.
Handle non-existant tmp dir in zuul builds
Add static events.yaml for CI/CD testingx
Generalize label construction to prevent namespace conflicts
Consume events directly from fm repo (required changes merged)
Update logs template for legibility.
Add clean up for temporary rst files.
Point parser at dynamically downloaded events file
Restore logs template

Note: This review deletes static alarm and log files
Note: This review excludes alarm files from git as they are now
      build-time temp files.
Note: This review uses a static copy of events.yaml to pass tox
      until the dep. below is met. It will need reconfiguration
      at that time.

Depends-On: https://review.opendev.org/c/starlingx/fault/+/863574

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I0bb8d0a77b9d3cf22b33f8930c569b3e70b7291c
2022-11-18 11:34:27 -05:00

2.0 KiB

Update Orchestration CLI

The update orchestration CLI is sw-manager. Use this to create your update strategy.

The commands and options map directly to the parameter descriptions in the web interface dialog, described in Configuring Update Orchestration <configuring-update-orchestration>.

Note

To use update orchestration commands, you need administrator privileges. You must log in to the active controller as user sysadmin and source the /etc/platform/openrc script to obtain administrator privileges. Do not use sudo.

Note

Management-affecting alarms cannot be ignored at the indicated severity level or higher by using relaxed alarm rules during an orchestrated update operation. For a list of management-affecting alarms, see : Alarm Messages <100-series-alarm-messages-starlingx>. To display management-affecting active alarms, use the following command:

~(keystone_admin)$ fm alarm-list --mgmt_affecting

During an orchestrated update operation, the following alarms are ignored even when strict restrictions are selected:

  • 200.001, Maintenance host lock alarm
  • 900.001, Patch in progress
  • 900.005, Upgrade in progress
  • 900.101, Software patch auto apply in progress

Help is available for the overall command and also for each sub-command. For example:

~(keystone_admin)]$  sw-manager patch-strategy --help
usage: sw-manager patch-strategy [-h]  ...

optional arguments:
  -h, --help  show this help message and exit

Update orchestration commands include:

  • create - Create a strategy
  • delete - Delete a strategy
  • apply - Apply a strategy
  • abort - Abort a strategy
  • show - Show a strategy