From 4e18936084400728c02c820e03c19080e8869314 Mon Sep 17 00:00:00 2001
From: Mark <mark@openappstack.net>
Date: Mon, 16 Dec 2019 15:52:48 +0100
Subject: [PATCH] Change order of install instructions
---
helmchart/single-sign-on/README.md | 46 ++++++++++++++++--------------
1 file changed, 24 insertions(+), 22 deletions(-)
diff --git a/helmchart/single-sign-on/README.md b/helmchart/single-sign-on/README.md
index 7b3ca8a..d4cdec9 100644
--- a/helmchart/single-sign-on/README.md
+++ b/helmchart/single-sign-on/README.md
@@ -12,6 +12,30 @@ to create new users, assign roles to users and grant users access to application
* ORY helm chart repository installed
* `helm repo add ory https://k8s.ory.sh/helm/charts && helm repo update`
+## Configuration
+
+You can configure the chart by changing the default values in the `./values.yaml` file.
+The following table lists the configurable parameters of the single sign-on chart and their
+default values. Values in **bold** letters need to be changed for Routing and TLS to work.
+
+| Parameter | Description | Default |
+| ------------------------------------ | ------------------------------------------------------- | ------------------------- |
+| `singleSignOnHost` | **FQDN of the openID Connect / oAuth2 server** | **sso.oas.example.net** |
+| `loginProviderImage.repository` | Name of image repository to be used for login provider | open.greenhost.net:4567/openappstack/single-sign-on/login_provider |
+| `loginProviderImage.tag` | Release version of login provider image | master |
+| `consentProviderImage.repository` | Name of image repository to be used for consent provider| open.greenhost.net:4567/openappstack/single-sign-on/consent_provider |
+| `consentProviderImage.tag` | Release version of consent provider image | master |
+| `userpanel.ingress.host` | **FQDN of the userpanel** | **admin.oas.example.net** |
+| `userpanel.oAuth.client_secret` | oAuth2 client secret | YouReallyNeedToChangeThis |
+| `userbackend.username` | Username of the admin user | admin |
+| `userbackend.password` | Password of the admin user | YouReallyNeedToChangeThis |
+| `userbackend.email` | Email address of the admin user | admin@example.net |
+| `userbackend.postgres.password` | Root pw of the psql DB | postgres |
+| `hydra.hydra.config.urls.self.issuer`| **Base URI of the oAuth server** | **https://sso.oas.example.net** |
+| `hydra.hydra.config.urls.login` | **URI that will be used for the login page** | **https://sso.oas.example.net/login** |
+| `hydra.hydra.config.urls.consent` | **URI that will be used for permission checks** | **https://sso.oas.example.net/consent** |
+| `hydra.hydra.config.secrets.system` | Secret that is used to generate secure tokens | YouReallyNeedToChangeThis |
+
## Installing and uninstalling the Chart
To install the chart with the realease name `single-sign-on` first clone the repository,
@@ -36,25 +60,3 @@ $ helm delete single-sign-on --purge
> **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.
-## Configuration
-
-The following table lists the configurable parameters of the single sign-on chart and their
-default values. Values in **bold** letters need to be changed for Routing and TLS to work.
-
-| Parameter | Description | Default |
-| ------------------------------------ | ------------------------------------------------------- | ------------------------- |
-| `singleSignOnHost` | **FQDN of the openID Connect / oAuth2 server** | **sso.oas.example.net** |
-| `loginProviderImage.repository` | Name of image repository to be used for login provider | open.greenhost.net:4567/openappstack/single-sign-on/login_provider |
-| `loginProviderImage.tag` | Release version of login provider image | master |
-| `consentProviderImage.repository` | Name of image repository to be used for consent provider| open.greenhost.net:4567/openappstack/single-sign-on/consent_provider |
-| `consentProviderImage.tag` | Release version of consent provider image | master |
-| `userpanel.ingress.host` | **FQDN of the userpanel** | **admin.oas.example.net** |
-| `userpanel.oAuth.client_secret` | oAuth2 client secret | YouReallyNeedToChangeThis |
-| `userbackend.username` | Username of the admin user | admin |
-| `userbackend.password` | Password of the admin user | YouReallyNeedToChangeThis |
-| `userbackend.email` | Email address of the admin user | admin@example.net |
-| `userbackend.postgres.password` | Root pw of the psql DB | postgres |
-| `hydra.hydra.config.urls.self.issuer`| **Base URI of the oAuth server** | **https://sso.oas.example.net** |
-| `hydra.hydra.config.urls.login` | **URI that will be used for the login page** | **https://sso.oas.example.net/login** |
-| `hydra.hydra.config.urls.consent` | **URI that will be used for permission checks** | **https://sso.oas.example.net/consent** |
-| `hydra.hydra.config.secrets.system` | Secret that is used to generate secure tokens | YouReallyNeedToChangeThis |
--
GitLab