helm-broker/

README

Helm Broker

Overview

The Helm Broker is an implementation of a Service Broker which runs on the Kyma cluster and deploys applications into the Kubernetes cluster using Kyma bundles, and the Helm client. A bundle is an abstraction layer over a Helm chart which allows you to represent it as a ClusterServiceClass in the Service Catalog. For example, a bundle can provide plan definitions or binding details. The Helm Broker fetches bundles definitions from an HTTP servers. A list of HTTP bundles repositories is defined in the ConfigMap and can be changed in the runtime.

For the details about Helm Broker configuration, see this document. See the Create a bundle and Bind bundles documents to learn more about bundles. The Helm Broker implements the Service Broker API. For more information about the Service Brokers, see the Service Brokers overview document.

Prerequisites

To set up the project, download these tools:

• Go 1.11.4
• Dep v0.5.0
• Docker

These Go and Dep versions are compliant with the buildpack used by Prow. For more details read this document.

Development

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

Run a local version

To run the application without building a binary file, run this command:

APP_KUBECONFIG_PATH=/Users/$User/.kube/config APP_CONFIG_FILE_NAME=contrib/minimal-config.yaml  APP_CLUSTER_SERVICE_BROKER_NAME=helm-broker APP_HELM_BROKER_URL=http://localhost:8080 APP_NAMESPACE=kyma-system go run cmd/broker/main.go

NOTE: Not all features are available when you run the Helm Broker locally. All features which perform actions with Tiller do not work.