From 34986c2967ec2d81d38ff97ddd88a56005988eab Mon Sep 17 00:00:00 2001 From: Pim van Nierop Date: Fri, 19 Jul 2024 13:52:52 +0200 Subject: [PATCH] Allow config of http URLs in upload-connect-frontend --- .../radar-upload-connect-frontend/Chart.yaml | 2 +- .../radar-upload-connect-frontend/README.md | 86 ++++++++++--------- .../templates/deployment.yaml | 4 +- .../radar-upload-connect-frontend/values.yaml | 4 + 4 files changed, 51 insertions(+), 45 deletions(-) diff --git a/charts/radar-upload-connect-frontend/Chart.yaml b/charts/radar-upload-connect-frontend/Chart.yaml index 8e832a5a..15772ef7 100644 --- a/charts/radar-upload-connect-frontend/Chart.yaml +++ b/charts/radar-upload-connect-frontend/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: "0.5.10" description: A Helm chart for RADAR-base upload connector frontend application that provides a UI for uploading files and sending them to the upload-backend. name: radar-upload-connect-frontend -version: 0.3.1 +version: 0.3.2 icon: "http://radar-base.org/wp-content/uploads/2022/09/Logo_RADAR-Base-RGB.png" sources: - https://github.com/RADAR-base/radar-helm-charts/tree/main/charts/radar-upload-connect-frontend diff --git a/charts/radar-upload-connect-frontend/README.md b/charts/radar-upload-connect-frontend/README.md index ecffca8e..c2bbedbf 100644 --- a/charts/radar-upload-connect-frontend/README.md +++ b/charts/radar-upload-connect-frontend/README.md @@ -3,7 +3,7 @@ # radar-upload-connect-frontend [![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/radar-upload-connect-frontend)](https://artifacthub.io/packages/helm/radar-base/radar-upload-connect-frontend) -![Version: 0.3.1](https://img.shields.io/badge/Version-0.3.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.10](https://img.shields.io/badge/AppVersion-0.5.10-informational?style=flat-square) +![Version: 0.3.2](https://img.shields.io/badge/Version-0.3.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.5.10](https://img.shields.io/badge/AppVersion-0.5.10-informational?style=flat-square) A Helm chart for RADAR-base upload connector frontend application that provides a UI for uploading files and sending them to the upload-backend. @@ -29,45 +29,47 @@ A Helm chart for RADAR-base upload connector frontend application that provides ## Values -| Key | Type | Default | Description | -|-----|------|---------|-------------| -| replicaCount | int | `2` | Number of radar-upload-connect-frontend replicas to deploy | -| image.repository | string | `"radarbase/radar-upload-connect-frontend"` | radar-upload-connect-frontend image repository | +| Key | Type | Default | Description | +|-----|------|---------|----------------------------------------------------------------------------------------------------------------------------------------| +| replicaCount | int | `2` | Number of radar-upload-connect-frontend replicas to deploy | +| image.repository | string | `"radarbase/radar-upload-connect-frontend"` | radar-upload-connect-frontend image repository | | image.tag | string | `"0.5.10"` | radar-upload-connect-frontend image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. | -| image.pullPolicy | string | `"IfNotPresent"` | radar-upload-connect-frontend image pull policy | -| imagePullSecrets | list | `[]` | Docker registry secret names as an array | -| nameOverride | string | `""` | String to partially override radar-upload-connect-frontend.fullname template with a string (will prepend the release name) | -| fullnameOverride | string | `""` | String to fully override radar-upload-connect-frontend.fullname template with a string | -| podSecurityContext | object | `{}` | Configure radar-upload-connect-frontend pods' Security Context | -| securityContext | object | `{}` | Configure radar-upload-connect-frontend containers' Security Context | -| service.type | string | `"ClusterIP"` | Kubernetes Service type | -| service.port | int | `80` | radar-upload-connect-frontend port | -| ingress.enabled | bool | `true` | Enable ingress controller resource | -| ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer | -| ingress.path | string | `"/upload/?(.*)"` | Path within the url structure | -| ingress.pathType | string | `"ImplementationSpecific"` | Ingress Path type | -| ingress.ingressClassName | string | `"nginx"` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | -| ingress.hosts | list | `["localhost"]` | Host to listen to requests to | -| ingress.tls.secretName | string | `"radar-base-tls-radar-upload-connect-frontend"` | Name of the secret containing TLS certificates | -| resources.requests | object | `{"cpu":"100m","memory":"128Mi"}` | CPU/Memory resource requests | -| nodeSelector | object | `{}` | Node labels for pod assignment | -| tolerations | list | `[]` | Toleration labels for pod assignment | -| affinity | object | `{}` | Affinity labels for pod assignment | -| extraEnvVars | list | `[]` | Extra environment variables | -| customLivenessProbe | object | `{}` | Custom livenessProbe that overrides the default one | -| livenessProbe.enabled | bool | `true` | Enable livenessProbe | -| livenessProbe.initialDelaySeconds | int | `3` | Initial delay seconds for livenessProbe | -| livenessProbe.periodSeconds | int | `300` | Period seconds for livenessProbe | -| livenessProbe.timeoutSeconds | int | `10` | Timeout seconds for livenessProbe | -| livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | -| livenessProbe.failureThreshold | int | `3` | Failure threshold for livenessProbe | -| customReadinessProbe | object | `{}` | Custom readinessProbe that overrides the default one | -| readinessProbe.enabled | bool | `true` | Enable readinessProbe | -| readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | -| readinessProbe.periodSeconds | int | `10` | Period seconds for readinessProbe | -| readinessProbe.timeoutSeconds | int | `10` | Timeout seconds for readinessProbe | -| readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | -| readinessProbe.failureThreshold | int | `3` | Failure threshold for readinessProbe | -| networkpolicy | object | check `values.yaml` | Network policy defines who can access this application and who this applications has access to | -| server_name | string | `"localhost"` | Server name or domain name | -| vue_app_client_id | string | `"radar_upload_frontend"` | OAuth2 client id of the upload connect frontend application | +| image.pullPolicy | string | `"IfNotPresent"` | radar-upload-connect-frontend image pull policy | +| imagePullSecrets | list | `[]` | Docker registry secret names as an array | +| nameOverride | string | `""` | String to partially override radar-upload-connect-frontend.fullname template with a string (will prepend the release name) | +| fullnameOverride | string | `""` | String to fully override radar-upload-connect-frontend.fullname template with a string | +| podSecurityContext | object | `{}` | Configure radar-upload-connect-frontend pods' Security Context | +| securityContext | object | `{}` | Configure radar-upload-connect-frontend containers' Security Context | +| service.type | string | `"ClusterIP"` | Kubernetes Service type | +| service.port | int | `80` | radar-upload-connect-frontend port | +| ingress.enabled | bool | `true` | Enable ingress controller resource | +| ingress.annotations | object | check values.yaml | Annotations that define default ingress class, certificate issuer | +| ingress.path | string | `"/upload/?(.*)"` | Path within the url structure | +| ingress.pathType | string | `"ImplementationSpecific"` | Ingress Path type | +| ingress.ingressClassName | string | `"nginx"` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | +| ingress.hosts | list | `["localhost"]` | Host to listen to requests to | +| ingress.tls.secretName | string | `"radar-base-tls-radar-upload-connect-frontend"` | Name of the secret containing TLS certificates | +| resources.requests | object | `{"cpu":"100m","memory":"128Mi"}` | CPU/Memory resource requests | +| nodeSelector | object | `{}` | Node labels for pod assignment | +| tolerations | list | `[]` | Toleration labels for pod assignment | +| affinity | object | `{}` | Affinity labels for pod assignment | +| extraEnvVars | list | `[]` | Extra environment variables | +| customLivenessProbe | object | `{}` | Custom livenessProbe that overrides the default one | +| livenessProbe.enabled | bool | `true` | Enable livenessProbe | +| livenessProbe.initialDelaySeconds | int | `3` | Initial delay seconds for livenessProbe | +| livenessProbe.periodSeconds | int | `300` | Period seconds for livenessProbe | +| livenessProbe.timeoutSeconds | int | `10` | Timeout seconds for livenessProbe | +| livenessProbe.successThreshold | int | `1` | Success threshold for livenessProbe | +| livenessProbe.failureThreshold | int | `3` | Failure threshold for livenessProbe | +| customReadinessProbe | object | `{}` | Custom readinessProbe that overrides the default one | +| readinessProbe.enabled | bool | `true` | Enable readinessProbe | +| readinessProbe.initialDelaySeconds | int | `5` | Initial delay seconds for readinessProbe | +| readinessProbe.periodSeconds | int | `10` | Period seconds for readinessProbe | +| readinessProbe.timeoutSeconds | int | `10` | Timeout seconds for readinessProbe | +| readinessProbe.successThreshold | int | `1` | Success threshold for readinessProbe | +| readinessProbe.failureThreshold | int | `3` | Failure threshold for readinessProbe | +| networkpolicy | object | check `values.yaml` | Network policy defines who can access this application and who this applications has access to | +| server_name | string | `"localhost"` | Server name or domain name | +| vue_app_api_base_url | string | `nil` | Vue app base URL; needed when deviating from https://server_name/upload/api/ | +| vue_app_auth_api | string | `nil` | Vue IDP URL; needed when deviating from https://server_name/managementportal/oauth | +| vue_app_client_id | string | `"radar_upload_frontend"` | OAuth2 client id of the upload connect frontend application | diff --git a/charts/radar-upload-connect-frontend/templates/deployment.yaml b/charts/radar-upload-connect-frontend/templates/deployment.yaml index f936b091..0536d3da 100644 --- a/charts/radar-upload-connect-frontend/templates/deployment.yaml +++ b/charts/radar-upload-connect-frontend/templates/deployment.yaml @@ -48,9 +48,9 @@ spec: - name: VUE_APP_BASE_URL value: "/upload" - name: VUE_APP_API_BASE_URL - value: "https://{{ .Values.server_name }}/upload/api/" + value: {{ .Values.vue_app_api_base_url | default "https://{{ .Values.server_name }}/upload/api/" }} - name: VUE_APP_AUTH_API - value: "https://{{ .Values.server_name }}/managementportal/oauth" + value: {{ .Values.vue_app_auth_api | default "https://{{ .Values.server_name }}/managementportal/oauth" }} - name: VUE_APP_AUTH_CALLBACK value: "{{ .Values.server_name }}/upload/login" - name: VUE_APP_CLIENT_ID diff --git a/charts/radar-upload-connect-frontend/values.yaml b/charts/radar-upload-connect-frontend/values.yaml index 8e24bc91..e159acb7 100644 --- a/charts/radar-upload-connect-frontend/values.yaml +++ b/charts/radar-upload-connect-frontend/values.yaml @@ -154,5 +154,9 @@ networkpolicy: # -- Server name or domain name server_name: localhost +# -- Vue app base URL; needed when deviating from https://server_name/upload/api/ +vue_app_api_base_url: +# -- Vue IDP URL; needed when deviating from https://server_name/managementportal/oauth +vue_app_auth_api: # -- OAuth2 client id of the upload connect frontend application vue_app_client_id: radar_upload_frontend