From 7d5f343d295d8f5e1fc52c4304360e5616242d12 Mon Sep 17 00:00:00 2001 From: KsaweryZietara Date: Fri, 10 Jan 2025 08:57:17 +0100 Subject: [PATCH 01/14] Additional worker node pools docs --- docs/user/03-10-service-description.md | 132 +++++++------- .../04-40-additional-worker-node-pools.md | 164 ++++++++++++++++++ 2 files changed, 236 insertions(+), 60 deletions(-) create mode 100644 docs/user/04-40-additional-worker-node-pools.md diff --git a/docs/user/03-10-service-description.md b/docs/user/03-10-service-description.md index 4663fadc4a..3c5a7d3bc7 100644 --- a/docs/user/03-10-service-description.md +++ b/docs/user/03-10-service-description.md @@ -72,16 +72,18 @@ These are the provisioning parameters for Azure that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D2s_v5` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| Parameter name | Type | Description | Required | Default value | +|-----------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D2s_v5` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -93,16 +95,18 @@ These are the provisioning parameters for Azure that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D4s_v5` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| Parameter name | Type | Description | Required | Default value | +|-----------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D4s_v5` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -118,16 +122,18 @@ These are the provisioning parameters for AWS that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| Parameter name | Type | Description | Required | Default value | +|-----------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -144,16 +150,18 @@ These are the provisioning parameters for GCP that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-----------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `n2-standard-2` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `4` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| Parameter name | Type | Description | Required | Default value | +|-----------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-----------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `n2-standard-2` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `4` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -170,16 +178,18 @@ These are the provisioning parameters for SapConvergedCloud that you can configu -| Parameter name | Type | Description | Required | Default value | -|-------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `g_c2_m8` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `20` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| Parameter name | Type | Description | Required | Default value | +|-----------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `g_c2_m8` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `20` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -261,16 +271,18 @@ These are the provisioning parameters for the `preview` plan that you configure: -| Parameter name | Type | Description | Required | Default value | -|-------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| Parameter name | Type | Description | Required | Default value | +|-----------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md new file mode 100644 index 0000000000..17165b6c80 --- /dev/null +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -0,0 +1,164 @@ +# Additional Worker Node Pools + +To create an SAP BTP, Kyma runtime with additional worker node pools, specify the `additionalWorkerNodePools` provisioning parameter. + +> [!NOTE] +> `name`, `machineType`, `autoScalerMin` and `autoScalerMax` values are mandatory for additional worker node pool configuration. + +See the example: + +```bash + export VERSION=1.15.0 + curl --request PUT "https://$BROKER_URL/oauth/v2/service_instances/$INSTANCE_ID?accepts_incomplete=true" \ + --header 'X-Broker-API-Version: 2.14' \ + --header 'Content-Type: application/json' \ + --header "$AUTHORIZATION_HEADER" \ + --header 'Content-Type: application/json' \ + --data-raw "{ + \"service_id\": \"47c9dcbf-ff30-448e-ab36-d3bad66ba281\", + \"plan_id\": \"4deee563-e5ec-4731-b9b1-53b42d855f0c\", + \"context\": { + \"globalaccount_id\": \"$GLOBAL_ACCOUNT_ID\" + }, + \"parameters\": { + \"name\": \"$NAME\", + \"region\": \"$REGION\", + \"additionalWorkerNodePools\": { + \"list\": [ + { + \"name\": \"worker-1\", + \"machineType\": \"Standard_D2s_v5\", + \"autoScalerMin\": 3, + \"autoScalerMax\": 20 + }, + { + \"name\": \"worker-2\", + \"machineType\": \"Standard_D4s_v5\", + \"autoScalerMin\": 5, + \"autoScalerMax\": 25 + } + ] + } + } + }" +``` + +If you do not provide the `additionalWorkerNodePools` object in the provisioning request, or set `skipModification` property to `true`, no additional worker node pools will be created. +If you do not provide the `additionalWorkerNodePools` object in the update request or set `skipModification` property to `true`, saved additional worker node pools stay untouched. +However, if you provide an empty list in the update request, all additional worker node pools will be removed. + +See the following JSON example without the `additionalWorkerNodePools` object: +```json +{ + "service_id" : "47c9dcbf-ff30-448e-ab36-d3bad66ba281", + "plan_id" : "4deee563-e5ec-4731-b9b1-53b42d855f0c", + "context" : { + "globalaccount_id" : {GLOBAL_ACCOUNT_ID} + }, + "parameters" : { + "region": {REGION}, + "name" : {CLUSTER_NAME} + } +} +``` + +See the following JSON example with the `additionalWorkerNodePools` object with `skipModification` property set to `true`: +```json +{ + "service_id" : "47c9dcbf-ff30-448e-ab36-d3bad66ba281", + "plan_id" : "4deee563-e5ec-4731-b9b1-53b42d855f0c", + "context" : { + "globalaccount_id" : {GLOBAL_ACCOUNT_ID} + }, + "parameters" : { + "region": {REGION}, + "name" : {CLUSTER_NAME}, + "additionalWorkerNodePools" : { + "skipModification": true + } + } +} +``` + +See the following JSON example, where the `additionalWorkerNodePools` object contains an empty list: +```json +{ + "service_id" : "47c9dcbf-ff30-448e-ab36-d3bad66ba281", + "plan_id" : "4deee563-e5ec-4731-b9b1-53b42d855f0c", + "context" : { + "globalaccount_id" : {GLOBAL_ACCOUNT_ID} + }, + "parameters" : { + "region": {REGION}, + "name" : {CLUSTER_NAME}, + "additionalWorkerNodePools" : { + "list": [] + } + } +} +``` + +To update additional worker node pools, provide list of objects with values for the mandatory properties. Without these values, a validation error occurs. +The update operation overwrites the additional worker node pools with the list provided in JSON. See the following scenario: + +1. An existing instance has the following additional worker node pools: +```json +{ + "additionalWorkerNodePools": { + "list": [ + { + "name": "worker-1", + "machineType": "Standard_D2s_v5", + "autoScalerMin": 3, + "autoScalerMax": 20 + }, + { + "name": "worker-2", + "machineType": "Standard_D4s_v5", + "autoScalerMin": 5, + "autoScalerMax": 25 + } + ] + } +} +``` + +2. A user sends an update request (HTTP PUT) with the following JSON in the payload: +```json +{ + "service_id": "47c9dcbf-ff30-448e-ab36-d3bad66ba281", + "plan_id": "4deee563-e5ec-4731-b9b1-53b42d855f0c", + "context": { + "globalaccount_id" : {GLOBAL_ACCOUNT_ID} + }, + "parameters": { + "name" : {CLUSTER_NAME}, + "additionalWorkerNodePools": { + "list": [ + { + "name": "worker-3", + "machineType": "Standard_D8s_v5", + "autoScalerMin": 10, + "autoScalerMax": 30 + } + ] + } + } +} +``` + +3. The additional worker node pools are updated to include the values of the `additionalWorkerNodePools` object from JSON provided in the update request: +```json +{ + "additionalWorkerNodePools": { + "list": [ + { + "name": "worker-3", + "machineType": "Standard_D8s_v5", + "autoScalerMin": 10, + "autoScalerMax": 30 + } + ] + } +} +``` From c0cf2166cda4f4ca326c2936d780ae8e02b9ad8f Mon Sep 17 00:00:00 2001 From: KsaweryZietara Date: Wed, 15 Jan 2025 10:03:05 +0100 Subject: [PATCH 02/14] Add not_supported footnote --- docs/user/03-10-service-description.md | 146 +++++++++++++------------ 1 file changed, 74 insertions(+), 72 deletions(-) diff --git a/docs/user/03-10-service-description.md b/docs/user/03-10-service-description.md index 3c5a7d3bc7..655313bbfb 100644 --- a/docs/user/03-10-service-description.md +++ b/docs/user/03-10-service-description.md @@ -72,18 +72,18 @@ These are the provisioning parameters for Azure that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-----------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D2s_v5` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | -| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | -| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | +| Parameter name | Type | Description | Required | Default value | +|------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D2s_v5` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update) [2](#not_supported)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update) [2](#not_supported)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -95,18 +95,18 @@ These are the provisioning parameters for Azure that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-----------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D4s_v5` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | -| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | -| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | +| Parameter name | Type | Description | Required | Default value | +|------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-------------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `Standard_D4s_v5` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `2` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update) [2](#not_supported)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update) [2](#not_supported)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -122,18 +122,18 @@ These are the provisioning parameters for AWS that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-----------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | -| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | -| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | +| Parameter name | Type | Description | Required | Default value | +|------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update) [2](#not_supported)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update) [2](#not_supported)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -150,18 +150,18 @@ These are the provisioning parameters for GCP that you can configure: -| Parameter name | Type | Description | Required | Default value | -|-----------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-----------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `n2-standard-2` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `4` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | -| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | -| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | +| Parameter name | Type | Description | Required | Default value | +|------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------|:--------:|-----------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `n2-standard-2` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `4` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of VMs that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update) [2](#not_supported)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update) [2](#not_supported)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -178,18 +178,18 @@ These are the provisioning parameters for SapConvergedCloud that you can configu -| Parameter name | Type | Description | Required | Default value | -|-----------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `g_c2_m8` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `20` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | -| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | -| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | +| Parameter name | Type | Description | Required | Default value | +|-------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `g_c2_m8` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `30` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["a"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create. | No | `20` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update) [2](#not_supported)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update) [2](#not_supported)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -271,18 +271,18 @@ These are the provisioning parameters for the `preview` plan that you configure: -| Parameter name | Type | Description | Required | Default value | -|-----------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| -| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | -| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | -| **region** | string | Defines the cluster region. | Yes | None | -| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | -| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | -| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | -| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | -| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | -| **additionalWorkerNodePools.list[1](#update)** | array | Defines a custom list of additional worker node pools | No | None | -| **additionalWorkerNodePools.skipModification[1](#update)** | bool | Defines whether to skip modification of additional worker node pools | No | None | +| Parameter name | Type | Description | Required | Default value | +|------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------|:--------:|---------------| +| **machineType** | string | Specifies the provider-specific virtual machine type. | No | `m6i.large` | +| **volumeSizeGb** | int | Specifies the size of the root volume. | No | `50` | +| **region** | string | Defines the cluster region. | Yes | None | +| **zones** | string | Defines the list of zones in which Runtime Provisioner creates a cluster. | No | `["1"]` | +| **autoScalerMin[1](#update)** | int | Specifies the minimum number of virtual machines to create. | No | `3` | +| **autoScalerMax[1](#update)** | int | Specifies the maximum number of virtual machines to create, up to `40` allowed. | No | `10` | +| **maxSurge[1](#update)** | int | Specifies the maximum number of virtual machines that are created during an update. | No | `4` | +| **maxUnavailable[1](#update)** | int | Specifies the maximum number of virtual machines that can be unavailable during an update. | No | `1` | +| **additionalWorkerNodePools.list[1](#update) [2](#not_supported)** | array | Defines a custom list of additional worker node pools | No | None | +| **additionalWorkerNodePools.skipModification[1](#update) [2](#not_supported)** | bool | Defines whether to skip modification of additional worker node pools | No | None | @@ -290,3 +290,5 @@ These are the provisioning parameters for the `preview` plan that you configure:
1 This parameter is available for PATCH as well, and can be updated with the same constraints as during provisioning. +
+2 This parameter is not yet supported. From b535bb1a17820a3bd23c4a7aa48f6c5f909ecff8 Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:42:34 +0100 Subject: [PATCH 03/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index 17165b6c80..2331542102 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -1,5 +1,8 @@ # Additional Worker Node Pools +> [!NOTE] +> This feature is still being developed and will be available soon. + To create an SAP BTP, Kyma runtime with additional worker node pools, specify the `additionalWorkerNodePools` provisioning parameter. > [!NOTE] From c10172b0198846431eac68aad00ba3bd155ff332 Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:43:17 +0100 Subject: [PATCH 04/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index 2331542102..e5c67506aa 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -6,7 +6,7 @@ To create an SAP BTP, Kyma runtime with additional worker node pools, specify the `additionalWorkerNodePools` provisioning parameter. > [!NOTE] -> `name`, `machineType`, `autoScalerMin` and `autoScalerMax` values are mandatory for additional worker node pool configuration. +> **name**, **machineType**, **autoScalerMin**, and **autoScalerMax** values are mandatory for additional worker node pool configuration. See the example: From ab73513938a704efff56130edb0d20c45232a92f Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:43:32 +0100 Subject: [PATCH 05/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index e5c67506aa..4bc5762d67 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -46,7 +46,8 @@ See the example: }" ``` -If you do not provide the `additionalWorkerNodePools` object in the provisioning request, or set `skipModification` property to `true`, no additional worker node pools will be created. +If you do not provide the `additionalWorkerNodePools` object in the provisioning request or set the **skipModification** property to `true`, no additional worker node pools are created. + If you do not provide the `additionalWorkerNodePools` object in the update request or set `skipModification` property to `true`, saved additional worker node pools stay untouched. However, if you provide an empty list in the update request, all additional worker node pools will be removed. From 7ec25139ba69ccc29c35745c46227bb6ed2ab7cc Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:43:50 +0100 Subject: [PATCH 06/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index 4bc5762d67..b5b4cd3a19 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -48,7 +48,7 @@ See the example: If you do not provide the `additionalWorkerNodePools` object in the provisioning request or set the **skipModification** property to `true`, no additional worker node pools are created. -If you do not provide the `additionalWorkerNodePools` object in the update request or set `skipModification` property to `true`, saved additional worker node pools stay untouched. +If you do not provide the `additionalWorkerNodePools` object in the update request or set the **skipModification** property to `true`, the saved additional worker node pools stay untouched. However, if you provide an empty list in the update request, all additional worker node pools will be removed. See the following JSON example without the `additionalWorkerNodePools` object: From 9cb45eceab6183db3e84b6119eaad00404347a7c Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:44:02 +0100 Subject: [PATCH 07/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index b5b4cd3a19..8a40061b20 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -49,7 +49,7 @@ See the example: If you do not provide the `additionalWorkerNodePools` object in the provisioning request or set the **skipModification** property to `true`, no additional worker node pools are created. If you do not provide the `additionalWorkerNodePools` object in the update request or set the **skipModification** property to `true`, the saved additional worker node pools stay untouched. -However, if you provide an empty list in the update request, all additional worker node pools will be removed. +However, if you provide an empty list in the update request, all additional worker node pools are removed. See the following JSON example without the `additionalWorkerNodePools` object: ```json From 23b0a942d6b08faec2cb5e4550b73556af348852 Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:44:21 +0100 Subject: [PATCH 08/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index 8a40061b20..53f559bc05 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -52,6 +52,7 @@ If you do not provide the `additionalWorkerNodePools` object in the update reque However, if you provide an empty list in the update request, all additional worker node pools are removed. See the following JSON example without the `additionalWorkerNodePools` object: + ```json { "service_id" : "47c9dcbf-ff30-448e-ab36-d3bad66ba281", From e1dc722601501cfb94af8e82515b03ee72dec70f Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:44:32 +0100 Subject: [PATCH 09/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index 53f559bc05..dc72afdde4 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -68,6 +68,7 @@ See the following JSON example without the `additionalWorkerNodePools` object: ``` See the following JSON example with the `additionalWorkerNodePools` object with `skipModification` property set to `true`: + ```json { "service_id" : "47c9dcbf-ff30-448e-ab36-d3bad66ba281", From ba945da87fd472b116a86c22590ca4ba50ee41ad Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:44:42 +0100 Subject: [PATCH 10/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index dc72afdde4..e768c1a4e7 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -87,6 +87,7 @@ See the following JSON example with the `additionalWorkerNodePools` object with ``` See the following JSON example, where the `additionalWorkerNodePools` object contains an empty list: + ```json { "service_id" : "47c9dcbf-ff30-448e-ab36-d3bad66ba281", From 972f731148797d683f6c2db6e77314a0c2a7b3f3 Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:45:15 +0100 Subject: [PATCH 11/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index e768c1a4e7..eae15ce92a 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -105,7 +105,7 @@ See the following JSON example, where the `additionalWorkerNodePools` object con } ``` -To update additional worker node pools, provide list of objects with values for the mandatory properties. Without these values, a validation error occurs. +To update additional worker node pools, provide a list of objects with values for the mandatory properties. Without these values, a validation error occurs. The update operation overwrites the additional worker node pools with the list provided in JSON. See the following scenario: 1. An existing instance has the following additional worker node pools: From 750d537118209b31867bb6f2155f6f1d68e00f11 Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:46:35 +0100 Subject: [PATCH 12/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index eae15ce92a..4078fecda1 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -109,6 +109,7 @@ To update additional worker node pools, provide a list of objects with values fo The update operation overwrites the additional worker node pools with the list provided in JSON. See the following scenario: 1. An existing instance has the following additional worker node pools: + ```json { "additionalWorkerNodePools": { From 5c636e53f8505f3de002660466f43847b7c86e78 Mon Sep 17 00:00:00 2001 From: KsaweryZietara <91937141+KsaweryZietara@users.noreply.github.com> Date: Wed, 15 Jan 2025 11:55:26 +0100 Subject: [PATCH 13/14] Update docs/user/04-40-additional-worker-node-pools.md Co-authored-by: Iwona Langer --- docs/user/04-40-additional-worker-node-pools.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index 4078fecda1..5e8c8a10b1 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -106,7 +106,7 @@ See the following JSON example, where the `additionalWorkerNodePools` object con ``` To update additional worker node pools, provide a list of objects with values for the mandatory properties. Without these values, a validation error occurs. -The update operation overwrites the additional worker node pools with the list provided in JSON. See the following scenario: +The update operation overwrites the additional worker node pools with the list provided in the JSON format. See the following scenario: 1. An existing instance has the following additional worker node pools: From 7393378a040c2226ffc8c8f3bced345186f36092 Mon Sep 17 00:00:00 2001 From: KsaweryZietara Date: Wed, 15 Jan 2025 12:02:03 +0100 Subject: [PATCH 14/14] Replace JSON with JSON file --- docs/user/04-40-additional-worker-node-pools.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/04-40-additional-worker-node-pools.md b/docs/user/04-40-additional-worker-node-pools.md index 5e8c8a10b1..bcf3634343 100644 --- a/docs/user/04-40-additional-worker-node-pools.md +++ b/docs/user/04-40-additional-worker-node-pools.md @@ -106,7 +106,7 @@ See the following JSON example, where the `additionalWorkerNodePools` object con ``` To update additional worker node pools, provide a list of objects with values for the mandatory properties. Without these values, a validation error occurs. -The update operation overwrites the additional worker node pools with the list provided in the JSON format. See the following scenario: +The update operation overwrites the additional worker node pools with the list provided in the JSON file. See the following scenario: 1. An existing instance has the following additional worker node pools: @@ -131,7 +131,7 @@ The update operation overwrites the additional worker node pools with the list p } ``` -2. A user sends an update request (HTTP PUT) with the following JSON in the payload: +2. A user sends an update request (HTTP PUT) with the following JSON file in the payload: ```json { "service_id": "47c9dcbf-ff30-448e-ab36-d3bad66ba281", @@ -155,7 +155,7 @@ The update operation overwrites the additional worker node pools with the list p } ``` -3. The additional worker node pools are updated to include the values of the `additionalWorkerNodePools` object from JSON provided in the update request: +3. The additional worker node pools are updated to include the values of the `additionalWorkerNodePools` object from JSON file provided in the update request: ```json { "additionalWorkerNodePools": {