docs: Helm install on GKE, AKS, and EKS (#2777)

* docs: Helm install on GKE * docs: fix to yaml * docs: remove unnecessary sudo, kubeconfig flag and create namespace Creating namespace initially makes more sense. Since it can be used during the database installation. Also removing sudo makes kubeconfig flag unnecessary too * docs: fix file name * docs: fix * docs: fix indentation fix indentation so that copying is simpler * docs: rephrase * docs: Helm install on EKS docs: Helm install on EKS * fix: typo * docs: EKS fix * docs: fix mistake in GKE too * docs: Helm install on AKS * docs: fix
JanssenProject · Nov 7, 2022 · 1f9c2e4 · 1f9c2e4
1 parent 70f2c85
commit 1f9c2e4
Show file tree

Hide file tree

Showing 3 changed files with 661 additions and 3 deletions.
diff --git a/docs/admin/install/helm-install/amazon-eks.md b/docs/admin/install/helm-install/amazon-eks.md
@@ -3,6 +3,230 @@ tags:
   - administration
   - installation
   - helm
+  - EKS
+  - Amazon Web Services
+  - AWS
 ---
 
-This file is a placeholder.
+# Install Janssen on EKS
+
+## System Requirements
+
+The resources may be set to the minimum as below:
+
+- 8 GiB RAM
+- 8 CPU cores
+- 50GB hard-disk
+
+Use the listing below for detailed estimation of minimum required resources. Table contains the default resources recommendations per service. Depending on the use of each service the resources needs may be increase or decrease.
+
+| Service           | CPU Unit | RAM   | Disk Space | Processor Type | Required                           |
+| ----------------- | -------- | ----- | ---------- | -------------- | ---------------------------------- |
+| Auth server       | 2.5      | 2.5GB | N/A        | 64 Bit         | Yes                                |
+| LDAP (OpenDJ)     | 1.5      | 2GB   | 10GB       | 64 Bit         | Only if couchbase is not installed |
+| fido2             | 0.5      | 0.5GB | N/A        | 64 Bit         | No                                 |
+| scim              | 1.0      | 1.0GB | N/A        | 64 Bit         | No                                 |
+| config - job      | 0.5      | 0.5GB | N/A        | 64 Bit         | Yes on fresh installs              |
+| persistence - job | 0.5      | 0.5GB | N/A        | 64 Bit         | Yes on fresh installs              |
+| client-api        | 1        | 0.4GB | N/A        | 64 Bit         | No                                 |
+| nginx             | 1        | 1GB   | N/A        | 64 Bit         | Yes if not ALB                     |
+| auth-key-rotation | 0.3      | 0.3GB | N/A        | 64 Bit         | No [Strongly recommended]          |
+| config-api        | 0.5      | 0.5GB | N/A        | 64 Bit         | No                                 |
+
+Releases of images are in style 1.0.0-beta.0, 1.0.0-0
+
+## Initial Setup
+
+1.  Install [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+
+2.  Configure your AWS user account using [aws configure](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) command. This makes you able to authenticate before creating the cluster.
+    Note that this user account must have permissions to work with Amazon EKS IAM roles and service linked roles, AWS CloudFormation, and a VPC and related resources
+
+3.  Install [kubectl](https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html)
+
+4.  Install [eksctl](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html) 
+
+5.  Create cluster using eksctl such as the following example:
+
+    ```  
+    eksctl create cluster --name janssen-cluster --nodegroup-name jans-nodes --node-type NODE_TYPE --nodes 2  --managed --region REGION_CODE
+    ```
+    You can adjust `node-type` and `nodes` number as per your desired cluster size
+
+6.  Install [Helm3](https://helm.sh/docs/intro/install/)
+
+7.  Create `jans` namespace where our resources will reside
+    ```
+    kubectl create namespace jans
+    ```
+
+## Jans Installation using Helm
+1.  Install [Nginx-Ingress](https://github.com/kubernetes/ingress-nginx), if you are not using Istio ingress
+
+      ```
+      helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
+      helm repo add stable https://charts.helm.sh/stable
+      helm repo update
+      helm install nginx ingress-nginx/ingress-nginx
+      ```
+
+2.  Create a file named `override.yaml` and add changes as per your desired configuration:
+
+    - FQDN/domain is *not* registered:
+
+
+        Get the Loadbalancer address: 
+        ```
+        kubectl get svc nginx-ingress-nginx-controller --output jsonpath='{.status.loadBalancer.ingress[0].hostname}'
+        ```
+
+      
+        
+        Add the following yaml snippet to your `override.yaml` file:
+
+        ```yaml
+        global:
+            isFqdnRegistered: false
+        config:
+            configmap:
+                lbAddr: http:// #Add LB address from previous command
+        ```
+
+    - FQDN/domain is registered:
+
+        Add the following yaml snippet to your `override.yaml` file`:
+
+        ```yaml
+        global:
+            isFqdnRegistered: true
+            fqdn: demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans
+        config:
+            configmap:
+                lbAddr: http:// #Add LB address from previous command
+        nginx:
+          ingress:
+              enabled: true
+              path: /
+              hosts:
+              - demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans
+              tls:
+              - secretName: tls-certificate
+                hosts:
+                - demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans
+        ```
+
+
+
+
+
+
+    -  LDAP/Opendj for persistence storage
+
+
+          Add the following yaml snippet to your `override.yaml` file:
+          ```yaml
+          global:
+            cnPersistenceType: ldap
+            storageClass:
+              provisioner: kubernetes.io/aws-ebs
+            opendj:
+              enabled: true
+          ```
+
+          So if your desired configuration has no-FQDN and LDAP, the final `override.yaml` file will look something like that:
+
+          ```yaml
+           global:
+             cnPersistenceType: ldap
+             isFqdnRegistered: false
+             storageClass:
+               provisioner: kubernetes.io/aws-ebs
+             opendj:
+               enabled: true
+           config:
+            configmap:
+                lbAddr: http:// #Add LB address from previous command
+           nginx-ingress:
+            ingress:
+                path: /
+                hosts:
+                - demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans
+                tls:
+                - secretName: tls-certificate
+                  hosts:
+                  - demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans          
+          ```
+
+
+
+
+
+
+
+    - MySQL for persistence storage
+
+      In a production environment, a production grade MySQL server should be used such as `Amazon RDS`
+
+      For testing purposes, you can deploy it on the EKS cluster using the following commands:
+
+      ```
+      helm repo add bitnami https://charts.bitnami.com/bitnami
+      helm install my-release --set auth.rootPassword=Test1234#,auth.database=jans bitnami/mysql -n jans
+      ```
+
+      Add the following yaml snippet to your `override.yaml` file:
+
+      ```yaml
+      
+      global:
+        cnPersistenceType: sql
+      config:
+        configmap:
+          cnSqlDbName: jans
+          cnSqlDbPort: 3306
+          cnSqlDbDialect: mysql
+          cnSqlDbHost: my-release-mysql.jans.svc
+          cnSqlDbUser: root
+          cnSqlDbTimezone: UTC
+          cnSqldbUserPassword: Test1234#
+      ```
+
+      So if your desired configuration has FQDN and MySQL, the final `override.yaml` file will look something like that:
+
+      ```yaml
+      global:
+        cnPersistenceType: sql
+        isFqdnRegistered: true
+        fqdn: demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans
+      nginx-ingress:
+        ingress:
+            path: /
+            hosts:
+            - demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans
+            tls:
+            - secretName: tls-certificate
+              hosts:
+              - demoexample.jans.org #CHANGE-THIS to the FQDN used for Jans  
+      config:
+        configmap:
+          lbAddr: http:// #Add LB address from previous command
+          cnSqlDbName: jans
+          cnSqlDbPort: 3306
+          cnSqlDbDialect: mysql
+          cnSqlDbHost: my-release-mysql.jans.svc
+          cnSqlDbUser: root
+          cnSqlDbTimezone: UTC
+          cnSqldbUserPassword: Test1234#
+      ```
+
+3.  Install Jans
+
+
+
+      After finishing all the tweaks to the `override.yaml` file, we can use it to install jans.
+
+      ```
+      helm repo add janssen https://docs.jans.io/charts
+      helm repo update
+      helm install janssen janssen/janssen -n jans -f override.yaml
+      ```