Remove NodePorts, update README and values.yaml (#14)

* Remove NodePorts to exposed services Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> * Use Ingress instead of NodePorts, update README and values Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> --------- Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com>
galasa-dev · Mar 25, 2024 · 54a1379 · 54a1379
1 parent 0a0dceb
commit 54a1379
Show file tree

Hide file tree

Showing 12 changed files with 21 additions and 165 deletions.
diff --git a/README.md b/README.md
@@ -40,25 +40,17 @@ the latest versions of the packages. You can then run `helm search repo galasa`
 
 Note: The Galasa Ecosystem Helm chart will deploy three persistent volumes. If you need to provide a Kubernetes storage class for these PVs, update the `storageClass` value in your [values.yaml](./charts/ecosystem/values.yaml) file with the name of a valid StorageClass on your cluster.
 
-If you are deploying to minikube, you can use the `standard` storage class created for you by minikube, but this is not required.
-
 Download the [values.yaml](charts/ecosystem/values.yaml) file and within it:
 
   1. Set the `galasaVersion` value to a version of galasa you want to run (see [releases](https://galasa.dev/releases) for released versions). You should not use latest to ensure each pod in the Ecosystem is running at the same level.
-  2. Set the `externalHostname` value to the DNS hostname or IP address of the Kubernetes node that will be used to access the Galasa NodePort services.
+  2. Set the `externalHostname` value to the hostname that will be used to access Galasa services. 
      * If you are deploying to minikube, the cluster's IP address can be retrieved by running `minikube ip`.
 
 Once you have updated the `galasaVersion` and `externalHostname` values, continue following the instructions below to set up Ingress and Dex for your ecosystem.
 
 #### Configuring Ingress
 
-By default, the ecosystem chart enables Ingress to reach services running within a Kubernetes cluster. See the [Kubernetes documentation](https://kubernetes.io/docs/concepts/services-networking/ingress) to learn more about Ingress.
-
-If you are deploying to minikube and are using Ingress to expose services, ensure the NGINX Ingress controller is enabled by running:
-
-```console
-minikube addons enable ingress
-```
+The ecosystem chart uses Ingress to reach services running within a Kubernetes cluster. See the [Kubernetes documentation](https://kubernetes.io/docs/concepts/services-networking/ingress) to learn more about Ingress.
 
 Assuming your Ingress controller has been set up on your Kubernetes cluster, update the values under the `ingress` section within your values.yaml file as follows to configure the use of Ingress in your ecosystem:
 
@@ -212,52 +204,38 @@ Once the `helm test` command ends and displays a success message, the Ecosystem
 
 ### Accessing services
 
-#### Using Ingress
-
-When using Ingress, the URL of the Ecosystem bootstrap will be your external hostname, followed by `/api/bootstrap`.
+Using Ingress, the URL of the Ecosystem bootstrap will be your external hostname followed by `/api/bootstrap`.
 
 For example, if the external hostname you provided was `example.com` and you have provided values for using TLS, the bootstrap URL would be `https://example.com/api/bootstrap`. This is the URL that you would enter into a galasactl command's `--bootstrap` option to interact with your ecosystem.
 
-If you have enabled Ingress and are deploying to minikube, add an entry to your `/etc/hosts` file like the one shown below, ensuring the IP address matches the output of `minikube ip`.
-
-```console
-192.168.49.2 example.com
-```
-
-#### Using NodePorts
-
-To determine the URL of the Ecosystem bootstrap, issue the command:
-
-```console
-kubectl get svc
-```
-
-Look for the `api-external` service and the NodePort associated with the 8080 port. Combine that with the external hostname you provided to form the bootstrap URL. For example, the following snippet shows `30960` to be associated with port 8080:
-
-```console
-test-api-external  NodePort  10.107.160.208  <none>  9010:31359/TCP,9011:31422/TCP,8080:30960/TCP  18s
-```
-
-If the external hostname you provided was `example.com`, the bootstrap URL will be `http://example.com:30960/bootstrap`. You will enter this in a galasactl command's `--bootstrap` option.
-
 ### Upgrading the Galasa Ecosystem
 
-If you want to upgrade the Galasa Ecosystem to use a newer version of Galasa, for example, then you can use the following command:
+If you want to upgrade the Galasa Ecosystem to use a newer version of Galasa, for example, then you can use the following commands:
 
 ```console
-helm upgrade <release-name> galasa/ecosystem --reuse-values --set galasaVersion=0.28.0 --wait
+helm repo update
+helm upgrade <release-name> galasa/ecosystem --reuse-values --set galasaVersion=0.33.0 --wait
 ```
 
 ### Development
 To install the latest development version of the Galasa Ecosystem chart, clone this repository and update the following values in your [values.yaml](charts/ecosystem/values.yaml) file:
 
 1. Set the `galasaVersion` value to `main`
 2. Set the `galasaRegistry` value to `harbor.galasa.dev/galasadev`
-3. Set the `externalHostname` value to the DNS hostname or IP address of the Kubernetes node that will be used to access the Galasa NodePort services.
-   * If you are deploying to minikube, the cluster's IP address can be retrieved by running `minikube ip`.
+3. Set the `externalHostname` value to the hostname that will be used to access Galasa services.
+   * When deploying to minikube on Linux/macOS, add an entry to your `/etc/hosts` file like the one shown below, ensuring the IP address matches the output of `minikube ip`.
+      ```console
+      192.168.49.2 example.com
+      ```
 
 Follow the installation instructions [above](#configuring-ingress) to update the rest of your values.yaml file, including values to configure Ingress and Dex.
 
+If you are deploying to minikube, ensure the NGINX Ingress controller is enabled by running:
+
+```console
+minikube addons enable ingress
+```
+
 Once you have updated your values.yaml file, run the following command, providing the path to the [`ecosystem`](./charts/ecosystem) directory in this repository (e.g. `~/helm/charts/ecosystem`).
 
 ```console

diff --git a/charts/ecosystem/Chart.yaml b/charts/ecosystem/Chart.yaml
@@ -11,4 +11,4 @@ type: application
 #
 home: "galasa.dev"
 #
-version: "0.32.0"
+version: "0.33.0"
diff --git a/charts/ecosystem/templates/api-ingress.yaml b/charts/ecosystem/templates/api-ingress.yaml
@@ -4,7 +4,6 @@
 # SPDX-License-Identifier: EPL-2.0
 #
 
-{{- if .Values.ingress.enabled }}
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
@@ -31,4 +30,3 @@ spec:
             name: {{ .Release.Name }}-api
             port:
               number: 8080
-{{- end }}
diff --git a/charts/ecosystem/templates/api-service-external.yaml b/charts/ecosystem/templates/api-service-external.yaml
diff --git a/charts/ecosystem/templates/api.yaml b/charts/ecosystem/templates/api.yaml
@@ -119,17 +119,6 @@ spec:
           - name: cacert-share
             mountPath: /cacerts
       {{- end }}
-      - name: configure-bootstrap
-        image: {{ .Values.galasaRegistry }}/galasa-boot-embedded-{{ .Values.architecture }}:{{ .Values.galasaVersion }}
-        imagePullPolicy: {{ .Values.pullPolicy }}
-        command:
-          - /bin/bash
-          - -ec
-          - |
-            source /galasa/set-external-env.sh --hostname {{ .Values.externalHostname }} --prefix {{ .Release.Name }}-
-            kubectl get configmap {{ .Release.Name }}-bootstrap-file -o yaml > bootstrap.yaml
-            sed -i "s;etcd:http://etcd:2379;${GALASA_EXTERNAL_ETCD_STORE};g" bootstrap.yaml
-            kubectl replace -f bootstrap.yaml
       containers:
       - name: api
         image: {{ .Values.galasaRegistry }}/galasa-boot-embedded-{{ .Values.architecture }}:{{ .Values.galasaVersion }}

diff --git a/charts/ecosystem/templates/couchdb-service-external.yaml b/charts/ecosystem/templates/couchdb-service-external.yaml
diff --git a/charts/ecosystem/templates/dex-ingress.yaml b/charts/ecosystem/templates/dex-ingress.yaml
@@ -4,7 +4,6 @@
 # SPDX-License-Identifier: EPL-2.0
 #
 
-{{- if .Values.ingress.enabled }}
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
@@ -31,4 +30,3 @@ spec:
             name: {{ .Release.Name }}-dex
             port:
               number: 5556
-{{- end }}
diff --git a/charts/ecosystem/templates/dex-service-external.yaml b/charts/ecosystem/templates/dex-service-external.yaml
diff --git a/charts/ecosystem/templates/engine-controller.yaml b/charts/ecosystem/templates/engine-controller.yaml
@@ -49,7 +49,6 @@ spec:
           - /bin/bash
           - -ec
           - |
-            source /galasa/set-external-env.sh --hostname {{ .Values.externalHostname }} --prefix {{ .Release.Name }}-
             java -jar boot.jar --obr file:galasa.obr --bootstrap http://{{ .Release.Name }}-api:8080/bootstrap --setupeco
             java -jar boot.jar --obr file:galasa.obr --bootstrap http://{{ .Release.Name }}-api:8080/bootstrap --k8scontroller
         env:

diff --git a/charts/ecosystem/templates/etcd-service-external.yaml b/charts/ecosystem/templates/etcd-service-external.yaml
diff --git a/charts/ecosystem/templates/webui-ingress.yaml b/charts/ecosystem/templates/webui-ingress.yaml
@@ -4,7 +4,6 @@
 # SPDX-License-Identifier: EPL-2.0
 #
 
-{{- if .Values.ingress.enabled }}
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
@@ -30,4 +29,3 @@ spec:
             name: {{ .Release.Name }}-webui
             port:
               number: 8080
-{{- end }}
diff --git a/charts/ecosystem/values.yaml b/charts/ecosystem/values.yaml
@@ -15,7 +15,7 @@ externalHostname: "example.com"
 # The version of Galasa you want to run with, it is better that you do not use "latest" to ensure
 # all the components are running the same version and a controlled upgrade can be performed
 #
-galasaVersion: "0.29.0"
+galasaVersion: "0.33.0"
 #
 #
 # The container registry the Galasa images can be found in
@@ -62,9 +62,6 @@ kubectlImage: "bitnami/kubectl:1.28"
 # Note: The externalHostname value must be a valid DNS name for ingress to be used.
 #
 ingress:
-  # Enables/disables the use of ingress
-  enabled: true
-
   # The IngressClass to use for ingresses
   ingressClassName: "nginx"
 
@@ -75,7 +72,7 @@ ingress:
   #     secretName: mysecret
   tls: {}
 
-  # The name of the Secret containing root and intermediate CA certificates in a single .pem file
+  # Optional - The name of the Secret containing root and intermediate CA certificates in a single .pem file.
   caCertSecretName: ""
 
   # Annotations to be added to ingresses. For example:
@@ -111,11 +108,6 @@ dex:
   #       name: my-env-configmap
   envFrom: []
 
-  # NodePorts to access Dex services through (Helm will dynamically assign NodePorts in the
-  # 30000 to 32767 range if they are left blank).
-  nodePorts:
-    http: # blank - dynamically assigned
-
   # The Dex configuration - See the [Dex documentation](https://dexidp.io/docs) for more information.
   # By default, etcd is used as the storage option for the Galasa Ecosystem.
   config:
@@ -138,4 +130,5 @@ dex:
     expiry:
       idTokens: 24h
       refreshTokens:
+        reuseInterval: 8760h # 1 year
         validIfNotUsedFor: 8760h # 1 year