Merge pull request #608 from Human-Connection/docs-update_https_configuration

Docs update https configuration

deployment/digital-ocean/https/.gitignore

@@ -0,0 +1,2 @@
+ingress.yaml
+issuer.yaml

deployment/digital-ocean/https/README.md

@@ -12,20 +12,31 @@ $ kubectl apply -f https://raw.githubusercontent.com/jetstack/cert-manager/relea
 $ helm install --name cert-manager --namespace cert-manager stable/cert-manager
 ```
 
-Create letsencrypt issuers. _Change the email address_ in these files before running this command.
+## Create Letsencrypt Issuers and Ingress Services
+
+Copy the configuration templates and change the file according to your needs.
 
 ```bash
 # in folder deployment/digital-ocean/https/
-$ kubectl apply -f issuer.yaml
+cp templates/issuer.template.yaml ./issuer.yaml
+cp templates/ingress.template.yaml ./ingress.yaml
 ```
 
-Create an ingress service in namespace `human-connection`. _Change the domain name_ according to your needs:
+At least, **change email addresses** in `issuer.yaml`. For sure you also want
+to _change the domain name_ in `ingress.yaml`.
+
+Once you are done, apply the configuration:
 
 ```bash
 # in folder deployment/digital-ocean/https/
-$ kubectl apply -f ingress.yaml
+$ kubectl apply -f .
 ```
 
+By now, your cluster should have an external IP address assigned. If you visit
+your dashboard, this is how it should look like:
+
+![Screenshot of the kubernetes dashboard showing the extrenal ip address](./ip-address.png)
+
 Check the ingress server is working correctly:
 
 ```bash

deployment/human-connection/README.md

@@ -9,13 +9,21 @@ just apply our provided configuration files to your cluster.
 Copy our provided templates:
 
 ```bash
-$ cp secrets.template.yaml human-connection/secrets.yaml
-$ cp configmap.template.yaml human-connection/configmap.yaml
+# in folder deployment/human-connection/
+$ cp templates/secrets.template.yaml ./secrets.yaml
+$ cp templates/configmap.template.yaml ./configmap.yaml
 ```
 
 Change the `configmap.yaml` as needed, all variables will be available as
 environment variables in your deployed kubernetes pods.
 
+Probably you want to change this environment variable to your actual domain:
+
+```
+# in configmap.yaml
+CLIENT_URI: "https://nitro-staging.human-connection.org"
+```
+
 If you want to edit secrets, you have to `base64` encode them. See [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-manually).
 
 ```bash
@@ -30,7 +38,8 @@ your deployed kubernetes pods.
 ## Create a namespace
 
 ```bash
-$ kubectl apply -f namespace-human-connection.yaml
+# in folder deployment/human-connection/
+$ kubectl apply -f namespace.yaml
 ```
 
 If you have a [kubernets dashboard](../digital-ocean/dashboard/README.md)
@@ -48,7 +57,7 @@ persistent volumes once before you apply the configuration.
 ## Apply the configuration
 
 ```bash
-# in folder deployment/ 
+# in folder deployment/
 $ kubectl apply -f human-connection/
 ```
 

deployment/human-connection/namespace.yaml

@@ -0,0 +1,6 @@
+kind: Namespace
+apiVersion: v1
+metadata:
+  name: human-connection
+  labels:
+    name: human-connection