Skip to content

Commit

Permalink
CASMCMS-9242: Update BOS OpenAPI spec to pull in new options
Browse files Browse the repository at this point in the history
  • Loading branch information
@mharding-hpe
mharding-hpe committed Jan 7, 2025
1 parent 53d6777 commit 8f06492
Show file tree
Hide file tree
Showing 2 changed files with 151 additions and 8 deletions.
21 changes: 19 additions & 2 deletions cray/modules/bos/openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1182,10 +1182,15 @@ components:
Options for the boot orchestration service.
type: object
properties:
bss_read_timeout:
type: integer
description: The amount of time (in seconds) to wait for a response before timing out a request to BSS
example: 20
minimum: 10
maximum: 86400
cfs_read_timeout:
type: integer
description: |
The amount of time (in seconds) to wait for a response before timing out a request to CFS
description: The amount of time (in seconds) to wait for a response before timing out a request to CFS
example: 20
minimum: 10
maximum: 86400
Expand All @@ -1204,6 +1209,12 @@ components:
discovery_frequency:
type: integer
description: How frequently the BOS discovery agent syncs new components from HSM. (in seconds)
hsm_read_timeout:
type: integer
description: The amount of time (in seconds) to wait for a response before timing out a request to HSM
example: 20
minimum: 10
maximum: 86400
logging_level:
type: string
description: The logging level for all BOS services
Expand All @@ -1216,6 +1227,12 @@ components:
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)
pcs_read_timeout:
type: integer
description: The amount of time (in seconds) to wait for a response before timing out a request to PCS
example: 20
minimum: 10
maximum: 86400
polling_frequency:
type: integer
description: How frequently the BOS operators check component state for needed actions. (in seconds)
Expand Down
138 changes: 132 additions & 6 deletions cray/modules/bos/swagger3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2582,9 +2582,16 @@
"description": "Options for the boot orchestration service.\n",
"type": "object",
"properties": {
"bss_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to BSS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"cfs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.\n",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.",
"example": 20,
"minimum": 10,
"maximum": 86400
Expand All @@ -2609,6 +2616,13 @@
"type": "integer",
"description": "How frequently the BOS discovery agent syncs new components from HSM. (in seconds)"
},
"hsm_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to HSM.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"logging_level": {
"type": "string",
"description": "The logging level for all BOS services"
Expand All @@ -2625,6 +2639,13 @@
"type": "integer",
"description": "How long BOS will wait for a node to power off before forcefully powering off (in seconds)"
},
"pcs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to PCS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"polling_frequency": {
"type": "integer",
"description": "How frequently the BOS operators check component state for needed actions. (in seconds)"
Expand Down Expand Up @@ -3607,9 +3628,16 @@
"description": "Options for the boot orchestration service.\n",
"type": "object",
"properties": {
"bss_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to BSS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"cfs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.\n",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.",
"example": 20,
"minimum": 10,
"maximum": 86400
Expand All @@ -3634,6 +3662,13 @@
"type": "integer",
"description": "How frequently the BOS discovery agent syncs new components from HSM. (in seconds)"
},
"hsm_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to HSM.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"logging_level": {
"type": "string",
"description": "The logging level for all BOS services"
Expand All @@ -3650,6 +3685,13 @@
"type": "integer",
"description": "How long BOS will wait for a node to power off before forcefully powering off (in seconds)"
},
"pcs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to PCS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"polling_frequency": {
"type": "integer",
"description": "How frequently the BOS operators check component state for needed actions. (in seconds)"
Expand Down Expand Up @@ -5153,9 +5195,16 @@
"description": "Options for the boot orchestration service.\n",
"type": "object",
"properties": {
"bss_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to BSS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"cfs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.\n",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.",
"example": 20,
"minimum": 10,
"maximum": 86400
Expand All @@ -5180,6 +5229,13 @@
"type": "integer",
"description": "How frequently the BOS discovery agent syncs new components from HSM. (in seconds)"
},
"hsm_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to HSM.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"logging_level": {
"type": "string",
"description": "The logging level for all BOS services"
Expand All @@ -5196,6 +5252,13 @@
"type": "integer",
"description": "How long BOS will wait for a node to power off before forcefully powering off (in seconds)"
},
"pcs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to PCS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"polling_frequency": {
"type": "integer",
"description": "How frequently the BOS operators check component state for needed actions. (in seconds)"
Expand Down Expand Up @@ -14640,9 +14703,16 @@
"description": "Options for the boot orchestration service.\n",
"type": "object",
"properties": {
"bss_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to BSS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"cfs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.\n",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.",
"example": 20,
"minimum": 10,
"maximum": 86400
Expand All @@ -14667,6 +14737,13 @@
"type": "integer",
"description": "How frequently the BOS discovery agent syncs new components from HSM. (in seconds)"
},
"hsm_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to HSM.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"logging_level": {
"type": "string",
"description": "The logging level for all BOS services"
Expand All @@ -14683,6 +14760,13 @@
"type": "integer",
"description": "How long BOS will wait for a node to power off before forcefully powering off (in seconds)"
},
"pcs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to PCS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"polling_frequency": {
"type": "integer",
"description": "How frequently the BOS operators check component state for needed actions. (in seconds)"
Expand Down Expand Up @@ -14729,9 +14813,16 @@
"description": "Options for the boot orchestration service.\n",
"type": "object",
"properties": {
"bss_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to BSS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"cfs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.\n",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.",
"example": 20,
"minimum": 10,
"maximum": 86400
Expand All @@ -14756,6 +14847,13 @@
"type": "integer",
"description": "How frequently the BOS discovery agent syncs new components from HSM. (in seconds)"
},
"hsm_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to HSM.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"logging_level": {
"type": "string",
"description": "The logging level for all BOS services"
Expand All @@ -14772,6 +14870,13 @@
"type": "integer",
"description": "How long BOS will wait for a node to power off before forcefully powering off (in seconds)"
},
"pcs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to PCS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"polling_frequency": {
"type": "integer",
"description": "How frequently the BOS operators check component state for needed actions. (in seconds)"
Expand Down Expand Up @@ -14807,9 +14912,16 @@
"description": "Options for the boot orchestration service.\n",
"type": "object",
"properties": {
"bss_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to BSS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"cfs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.\n",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to CFS.",
"example": 20,
"minimum": 10,
"maximum": 86400
Expand All @@ -14834,6 +14946,13 @@
"type": "integer",
"description": "How frequently the BOS discovery agent syncs new components from HSM. (in seconds)"
},
"hsm_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to HSM.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"logging_level": {
"type": "string",
"description": "The logging level for all BOS services"
Expand All @@ -14850,6 +14969,13 @@
"type": "integer",
"description": "How long BOS will wait for a node to power off before forcefully powering off (in seconds)"
},
"pcs_read_timeout": {
"type": "integer",
"description": "The amount of time (in seconds) to wait for a response before timing out a request to PCS.",
"example": 20,
"minimum": 10,
"maximum": 86400
},
"polling_frequency": {
"type": "integer",
"description": "How frequently the BOS operators check component state for needed actions. (in seconds)"
Expand Down

0 comments on commit 8f06492

Please sign in to comment.