Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 3.21 KB

README.md

File metadata and controls

83 lines (50 loc) · 3.21 KB
Raw

Build Status

console-charts

Contains public Helm charts related to the Lightbend Console. Lightbend's helm repo is available at https://repo.lightbend.com/helm-charts.

Project layout

All projects must conform to the Helm chart layout.

If there are files that you don't want included in the chart, add them to a .helmignore file in your project directory.

Project Makefile

All projects must have a Makefile that implements the targets:

  • lint: Should do preliminary checks to confirm the project is ready for packaging.
  • package: Should create the chart tarball and push it up to the console-charts/docs directory.
  • test: Typically run by Travis to test the release.

A default common.mk file is included that can be used for this purpose, although a project is free to implement these targets as they see fit.

console-charts Makefile

The default target of the top-level Makefile packages all the charts and then builds the index.yaml file based on the tarballs.

If any of the lint, package, or test targets are invoked, they are recursively invoked on each of the projects. To run over a particular subset of projects just define a value on the command line. e.g. make package CHARTS=sample-project

Helm install a project:

To install the Helm chart for a particular project...

kubectl create serviceaccount --namespace kube-system tiller

kubectl create clusterrolebinding tiller-cluster-admin --clusterrole=cluster-admin --serviceaccount=kube-system:tiller

helm init --service-account tiller

helm repo add lightbend-helm-charts https://repo.lightbend.com/helm-charts

helm repo update

helm install lightbend-helm-charts/<chart-name> --name=<release-name> --namespace=lightbend --debug

Upgrade

helm repo update
helm upgrade lightbend-helm-charts/<chart-name> --name=<release-name> --namespace=lightbend --debug

Cutting a Release / Publishing Charts

See the Google doc for releasing Enterprise Suite Console for the definitive process.

Availability

Published Lightbend helm charts are available from the the public helm repo. Assuming you have es-repo mapped to the https://repo.lightbend.com/helm-charts repo in helm, then for a list of all currently published Lightbend charts run:

helm repo update
helm search es-repo

Maintenance

Enterprise Suite Team [email protected]

License

Copyright (C) 2018 Lightbend Inc. (https://www.lightbend.com).

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.