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 bundle definitions from an HTTP server. By default, the Helm Broker contains an embedded HTTP server which serves bundles from the Kyma bundles directory.
For the details about Helm Broker configuration, see this document. See How to create a yBundle and Binding yBundles to learn more about the bundles. The Helm Broker implements the Service Broker API. For more information about the Service Brokers, see the Service Brokers overview document.
Prerequisites
You need the following tools to set up the project:
Development
Before each commit, use the before-commit.sh script, which tests your changes.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
broker
command
|
|
|
checker
command
|
|
|
indexbuilder
command
|
|
|
reposerver
command
|
|
|
targz
command
|
|
|
broker/automock
Code generated by mockery v1.0.0
|
Code generated by mockery v1.0.0 |
|
helm/automock
Code generated by mockery v1.0.0
|
Code generated by mockery v1.0.0 |
|
platform/logger/spy
Package spy provides an implementation of go-sdk.logger that helps test logging.
|
Package spy provides an implementation of go-sdk.logger that helps test logging. |
|
storage/testing
Package testing provides test functions for storage.
|
Package testing provides test functions for storage. |
|
ybind/automock
Code generated by mockery v1.0.0
|
Code generated by mockery v1.0.0 |
|
platform
|
|
|
logger
Package logger is responsible for logging.
|
Package logger is responsible for logging. |
|
logger/spy
Package spy provides an implementation of go-sdk.logger that helps test logging.
|
Package spy provides an implementation of go-sdk.logger that helps test logging. |
|
ptr
Package ptr provides conversion rules to pointers for DTO construction.
|
Package ptr provides conversion rules to pointers for DTO construction. |
|
time
Package time provide features which supplements standard time package.
|
Package time provide features which supplements standard time package. |