diff --git a/api/services/ocean/rightsizing/paths/oceanRightsizingClusterConfiguration.yaml b/api/services/ocean/rightsizing/paths/oceanRightsizingClusterConfiguration.yaml index 715b3366..3a3b9456 100644 --- a/api/services/ocean/rightsizing/paths/oceanRightsizingClusterConfiguration.yaml +++ b/api/services/ocean/rightsizing/paths/oceanRightsizingClusterConfiguration.yaml @@ -1,11 +1,11 @@ post: - summary: "Set Cluster Recommendations Percentile" + summary: "Set Rightsizing Cluster configuration" description: | - Set Recommendations Percentile for the Ocean Cluster. + Set Cluster Configuration for the Ocean Cluster.

**This action can take a few minutes to complete.** - operationId: "SetClusterRecommendationsPercentile" + operationId: "SetClusterConfiguration" tags: - "Ocean Automatic Rightsizing" parameters: @@ -21,7 +21,28 @@ post: - $ref: "../schemas/oceanRightsizingSetClusterRecommendationsPercentileRequest.yaml" responses: 200: - description: Ocean Cluster Recommendations Percentile Response + description: Ocean Cluster configuration Response + $ref: "../responses/oceanRightsizingClusterConfigurationCreateResponse.yaml" + 400: + description: "Bad Request" + +get: + summary: "Get Rightsizing Cluster configuration" + description: | + Get Cluster Configuration for the Ocean Cluster. +
+
+ **This action can take a few minutes to complete.** + operationId: "GetClusterConfiguration" + tags: + - "Ocean Automatic Rightsizing" + parameters: + - $ref: "../parameters/oceanId.yaml" + - $ref: "../parameters/clusterIdentifier.yaml" + - $ref: "../../../../commons/parameters/accountId.yaml" + responses: + 200: + description: Ocean Cluster configuration Response $ref: "../responses/oceanRightsizingClusterConfigurationResponse.yaml" 400: description: "Bad Request" \ No newline at end of file diff --git a/api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationCreateResponse.yaml b/api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationCreateResponse.yaml new file mode 100644 index 00000000..5f488f49 --- /dev/null +++ b/api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationCreateResponse.yaml @@ -0,0 +1,46 @@ +description: Ocean Rightsizing Cluster Configuration Response +content: + application/json: + schema: + allOf: + - $ref: "../../../../commons/schemas/responseItemWrapper.yaml" + - type: object + properties: + request: + type: object + properties: + url: + example: "/ocean/{oceanId}/rightSizing/cluster/configuration" + method: + example: "POST" + response: + type: object + properties: + items: + type: array + items: + type: object + properties: + oceanId: + type: string + example: "o-abcd1234" + clusterIdentifier: + type: string + example: "dev-cluster" + config: + type: object + properties: + recommendationsCpuPercentile: + type: integer + example: 85 + recommendationsMemoryPercentile: + type: integer + example: 85 + downsideOnly: + type: boolean + example: false + adjustLimitOnDownsize: + type: boolean + example: true + kind: + example: "mcs:ocean:rightSizing:clusterConfiguration" \ No newline at end of file diff --git a/api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationResponse.yaml b/api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationResponse.yaml index c19e8dc7..2ca96e24 100644 --- a/api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationResponse.yaml +++ b/api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationResponse.yaml @@ -12,7 +12,7 @@ content: url: example: "/ocean/{oceanId}/rightSizing/cluster/configuration" method: - example: "POST" + example: "GET" response: type: object properties: @@ -39,5 +39,8 @@ content: downsideOnly: type: boolean example: false + adjustLimitOnDownsize: + type: boolean + example: true kind: example: "mcs:ocean:rightSizing:clusterConfiguration" \ No newline at end of file diff --git a/api/services/ocean/rightsizing/schemas/oceanRightsizingSetClusterRecommendationsPercentileRequest.yaml b/api/services/ocean/rightsizing/schemas/oceanRightsizingSetClusterRecommendationsPercentileRequest.yaml index 7420849a..30829d8d 100644 --- a/api/services/ocean/rightsizing/schemas/oceanRightsizingSetClusterRecommendationsPercentileRequest.yaml +++ b/api/services/ocean/rightsizing/schemas/oceanRightsizingSetClusterRecommendationsPercentileRequest.yaml @@ -19,4 +19,10 @@ properties: downsideOnly: type: boolean description: When set to 'true', only downscale recommendations will be applied. + example: false + default: false + adjustLimitOnDownsize: + type: boolean + description: When set to 'true', the limit will be adjusted when downscale recommendations are applied. + example: true default: false \ No newline at end of file