helm-charts/README.md

4.2 KiB

Helm Charts for Kubernetes Service Catalog on Azure

CircleCI

Overview

This repository contains Helm charts for use with the Kubernetes Service Catalog and the Microsoft Open Service Broker for Azure.

🚨 The project is in alpha status. This means that no assurances are made about backwards compatibility or stability until Open Service Broker for Azure has reached v1.

Each chart has one or more dependencies on Azure services (e.g. Azure SQL, CosmosDB, ...) which are fulfilled by Open Service Broker for Azure and the Kubernetes Service Catalog working in tandem.

The following charts are available:

Prerequisites

You'll need a Kubernetes cluster, version 1.7 or later, with Service Catalog and Open Service Broker for Azure installed on it.

Please see the prerequisities guide for details on how to install all of these prerequisities.

Installing Charts

All of the charts herein are stored in a Helm chart repository.

First, add the Azure charts repository to your local list:

helm repo add azure https://kubernetescharts.blob.core.windows.net/azure

After you've added the Azure charts repository, you'll have access to the charts you see here. For example, you can search for charts:

$helm search wordpress
NAME            	VERSION	DESCRIPTION
azure/wordpress 	0.6.12 	Web publishing platform for building blogs and ...
local/wordpress 	0.6.12 	Web publishing platform for building blogs and ...
stable/wordpress	0.6.10 	Web publishing platform for building blogs and ...

Notice that azure/wordpress is listed above. This is the chart that you see in this Github repository.

Creating a New Chart

If you are looking to create a chart, please see the list of with the Help Wanted label here.

If you decide to create a new chart, please follow the following guidelines:

  • Look at the upstream charts repository for prior art
  • Wherever possible, ensure that your chart has the option to install the service to be provisioned locally, in the cluster
    • For example, if your chart provisions Azure MySQL, ensure that the chart can be installed with the option to create a MySQL instance in the cluster. The default should be to provision on Azure
  • Include a detailed README.md and NOTES.txt file for your chart
    • Here is an example of a NOTES.txt file

Contributing

For details on how to contribute to this project, please see contributing.md.

This project welcomes contributions and suggestions. All contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.