Skip to content

Commit

Permalink
OPSEXP-2291 Bump Search services chart to most recent conventions (#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
gionn authored Jan 12, 2024
1 parent 7d82c7f commit c18bfc3
Show file tree
Hide file tree
Showing 40 changed files with 545 additions and 415 deletions.
8 changes: 4 additions & 4 deletions charts/alfresco-search-service/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
dependencies:
- name: alfresco-insight-zeppelin
repository: ""
version: 2.2.0
version: 3.0.0-alpha.0
- name: alfresco-common
repository: https://alfresco.github.io/alfresco-helm-charts/
version: 2.1.0
digest: sha256:d936b2a9611e46791878d3a7ead2d61fc97e65e343955aeb247b4709f124a725
generated: "2023-09-13T17:05:38.325916+02:00"
version: 3.1.0
digest: sha256:611a989ecff183861c046d6090836371cac0abb9fee3e05278d239769a568cbc
generated: "2024-01-08T17:15:25.064429+01:00"
6 changes: 3 additions & 3 deletions charts/alfresco-search-service/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ keywords:
name: alfresco-search-service
sources:
- https://github.com/Alfresco/alfresco-helm-charts
version: 2.1.0
version: 3.0.0-alpha.0
appVersion: 2.0.8.2
dependencies:
- name: alfresco-insight-zeppelin
version: 2.2.0
version: 3.0.0-alpha.0
condition: alfresco-insight-zeppelin.enabled
- name: alfresco-common
version: 2.1.0
version: 3.1.0
repository: https://alfresco.github.io/alfresco-helm-charts/
37 changes: 24 additions & 13 deletions charts/alfresco-search-service/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# alfresco-search-service

![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![AppVersion: 2.0.8.2](https://img.shields.io/badge/AppVersion-2.0.8.2-informational?style=flat-square)
![Version: 3.0.0-alpha.0](https://img.shields.io/badge/Version-3.0.0--alpha.0-informational?style=flat-square) ![AppVersion: 2.0.8.2](https://img.shields.io/badge/AppVersion-2.0.8.2-informational?style=flat-square)

A Helm chart for deploying Alfresco Search Service

Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for information on the Helm charts and deployment instructions.
Checkout [alfresco-content-services chart's doc](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for an example of how to leverage this chart from an umbrella chart.

**Homepage:** <https://www.alfresco.com>

Expand All @@ -16,13 +16,14 @@ Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/b

| Repository | Name | Version |
|------------|------|---------|
| | alfresco-insight-zeppelin | 2.2.0 |
| https://alfresco.github.io/alfresco-helm-charts/ | alfresco-common | 2.1.0 |
| | alfresco-insight-zeppelin | 3.0.0-alpha.0 |
| https://alfresco.github.io/alfresco-helm-charts/ | alfresco-common | 3.1.0 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | string | `""` | Pod affinity, passed thru tpl function |
| alfresco-insight-zeppelin.enabled | bool | `false` | |
| environment.SOLR_CREATE_ALFRESCO_DEFAULTS | string | `"alfresco,archive"` | |
| global.alfrescoRegistryPullSecrets | string | `"quay-registry-secret"` | |
Expand All @@ -44,10 +45,14 @@ Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/b
| livenessProbe.initialDelaySeconds | int | `130` | |
| livenessProbe.periodSeconds | int | `20` | |
| livenessProbe.timeoutSeconds | int | `10` | |
| nodeSelector | object | `{}` | Define the alfresco-search properties to use in the k8s cluster This is the search provider used by alfresco-content-repository |
| persistence | object | `{"EbsPvConfiguration":{"fsType":"ext4"},"VolumeSizeRequest":"10Gi","enabled":true,"search":{"data":{"mountPath":"/opt/alfresco-search-services/data","subPath":"alfresco-content-services/solr-data"}}}` | Defines the persistence |
| persistence.VolumeSizeRequest | string | `"10Gi"` | Only define if you have a specific claim already created existingClaim: "search-master-claim" |
| persistence.enabled | bool | `true` | If set to false data will be lost with pods |
| nodeSelector | object | `{}` | |
| persistence.accessModes[0] | string | `"ReadWriteOnce"` | |
| persistence.baseSize | string | `"10Gi"` | Capacity of the PVC for persistency |
| persistence.enabled | bool | `true` | When disabled, data is lost when pod is terminated/rescheduled |
| persistence.existingClaim | string | `nil` | Provide a pre-existing PVC for persistency |
| persistence.search.data.mountPath | string | `"/opt/alfresco-search-services/data"` | |
| persistence.search.data.subPath | string | `"alfresco-content-services/solr-data"` | |
| persistence.storageClass | string | `nil` | Bind PVC based on storageClass (e.g. dynamic provisioning) |
| podSecurityContext.fsGroup | int | `33007` | |
| podSecurityContext.runAsGroup | int | `33007` | |
| podSecurityContext.runAsNonRoot | bool | `true` | |
Expand All @@ -58,12 +63,13 @@ Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/b
| repository.existingConfigMap.keys.host | string | `"SOLR_ALFRESCO_HOST"` | Key within the configmap holding the repository hostname |
| repository.existingConfigMap.keys.port | string | `"SOLR_ALFRESCO_PORT"` | Key within the configmap holding the repository port |
| repository.existingConfigMap.keys.securecomms | string | `"SOLR_ALFRESCO_SECURE_COMMS"` | Key within the configmap holding the repository security level |
| repository.existingConfigMap.name | string | `nil` | Name of a pre-existing configmap containing Alfresco repository URL In addition to tjhe keys mentionned bellow the configMap may contain any solr property translated as an env variable (e.g SOLR_ALFRESCO_BASEURL). |
| repository.existingConfigMap.name | string | `nil` | Name of a pre-existing configmap containing Alfresco repository URL |
| repository.existingSecret.keys.sharedSecret | string | `"SOLR_ALFRESCO_SECURECOMMS_SECRET"` | Key within the secret holding the repository shared secret |
| repository.existingSecret.name | string | `nil` | Name of a pre-existing secret containing message broker credentials |
| repository.securecomms | string | `"secret"` | repository security level to use when tracking the repo ('none' or 'secret') |
| repository.sharedSecret | string | `nil` | Secret shared with the repository when securecomms is set to 'secret' |
| repository.url | string | `"http://alfresco-search-service/solr"` | Alfresco repository URL |
| repository.existingSecret.name | string | `nil` | Alternatively, provide a pre-existing secret containing the shared secret used with repository when `securecomms` is `secret` |
| repository.host | string | `nil` | Alfresco repository hostname |
| repository.port | string | `nil` | Alfresco repository port |
| repository.securecomms | string | `"secret"` | Alfresco repository security level to use when tracking the repo ('none' or 'secret') |
| repository.sharedSecret | string | `nil` | Shared secret used with repository when `securecomms` is `secret` |
| resources.limits.cpu | string | `"4"` | |
| resources.limits.memory | string | `"2000Mi"` | |
| resources.requests.cpu | string | `"0.50"` | |
Expand All @@ -74,4 +80,9 @@ Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/b
| searchServicesImage.tag | string | `"2.0.8.2"` | |
| service.name | string | `"solr"` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
| serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? |
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
| tolerations | list | `[]` | |
| type | string | `"search-services"` | set alfresco-insight-zeppelin.enabled=true As the Docker Image for Insight Engine is not publicly available the alfrescoRegistryPullSecrets has to be set More information can be found on https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/registry-authentication.md |
2 changes: 1 addition & 1 deletion charts/alfresco-search-service/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

{{ template "chart.description" . }}

Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for information on the Helm charts and deployment instructions.
Checkout [alfresco-content-services chart's doc](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for an example of how to leverage this chart from an umbrella chart.

{{ template "chart.homepageLine" . }}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dependencies:
- name: alfresco-common
repository: https://alfresco.github.io/alfresco-helm-charts/
version: 2.1.0
digest: sha256:fa11b87976e8340dfe349a0bc7d672c197decf3303de5bbe102c19f6216690fa
generated: "2023-08-18T17:03:16.720641+02:00"
version: 3.1.0
digest: sha256:9c28428c3dce7c46decd859744075a51482adc21b4c21427840695fcaa23039d
generated: "2024-01-05T16:35:03.929458+01:00"
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ keywords:
- alfresco zeppelin
- alfresco insight zeppelin
name: alfresco-insight-zeppelin
version: 2.2.0
version: 3.0.0-alpha.0
sources:
- https://github.com/Alfresco/alfresco-helm-charts
appVersion: 2.0.8
dependencies:
- name: alfresco-common
version: 2.1.0
version: 3.1.0
repository: https://alfresco.github.io/alfresco-helm-charts/
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# alfresco-insight-zeppelin

![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.0-informational?style=flat-square) ![AppVersion: 2.0.8](https://img.shields.io/badge/AppVersion-2.0.8-informational?style=flat-square)
![Version: 3.0.0-alpha.0](https://img.shields.io/badge/Version-3.0.0--alpha.0-informational?style=flat-square) ![AppVersion: 2.0.8](https://img.shields.io/badge/AppVersion-2.0.8-informational?style=flat-square)

A Helm chart for deploying Alfresco Insight Zeppelin

Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for information on the Helm charts and deployment instructions.
Checkout [alfresco-content-services chart's doc](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for an example of how to leverage this chart from an umbrella chart.

**Homepage:** <https://www.alfresco.com>

Expand All @@ -16,12 +16,13 @@ Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/b

| Repository | Name | Version |
|------------|------|---------|
| https://alfresco.github.io/alfresco-helm-charts/ | alfresco-common | 2.1.0 |
| https://alfresco.github.io/alfresco-helm-charts/ | alfresco-common | 3.1.0 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | string | `""` | Pod affinity, passed thru tpl function |
| environment.ZEPPELIN_INTP_MEM | string | `"-Xms512m -Xmx1g"` | |
| environment.ZEPPELIN_MEM | string | `"-Xms512m -Xmx1g"` | |
| global.alfrescoRegistryPullSecrets | string | `"quay-registry-secret"` | Global definition of Docker registry pull secret which can be overridden from parent ACS Helm chart(s) |
Expand All @@ -42,11 +43,19 @@ Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/b
| readinessProbe.periodSeconds | int | `20` | |
| readinessProbe.timeoutSeconds | int | `10` | |
| replicaCount | int | `1` | |
| repository | object | `{}` | The parent chart will set the values for "repository.host" and "repository.port" |
| repository.existingConfigMap.keys.host | string | `"REPO_HOST"` | Key within the configmap holding the repository hostname |
| repository.existingConfigMap.keys.port | string | `"REPO_PORT"` | Key within the configmap holding the repository port |
| repository.existingConfigMap.name | string | `nil` | Name of a pre-existing configmap containing Alfresco repository URL |
| repository.url | string | `"http://alfresco-search-service"` | Alfresco repository URL |
| resources.limits.cpu | string | `"1"` | |
| resources.limits.memory | string | `"1024Mi"` | |
| resources.requests.cpu | string | `"0.5"` | |
| resources.requests.memory | string | `"512Mi"` | |
| service.externalPort | int | `80` | |
| service.name | string | `"zeppelin"` | |
| service.type | string | `"ClusterIP"` | |
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
| serviceAccount.automount | bool | `true` | Automatically mount a ServiceAccount's API credentials? |
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
| tolerations | list | `[]` | |
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

{{ template "chart.description" . }}

Please refer to the [documentation](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for information on the Helm charts and deployment instructions.
Checkout [alfresco-content-services chart's doc](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/README.md) for an example of how to leverage this chart from an umbrella chart.

{{ template "chart.homepageLine" . }}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{{- define "alfresco-insight-zeppelin.deployment.name" -}}
{{- $scope := (dict "Values" (dict "nameOverride" "insight-zeppelin" ) "Chart" .Chart "Release" .Release) }}
{{- include "alfresco-insight-zeppelin.fullname" $scope }}
{{- end }}
Original file line number Diff line number Diff line change
@@ -1,28 +1,62 @@
{{/*
Get Alfresco Insight Zeppelin Full Name
Expand the name of the chart.
*/}}
{{- define "alfresco-insight-zeppelin.fullName" -}}
{{- $name := default .Chart.Name .Values.nameOverride -}}
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
{{- end -}}
{{- define "alfresco-insight-zeppelin.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Get Alfresco Zeppelin Host
Create a default fully qualified app name.
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
If release name contains chart name it will be used as a full name.
*/}}
{{- define "alfresco-insight-zeppelin.host" -}}
{{- printf "%s-%s" .Release.Name "alfresco-insight-zeppelin" -}}
{{- end -}}
{{- define "alfresco-insight-zeppelin.fullname" -}}
{{- if .Values.fullnameOverride }}
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- $name := default .Chart.Name .Values.nameOverride }}
{{- if contains $name .Release.Name }}
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
{{- end }}
{{- end }}
{{- end }}

{{/*
Get Alfresco Repo Host
Create chart name and version as used by the chart label.
*/}}
{{- define "alfresco-repo-host" -}}
{{- .Values.repository.host | default (printf "%s-repository" (include "content-services.shortname" $)) }}
{{- end -}}
{{- define "alfresco-insight-zeppelin.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Get Alfresco Repo Port
Common labels
*/}}
{{- define "alfresco-repo-port" -}}
{{- .Values.repository.port | default 80 }}
{{- end -}}
{{- define "alfresco-insight-zeppelin.labels" -}}
helm.sh/chart: {{ include "alfresco-insight-zeppelin.chart" . }}
{{ include "alfresco-insight-zeppelin.selectorLabels" . }}
{{- if .Chart.AppVersion }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}

{{/*
Selector labels
*/}}
{{- define "alfresco-insight-zeppelin.selectorLabels" -}}
app.kubernetes.io/name: {{ include "alfresco-insight-zeppelin.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

{{/*
Create the name of the service account to use
*/}}
{{- define "alfresco-insight-zeppelin.serviceAccountName" -}}
{{- if .Values.serviceAccount.create }}
{{- default (include "alfresco-insight-zeppelin.fullname" .) .Values.serviceAccount.name }}
{{- else }}
{{- default "default" .Values.serviceAccount.name }}
{{- end }}
{{- end }}
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
# Defines the config for the Alfresco Insight Zeppelin App
{{- if not .Values.repository.existingConfigMap.name }}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ template "alfresco-insight-zeppelin.fullName" . }}-configmap
name: {{ template "alfresco-insight-zeppelin.deployment.name" . }}
labels:
heritage: {{ .Release.Service }}
release: {{ .Release.Name }}
chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}
component: zeppelin
{{- include "alfresco-insight-zeppelin.labels" . | nindent 4 }}
data:
REPO_HOST: "{{ template "alfresco-repo-host" . }}"
REPO_PORT: "{{ template "alfresco-repo-port" . }}"
{{- range $key, $value := .Values.environment }}
{{ $key }}: {{ $value }}
{{- with .Values.repository }}
REPO_HOST: >-
{{ template "alfresco-common.url.host" .url }}
REPO_PORT: >-
{{ template "alfresco-common.url.port" .url }}
{{- end }}
{{- end }}
Loading

0 comments on commit c18bfc3

Please sign in to comment.