From a365ec5ac7c737a09a192983aa286a31c5de58ef Mon Sep 17 00:00:00 2001 From: Marcello Teodori <151025+mteodori@users.noreply.github.com> Date: Thu, 18 Jun 2020 14:29:11 +0100 Subject: [PATCH] AAE-2769 unify host and fix generated README (#39) --- .../alfresco-process-infrastructure/README.md | 34 ++++++++++--------- .../values.yaml | 32 +++++++++++------ 2 files changed, 39 insertions(+), 27 deletions(-) diff --git a/helm/alfresco-process-infrastructure/README.md b/helm/alfresco-process-infrastructure/README.md index 42117f398..fc1bd9a34 100644 --- a/helm/alfresco-process-infrastructure/README.md +++ b/helm/alfresco-process-infrastructure/README.md @@ -35,10 +35,11 @@ Source code can be found [here](https://github.com/Alfresco/alfresco-process-inf | alfresco-admin-app.ingress.path | string | `"/admin"` | | | alfresco-admin-app.nameOverride | string | `"alfresco-admin-app"` | | | alfresco-deployment-service.alfresco-content-services.enabled | bool | `true` | | -| alfresco-deployment-service.applications.connectors.emailConnector.host | string | `""` |In order to apply default account configuration to the email connector, all the variables need to be set. All email connectors in every applications in the cluster will share the same account.| -| alfresco-deployment-service.applications.connectors.emailConnector.password | string | `""` |In order to apply default account configuration to the email connector, all the variables need to be set. All email connectors in every applications in the cluster will share the same account.| -| alfresco-deployment-service.applications.connectors.emailConnector.port | string | `""` |In order to apply default account configuration to the email connector, all the variables need to be set. All email connectors in every applications in the cluster will share the same account.| -| alfresco-deployment-service.applications.connectors.emailConnector.username | string | `""` |In order to apply default account configuration to the email connector, all the variables need to be set. All email connectors in every applications in the cluster will share the same account.| +| alfresco-deployment-service.applications.connectors.emailConnector | object | `{"host":"","password":"","port":"","username":""}` | In order to apply default account configuration to the email connector, all the variables need to be set. All email connectors in every application in the cluster will share the same account. | +| alfresco-deployment-service.applications.connectors.emailConnector.host | string | `""` | email host | +| alfresco-deployment-service.applications.connectors.emailConnector.password | string | `""` | email password | +| alfresco-deployment-service.applications.connectors.emailConnector.port | string | `""` | email port | +| alfresco-deployment-service.applications.connectors.emailConnector.username | string | `""` | email username | | alfresco-deployment-service.applications.database.external | bool | `false` | | | alfresco-deployment-service.connectorVolume.permission | string | `"ReadWriteMany"` | | | alfresco-deployment-service.connectorVolume.storageClass | string | `"default-sc"` | | @@ -53,7 +54,7 @@ Source code can be found [here](https://github.com/Alfresco/alfresco-process-inf | alfresco-deployment-service.environment.apiUrl | string | `""` | | | alfresco-deployment-service.environment.namespace | string | installation namespace | namespace to copy secrets from to application namespaces | | alfresco-deployment-service.extraContainers | string | `"- name: dind\n image: \"{{ .Values.dind.image.repository }}:{{ .Values.dind.image.tag }}\"\n imagePullPolicy: IfNotPresent\n securityContext:\n privileged: true\n tty: true\n env:\n - name: DOCKER_HOST\n value: tcp://localhost:2375\n resources:\n requests:\n cpu: 1\n memory: 1024Mi\n limits:\n cpu: 2\n memory: 2048Mi\n volumeMounts:\n - mountPath: /var/lib/docker\n name: docker-daemon\n"` | | -| alfresco-deployment-service.extraEnv | string | `"- name: DOCKER_HOST\n value: tcp://localhost:2375\n- name: SERVER_PORT\n value: \"8080\"\n- name: SERVER_SERVLET_CONTEXTPATH\n value: \"{{ .Values.ingress.path }}\"\n- name: SERVER_USEFORWARDHEADERS\n value: \"true\"\n- name: SERVER_TOMCAT_INTERNALPROXIES\n value: \".*\"\n- name: MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE\n value: \"*\"\n- name: KEYCLOAK_AUTH_SERVER_URL\n value: '{{ include \"common.keycloak-url\" . }}'\n- name: DOCKER_REGISTRY_SERVER\n value: \"{{ .Values.dockerRegistry.server }}\"\n- name: DOCKER_REGISTRY_USERNAME\n value: \"{{ .Values.dockerRegistry.userName }}\"\n- name: DOCKER_REGISTRY_PASSWORD\n value: '{{ .Values.dockerRegistry.password }}'\n- name: DOCKER_REGISTRY_SECRET_NAME\n value: \"{{ .Values.dockerRegistry.secretName }}\"\n- name: DOCKER_REGISTRY_IMAGE_TAG\n value: \"develop\"\n- name: CONTENT_SERVICE_BASE_URL\n value: '{{ template \"alfresco-process-infrastructure.acs-url\" . }}'\n- name: CONTENT_SERVICE_ENABLED\n value: '{{ index .Values \"alfresco-content-services\" \"enabled\" }}'\n- name: MODELING_URL\n value: '{{ include \"common.gateway-url\" . }}/modeling-service'\n- name: ENVIRONMENT_HOST_URL\n value: '{{ include \"common.gateway-url\" . }}'\n- name: ENVIRONMENT_API_URL\n value: \"{{ .Values.environment.apiUrl }}\"\n- name: ENVIRONMENT_API_TOKEN\n value: \"{{ .Values.environment.apiToken }}\"\n- name: ENVIRONMENT_NAMESPACE\n value: \"{{ tpl .Values.environment.namespace . }}\"\n- name: PROJECT_RELEASE_VOLUME_STORAGE_CLASS\n value: \"{{ .Values.connectorVolume.storageClass }}\"\n- name: PROJECT_RELEASE_VOLUME_PERMISSION\n value: \"{{ .Values.connectorVolume.permission }}\"\n- name: APPLICATIONS_DATABASE_EXTERNAL\n value: \"{{ .Values.applications.database.external }}\"\n"` | | +| alfresco-deployment-service.extraEnv | string | `"- name: DOCKER_HOST\n value: tcp://localhost:2375\n- name: SERVER_PORT\n value: \"8080\"\n- name: SERVER_SERVLET_CONTEXTPATH\n value: \"{{ .Values.ingress.path }}\"\n- name: SERVER_USEFORWARDHEADERS\n value: \"true\"\n- name: SERVER_TOMCAT_INTERNALPROXIES\n value: \".*\"\n- name: MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE\n value: \"*\"\n- name: KEYCLOAK_AUTH_SERVER_URL\n value: '{{ include \"common.keycloak-url\" . }}'\n- name: DOCKER_REGISTRY_SERVER\n value: \"{{ .Values.dockerRegistry.server }}\"\n- name: DOCKER_REGISTRY_USERNAME\n value: \"{{ .Values.dockerRegistry.userName }}\"\n- name: DOCKER_REGISTRY_PASSWORD\n value: '{{ .Values.dockerRegistry.password }}'\n- name: DOCKER_REGISTRY_SECRET_NAME\n value: \"{{ .Values.dockerRegistry.secretName }}\"\n- name: DOCKER_REGISTRY_IMAGE_TAG\n value: \"develop\"\n- name: CONTENT_SERVICE_BASE_URL\n value: '{{ template \"alfresco-process-infrastructure.acs-url\" . }}'\n- name: CONTENT_SERVICE_ENABLED\n value: '{{ index .Values \"alfresco-content-services\" \"enabled\" }}'\n- name: MODELING_URL\n value: '{{ include \"common.gateway-url\" . }}/modeling-service'\n- name: ENVIRONMENT_HOST_URL\n value: '{{ include \"common.gateway-url\" . }}'\n- name: ENVIRONMENT_API_URL\n value: \"{{ .Values.environment.apiUrl }}\"\n- name: ENVIRONMENT_API_TOKEN\n value: \"{{ .Values.environment.apiToken }}\"\n- name: ENVIRONMENT_NAMESPACE\n value: \"{{ tpl .Values.environment.namespace . }}\"\n- name: PROJECT_RELEASE_VOLUME_STORAGE_CLASS\n value: \"{{ .Values.connectorVolume.storageClass }}\"\n- name: PROJECT_RELEASE_VOLUME_PERMISSION\n value: \"{{ .Values.connectorVolume.permission }}\"\n- name: APPLICATIONS_DATABASE_EXTERNAL\n value: \"{{ .Values.applications.database.external }}\"\n{{- if .Values.applications.connectors.emailConnector.username }}\n- name: CONNECTOR_EMAILCONNECTOR_USERNAME\n value: \"{{ .Values.applications.connectors.emailConnector.username }}\"\n{{- end }}\n{{- if .Values.applications.connectors.emailConnector.password }}\n- name: CONNECTOR_EMAILCONNECTOR_PASSWORD\n value: \"{{ .Values.applications.connectors.emailConnector.password }}\"\n{{- end }}\n{{- if .Values.applications.connectors.emailConnector.host }}\n- name: CONNECTOR_EMAILCONNECTOR_HOST\n value: \"{{ .Values.applications.connectors.emailConnector.host }}\"\n{{- end }}\n{{- if .Values.applications.connectors.emailConnector.port }}\n- name: CONNECTOR_EMAILCONNECTOR_PORT\n value: \"{{ .Values.applications.connectors.emailConnector.port }}\"\n{{- end }}\n"` | | | alfresco-deployment-service.extraInit.image.repository | string | `"bitnami/minideb-extras"` | | | alfresco-deployment-service.extraInit.image.tag | string | `"stretch"` | | | alfresco-deployment-service.extraVolumeMounts | string | `"- name: license\n mountPath: \"/root/.activiti/enterprise-license/\"\n readOnly: true\n"` | | @@ -117,17 +118,18 @@ Source code can be found [here](https://github.com/Alfresco/alfresco-process-inf | alfresco-modeling-service.probePath | string | `"/actuator/health"` | | | alfresco-modeling-service.rbac.create | bool | `false` | | | alfresco-modeling-service.serviceAccount.create | bool | `false` | | -| global.acs.host | string | `"{{ template \"common.gateway-host\" . }}"` | | -| global.gateway.annotations | object | `{}` | | -| global.gateway.domain | string | `"REPLACEME"` | | -| global.gateway.host | string | `"gateway.{{ template \"common.gateway-domain\" . }}"` | | -| global.gateway.http | string | `"false"` | | -| global.gateway.tlsacme | string | `"false"` | | -| global.keycloak.host | string | `"identity.{{ template \"common.gateway-domain\" . }}"` | | -| global.keycloak.realm | string | `"alfresco"` | | -| global.keycloak.resource | string | `"activiti"` | | -| global.keycloak.url | string | `""` | | -| global.registryPullSecrets[0] | string | `"quay-registry-secret"` | | +| global | object | `{"acs":{"host":"{{ template \"common.gateway-host\" . }}"},"gateway":{"annotations":{},"domain":"REPLACEME","host":"{{ template \"common.gateway-domain\" . }}","http":"false","tlsacme":"false"},"keycloak":{"host":"{{ template \"common.gateway-domain\" . }}","realm":"alfresco","resource":"activiti","url":""},"registryPullSecrets":["quay-registry-secret"]}` | for common values see https://github.com/Activiti/activiti-cloud-common-chart/blob/master/charts/common/README.md | +| global.acs.host | string | `"{{ template \"common.gateway-host\" . }}"` | host for content services | +| global.gateway.annotations | object | `{}` | Configure global annotations for all service ingresses | +| global.gateway.domain | string | `"REPLACEME"` | Set to configure gateway domain template, i.e. {{ .Release.Namespace }}.1.3.4.5.nip.io helm upgrade activiti . --install --set global.gateway.domain=1.2.3.4.nip.io | +| global.gateway.host | string | `"{{ template \"common.gateway-domain\" . }}"` | Set to configure single host domain name for all services, i.e. "{{ .Release.Namespace }}.{{ template "common.gateway-domain" . }}" | +| global.gateway.http | string | `"false"` | Set to false enables HTTPS configuration on all urls | +| global.gateway.tlsacme | string | `"false"` | Set to enable automatic TLS for ingress if https is enabled | +| global.keycloak.host | string | `"{{ template \"common.gateway-domain\" . }}"` | Configure Keycloak host template, i.e. "{{ .Release.Namespace }}.{{ .Values.global.gateway.domain }}" | +| global.keycloak.realm | string | `"alfresco"` | Configure Keycloak realm | +| global.keycloak.resource | string | `"activiti"` | Configure Keycloak resource | +| global.keycloak.url | string | `""` | Set full url to configure external Keycloak, https://keycloak.mydomain.com/auth | +| global.registryPullSecrets | list | `["quay-registry-secret"]` | Configure pull secrets for all deployments | | persistence.accessModes[0] | string | `"ReadWriteOnce"` | | | persistence.baseSize | string | `"100Gi"` | | | persistence.enabled | bool | `false` | | diff --git a/helm/alfresco-process-infrastructure/values.yaml b/helm/alfresco-process-infrastructure/values.yaml index 33c87b313..e42b7645b 100644 --- a/helm/alfresco-process-infrastructure/values.yaml +++ b/helm/alfresco-process-infrastructure/values.yaml @@ -1,41 +1,46 @@ # Default values for chart. # This is a YAML-formatted file. # Declare variables to be passed into your templates. +# README documentation generated automatically from this file via https://github.com/norwoodj/helm-docs +# global -- for common values see https://github.com/Activiti/activiti-cloud-common-chart/blob/master/charts/common/README.md global: - ## Configure pull secrets for all deployments + # global.registryPullSecrets -- Configure pull secrets for all deployments registryPullSecrets: - "quay-registry-secret" keycloak: - ## Configure Keycloak host template, i.e. "identity.{{ .Release.Namespace }}.{{ .Values.global.gateway.domain }}" - host: 'identity.{{ template "common.gateway-domain" . }}' + # global.keycloak.host -- Configure Keycloak host template, i.e. "{{ .Release.Namespace }}.{{ .Values.global.gateway.domain }}" + host: '{{ template "common.gateway-domain" . }}' - ## Set full url to configure external Keycloak, https://keycloak.mydomain.com/auth + # global.keycloak.url -- Set full url to configure external Keycloak, https://keycloak.mydomain.com/auth url: "" - ## Configure Keycloak realm + # global.keycloak.realm -- Configure Keycloak realm realm: "alfresco" + + # global.keycloak.resource -- Configure Keycloak resource resource: "activiti" gateway: - ## Set to configure single domain name for all services, i.e. "gateway.{{ .Release.Namespace }}.{{ template "common.gateway-domain" . }}" - host: 'gateway.{{ template "common.gateway-domain" . }}' + # global.gateway.host -- Set to configure single host domain name for all services, i.e. "{{ .Release.Namespace }}.{{ template "common.gateway-domain" . }}" + host: '{{ template "common.gateway-domain" . }}' - ## Set to false enables HTTPS configuration on all urls + # global.gateway.http -- Set to false enables HTTPS configuration on all urls http: "false" - ## Set to enable automatic TLS for ingress if https is enabled + # global.gateway.tlsacme -- Set to enable automatic TLS for ingress if https is enabled tlsacme: "false" - ## Set to configure gateway domain template, i.e. {{ .Release.Namespace }}.1.3.4.5.nip.io + # global.gateway.domain -- Set to configure gateway domain template, i.e. {{ .Release.Namespace }}.1.3.4.5.nip.io # helm upgrade activiti . --install --set global.gateway.domain=1.2.3.4.nip.io domain: "REPLACEME" - ## Configure global annotations for all service ingresses, i.e. + # global.gateway.annotations -- Configure global annotations for all service ingresses annotations: {} acs: + # global.acs.host -- host for content services host: '{{ template "common.gateway-host" . }}' alfresco-infrastructure: @@ -220,10 +225,15 @@ alfresco-deployment-service: database: external: false connectors: + # alfresco-deployment-service.applications.connectors.emailConnector -- In order to apply default account configuration to the email connector, all the variables need to be set. All email connectors in every application in the cluster will share the same account. emailConnector: + # alfresco-deployment-service.applications.connectors.emailConnector.username -- email username username: "" + # alfresco-deployment-service.applications.connectors.emailConnector.password -- email password password: "" + # alfresco-deployment-service.applications.connectors.emailConnector.host -- email host host: "" + # alfresco-deployment-service.applications.connectors.emailConnector.port -- email port port: "" ingress: path: /deployment-service