In v2 of the Boot Orchestration Service (BOS), it is possible to stage changes when creating a session.
These changes will not immediately take effect, and will instead be applied when the applystaged endpoint is called.
This is a BOS v2 feature only. For suggestions on working around this in v1, see Stage changes without BOS.
(ncn-mw#) Creating a staged session is no different than creating a normal session, with one exception: the staged value should be set to True.
For more on creating sessions, see Create a new v2 session.
cray bos v2 sessions create --template-name TEMPLATE_NAME --operation boot --stage True --format json
This creates a new BOS session that can be managed and monitored as normal, but rather than updating the component’s desired state, the desired state
information will be stored in a staged_state field. The session will continue to run so long as any components have staged state that has not been
applied so that status can be used to monitor actions such as rolling upgrades.
Applying staged state is done on a per component basis. Multiple components can be specified in a single call.
(ncn-mw#) In the CLI this can be done with a comma-separated list of component names (xnames), or by specifying a range of values.
cray bos v2 applystaged create --xnames x3000c0s19b[1-4]n0
(ncn-mw#) When using the API, components should be provided as a list of xnames.
curl -X POST -H "Authorization: Bearer ${TOKEN}" -H "Content-Type: application/json" --data '{"xnames":["x3000c0s19b1n0","x3000c0s19b2n0"]}' https://api-gw-service-nmn.local/apis/bos/v2/applystaged
When called, any staged data for the given components will be moved to the desired state. In addition BOS will check for the associated session in order to determine what kind of operation to apply. This allows users to stage any operation, including shutdowns.
If for some reason a session that was used to stage data is deleted before applystaged is called for the associated components, it will no longer be possible to apply the staged state
since BOS will not be able to determine which operation should be taken.
By default staged data will not be cleared when applystaged is called, allowing users to call the endpoint multiple times.
This behavior can be changed using the Options endpoint so that the staged data is cleared when applystaged is called.
To stage desired state without BOS v2, users can bypass BOS and set boot artifacts or configuration that will only take place when a node is later booted, whether that occurs manually, or triggered by a task manager.
For information on staging boot artifacts, see the section Upload Node Boot Information to Boot Script Service (BSS).
(ncn-mw#) Disable the Configuration Framework Service (CFS)
for all nodes receiving the staged configuration. Nodes will automatically re-enable configuration when they are rebooted and will be configured with any staged changes.
cray cfs v3 components update <xname> --enabled false
(ncn-mw#) Either set the new desired configuration or update the existing configuration.
If an entirely new configuration is being used or if no configuration was previously set for a component, then update the configuration name with the following:
cray cfs v3 components update <xname> --configuration-name <configuration_name>
If all nodes that share a configuration are being staged with an update, updating the shared configuration will stage the change for all relevant nodes. Be aware that if this step is taken and not all nodes that use the configuration are disabled in CFS, the configuration will automatically and immediately apply to all enabled nodes that are using it.
cray cfs v3 configurations update <configuration_name> --file <file_path>
Users also have the option of specifying branches rather than commits in configurations. If this feature is used, the configuration can also be updated by telling CFS to update the commits for all layers of a configuration that specify branches. Similar to when updating the configuration from a file, this will automatically start configuration on any enabled nodes that are using this configuration. For information on using branches, see Using branches in configuration layers.