Skip to content
A Service Broker which exposes Helm charts as Service Classes in the Service Catalog
Go Shell Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add repo templates (#3) Aug 7, 2019
charts/helm-broker Create release process (#45) Oct 25, 2019
cmd Fix etcd client timeout (#40) Oct 2, 2019
config/crds Enable URL templating from secret (#16) Aug 28, 2019
deploy Upgrade to alpine 3.10 (#42) Oct 10, 2019
docs Split main readme into separate docs (#50) Oct 31, 2019
hack Split main readme into separate docs (#50) Oct 31, 2019
internal Fix etcd client timeout (#40) Oct 2, 2019
pkg Upgrade readme file (#43) Oct 18, 2019
test Upgrade readme file (#43) Oct 18, 2019
tmp Initialize repository Jul 24, 2018
.github_changelog_generator Split main readme into separate docs (#50) Oct 31, 2019
.gitignore Create release process (#45) Oct 25, 2019
CODEOWNERS Add Maja and Alex to CODEOWNERS (#39) Sep 27, 2019
CODE_OF_CONDUCT.md
CONTRIBUTING.md Add repo templates (#3) Aug 7, 2019
Gopkg.lock
Gopkg.toml Extend addonsconfiguration CRD with secretRef (#12) Aug 20, 2019
LICENSE
Makefile
NOTICE.md Add repo templates (#3) Aug 7, 2019
OWNERS Fix ONWERS file regex (#27) Sep 6, 2019
README.md Add go report card badge (#53) Nov 8, 2019
before-commit.sh Add Helm Broker chart testing via chart-testing lib (#32) Sep 24, 2019

README.md

Helm Broker

Go Report Card Sourcegraph

Overview

The Helm Broker is a Service Broker which exposes Helm charts as Service Classes in the Service Catalog. To do so, the 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. To learn more about the Helm Broker, read the documentation.

If you want to use the Helm Broker with all dependencies, try out Kyma.

Project structure

The 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
  │    ├── proposals                # Proposed architecture decisions
  │    └── release                  # Release notes template
  │
  ├── 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
  │    ├── assetstore               # 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
You can’t perform that action at this time.