Skip to content

Commit

Permalink
CASMCMS-9145/CASMCMS-9146: Add new BOS options to CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
mharding-hpe committed Oct 7, 2024
1 parent bbae39a commit b47dd34
Show file tree
Hide file tree
Showing 2 changed files with 173 additions and 107 deletions.
50 changes: 34 additions & 16 deletions cray/modules/bos/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ openapi: "3.0.3"

info:
title: "Boot Orchestration Service"
version: "0.0.0-api"
version: "2.30.0"
description: |
The Boot Orchestration Service (BOS) provides coordinated provisioning actions
over defined hardware sets to enable boot, reboot, shutdown, configuration and
Expand Down Expand Up @@ -998,6 +998,12 @@ components:
minLength: 1
# This allows for over 10 years using the smallest units (minutes)
maxLength: 8
default_retry_policy:
type: integer
description: The default maximum number attempts per node for failed actions.
example: 1
minimum: 0
maximum: 1048576
disable_components_on_completion:
type: boolean
description: |
Expand All @@ -1009,6 +1015,24 @@ components:
minimum: 0
# A little over a year
maximum: 33554432
ims_errors_fatal:
type: boolean
description: |
This option modifies how BOS behaves when validating the architecture of a boot image in a boot set.
Specifically, this option comes into play when BOS needs data from IMS in order to do this validation, but
IMS is unreachable.
In the above situation, if this option is true, then the validation will fail.
Otherwise, if the option is false, then a warning will be logged, but the validation will not
be failed because of this.
ims_images_must_exist:
type: boolean
description: |
This option modifies how BOS behaves when validating a boot set whose boot image appears to be from IMS.
Specifically, this option comes into play when the image does not actually exist in IMS.
In the above situation, if this option is true, then the validation will fail.
Otherwise, if the option is false, then a warning will be logged, but the validation will not
be failed because of this. Note that if ims_images_must_exist is true but ims_errors_fatal is false, then
a failure to determine whether or not an image is in IMS will NOT result in a fatal error.
logging_level:
type: string
description: The logging level for all BOS services
Expand All @@ -1019,36 +1043,30 @@ components:
minimum: 0
# Over 12 days
maximum: 1048576
max_power_on_wait_time:
max_component_batch_size:
type: integer
description: How long BOS will wait for a node to power on before calling power on again (in seconds)
description: The maximum number of Components that a BOS operator will process at once. 0 means no limit.
example: 1000
minimum: 0
# Over 12 days
maximum: 1048576
maximum: 131071
max_power_off_wait_time:
type: integer
description: How long BOS will wait for a node to power off before forcefully powering off (in seconds)
minimum: 0
# Over 12 days
maximum: 1048576
polling_frequency:
max_power_on_wait_time:
type: integer
description: How frequently the BOS operators check Component state for needed actions (in seconds)
description: How long BOS will wait for a node to power on before calling power on again (in seconds)
minimum: 0
# Over 12 days
maximum: 1048576
default_retry_policy:
polling_frequency:
type: integer
description: The default maximum number attempts per node for failed actions.
example: 1
description: How frequently the BOS operators check Component state for needed actions (in seconds)
minimum: 0
# Over 12 days
maximum: 1048576
max_component_batch_size:
type: integer
description: The maximum number of Components that a BOS operator will process at once. 0 means no limit.
example: 1000
minimum: 0
maximum: 131071
reject_nids:
type: boolean
description: |
Expand Down
Loading

0 comments on commit b47dd34

Please sign in to comment.