From fb1552de10349ddaf45f2bcbf1a86a3d9647853d Mon Sep 17 00:00:00 2001 From: Maarten de Waard <maarten@greenhost.nl> Date: Tue, 21 Dec 2021 12:08:15 +0100 Subject: [PATCH] add helm repo URL to docs --- docs/helmchart.md | 14 +++++++------- helmchart/single-sign-on/CHANGELOG.md | 2 +- helmchart/single-sign-on/README.md | 4 +--- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/helmchart.md b/docs/helmchart.md index 7bca15d..4959478 100644 --- a/docs/helmchart.md +++ b/docs/helmchart.md @@ -146,25 +146,25 @@ grantTypes: ## Installing and uninstalling the Chart -To install the chart with the realease name `single-sign-on` first clone the repository, -and then run helm install. +To install the chart, add our helm repository[^1] and run the installation: ``` -$ git clone https://open.greenhost.net/stackspin/single-sign-on -$ cd single-sign-on/helmchart/single-sign-on/ -$ helm install -n single-sign-on . +# helm repo add single-sign-on https://open.greenhost.net/api/v4/projects/8/packages/helm/api/stable +$ helm install -n single-sign-on single-sign-on/single-sign-on ``` The last command will deploy the single sign-on components on your server and applies a default configuration. You should change the default configuration before running the command. + The [configuration](#configuration) section lists all configuration parameters. In case you already ran the install command, you can uninstall the deployment by executing: ``` $ helm list # [OPTIONAL] - Lists all deployed releases -$ helm delete single-sign-on --purge +$ helm delete single-sign-on ``` -> **WARNING**: Executing the `delete` command with the `purge` flag will delete all data that is related to the applications. Don't run this command in a production environment if you are not absolutely sure that you have a restorable backup of your data. +> **WARNING**: Executing the `delete` command will delete all data that is related to the applications. Don't run this command in a production environment if you are not absolutely sure that you have a restorable backup of your data. +[^1]: If you want to test a version that is not on the `main` branch yet, use `https://open.greenhost.net/api/v4/projects/8/packages/helm/unstable` diff --git a/helmchart/single-sign-on/CHANGELOG.md b/helmchart/single-sign-on/CHANGELOG.md index 93ee743..bba2ad3 100644 --- a/helmchart/single-sign-on/CHANGELOG.md +++ b/helmchart/single-sign-on/CHANGELOG.md @@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [0.5.1] - 2021-12-21 -- Host chart on Helm Repository +- Host chart on Helm Repository: https://open.greenhost.net/api/v4/projects/8/packages/helm/api/stable ## [0.5.0] - 2021-12-10 diff --git a/helmchart/single-sign-on/README.md b/helmchart/single-sign-on/README.md index 1ec3922..4a29e6f 100644 --- a/helmchart/single-sign-on/README.md +++ b/helmchart/single-sign-on/README.md @@ -1,3 +1 @@ -Please refer to the [online documentation](.../helmchart) - - +Please refer to the [online documentation](../../docs//helmchart.md) -- GitLab