Update examples and README.md (#71)

AzBuilder · Jun 30, 2023 · b533ee5 · b533ee5
1 parent 48768df
commit b533ee5
Show file tree

Hide file tree

Showing 11 changed files with 291 additions and 656 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ To uninstall the chart:
 
 ## Minikube
 
-To quickly test Terrakube in Minikube please follow [this](https://docs.terrakube.org/getting-started/deployment/minikube)
+To quickly test Terrakube in Minikube please follow [this](https://docs.terrakube.io/getting-started/deployment/minikube)
 
 ## Advance Installation
 
@@ -236,9 +236,9 @@ Once you have completed the above steps you can complete the file values.yaml to
 | security.internalSecret                   | Yes      | 32 Character secret to sing internal                                   |
 | security.dexClientId                      | Yes      | Based on Dex config file                                               |
 | security.dexClientScope                   | Yes      | Use "email openid profile offline_access groups"                       |
-| security.dexIssuerUri                     | Yes      | Should be "https://apiDomain/dex"                                      |
 | security.gcpCredentials                   | No       | JSON Credentials for Google Identity Authentication                    |
 | security.caCerts                          | No       | Custom CA certificates to be added at runtime                          |
+| storage.defaultStorage                    | No       | Enable default storage using minio helm chart                          |
 | storage.gcp.projectId                     | No       | GCP Project Id for the storage                                         |
 | storage.gcp.bucketName                    | No       | GCP Bucket name for the storage                                        |
 | storage.gcp.credentials                   | No       | GCP JSON Credentials for the storage                                   |
@@ -251,14 +251,12 @@ Once you have completed the above steps you can complete the file values.yaml to
 | storage.aws.region                        | No       | Aws region name (Example: us-east-1)                                   |
 | storage.aws.endpoint                      | No       | Setup custom endpoint (MinIO)                                          |
 | dex.enabled                               | No       | Enable Dex component                                                   |
-| dex.version                               | Yes      | Dex [version](https://github.com/dexidp/dex/releases)                  |
-| dex.replicaCount                          | Yes      |                                                                        |
-| dex.serviceType                           | Yes      | ClusterIP/NodePort/LoadBalancer/ExternalName                           |
-| dex.resources                             | No       |                                                                        |
-| dex.properties.config                     | Yes      | Dex configuration file                                                 |
-| dex.volumeMounts                          | No       |                                                                        |
-| dex.volumes                               | No       |                                                                        |
+| dex.*                                     | No       | Setup based on https://github.com/dexidp/helm-charts                   |
+| minio.*                                   | No       | Setup based on https://github.com/bitnami/charts/tree/main/bitnami/minio    |
+| postgres.*                                | No       | Setup based on https://github.com/bitnami/charts/tree/main/bitnami/postgres |
+| redis.*                                   | No       | Setup based on https://github.com/bitnami/charts/tree/main/bitnami/redis    |
 | api.enabled                               | Yes      | true/false                                                             |
+| api.defaultDatabase                       | No       | Enable default database using postgresql helm chart                    |
 | api.version                               | Yes      | Terrakube API version                                                  |
 | api.replicaCount                          | Yes      |                                                                        |
 | api.serviceAccountName                    | No       | Kubernetes Service Account name                                        |
@@ -286,7 +284,6 @@ Once you have completed the above steps you can complete the file values.yaml to
 | registry.replicaCount                     | Yes      |                                                                        |
 | registry.serviceAccountName               | No       | Kubernetes Service Account name                                        |
 | registry.serviceType                      | Yes      | ClusterIP/NodePort/LoadBalancer/ExternalName                           |
-| registry.properties.DexClientId           | Yes      | Dex Client Id for authentication                                       |
 | registry.env                              | No       |                                                                        |
 | registry.volumes                          | No       |                                                                        |
 | registry.volumeMounts                     | No       |                                                                        |
@@ -329,7 +326,6 @@ The API, Registry, Executor and UI support using affinity, taints and toleration
 ```yaml
 api:
   enabled: true
-  version: "2.6.0"
   replicaCount: "1"
   serviceType: "ClusterIP"
   resources:
@@ -390,7 +386,6 @@ Terrakube components configuration with custom CA certificates:
 ## API properties
 api:
   enabled: true
-  version: "2.7.0"
   replicaCount: "1"
   serviceType: "ClusterIP"
   env:
@@ -418,7 +413,6 @@ api:
 ## Executor properties
 executor:
   enabled: true
-  version: "2.7.0"
   replicaCount: "1"
   serviceType: "ClusterIP"
   env:
@@ -446,7 +440,6 @@ executor:
 ## Registry properties
 registry:
   enabled: true
-  version: "2.7.0"
   replicaCount: "1"
   serviceType: "ClusterIP"
   env:

diff --git a/charts/terrakube/Chart.yaml b/charts/terrakube/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 3.7.0
+version: 3.7.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/examples/AzureAuthentication-Example1.md b/examples/AzureAuthentication-Example1.md
@@ -27,92 +27,46 @@ security:
   internalSecret: "<<CHANGE_THIS>>" # Sample Key 32 characters Kb^8cMerPNZV6hS!9!kcD*KuUPUBa^B3
   dexClientId: "microsoft"
   dexClientScope: "email openid profile offline_access groups"
-  dexIssuerUri: "https://terrakube-api.domain.com/dex" # Change for your real domain
 
 ## Terraform Storage
 storage:
+  defaultStorage: false
   azure:
     storageAccountName: "<<CHANGE_THIS>>"
     storageAccountResourceGroup: "<<CHANGE_THIS>>"
     storageAccountAccessKey: "<<CHANGE_THIS>>"
 
 ## Dex
 dex:
-  enabled: true
-  version: "v2.32.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-  resources:
-    limits:
-      cpu: 512m
-      memory: 256Mi
-    requests:
-      cpu: 256m
-      memory: 128Mi
-  properties:
-    config:
-      issuer: https://terrakube-api.domain.com/dex
-      storage:
-        type: memory
-      oauth2:
-        responseTypes: ["code", "token", "id_token"]
-        skipApprovalScreen: true
-      web:
-        allowedOrigins: ['*']
-
-      staticClients:
-      - id: microsoft
-        redirectURIs:
-        - 'https://terrakube-ui.domain.com' # Change for your real domain
-        - 'http://localhost:3000'
-        - 'http://localhost:10001/login'
-        - 'http://localhost:10000/login'
-        - '/device/callback'
-        name: 'microsoft'
-        public: true
-
-      connectors:
-      - type: microsoft
-        id: microsoft
-        name: microsoft
-        config:
-          clientID: "<<CHANGE_THIS>>"
-          clientSecret: "<<CHANGE_THIS>>"
-          redirectURI: "https://terrakube-api.domain.com/dex/callback" # Change for your real domain
-          tenant: "<<CHANGE_THIS>>"
-
-## API properties
-api:
-  enabled: true
-  version: "2.14.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-  properties:
-    databaseType: "H2"
-
-## Executor properties
-executor:
-  enabled: true
-  version: "2.14.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-  properties:
-    toolsRepository: "https://github.com/AzBuilder/terrakube-extensions"
-    toolsBranch: "main"
-
-## Registry properties
-registry:
-  enabled: true
-  version: "2.14.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-
-## UI Properties
-ui:
-  enabled: true
-  version: "2.14.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
+  config:
+    issuer: https://terrakube-api.sandbox.terrakube.org/dex
+    storage:
+      type: memory
+    oauth2:
+      responseTypes: ["code", "token", "id_token"] 
+      skipApprovalScreen: true
+    web:
+      allowedOrigins: ['*']
+
+    staticClients:
+    - id: microsoft
+      redirectURIs:
+      - 'https://terrakube-api.domain.com'
+      - 'http://localhost:10001/login'
+      - 'http://localhost:10000/login'
+      - '/device/callback'
+      name: 'microsoft'
+      public: true
+
+    connectors:
+    - type: microsoft
+      id: microsoft
+      name: microsoft
+      config:
+        clientID: "<<CHANGE_THIS>>"
+        clientSecret: "<<CHANGE_THIS>>"
+        redirectURI: "https://terrakube-api.domain.com/dex/callback"
+        tenant: "<<CHANGE_THIS>>"
 
 ## Ingress properties
 ingress:

diff --git a/examples/AzureAuthentication-Example2.md b/examples/AzureAuthentication-Example2.md
@@ -28,64 +28,50 @@ security:
   internalSecret: "<<CHANGE_THIS>>" # Sample Key 32 characters Kb^8cMerPNZV6hS!9!kcD*KuUPUBa^B3
   dexClientId: "microsoft"
   dexClientScope: "email openid profile offline_access groups"
-  dexIssuerUri: "https://terrakube-api.domain.com/dex" # Change for your real domain
 
 ## Terraform Storage
 storage:
+  defaultStorage: false
   azure:
     storageAccountName: "<<CHANGE_THIS>>"
     storageAccountResourceGroup: "<<CHANGE_THIS>>"
     storageAccountAccessKey: "<<CHANGE_THIS>>"
 
 ## Dex
 dex:
-  enabled: true
-  version: "v2.32.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-  resources:
-    limits:
-      cpu: 512m
-      memory: 256Mi
-    requests:
-      cpu: 256m
-      memory: 128Mi
-  properties:
-    config:
-      issuer: https://terrakube-api.domain.com/dex
-      storage:
-        type: memory
-      oauth2:
-        responseTypes: ["code", "token", "id_token"]
-        skipApprovalScreen: true
-      web:
-        allowedOrigins: ['*']
-
-      staticClients:
-      - id: microsoft
-        redirectURIs:
-        - 'https://terrakube-ui.domain.com' # Change for your real domain
-        - 'http://localhost:3000'
-        - 'http://localhost:10001/login'
-        - 'http://localhost:10000/login'
-        - '/device/callback'
-        name: 'microsoft'
-        public: true
-
-      connectors:
-      - type: microsoft
-        id: microsoft
-        name: microsoft
-        config:
-          clientID: "<<CHANGE_THIS>>"
-          clientSecret: "<<CHANGE_THIS>>"
-          redirectURI: "https://terrakube-api.domain.com/dex/callback" # Change for your real domain
-          tenant: "<<CHANGE_THIS>>"
+  config:
+    issuer: https://terrakube-api.sandbox.terrakube.org/dex
+    storage:
+      type: memory
+    oauth2:
+      responseTypes: ["code", "token", "id_token"] 
+      skipApprovalScreen: true
+    web:
+      allowedOrigins: ['*']
+
+    staticClients:
+    - id: microsoft
+      redirectURIs:
+      - 'https://terrakube-api.domain.com'
+      - 'http://localhost:10001/login'
+      - 'http://localhost:10000/login'
+      - '/device/callback'
+      name: 'microsoft'
+      public: true
+
+    connectors:
+    - type: microsoft
+      id: microsoft
+      name: microsoft
+      config:
+        clientID: "<<CHANGE_THIS>>"
+        clientSecret: "<<CHANGE_THIS>>"
+        redirectURI: "https://terrakube-api.domain.com/dex/callback"
+        tenant: "<<CHANGE_THIS>>"
 
 ## API properties
 api:
   enabled: true
-  version: "2.14.0"
   replicaCount: "1"
   serviceType: "ClusterIP"
   properties:
@@ -95,30 +81,6 @@ api:
     databaseUser: "<<CHANGE_THIS>>"
     databasePassword: "<<CHANGE_THIS>>"
 
-## Executor properties
-executor:
-  enabled: true
-  version: "2.14.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-  properties:
-    toolsRepository: "https://github.com/AzBuilder/terrakube-extensions"
-    toolsBranch: "main"
-
-## Registry properties
-registry:
-  enabled: true
-  version: "2.14.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-
-## UI Properties
-ui:
-  enabled: true
-  version: "2.14.0"
-  replicaCount: "1"
-  serviceType: "ClusterIP"
-
 ## Ingress properties
 ingress:
   useTls: true