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_URL | Specifies the Director's URL. | http://compass-director.compass-system.svc.cluster.local:3000/graphql |
| APP_DIRECTOR_OAUTH_TOKEN_URL | Specifies the URL for OAuth authentication. | None |
| APP_DIRECTOR_OAUTH_CLIENT_ID | Specifies the client ID for OAuth authentication. | None |
| APP_DIRECTOR_OAUTH_SECRET | Specifies the client secret for OAuth authentication. | None |
| APP_DIRECTOR_OAUTH_SCOPE | Specifies the scopes for OAuth authentication. | runtime:read runtime:write |
| 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 |
| APP_KYMA_VERSION | Specifies the default Kyma version. | None |
| APP_ENABLE_ON_DEMAND_VERSION | If set to true, a user can specify a Kyma version in a provisioning request. |
false |
| APP_VERSION_CONFIG_NAMESPACE | Defines the Namespace with the ConfigMap that contains Kyma versions for global accounts configuration. | None |
| APP_VERSION_CONFIG_NAME | Defines the name of the ConfigMap that contains Kyma versions for global accounts configuration. | None |
| APP_PROVISIONING_MACHINE_IMAGE | Defines the Gardener machine image used in a provisioned node. | None |
| APP_PROVISIONING_MACHINE_IMAGE_VERSION | Defines the Gardener image version used in a provisioned cluster. | None |
| APP_TRIAL_REGION_MAPPING_FILE_PATH | Defines a path to the file which contains a mapping between the platform region and the Trial plan region. | None |
| APP_MAX_PAGINATION_PAGE | Defines the maximum number of objects that can be queried in one page using the endpoints that use pagination. | 100 |
| APP_LMS_URL | Defines the URL for the LMS system. | None |
| APP_LMS_CLUSTER_TYPE | Defines the cluster type for the LMS system. | single-node |
| APP_LMS_ENVIRONMENT | Specifies the environment for the LMS system. | dev |
| APP_LMS_SAML_TENANT | Defines the SAML tenant for the LMS system. | None |
| APP_LMS_ENABLED_FOR_GLOBAL_ACCOUNTS | An LMS instance gets provisioned for the specified Global Accounts. Possible values are all, none, {global-account-ID-1}, {global-account-ID-2}, ... |
all |
| APP_LMS_MANDATORY | Defines whether failing LMS activation will break provisioning. | true |
| APP_LMS_REGION | Defines the region for the LMS system. If set, this region is always used. If empty, the region is mapped from the OSB API request. | None |
| APP_LMS_TOKEN | Specifies the token for the LMS system. | None |
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
common
|
|
|
appinfo
Package appinfo is responsible for defining REST endpoints which are serving overall information about created and managed resources e.g.
|
Package appinfo is responsible for defining REST endpoints which are serving overall information about created and managed resources e.g. |
|
broker
Currently added in this package to be able to access plans schemas.
|
Currently added in this package to be able to access plans schemas. |
|
httputil
This package provides a syntactic sugar and helper functions to make http things easier to read or to express
|
This package provides a syntactic sugar and helper functions to make http things easier to read or to express |
|
lms/automock
Code generated by mockery v1.0.0
|
Code generated by mockery v1.0.0 |
|
logger
Package copied from https://github.com/kyma-project/kyma/blob/1.11.0/components/service-binding-usage-controller/internal/platform/logger/spy/logger.go Only Reset() method was added.
|
Package copied from https://github.com/kyma-project/kyma/blob/1.11.0/components/service-binding-usage-controller/internal/platform/logger/spy/logger.go Only Reset() method was added. |
|
runtime
This package is NOT FOR PRODUCTION USE CASE.
|
This package is NOT FOR PRODUCTION USE CASE. |
|
third_party/machinebox/graphql
Package graphql provides a low level GraphQL client.
|
Package graphql provides a low level GraphQL client. |
Click to show internal directories.
Click to hide internal directories.