Home

Awesome

Helm Broker

Go Report Card Sourcegraph

Overview

Helm Broker is a Service Broker that exposes Helm charts as Service Classes in Service Catalog. To do so, Helm Broker uses the concept of addons. An addon is an abstraction layer over a Helm chart which provides all information required to convert the chart into a Service Class.

Helm Broker fetches default cluster-wide addons defined by the helm-repos-urls custom resource (CR). This CR contains URLs that point to the release of the addons repository compatible with a given Kyma release. You can also configure Helm Broker to fetch addons definitions from other addons repositories.

You can install Helm Broker either as a standalone project, or as part of Kyma. In Kyma, you can use addons to install the following Service Brokers:

NOTE: Starting from Kyma 2.0, Helm Broker will no longer be supported.

To see all addons that Helm Broker provides, go to the addons repository.

Helm Broker implements the Open Service Broker API (OSB API). To be compliant with Service Catalog version used in Kyma, Helm Broker supports only the following OSB API versions:

NOTE: Helm Broker does not implement the OSB API update operation.

Next steps

To install Helm Broker and develop the project, read the installation document. For more details, tutorials, and troubleshooting, explore the documentation directory.

Project structure

The helm-broker repository has the following structure:

  ├── .github                   # Pull request and issue templates    
  ├── charts                    # Charts to install by Helm
  ├── cmd                       # Main applications of the project                                     
  ├── config                    # Configuration file templates or default configurations
  ├── deploy                    # Dockerfiles to build applications image
  │
  ├── docs                      # Documentation related to the project
  │    ├── assets                  # Diagrams and assets used in the documentation
  │    └── internal                # Proposals and release-related documentation
  │
  ├── hack                      # Scripts used by the Helm Broker developers
  │    ├── boilerplate              # Header used while generating code
  │    ├── ci                       # Source of the test for charts
  │    ├── examples                 # Example Kubernetes objects  
  │    └── release                  # Release pipeline scripts
  │
  ├── internal                  # Private application and library code
  │    ├── addon                    # Package that provides logic for fetching addons from different remote repositories
  │    ├── rafter                   # Client for the upload service which allows the Helm Broker to upload documentation
  │    ├── bind                     # Logic that renders the binding data
  │    ├── broker                   # Implementation of the OSB API contract
  │    ├── config                   # Configurations structs for both Controller and Broker
  │    ├── controller               # Logic of the ClusterAddonsConfigurations and AddonsConfigurations controllers
  │    ├── health                   # Handlers of the liveness and readiness probes
  │    ├── helm                     # Client for Helm
  │    ├── platform                 # Internal minor packages, such as logger or idProvider
  │    ├── storage                  # Storage layer for both memory and ETCD provider, based on factory design pattern
  │    └── model.go                 # All structs used in the project
  │
  ├── pkg                       # Library code to use by external applications
  │    ├── apis                     # Structs definitions for ClusterAddonsConfigurations and AddonsConfigurations
  │    └── client                   # Typed client for ClusterAddonsConfigurations and AddonsConfigurations
  │
  └── test                      # Additional external test applications and test data
       ├── charts                   # Implementation of the test for the `helm-broker` chart
       └── integration              # Implementation of the integration test