## 6.4.4  Provisioning and Updating Parameters in the Kyma Environment
You can configure the cluster parameters in the Kyma environment.
## Overview
To configure the cluster parameters, you can use your preferred interface, the SAP BTP cockpit or the SAP BTP command line interface.
To check which parameters are available for configuration in a particular plan, see Available Plans in the Kyma Environment [page 3131].
##  Remember
The parameters marked with an asterisk "*" are mandatory.
These are the configurable cluster parameters:
- Additional Worker Node Pools [page 3139]
- Administrators [page 3141]
- Auto Scaler Max [page 3141]
- Auto Scaler Min [page 3142]
- Cluster Name* [page 3143]
- Colocate Control Plane [page 3144]
- Machine Type [page 3144]
- Machine Type in Additional Worker Node Pools [page 3146]
- Modules [page 3147]
- Networking [page 3149]
- OpenID Connect (OIDC) [page 3151]
- Region* [page 3155]
## Additional Worker Node Pools
The Additional Worker Node Pools ( additionalWorkerNodePools ) array is an optional provisioning and updating parameter used for adding customized worker node pools to your Kyma runtime. It enables you to introduce worker nodes optimized and reserved for your particular workload requirements.
If you do not provide the additionalWorkerNodePools array in the provisioning request, no additional worker node pools are created.
If you do not provide the additionalWorkerNodePools array in the update request, the saved additional worker node pools stay unchanged. However, if you provide an empty array in the update request, all existing additional worker node pools are removed. If you rename your existing additional worker node pool, it is deleted and a new one is created.
See also Assigning Workloads to Worker Node Pools [page 3168].
##  Remember
The parameters marked with an asterisk "*" are mandatory.
Additional Worker Node Pools Nested Parameters
| Nested Parameter                       | Description                                                    | Supported Operation                 | Allowed Input                                                                                                                                                                                                                |
|----------------------------------------|----------------------------------------------------------------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Name* name type: string                | Specifies the unique name of your additional worker node pool. | Provisioning Updating               | Short string of up to 15 char- acters that contains only al- phanumeric lowercase char- acters (a-z, 0-9), and hy- phens (-). It must begin and end with an alphanumeric character, and can't contain whitespace characters. |
| Machine Type* machineType type: string | Specifies the provider-spe- cific virtual machine type.        | Provisioning Updating 1 [page 3140] | See Machine Type [page 3144].                                                                                                                                                                                                |
| Nested Parameter                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                       | Supported Operation                 | Allowed Input                                                                                                                                                                                                                                         |
|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| High Availability Zones* haZones type: boolean | Specifies if high availability zones are supported. This setting is permanent and cannot be updated. If enabled, your resources are distributed across three zones to enhance fault toler- ance. If high availability is disabled, all resources are placed in a single, randomly selected zone. Disabling haZones is not recommended for pro- duction environments. High availability is not sup- ported in the azure_lite plan. | Provisioning Updating 2 [page 3141] | true or false                                                                                                                                                                                                                                         |
| Auto Scaler Min* autoScalerMin type: integer   | Specifies the minimum num- ber of virtual machines to create.                                                                                                                                                                                                                                                                                                                                                                     | Provisioning Updating               | With high availability disa- bled, you can set it to 0 . With high availability enabled, you must set it to at least 3 . You can also set it to 0 in azure_lite because the plan does not support high availability. See Auto Scaler Min [page 3142]. |
| Auto Scaler Max* autoScalerMax type: integer   | Specifies the maximum num- ber of virtual machines to create.                                                                                                                                                                                                                                                                                                                                                                     | Provisioning Updating               | With high availability disa- bled, you can set it to 1 . With high availability enabled, you must set it to at least 3 . You can also set it to 1 in azure_lite because the plan does not support high availability. See Auto Scaler Max [page        |
##  Note
1 You can update your virtual machine type only within the general-purpose machine types. You cannot perform updates on compute-intensive machine types.
For details, see Machine Type [page 3144].
##  Note
- 2 Y ou can only use this parameter to update your Kyma runtime by creating a new additional worker node pool. You cannot use it to update an existing additional worker node pool.
See the example configuration:
```
 Sample Code "additionalWorkerNodePools": [ { "name": "worker-1", "machineType": "Standard_D2s_v5", "haZones": true, "autoScalerMin": 3, "autoScalerMax": 20 }, { "name": "worker-2", "machineType": "Standard_D4s_v5", "haZones": false, "autoScalerMin": 1, "autoScalerMax": 1 } ]
```
See also Assigning Workloads to Worker Node Pools [page 3168].
## Administrators
The Administrators ( administrators ) parameter is an array of strings. It is a provisioning and updating parameter, which specifies the list of runtime administrators. Complete the list with the administrators' email addresses as shown in the following example:
```
 Sample Code "administrators": [ "example_1@mail.com", "example_2@mail.com", "example_3@mail.com" ]
```
## Auto Scaler Max
The Auto Scaler Max ( autoScalerMax ) is an integer parameter, which specifies the maximum number of virtual machines you can create.
##  Remember
Cluster autoscaling is not subject to the Service Level Agreement (SLA). Successful autoscaling is not guaranteed. The mechanism may fail or take longer than expected due to constraints of the underlying cloud providers.
Auto Scaler Max Parameter
| Plan                                                                                                                                         | Supported Operation   |   Default Value |   Maximum Value | Allowed Input                                                                                                                                                                                                                      |
|----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Standard technical names: aws , gcp , azure Build Runtime technical names: build-runtime- aws , build- runtime-gcp , or build- runtime-azure | Provisioning Updating |              20 |             300 | Number between 3 and 300, but greater than or equal to Auto Scaler Min . Within the Additional Worker Node Pools ar- ray, with high availabil- ity disabled, you can set it to 1 . See Ad- ditional Worker Node Pools [page 3139]. |
| Kyma Test Demo and Development (Azure Lite) technical name: azure_lite                                                                       | Provisioning Updating |              10 |              40 | Number between 2 and 40, but greater than or equal to Auto Scaler Min . Within the Additional Worker Node Pools ar- ray, you can set it to 1 . See Additional Worker Node Pools [page 3139].                                       |
See the default JSON input:
##  Sample Code
"autoScalerMax": 20
## Auto Scaler Min
The Auto Scaler Min ( autoScalerMin ) is an integer parameter, which specifies the minimum number of virtual machines you can create.
Auto Scaler Min Parameter
| Plan                                                                                                                           | Supported Operation   |   Default Value |   Minimum Value | Allowed Input                                                                                                                                                                                                             |
|--------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Standard technical names: aws , gcp , azure Build Runtime technical names: build-runtime- aws , build- runtime-gcp , or build- | Provisioning Updating |               3 |               3 | Number between 3 and the current value set in Auto Scaler Max . Within the Additional Worker Node Pools ar- ray, with high availabil- ity disabled, you can set it to 0 . See Ad- ditional Worker Node Pools [page 3139]. |
| Kyma Test Demo and Development (Azure Lite) technical name: azure_lite                                                         | Provisioning Updating |               2 |               2 | Number between 2 and the current value set in Auto Scaler Max . Within the Additional Worker Node Pools ar- ray, you can set it to 0 . See Additional Worker Node Pools [page 3139].                                      |
See an example of the JSON input:
##  Sample Code
"autoScalerMin": 3
## Cluster Name*
The Cluster Name ( name ) is a string, which provides the name of your cluster.
##  Remember
The parameters marked with an asterisk "*" are mandatory.
Cluster Name Parameter
| Parameter                                          | Supported Operation   | Default Value                                             | Allowed Input                                                                                                                                                                      |
|----------------------------------------------------|-----------------------|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Cluster Name* btp CLI parameter: name type: string | Provisioning          | Automatically generated as your Subaccount's Subdo- main. | Short string of up to 32 characters that contains only alphanumeric characters (A- Z, a-z, 0-9), periods, under- scores, and hyphens. It must not contain whitespace char- acters. |
## Colocate Control Plane
Colocate Control Plane (technical name: colocateControlPlane ) is a provisioning parameter. It is a boolean that enables you to decide if your control plane and worker nodes should be in the same region.
If you set it to true , it ensures the location of the control plane in the same region where your cluster's worker nodes are deployed. With this setting, you can control where your sensitive data is stored. If the control plane cannot be colocated in the selected region, the provisioning process fails. The error message offers you a list of regions supporting the control plane colocation.
If you set the parameter to false or leave the field empty, your control plane can sometimes be deployed in a different region than the worker nodes.
To learn which regions support the control plane colocation, see the Region* [page 3155] section.
See an example of the JSON input:
##  Sample Code
"colocateControlPlane": true
## Machine Type
The Machine Type ( machineType ) parameter is a string, which specifies the provider-specific virtual machine type.
The following table lists general-purpose machine types available for use in the mandatory Kyma worker node pool and in your additional worker node pools.
Machine Type Parameter
| Plan                          | Supported Operation   | Default Value   | Allowed Input   | Virtual Machine Size   |
|-------------------------------|-----------------------|-----------------|-----------------|------------------------|
| Standard: Amazon Web Services | Provisioning Updating | m6i.large       | m6i.large       | 2vCPU,8GBRAM           |
|                               |                       |                 | m6i.xlarge      | 4 vCPU,16GBRAM         |
| technical name: aws           |                       |                 |                 |                        |
| Plan                                 | Supported Operation   | Default Value   | Allowed Input     | Virtual Machine Size   |
|--------------------------------------|-----------------------|-----------------|-------------------|------------------------|
| Build Runtime: Ama- zon Web Services |                       |                 | m6i.2xlarge       | 8vCPU,32GBRAM          |
| Build Runtime: Ama- zon Web Services |                       |                 | m6i.4xlarge       | 16vCPU,64GBRAM         |
| technical name: build-               |                       |                 | m6i.8xlarge       | 32 vCPU,128GBRAM       |
| runtime-aws                          |                       |                 | m6i.12xlarge      | 48 vCPU,192GBRAM       |
|                                      |                       |                 | m6i.16xlarge      | 64 vCPU,256GBRAM       |
|                                      |                       |                 | m5.large          | 2vCPU,8GBRAM           |
|                                      |                       |                 | m5.xlarge         | 4 vCPU,16GBRAM         |
|                                      |                       |                 | m5.2xlarge        | 8vCPU,32GBRAM          |
|                                      |                       |                 | m5.4xlarge        | 16vCPU,64GBRAM         |
|                                      |                       |                 | m5.8xlarge        | 32 vCPU,128GBRAM       |
|                                      |                       |                 | m5.12xlarge       | 48 vCPU,192GBRAM       |
|                                      |                       |                 | m5.16xlarge       | 64 vCPU,256GBRAM       |
| Standard: Google                     | Provisioning          | n2-standard-2   | n2-standard-2     | 2vCPU,8GBRAM           |
| Cloud                                | Updating              |                 | n2-standard-4     | 4 vCPU,16GBRAM         |
| technical name: gcp                  |                       |                 | n2-standard-8     | 8vCPU,32GBRAM          |
| Build Runtime: Google                |                       |                 | n2-standard-16    | 16vCPU,64GBRAM         |
| Cloud                                |                       |                 | n2-standard-32    | 32 vCPU,128GBRAM       |
| technical name: build-               |                       |                 | n2-standard-48    | 48 vCPU,192GBRAM       |
| runtime-gcp                          |                       |                 | n2-standard-64    | 64 vCPU,256GBRAM       |
| Standard: Microsoft                  | Provisioning          | Standard_D2s_v5 | Standard_D2s_v5   | 2vCPU,8GBRAM           |
| Azure                                | Updating              |                 | Standard_D4s_v5   | 4 vCPU,16GBRAM         |
| technical name:                      |                       |                 | Standard_D8s_v5   | 8vCPU,32GBRAM          |
| azure Build Runtime: Micro-          |                       |                 | Standard_D16s_v 5 | 16vCPU,64GBRAM         |
| soft Azure technical                 |                       |                 | Standard_D32s_v 5 | 32 vCPU,128GBRAM       |
| name: build- runtime-azure           |                       |                 | Standard_D48s_v 5 | 48 vCPU,192GBRAM       |
|                                      |                       |                 | Standard_D64s_v 5 | 64 vCPU,256GBRAM       |
|                                      |                       |                 | Standard_D4_v3    | 4 vCPU,16GBRAM         |
|                                      |                       |                 | Standard_D8_v3    | 8vCPU,32GBRAM          |
|                                      |                       |                 | Standard_D16_v3   | 16vCPU,64GBRAM         |
|                                      |                       |                 | Standard_D32_v3   | 32 vCPU,128GBRAM       |
| Plan                                        | Supported Operation   | Default Value   | Allowed Input                  | Virtual Machine Size          |
|---------------------------------------------|-----------------------|-----------------|--------------------------------|-------------------------------|
|                                             |                       |                 | Standard_D48_v3                | 48 vCPU,192GBRAM              |
| Kyma Test Demo and Development (Azure Lite) | Provisioning Updating | Standard_D4s_v5 | Standard_D4s_v5 Standard_D4_v3 | 4 vCPU,16GBRAM 4 vCPU,16GBRAM |
| technical name: azure_lite                  |                       |                 |                                |                               |
See an example input for the Machine Type parameter:
##  Sample Code
"machineType": "m5.xlarge"
## Machine Type in Additional Worker Node Pools
In your additional worker node pools, you can use the general-purpose virtual machines listed in the Machine Type Parameter [page 3144] table and the following compute-intensive machine types.
##  Note
The virtual machines in the following table are only available for use in Additional Worker Node Pools [page 3139].
Machine Type in Additional Worker Node Pools
| Plan                                                                                                     | Supported Operation   | Allowed Input        | Virtual Machine Size                                    | Availability Regions                                                    |
|----------------------------------------------------------------------------------------------------------|-----------------------|----------------------|---------------------------------------------------------|-------------------------------------------------------------------------|
| Standard: Amazon Web Services technical name: aws Build Runtime: zon Web Services technical name: build- | Provisioning Updating | c7i.large c7i.xlarge | 2vCPU,4GBRAM 4vCPU,8GBRAM 8 vCPU,16GBRAM 16vCPU,32GBRAM | All Amazon Web Serv- ices regions. See Re- gion* [page 3155].           |
| Standard: Google Cloud technical name:                                                                   | Provisioning Updating |                      |                                                         | All Amazon Web Serv- ices regions. See Re- gion* [page 3155].           |
|                                                                                                          | Provisioning Updating | c7i.2xlarge          |                                                         | All Amazon Web Serv- ices regions. See Re- gion* [page 3155].           |
| Ama-                                                                                                     | Provisioning Updating | c7i.4xlarge          |                                                         | All Amazon Web Serv- ices regions. See Re- gion* [page 3155].           |
|                                                                                                          | Provisioning Updating | c7i.8xlarge          | 32vCPU,64GBRAM                                          | All Amazon Web Serv- ices regions. See Re- gion* [page 3155].           |
|                                                                                                          | Provisioning Updating | c7i.12xlarge         | 48vCPU,96GBRAM                                          | All Amazon Web Serv- ices regions. See Re- gion* [page 3155].           |
| runtime-aws                                                                                              | Provisioning Updating | c7i.16xlarge         | 64 vCPU,128GBRAM                                        | All Amazon Web Serv- ices regions. See Re- gion* [page 3155].           |
| Build Runtime:                                                                                           | Provisioning Updating | c2d-highcpu-2        | 2vCPU,4GBRAM                                            | europe-west3 europe-west4 us-central1 us-west1 us-east4 asia-southeast1 |
|                                                                                                          | Provisioning Updating | c2d-highcpu-4        | 4vCPU,8GBRAM                                            | europe-west3 europe-west4 us-central1 us-west1 us-east4 asia-southeast1 |
| gcp                                                                                                      | Provisioning Updating | c2d-highcpu-8        | 8 vCPU,16GBRAM                                          | europe-west3 europe-west4 us-central1 us-west1 us-east4 asia-southeast1 |
| Google Cloud                                                                                             | Provisioning Updating | c2d-highcpu-16       | 16vCPU,32GBRAM 32vCPU,64GBRAM                           | europe-west3 europe-west4 us-central1 us-west1 us-east4 asia-southeast1 |
|                                                                                                          | Provisioning Updating | c2d-highcpu-32       |                                                         | europe-west3 europe-west4 us-central1 us-west1 us-east4 asia-southeast1 |
| Plan                                                                                                                  | Supported Operation   | Allowed Input                                                                                                           | Virtual Machine Size                                                                                   | Availability Regions                                  |
|-----------------------------------------------------------------------------------------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| technical name: build- runtime-gcp                                                                                    |                       | c2d-highcpu-56                                                                                                          | 56 vCPU,112GBRAM                                                                                       | asia-south1                                           |
| Standard: Microsoft Azure technical name: azure Build Runtime: Micro- soft Azure technical name: build- runtime-azure | Provisioning Updating | Standard_F2s_v2 Standard_F4s_v2 Standard_F8s_v2 Standard_F16s_v 2 Standard_F32s_v 2 Standard_F48s_v 2 Standard_F64s_v 2 | 2vCPU,4GBRAM 4vCPU,8GBRAM 8 vCPU,16GBRAM 16vCPU,32GBRAM 32vCPU,64GBRAM 48vCPU,96GBRAM 64 vCPU,128GBRAM | All Microsoft Azure regions. See Region* [page 3155]. |
## Modules
With the Modules ( modules ) object, you can define which Kyma modules you want to provision in your cluster. You can also use it to create a cluster without any modules.
##  Note
API for module configuration is built on the oneOf feature from the JSON schema. If the modules object is passed to API, it must have only one valid option: Default ( default ) or Custom ( list ). Even if you remove the modules object from the JSON schema, the default Kyma modules are provisioned in your cluster.
##  Remember
The parameters marked with an asterisk "*" are mandatory.
Modules Parameters
| Nested Parameter                         | Description                                                                     | Supported Opera- tion   | Default Value   |
|------------------------------------------|---------------------------------------------------------------------------------|-------------------------|-----------------|
| Default                                  | Defines whether to use the default list of Kyma modules. Check the Default mod- | Provisioning            | true            |
| btp CLI parameter: default type: boolean | Kyma Modules to find out which ules are in the default modules list.            |                         |                 |
## Nested Parameter
## Description
## Supported Opera-
tion
Default Value
| Custom                  | Defines a custom list of Kyma modules.             | Provisioning   | [ ] (empty array)   |
|-------------------------|----------------------------------------------------|----------------|---------------------|
| btp CLI parameter: list | Leave your custom list of Kyma mod- mod-           |                |                     |
| type: array of objects  | ules empty if you don't want any ules provisioned. |                |                     |
The Custom ( list ) parameter includes three nested parameters: Name* , Channel , and Custom Resource Policy .
Custom list Parameters
| Nested Parameter                                                             | Description                                                                                                                                                                                                                                                                    | Supported Operation   | Default Value        |
|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|----------------------|
| Name* btp CLI parameter: name type: string                                   | Look up the available Kyma modules and their technical names at Kyma Modules [page 83].                                                                                                                                                                                        | Provisioning          | n/a                  |
| Channel btp CLI parameter: channel type: string                              | Defines the preferred re- lease channel. The default is regular . The other option is fast .                                                                                                                                                                                   | Provisioning          | "" (an empty string) |
| Custom Resource Policy btp CLI parameter: customResourcePolic y type: string | Defines how a module's cus- tom resource configuration is handled during enablement and reconciliation. By default, it is set to CreateAndDelete and allows the creation or dele- tion of a module's resource. If you set it to Ignore , a module's resource is not cre- ated. | Provisioning          | "" (an empty string) |
You have the default Kyma modules provisioned in your cluster if you do not provide the modules object in the JSON payload, or if you use the following input:
```
 Sample Code "modules": { "default": true }
```
See an example of JSON input for a custom list of Kyma modules:
```
 Sample Code "modules": { "list": [ { "name": "btp-operator" }, { "name": "keda", "customResourcePolicy": "CreateAndDelete", "channel": "fast" } ] }
```
Applying the following values results in Kyma runtime provisioning without any Kyma modules.
## 
```
Sample Code "modules": { "list": [] }
```
```
 Sample Code "modules": { "default": false }
```
## Networking
The Networking ( networking ) object provides networking configuration. These values are immutable and cannot be updated later.
##  Remember
The parameters marked with an asterisk "*" are mandatory.
Networking Parameters
| Nested Parameter                                            | Description                                   | Supported Operation   | Default Value   | Allowed Input                                                                                                                                                                                                                                                                                                                                   |
|-------------------------------------------------------------|-----------------------------------------------|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CIDR range for Nodes* btp CLI parameter: nodes type: string | Defines a custom IP range for worker no- des. | Provisioning          | 10.250.0.0/16   | The CIDR range for nodes must not over- lap with the following CIDRs: 10.242.0.0/16, 10.64.0.0/11, 10.254.0.0/16, 10.243.0.0/16, 192.168.123.0/24, 240.0.0.0/8. Also, the range for no- des must not overlap with those used for Pods or Services. That is also valid for the default ranges set for Pods or Services if you don't provide your |
| CIDR range for Pods btp CLI parameter: pods type: string    | Defines a custom IP range for Pods.           | Provisioning          | 10.96.0.0/13    | CIDR range for Pods must not overlap with the following CIDRs: 10.242.0.0/16, 10.64.0.0/11, 10.254.0.0/16, 10.243.0.0/16, 192.168.123.0/24, 240.0.0.0/8. Also, the range for Pods must not overlap with those used for no- des or Services. That is also valid for the default range set for Services if you don't provide your own.            |
| Nested Parameter                                                 | Description                             | Supported Operation   | Default Value   | Allowed Input                                                                                                      |
|------------------------------------------------------------------|-----------------------------------------|-----------------------|-----------------|--------------------------------------------------------------------------------------------------------------------|
| CIDR range for Services btp CLI parameter: services type: string | Defines a custom IP range for Services. | Provisioning          | 10.104.0.0/13   | CIDR range for Serv- ices must not over- lap with the following CIDRs: 10.242.0.0/16, 10.64.0.0/11, 10.254.0.0/16, |
See the default JSON input for the Networking object:
```
 Sample Code "networking": { "nodes": "10.250.0.0/16" "pods": "10.96.0.0/13" "services": "10.104.0.0/13" }
```
## OpenID Connect (OIDC)
The OpenID Connect (OIDC) property can be configured in the following ways:
- As a list of oidc objects
- As a single oidc object
## OIDC Configured as a List of oidc Objects
The OpenID Connect ( oidc ) property is a list of oidc objects. You can use it to configure one or several oidc objects.
For more information on the configuration options, see Custom OpenID Connect Configuration [page 3170].
```
 Remember The parameters marked with an asterisk "*" are mandatory.
```
OIDC Parameters for a List of oidc Objects
| Nested Parameter                                              | Description                                                                                                                                                                                                          | Supported Operation   | Default Value   | Allowed Input                                                                                                                                                                             |
|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Client ID* btp CLI parameter: clientID                        | The client ID for the OpenID Connect client.                                                                                                                                                                         | Provisioning Updating | n/a             | n/a                                                                                                                                                                                       |
| Issuer URL* btp CLI parameter: is- suerURL                    | Provides the URL of the OpenID issuer.                                                                                                                                                                               | Provisioning Updating | n/a             | Only HTTPS scheme is accepted.                                                                                                                                                            |
| Groups Claim* btp CLI parameter: groupsClaim                  | If provided, specifies the name of a custom OIDC claim for specify- ing user groups.                                                                                                                                 | Provisioning Updating | n/a             | n/a                                                                                                                                                                                       |
| Groups Prefix* btp CLI parameter: groupsPrefix type:string    | If specified, causes claims mapping to group names to be prefixed with the pro- vided value. If not provided, the prefix defaults to - (dash character with- out additional charac- ters), and disables pre- fixing. | Provisioning Updating | n/a             | For example, the value oidc: results in groups like oidc:engineerin g and oidc:marketing . To skip any prefixing, provide the value - (dash character with- out additional charac- ters). |
| Username Claim* btp CLI parameter: usernameClaim type: string | Provides the OpenID claim to use as the user name.                                                                                                                                                                   | Provisioning Updating | n/a             | n/a                                                                                                                                                                                       |
| Required Claims btp CLI parameter: requiredClaims type: array | Describes a required claim in the ID Token. If set, the claim is veri- fied to be present in the ID Token with the matching value.                                                                                   | Provisioning Updating | n/a             | List of key=value pairs. To remove a previously set value, leave the ar- ray empty.                                                                                                       |
| Nested Parameter                                                     | Description                                                                                                                                          | Supported Operation   | Default Value   | Allowed Input                                                                                        |
|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------|------------------------------------------------------------------------------------------------------|
| Signing Algs* btp CLI parameter: signingAlgs type: array             | Provides the OIDC signing algorithms for Kyma runtime.                                                                                               | Provisioning Updating | n/a             | Comma-separated list of allowed JOSE asym- metric signing algo- rithms, for example, RS256 , ES256 . |
| Username Prefix* btp CLI parameter: usernamePrefix type: string      | Provides an OIDC user- name prefix for Kyma runtime.                                                                                                 | Provisioning Updating | n/a             | To skip any prefixing, provide the value - (dash character with- out additional charac- ters).       |
| Encoded JWKS Array btp CLI parameter: encodedJwksArra y type: string | The JSON Web Key Set (JWKS) array encoded in base64. Use it when your OIDC metadata discovery endpoint is inaccessi- ble from the public in- ternet. | Provisioning Updating | n/a             | Base64 encoded string. To remove a previously set value, leave the in- put empty.                    |
The following example shows the default configuration of a list of oidc objects. To revert your changes to the default settings, copy and paste the following values:
```
 Sample Code "oidc": { "list": [ { "clientID": "12b13a26-d993-4d0c-aa08-5f5852bbdff6", "groupsClaim": "groups", "issuerURL": "https://kyma.accounts.ondemand.com", "groupsPrefix": "-" "signingAlgs": ["RS256"], "usernameClaim": "sub", "usernamePrefix": "-", "requiredClaims": [], "encodedJwksArray": "" } ] }
```
## OIDC Configured as a Single oidc Object
##  Note
This approach is not recommended. Use it only to maintain backward compatibility with existing automations.
For more information on the configuration options, see Custom OpenID Connect Configuration [page 3170].
##  Remember
The parameters marked with an asterisk "*" are mandatory.
OIDC Parameters for a Single oidc Object
| Nested Parameter                                              | Description                                                                                                                                                                                                          | Supported Operation   | Default Value   | Allowed Input                                                                                                                                                                             |
|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Client ID* btp CLI parameter: clientID                        | The client ID for the OpenID Connect client.                                                                                                                                                                         | Provisioning Updating | n/a             | n/a                                                                                                                                                                                       |
| Issuer URL* btp CLI parameter: is- suerURL                    | Provides the URL of the OpenID issuer.                                                                                                                                                                               | Provisioning Updating | n/a             | Only HTTPS scheme is accepted.                                                                                                                                                            |
| Groups Claim btp CLI parameter: groupsClaim                   | If provided, specifies the name of a custom OIDC claim for specify- ing user groups.                                                                                                                                 | Provisioning Updating | groups          | n/a                                                                                                                                                                                       |
| Groups Prefix btp CLI parameter: groupsPrefix type:string     | If specified, causes claims mapping to group names to be prefixed with the pro- vided value. If not provided, the prefix defaults to - (dash character with- out additional charac- ters), and disables pre- fixing. | Provisioning Updating | -               | For example, the value oidc: results in groups like oidc:engineerin g and oidc:marketing . To skip any prefixing, provide the value - (dash character with- out additional charac- ters). |
| Username Claim btp CLI parameter: usernameClaim type: string  | Provides the OpenID claim to use as the user name.                                                                                                                                                                   | Provisioning Updating | n/a             | n/a                                                                                                                                                                                       |
| Required Claims btp CLI parameter: requiredClaims type: array | Describes a required claim in the ID Token. If set, the claim is veri- fied to be present in the ID Token with the matching value.                                                                                   | Provisioning Updating | n/a             | List of key=value pairs. To remove a previously set value, provide only the value - (dash character without ad- ditional characters).                                                     |
| Nested Parameter                                                     | Description                                                                                                                                          | Supported Operation   | Default Value   | Allowed Input                                                                                                                       |
|----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------|
| Signing Algs btp CLI parameter: signingAlgs type: array              | Provides the OIDC signing algorithms for Kyma runtime.                                                                                               | Provisioning Updating | RS256           | Comma-separated list of allowed JOSE asym- metric signing algo- rithms, for example, RS256 , ES256 .                                |
| Username Prefix btp CLI parameter: usernamePrefix type: string       | Provides an OIDC user- name prefix for Kyma runtime.                                                                                                 | Provisioning Updating | -               | To skip any prefixing, provide the value - (dash character with- out additional charac- ters).                                      |
| Encoded JWKS Array btp CLI parameter: encodedJwksArra y type: string | The JSON Web Key Set (JWKS) array encoded in base64. Use it when your OIDC metadata discovery endpoint is inaccessi- ble from the public in- ternet. | Provisioning Updating | n/a             | Base64 encoded string. To remove a previously set value, provide only the value - (dash character without ad- ditional characters). |
The following example shows the default configuration of an oidc object. To revert your changes to the default settings, copy and paste the following values:
```
{ ... "oidc" : { "clientID" : "12b13a26-d993-4d0c-aa08-5f5852bbdff6", "issuerURL" : "https://kyma.accounts.ondemand.com", "groupsClaim" : "groups", "groupsPrefix" : "-", "signingAlgs" : ["RS256"], "usernamePrefix" : "-", "usernameClaim" : "sub", "requiredClaims" : ["-"], "encodedJwksArray": "-" } ... }
```
## Region*
Region* ( region ) is a mandatory string parameter, which defines a region where your cluster runs.
##  Note
The region marked with " 4 " supports the Colocate Control Plane feature.
For more information, see Colocate Control Plane [page 3144].
## Region Parameter
| Plan                                                      | Supported Operation   | Region Technical Key         | Region Name                       |
|-----------------------------------------------------------|-----------------------|------------------------------|-----------------------------------|
| Standard: Amazon Web Serv- ices                           | Provisioning          | eu-central-1 4 [page 3155]   | Europe (Frankfurt) 4 [page 3155]  |
| Standard: Amazon Web Serv- ices                           | Provisioning          | eu-west-2                    | Europe (London)                   |
| technical name: aws                                       | Provisioning          | ca-central-1                 | Canada (Montreal)                 |
| Free                                                      | Provisioning          | sa-east-1                    | Brazil (São Paulo)                |
| technical name: free                                      | Provisioning          | us-east-1 4 [page 3155]      | US East (VA) 4 [page 3155]        |
| Build Runtime: Amazon Web Services technical name: build- | Provisioning          | ap-northeast-1               | Japan (Tokyo)                     |
|                                                           | Provisioning          | ap-northeast-2 4 [page 3155] | South Korea (Seoul) 4 [page 3155] |
| runtime-aws                                               | Provisioning          | ap-south-1                   | India (Mumbai)                    |
| runtime-aws                                               | Provisioning          | ap-southeast-1 4 [page 3155] | Singapore 4 [page 3155]           |
| runtime-aws                                               | Provisioning          | ap-southeast-2 4 [page 3155] | Australia (Sydney) 4 [page 3155]  |
| runtime-aws                                               | Provisioning          | us-west-2 4 [page 3155]      | US West (Oregon) 4 [page 3155]    |
| Standard: Google Cloud                                    | Provisioning          | europe-west3                 | Europe (Frankfurt)                |
| technical name: gcp                                       | Provisioning          | europe-west4                 | Europe (Netherlands)              |
| Build Runtime: Google Cloud                               | Provisioning          | asia-south1 4 [page 3155]    | India (Mumbai) 4 [page 3155]      |
| technical name: build-                                    | Provisioning          | us-central1 4 [page 3155]    | US Central (IA) 4 [page 3155]     |
| runtime-gcp                                               | Provisioning          | asia-northeast2              | Japan (Osaka)                     |
| runtime-gcp                                               | Provisioning          | me-central2                  | KSA (Dammam)                      |
| runtime-gcp                                               | Provisioning          | me-west1                     | Israel (Tel Aviv)                 |
| runtime-gcp                                               | Provisioning          | australia- southeast1        | Australia (Sydney)                |
| runtime-gcp                                               | Provisioning          | southamerica-east1           | Brazil (São Paulo)                |
| runtime-gcp                                               | Provisioning          | asia-northeast1              | Japan (Tokyo)                     |
| runtime-gcp                                               | Provisioning          | asia-southeast1              | Singapore (Jurong West)           |
| runtime-gcp                                               | Provisioning          | us-west1                     | North America (Oregon)            |
| runtime-gcp                                               | Provisioning          | us-east4                     | North America (Virginia)          |
| Standard: Microsoft Azure                                 | Provisioning          | eastus 4 [page 3155]         | US East (VA) 4 [page 3155]        |
| technical name: azure                                     | Provisioning          | centralus                    | US Central (IA)                   |
| Kyma Test Demo and Devel-                                 | Provisioning          | westus2 4 [page 3155]        | US West (WA) 4 [page 3155]        |
| opment (Azure Lite)                                       | Provisioning          | uksouth                      | UKSouth (London)                  |
| technical name: azure_lite                                | Provisioning          | northeurope                  | North EU (Ireland)                |
| Plan                           | Supported Operation   | Region Technical Key           | Region Name                        |
|--------------------------------|-----------------------|--------------------------------|------------------------------------|
| Build Runtime: Microsoft Azure |                       | westeurope 4 [page 3155]       | Europe (Netherlands) 4 [page 3155] |
| technical name: build-         |                       | japaneast                      | Japan (Tokyo)                      |
| runtime-azure                  |                       | southeastasia                  | Singapore                          |
|                                |                       | australiaeast 4 [page 3155]    | Australia (Sydney) 4 [page 3155]   |
|                                |                       | switzerlandnorth 4 [page 3155] | Switzerland (Zurich) 4 [page 3155] |
|                                |                       | brazilsouth                    | Brazil (São Paulo)                 |
|                                |                       | canadacentral                  | Canada (Toronto)                   |
Here is an example of the JSON input for the Region parameter:
##  Sample Code
"region": "us-east-1"
## Related Information
Available Plans in the Kyma Environment [page 3131]
Regions for the Kyma Environment [page 48]
Kyma Modules [page 83]
Account Administration Using the SAP BTP Command Line Interface (btp CLI) [page 2401]