Skip to content

Latest commit

 

History

History
56 lines (46 loc) · 2.93 KB

03-08-kyma-versions.md

File metadata and controls

56 lines (46 loc) · 2.93 KB
title type
Configure Kyma version
Details

Kyma Environment Broker is configured with a default Kyma version specified in the APP_KYMA_VERSION environment variable. This means that each Kyma Runtime provisioned by Kyma Environment Broker in a given global account is installed in the default Kyma version. You can also specify a different Kyma version for a global account or subaccount using a ConfigMap. To specify a version for a given account, use the following prefixes in ConfigMap keys:

  • GA_ for a global account
  • SA_ for a subaccount

The subaccount version has a higher priority than the global account mapping. When provided, the version for a subaccount is used as long as the subaccount ID in the provisioning request matches the subaccount ID in the ConfigMap. See the example:

apiVersion: v1
kind: ConfigMap
metadata:
  name: kyma-versions
  namespace: "kcp-system"
data:
  GA_3e64ebae-38b5-46a0-b1ed-9ccee153a0ae: "1.15.0-rc1"
  SA_df29c526-0c3d-4e2c-ba41-8b69cde41961: "PR-3721"
  SA_4abbc9b5-055a-4571-b762-9d61b4b8a2e7: "main-1ab234"

This ConfigMap contains a default version for a global account and a subaccount. The 3e64ebae-38b5-46a0-b1ed-9ccee153a0ae parameter is a global account ID, and the value is the Kyma version specified for this global account. The df29c526-0c3d-4e2c-ba41-8b69cde41961 and 4abbc9b5-055a-4571-b762-9d61b4b8a2e7 parameters are a subaccount IDs, and the values are the Kyma versions specified for those subaccounts.

The Kyma version value could be either a Github tag (e.g. 1.15.0-rc1 or 1.16.0), a version built from a pull request (e.g. PR-3721), or a version from the main branch with the specific commit hash, for example: 1ab234.

NOTE: From April 8, 2021, the default branch on the kyma repository switched from master to main. For this reason, versions with commits from before this date are not supported.

You can also specify a Kyma version using the kymaVersion provisioning parameter, for example:

   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\",
           \"kymaVersion\": \"$VERSION"
       }
   }"

The kymaVersion provisioning parameter overrides the default settings. To enable this feature, set the APP_ENABLE_ON_DEMAND_VERSION environment variable to true.

NOTE: The default Kyma version for the preview plan is set separately in the APP_KYMA_PREVIEW_VERSION environment variable.