2017-09-06 01:43:57 +03:00
|
|
|
# Helm Charts for Kubernetes Service Catalog on Azure
|
|
|
|
|
|
2017-10-30 23:59:42 +03:00
|
|
|
[](https://circleci.com/gh/Azure/helm-charts)
|
2017-10-06 00:25:58 +03:00
|
|
|
|
2017-10-11 21:27:54 +03:00
|
|
|
# Overview
|
|
|
|
|
|
2017-09-06 01:43:57 +03:00
|
|
|
This repository contains [Helm](https://helm.sh/) charts for use with the
|
|
|
|
|
[Kubernetes Service Catalog](https://github.com/kubernetes-incubator/service-catalog)
|
2017-12-02 01:05:27 +03:00
|
|
|
and the Microsoft Open Service Broker for Azure.
|
2017-09-06 01:43:57 +03:00
|
|
|
|
|
|
|
|
Each chart has one or more dependencies on Azure services (e.g. Azure SQL, CosmosDB, ...)
|
2017-12-02 01:05:27 +03:00
|
|
|
which are fulfilled by [Open Service Broker for Azure](https://github.com/Azure/open-service-broker-azure) and
|
2017-10-11 21:27:54 +03:00
|
|
|
the [Kubernetes Service Catalog](https://github.com/kubernetes-incubator/service-catalog) working
|
|
|
|
|
in tandem.
|
|
|
|
|
|
2017-11-29 00:55:27 +03:00
|
|
|
The following charts are available:
|
|
|
|
|
|
|
|
|
|
- [Concourse CI](./concourse)
|
|
|
|
|
- [Wordpress](./wordpress)
|
|
|
|
|
- [phpBB](./phpbb)
|
|
|
|
|
|
2017-11-02 20:58:00 +03:00
|
|
|
# Prerequisites
|
|
|
|
|
|
2017-11-21 20:59:19 +03:00
|
|
|
You'll need a [Kubernetes](https://kubernetes.io) cluster, version 1.7 or later,
|
|
|
|
|
with [Service Catalog](https://github.com/kubernetes-incubator/service-catalog)
|
2017-12-02 01:05:27 +03:00
|
|
|
and [Open Service Broker for Azure](https://github.com/Azure/open-service-broker-azure)
|
2017-11-21 20:59:19 +03:00
|
|
|
installed on it.
|
|
|
|
|
|
|
|
|
|
Please see [the prerequisities guide](./docs/prerequisities/README.md) for
|
|
|
|
|
details on how to install all of these prerequisities.
|
|
|
|
|
|
2017-10-11 21:27:54 +03:00
|
|
|
# Installing Charts
|
|
|
|
|
|
|
|
|
|
All of the charts herein are stored in a
|
|
|
|
|
[Helm chart repository](https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md).
|
|
|
|
|
|
|
|
|
|
First, add the Azure charts repository to your local list:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$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
|
2017-09-06 01:43:57 +03:00
|
|
|
|
2017-10-31 23:48:09 +03:00
|
|
|
If you are looking to create a chart, please see the list of with the `Help Wanted`
|
|
|
|
|
label [here](https://github.com/Azure/helm-charts/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
|
2017-10-30 23:55:40 +03:00
|
|
|
|
2017-11-29 00:47:32 +03:00
|
|
|
If you decide to create a new chart, please follow the following guidelines:
|
|
|
|
|
|
|
|
|
|
- Look at the [upstream charts repository](https://github.com/kubernetes/charts) 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](./wordpress/templates/NOTES.txt) is an
|
|
|
|
|
example of a NOTES.txt file
|
|
|
|
|
|
2017-10-30 23:55:40 +03:00
|
|
|
# Contributing
|
|
|
|
|
|
2017-11-09 17:43:37 +03:00
|
|
|
For details on how to contribute to this project, please see [contributing.md](./docs/contributing.md).
|
|
|
|
|
|
2017-10-30 23:55:40 +03:00
|
|
|
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](https://opensource.microsoft.com/codeofconduct/).
|
|
|
|
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
|
|
|
|
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
