remote-environment-broker/

README

Remote Environment Broker

Overview

The Remote Environment Broker (REB) provides remote environments in the Service Catalog. A remote environment represents the environment connected to the Kyma instance. The REB implements the Service Broker API.

The REB fetches all the remote environments' custom resources and exposes their APIs and Events as service classes to the Service Catalog. When the remote environments list is available in the Service Catalog, you can provision those service classes and enable Kyma services to use them.

For more details about provisioning, deprovisioning, binding, and unbinding, see the Service Broker API documentation.

Prerequisites

You need the following tools to set up the project:

• The 1.9 or higher version of Go
• The latest version of Docker
• The latest version of Dep

Details

The Remote Environment Broker converts the RemoteEnvironment Custom Resource to the Open Service Broker API Service Object. All fields are mapped one-to-one except from the name and metadata.providerDisplayName properties.

The pattern for the metadata.providerDisplayName property is as follows:

{RemoteEnvironment.Service.ProviderDisplayName} - {RemoteEnvironment.Name}

It enables you to easily distinguish different remote environments from the same provider.

The pattern for the name property is as follows:

{NORMALIZED_DISPLAY_NAME}-{FIST_FIVE_CHARARACTERS_OF_SHA_FROM_SERVICE_ID}

After normalization, the displayName contains only lowercase characters, numbers and hyphens.

Development

Before each commit, use the before-commit.sh script, which tests your changes.

Code generation

Structs related to Custom Resource Definitions are defined in pkg/apis/remoteenvironment/v1alpha1/types.go and registered in pkg/apis/remoteenvironment/v1alpha1/. After making any changes there, please run:

./hack/update-codegen.sh