From 27cc43359f6eea7bb443caed7b73d0ba023b8f58 Mon Sep 17 00:00:00 2001 From: "Mitch Harding (the weird one)" Date: Tue, 7 Jan 2025 17:04:39 -0500 Subject: [PATCH] CASMCMS-9242: Update BOS OpenAPI spec to pull in new options --- cray/modules/bos/openapi.yaml | 27 ++++- cray/modules/bos/swagger3.json | 180 +++++++++++++++++++++++++++++++-- 2 files changed, 199 insertions(+), 8 deletions(-) diff --git a/cray/modules/bos/openapi.yaml b/cray/modules/bos/openapi.yaml index cf52003..edb8874 100644 --- a/cray/modules/bos/openapi.yaml +++ b/cray/modules/bos/openapi.yaml @@ -975,10 +975,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 @@ -1022,6 +1027,12 @@ components: minimum: 0 # A little over a year maximum: 33554432 + 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 ims_errors_fatal: type: boolean description: | @@ -1040,6 +1051,12 @@ components: 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. + ims_read_timeout: + type: integer + description: The amount of time (in seconds) to wait for a response before timing out a request to IMS + example: 20 + minimum: 10 + maximum: 86400 logging_level: type: string description: The logging level for all BOS services @@ -1068,6 +1085,12 @@ components: minimum: 0 # Over 12 days maximum: 1048576 + 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) diff --git a/cray/modules/bos/swagger3.json b/cray/modules/bos/swagger3.json index 1990686..942df2f 100644 --- a/cray/modules/bos/swagger3.json +++ b/cray/modules/bos/swagger3.json @@ -3080,9 +3080,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 @@ -3124,6 +3131,13 @@ "minimum": 0, "maximum": 33554432 }, + "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 + }, "ims_errors_fatal": { "type": "boolean", "description": "This option modifies how BOS behaves when validating the architecture of a boot image in a boot set.\nSpecifically, this option comes into play when BOS needs data from IMS in order to do this validation, but\nIMS is unreachable.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this.\n" @@ -3132,6 +3146,13 @@ "type": "boolean", "description": "This option modifies how BOS behaves when validating a boot set whose boot image appears to be from IMS.\nSpecifically, this option comes into play when the image does not actually exist in IMS.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this. Note that if ims_images_must_exist is true but ims_errors_fatal is false, then\na failure to determine whether or not an image is in IMS will NOT result in a fatal error.\n" }, + "ims_read_timeout": { + "type": "integer", + "description": "The amount of time (in seconds) to wait for a response before timing out a request to IMS", + "example": 20, + "minimum": 10, + "maximum": 86400 + }, "logging_level": { "type": "string", "description": "The logging level for all BOS services", @@ -3162,6 +3183,13 @@ "minimum": 0, "maximum": 1048576 }, + "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)", @@ -3780,9 +3808,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 @@ -3824,6 +3859,13 @@ "minimum": 0, "maximum": 33554432 }, + "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 + }, "ims_errors_fatal": { "type": "boolean", "description": "This option modifies how BOS behaves when validating the architecture of a boot image in a boot set.\nSpecifically, this option comes into play when BOS needs data from IMS in order to do this validation, but\nIMS is unreachable.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this.\n" @@ -3832,6 +3874,13 @@ "type": "boolean", "description": "This option modifies how BOS behaves when validating a boot set whose boot image appears to be from IMS.\nSpecifically, this option comes into play when the image does not actually exist in IMS.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this. Note that if ims_images_must_exist is true but ims_errors_fatal is false, then\na failure to determine whether or not an image is in IMS will NOT result in a fatal error.\n" }, + "ims_read_timeout": { + "type": "integer", + "description": "The amount of time (in seconds) to wait for a response before timing out a request to IMS", + "example": 20, + "minimum": 10, + "maximum": 86400 + }, "logging_level": { "type": "string", "description": "The logging level for all BOS services", @@ -3862,6 +3911,13 @@ "minimum": 0, "maximum": 1048576 }, + "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)", @@ -5333,9 +5389,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 @@ -5377,6 +5440,13 @@ "minimum": 0, "maximum": 33554432 }, + "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 + }, "ims_errors_fatal": { "type": "boolean", "description": "This option modifies how BOS behaves when validating the architecture of a boot image in a boot set.\nSpecifically, this option comes into play when BOS needs data from IMS in order to do this validation, but\nIMS is unreachable.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this.\n" @@ -5385,6 +5455,13 @@ "type": "boolean", "description": "This option modifies how BOS behaves when validating a boot set whose boot image appears to be from IMS.\nSpecifically, this option comes into play when the image does not actually exist in IMS.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this. Note that if ims_images_must_exist is true but ims_errors_fatal is false, then\na failure to determine whether or not an image is in IMS will NOT result in a fatal error.\n" }, + "ims_read_timeout": { + "type": "integer", + "description": "The amount of time (in seconds) to wait for a response before timing out a request to IMS", + "example": 20, + "minimum": 10, + "maximum": 86400 + }, "logging_level": { "type": "string", "description": "The logging level for all BOS services", @@ -5415,6 +5492,13 @@ "minimum": 0, "maximum": 1048576 }, + "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)", @@ -12406,9 +12490,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 @@ -12450,6 +12541,13 @@ "minimum": 0, "maximum": 33554432 }, + "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 + }, "ims_errors_fatal": { "type": "boolean", "description": "This option modifies how BOS behaves when validating the architecture of a boot image in a boot set.\nSpecifically, this option comes into play when BOS needs data from IMS in order to do this validation, but\nIMS is unreachable.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this.\n" @@ -12458,6 +12556,13 @@ "type": "boolean", "description": "This option modifies how BOS behaves when validating a boot set whose boot image appears to be from IMS.\nSpecifically, this option comes into play when the image does not actually exist in IMS.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this. Note that if ims_images_must_exist is true but ims_errors_fatal is false, then\na failure to determine whether or not an image is in IMS will NOT result in a fatal error.\n" }, + "ims_read_timeout": { + "type": "integer", + "description": "The amount of time (in seconds) to wait for a response before timing out a request to IMS", + "example": 20, + "minimum": 10, + "maximum": 86400 + }, "logging_level": { "type": "string", "description": "The logging level for all BOS services", @@ -12488,6 +12593,13 @@ "minimum": 0, "maximum": 1048576 }, + "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)", @@ -12530,9 +12642,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 @@ -12574,6 +12693,13 @@ "minimum": 0, "maximum": 33554432 }, + "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 + }, "ims_errors_fatal": { "type": "boolean", "description": "This option modifies how BOS behaves when validating the architecture of a boot image in a boot set.\nSpecifically, this option comes into play when BOS needs data from IMS in order to do this validation, but\nIMS is unreachable.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this.\n" @@ -12582,6 +12708,13 @@ "type": "boolean", "description": "This option modifies how BOS behaves when validating a boot set whose boot image appears to be from IMS.\nSpecifically, this option comes into play when the image does not actually exist in IMS.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this. Note that if ims_images_must_exist is true but ims_errors_fatal is false, then\na failure to determine whether or not an image is in IMS will NOT result in a fatal error.\n" }, + "ims_read_timeout": { + "type": "integer", + "description": "The amount of time (in seconds) to wait for a response before timing out a request to IMS", + "example": 20, + "minimum": 10, + "maximum": 86400 + }, "logging_level": { "type": "string", "description": "The logging level for all BOS services", @@ -12612,6 +12745,13 @@ "minimum": 0, "maximum": 1048576 }, + "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)", @@ -12643,9 +12783,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 @@ -12687,6 +12834,13 @@ "minimum": 0, "maximum": 33554432 }, + "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 + }, "ims_errors_fatal": { "type": "boolean", "description": "This option modifies how BOS behaves when validating the architecture of a boot image in a boot set.\nSpecifically, this option comes into play when BOS needs data from IMS in order to do this validation, but\nIMS is unreachable.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this.\n" @@ -12695,6 +12849,13 @@ "type": "boolean", "description": "This option modifies how BOS behaves when validating a boot set whose boot image appears to be from IMS.\nSpecifically, this option comes into play when the image does not actually exist in IMS.\nIn the above situation, if this option is true, then the validation will fail.\nOtherwise, if the option is false, then a warning will be logged, but the validation will not\nbe failed because of this. Note that if ims_images_must_exist is true but ims_errors_fatal is false, then\na failure to determine whether or not an image is in IMS will NOT result in a fatal error.\n" }, + "ims_read_timeout": { + "type": "integer", + "description": "The amount of time (in seconds) to wait for a response before timing out a request to IMS", + "example": 20, + "minimum": 10, + "maximum": 86400 + }, "logging_level": { "type": "string", "description": "The logging level for all BOS services", @@ -12725,6 +12886,13 @@ "minimum": 0, "maximum": 1048576 }, + "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)",