Skip to content

Commit

Permalink
MM-15383 Adding RELEASE.md to cover the chart-releaser updates (#72)
Browse files Browse the repository at this point in the history
* MM-15383 Adding RELEASE.md to cover the chart-releaser updates

* MM-15383 Updating README.md to cover the use of Helm Chart releases
  • Loading branch information
stylianosrigas authored and cpanato committed May 4, 2019
1 parent b4219b0 commit 423f4c0
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ We recommend installing Helm v2.13.1 or later.
Once Helm is installed and initialized, run the following:

```bash
helm repo add mattermost https://releases.mattermost.com/helm
helm repo add mattermost https://helm.mattermost.com
helm repo add incubator https://kubernetes-charts-incubator.storage.googleapis.com/
```

Expand Down Expand Up @@ -162,27 +162,27 @@ See the [stable/minio configuration settings](https://github.com/helm/charts/tre

# 3. Install

Clone this repository and cd into it:
After adding the Mattermost repo (see section 1.2) you can install a version of the preferred chart by running:

```bash
git clone https://github.com/mattermost/mattermost-kubernetes.git
cd mattermost-kubernetes
helm install --repo https://helm.mattermost.com <chart_name> --version <version_number>
```

Get the dependencies needed to run the chart:
For example:
```bash
cd ./charts/mattermost-enterprise-edition
helm dependencies update
cd ..
helm install --repo https://helm.mattermost.com mattermost-enterprise-edition --version v0.8.2
```

If no Helm Chart version is specified the latest version will be installed.

To run with your custom `config.yaml`, install using:
```bash
helm install -f config.yaml ./mattermost-enterprise-edition
helm install -f config.yaml --repo https://helm.mattermost.com mattermost-enterprise-edition
```

To upgrade an existing release, modify the `config.yaml` with your desired changes and then use:
```bash
helm upgrade -f config.yaml <your-release-name> ./charts/mattermost-enterprise-edition
helm upgrade -f config.yaml <your-release-name> --repo https://helm.mattermost.com mattermost-enterprise-edition
```

## 3.1 Uninstalling Mattermost Enterprise Helm Chart
Expand All @@ -193,13 +193,13 @@ If you are done with your deployment and want to delete it, use `helm delete <yo

You can launch the Mattermost push proxy chart with:
```bash
helm install ./charts/mattermost-push-proxy
helm install --repo https://helm.mattermost.com mattermost-push-proxy
```

To list options for mattermost-push-proxy:

```bash
helm inspect values mattermost-push-proxy
helm inspect values --repo https://helm.mattermost.com mattermost-push-proxy
```

# 4. Developing
Expand Down
37 changes: 37 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Mattermost Helm Chart Releases
====================================================

# Chart Releaser

The [chart-releaser](https://github.com/helm/chart-releaser) is being used to enable the mattermost-helm [repo](https://github.com/mattermost/mattermost-helm) to self-host Helm Chart releases via the use of Github pages.

# CircleCI

CircleCI is being used to release a new version of the Mattermost Helm Charts. The [release script](https://github.com/mattermost/mattermost-helm/blob/master/.circleci/release.sh) creates a release package of the new Helm Chart version and updates the [index.yaml](https://github.com/mattermost/mattermost-helm/blob/gh-pages/index.yaml) which in this case is hosted in a Github page. The CircleCI is triggered, when a new commit is pushed in the **master** branch.

# How to Release a new Version

For a new Helm Chart release the version of the Helm Chart should be updated in the *Chart.yaml*. The chart-releaser tool will handle the packaging of the new version, will push it to the Github repo as a new [release](https://github.com/mattermost/mattermost-helm/releases) and update the index file to reflect the new version.

# How to Install a New Release

The *index.yaml* is hosted in a Github page and can be accessed via https://helm.mattermost.com/. In order to make use of a Mattermost Helm Chart specific version the Mattermost Helm repo should be added first by running:

```bash
helm repo add mattermost https://helm.mattermost.com
```

And then a version of the preferred chart can be installed by running:

```bash
helm install --repo https://helm.mattermost.com <chart_name> --version <version_number>
```

For example:


```bash
helm install --repo https://helm.mattermost.com mattermost-push-proxy --version v0.1.4
```

If no Helm Chart version is specified the latest version will be installed.

0 comments on commit 423f4c0

Please sign in to comment.