kyma-environment-broker/

README

Kyma Environment Broker

Overview

Kyma Environment Broker (KEB) is a component that allows you to provision Kyma as a Runtime on clusters provided by third-party providers. It uses the Runtime Provisioner's API to install Kyma on a given cluster.

For more information, read the documentation where you can find information on:

• Architecture
• Service description
• Runtime components
• Runtime provisioning and deprovisioning
• Hyperscaler account pool
• Authorization
• Runtime overrides
• Provisioning Kyma environment
• Deprovisioning Kyma environment
• Operation status
• Instance details

Configuration

KEB binary allows you to override some configuration parameters. You can specify the following environment variables:

Name	Description	Default value
APP_PORT	Specifies the port on which the HTTP server listens.	8080
APP_PROVISIONING_DEFAULT_GARDENER_SHOOT_PURPOSE	Specifies the purpose of the created cluster. The possible values are: development, evaluation, production, testing.	development
APP_PROVISIONING_URL	Specifies a URL to the Runtime Provisioner's API.	None
APP_PROVISIONING_SECRET_NAME	Specifies the name of the Secret which holds credentials to the Runtime Provisioner's API.	None
APP_PROVISIONING_GARDENER_PROJECT_NAME	Defines the Gardener project name.	true
APP_PROVISIONING_GCP_SECRET_NAME	Defines the name of the Secret which holds credentials to GCP.	None
APP_PROVISIONING_AWS_SECRET_NAME	Defines the name of the Secret which holds credentials to AWS.	None
APP_PROVISIONING_AZURE_SECRET_NAME	Defines the name of the Secret which holds credentials to Azure.	None
APP_AUTH_USERNAME	Specifies the Kyma Environment Service Broker authentication username.	None
APP_AUTH_PASSWORD	Specifies the Kyma Environment Service Broker authentication password.	None
APP_DIRECTOR_NAMESPACE	Specifies the Namespace in which Director is deployed.	kcp-system
APP_DIRECTOR_URL	Specifies the Director's URL.	http://compass-director.compass-system.svc.cluster.local:3000/graphql
APP_DIRECTOR_OAUTH_CREDENTIALS_SECRET_NAME	Specifies the name of the Secret created by the Integration System.	compass-kyma-environment-broker-credentials
APP_DIRECTOR_SKIP_CERT_VERIFICATION	Specifies whether TLS checks the presented certificates.	false
APP_DATABASE_USER	Defines the database username.	postgres
APP_DATABASE_PASSWORD	Defines the database user password.	password
APP_DATABASE_HOST	Defines the database host.	localhost
APP_DATABASE_PORT	Defines the database port.	5432
APP_DATABASE_NAME	Defines the database name.	broker
APP_DATABASE_SSL	Specifies the SSL Mode for PostgrSQL. See all the possible values here.	disable