Some language improvements

docs/local_dev_remote_kratos.md

@@ -2,25 +2,25 @@
 
 # Introduction
 
-kratos managed the user database. It has profiles of all users and keeps track
-of lost password policies, welcome e-mails, TOTP (future). First, Last name etc.
+kratos manage the user database. It has profiles of all users and keeps track
+of lost password policies, welcome e-mails, TOTP (future), First, Last name etc.
 
 Kratos is a flexible identity manager where our own "schema" can be defined with
 the information we want for Stack Spin. 
 
 Kratos has a public API, which should be accessible for the world, and an admin API
-which is ONLY accible for our panel/board to manage users.
+which is ONLY accessible for our panel/board to manage users.
 
 At the point of writing BOTH end-point are not public yet. We can use SSH port
-forwards for development.
+forwards during development.
 
 # Installation
 
-The current kratos version is not yet merge to master. However, this does not
+The current kratos version is not yet merged to master. However, this does not
 prevent us from developing already. To use / add the kratos backend, the
 following needs to be done:
 
-On you `kubectl` / controller machine, make sure to checkout:
+On your provisioning machine, make sure to checkout:
 
 `git@open.greenhost.net:openappstack/single-sign-on.git`
 
@@ -41,7 +41,7 @@ flux suspend source chart oas-single-sign-on
 when we install the new version of the `single-sign-on` helmchart:
 
 ```
-helm get values single-sign-on > /to/a/path/my_cluster_values.yaml
+helm get values single-sign-on -n oas > /to/a/path/my_cluster_values.yaml
 ```
 
 3. Install the single-sign-on helmchart with kratos service
@@ -53,21 +53,22 @@ helm upgrade -f /to/a/path/my_cluster_values.yaml single-sign-on . -n oas --debu
 
 This will install the latest version. 
 
-**Note**: Known issue, in some circuimstances the installation fails because the
-"automerge", to update the database fields, kicks in while at that point is too
-early. This needs more investigation. If you run into this problem, try the
-following: 
+**Note**: Known issue, in some circumstances the installation fails because
+kratos automigration kicks in too early. This needs more investigation. If you run 
+into this problem, try the following: 
 
 1. Open the file `helmchart/single-sign-on/values.yaml`
-2. Set the `autoMigrate` on line 151 to false
+2. Set the `autoMigrate` on line 151 to `false`
 3. Rerun the upgrade.
 
-After successful upgrade, adjust the value back to `true` and rerun the install. 
+After successful upgrade, adjust the value back to `true` and rerun the upgrade
+once again. As the PVC and database server are now up and running, the
+automigration works as expected
 
-It looks there is some kind of race condition, by first disabeling, the storage
-to store the database is created, so on the second run, this racecondition is
-not hit. This *should* not happen with kubernetes, so maybe the cause is
-something else.
+It looks there is some kind of race condition, by first disabling the
+automigration, the storage to store the database is created, so on the second run, 
+this race condition is not hit. This *should* not happen with kubernetes, so 
+maybe the cause is something else.
 
 # Development
 
@@ -80,7 +81,7 @@ kratos.
 ./set-ssh-tunnel.sh `oas.example.com`
 ```
 
-(the tunnel goes to the kubernetes node, so *not* your controller node.
+(the tunnel goes to the kubernetes node, so *not* to your provisioning machine.
 
 kratos API is specified on their website:
 
@@ -93,3 +94,4 @@ Some example can be found in:
 ```
 
 
+

helmchart/single-sign-on/README.md

 Please refer to the [online documentation](.../helmchart)
 
 
-
-This helmchart provides a first iteration of kratos services
-as backend for user database storage. 
-
-The Kratos backend is not used by applications yet and is just
-added to provide an infrastructure to develop the new frontend.
-
-To apply this helmchart for testing and add kratos to your
-stackspin cluster for development, follow those steps. Please
-note, it can be needed to specify the right namesapce (`ex: -n oas`)
-
-
-1. Suspend `core` kustomization
-
-If this is applied on a Stack Spin cluster, then the update 
-mechanism will revert back to the old version at some point in time
-so this needs to be suspended
-
-```
-flux suspend kustomization core
-```
-
-2. Backup you cluster values:
-```
-helm get values single-sign-on > cluster-values.yaml
-```
-
-3. Upgrade the helm chart to include kratos
-
-```
-helm upgrade -f ../cluster-values.yaml single-sign-on . --debug
-```
-
-3. Suspend

helmchart/single-sign-on/values.yaml

@@ -79,6 +79,8 @@ postgresql:
     annotations: {}
   postgresqlDatabase: kratos
   postgresqlUsername: kratos
+  # This will be overwritten during installation. If this helm
+  # chart is installed manual, this should be randomized or altered
   postgresqlPassword: kratos
 
 kratos: