From 0fbf063d8e9f820dafa29383a8a772b7bf5d9ebb Mon Sep 17 00:00:00 2001 From: Tomas Pizarro Date: Fri, 16 Mar 2018 19:09:24 +0100 Subject: [PATCH] [stable/osclass] Allow use of external database (#4189) * [stable/osclass] Allow use of external database * Fix typo * Fix typo * Update image tag * Delete trailing space --- stable/osclass/Chart.yaml | 2 +- stable/osclass/README.md | 10 ++++ stable/osclass/requirements.lock | 4 +- stable/osclass/requirements.yaml | 1 + stable/osclass/templates/NOTES.txt | 47 ++++++++++++++++++- stable/osclass/templates/deployment.yaml | 26 +++++++++- .../osclass/templates/externaldb-secrets.yaml | 14 ++++++ stable/osclass/values.yaml | 44 ++++++++++++++++- 8 files changed, 140 insertions(+), 8 deletions(-) create mode 100644 stable/osclass/templates/externaldb-secrets.yaml diff --git a/stable/osclass/Chart.yaml b/stable/osclass/Chart.yaml index 6b56364d0f..fef4dfaddc 100644 --- a/stable/osclass/Chart.yaml +++ b/stable/osclass/Chart.yaml @@ -1,5 +1,5 @@ name: osclass -version: 0.5.3 +version: 0.6.0 appVersion: 3.7.4 description: Osclass is a php script that allows you to quickly create and manage your own free classifieds site. diff --git a/stable/osclass/README.md b/stable/osclass/README.md index bc9c74a8fb..7475ea3578 100644 --- a/stable/osclass/README.md +++ b/stable/osclass/README.md @@ -71,6 +71,16 @@ The following tables lists the configurable parameters of the Osclass chart and | `persistence.moodle.storageClass` | PVC Storage Class for OSClass volume | `nil` (uses alpha storage class annotation) | | `persistence.moodle.accessMode` | PVC Access Mode for OSClass volume | `ReadWriteOnce` | | `persistence.moodle.size` | PVC Storage Request for OSClass volume | `8Gi` | +| `allowEmptyPassword` | Allow DB blank passwords | `yes` | +| `externalDatabase.host` | Host of the external database | `nil` | +| `externalDatabase.port` | Port of the external database | `3306` | +| `externalDatabase.user` | Existing username in the external db | `bn_osclass` | +| `externalDatabase.password` | Password for the above username | `nil` | +| `externalDatabase.database` | Name of the existing databse | `bitnami_osclass` | +| `mariadb.enabled` | Wheter to use or not the mariadb chart | `true` | +| `mariadb.mariadbDatabase` | Database name to create | `bitnami_osclass` | +| `mariadb.mariadbUser` | Database user to create | `bn_osclass` | +| `mariadb.mariadbPassword` | Password for the database | `nil` | | `mariadb.mariadbRootPassword` | MariaDB admin password | `nil` | | `mariadb.persistence.enabled` | Enable MariaDB persistence using PVC | `true` | | `mariadb.persistence.storageClass` | PVC Storage Class for MariaDB volume | `generic` | diff --git a/stable/osclass/requirements.lock b/stable/osclass/requirements.lock index 51c509f32a..88c072b75b 100644 --- a/stable/osclass/requirements.lock +++ b/stable/osclass/requirements.lock @@ -2,5 +2,5 @@ dependencies: - name: mariadb repository: https://kubernetes-charts.storage.googleapis.com/ version: 0.7.0 -digest: sha256:e1af13ac4ac21f67582006f12d2b4eb78a1a2a59b34338fac850f2bec0b08b41 -generated: 2017-08-09T22:52:55.248933663-04:00 +digest: sha256:f59f68030aa5c50b9e776b813804875fac911f91c2aa384e991f37a795c5ae34 +generated: 2018-03-15T16:14:55.447738+01:00 diff --git a/stable/osclass/requirements.yaml b/stable/osclass/requirements.yaml index 4896aa89de..7c0c6a88a9 100644 --- a/stable/osclass/requirements.yaml +++ b/stable/osclass/requirements.yaml @@ -2,3 +2,4 @@ dependencies: - name: mariadb version: 0.7.0 repository: https://kubernetes-charts.storage.googleapis.com/ + condition: mariadb.enabled diff --git a/stable/osclass/templates/NOTES.txt b/stable/osclass/templates/NOTES.txt index 4f05e88261..303d3602d6 100644 --- a/stable/osclass/templates/NOTES.txt +++ b/stable/osclass/templates/NOTES.txt @@ -1,3 +1,5 @@ +{{- if or .Values.mariadb.enabled .Values.externalDatabase.host -}} + {{- if empty (include "osclass.host" .) -}} ############################################################################### ### ERROR: You did not provide an external host in your 'helm install' call ### @@ -27,8 +29,17 @@ host. To configure Osclass with the URL of your service: 2. Complete your Osclass deployment by running: - helm upgrade {{ .Release.Name }} \ - --set osclassHost=$APP_HOST,osclassPassword=$APP_PASSWORD{{ if .Values.mariadb.mariadbRootPassword }},mariadb.mariadbRootPassword=$APP_DATABASE_PASSWORD{{ end }} stable/osclass +{{- if .Values.mariadb.enabled }} + + helm upgrade {{ .Release.Name }} stable/osclass \ + --set osclassHost=$APP_HOST,osclassPassword=$APP_PASSWORD{{ if .Values.mariadb.mariadbRootPassword }},mariadb.mariadbRootPassword=$APP_DATABASE_PASSWORD{{ end }} +{{- else }} + + ## PLEASE UPDATE THE EXTERNAL DATABASE CONNECTION PARAMETERS IN THE FOLLOWING COMMAND AS NEEDED ## + + helm upgrade {{ .Release.Name }} stable/osclass \ + --set osclassPassword=$APP_PASSWORD,osclassHost=$APP_HOST,serviceType={{ .Values.serviceType }},mariadb.enabled=false{{- if not (empty .Values.externalDatabase.host) }},externalDatabase.host={{ .Values.externalDatabase.host }}{{- end }}{{- if not (empty .Values.externalDatabase.user) }},externalDatabase.user={{ .Values.externalDatabase.user }}{{- end }}{{- if not (empty .Values.externalDatabase.password) }},externalDatabase.password={{ .Values.externalDatabase.password }}{{- end }}{{- if not (empty .Values.externalDatabase.database) }},externalDatabase.database={{ .Values.externalDatabase.database }}{{- end }} +{{- end }} {{- else -}} 1. Get the Osclass URL by running: @@ -50,3 +61,35 @@ host. To configure Osclass with the URL of your service: echo Username : {{ .Values.osclassUsername }} echo Password : $(kubectl get secret --namespace {{ .Release.Namespace }} {{ template "osclass.fullname" . }} -o jsonpath="{.data.osclass-password}" | base64 --decode) {{- end }} + +{{- else -}} + +######################################################################################## +### ERROR: You did not provide an external database host in your 'helm install' call ### +######################################################################################## + +This deployment will be incomplete until you configure Osclass with a resolvable database +host. To configure Osclass to use and external database host: + + +1. Complete your Osclass deployment by running: + +{{- if contains "NodePort" .Values.serviceType }} + export APP_HOST=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") +{{- else if contains "LoadBalancer" .Values.serviceType }} + + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + Watch the status with: 'kubectl get svc --namespace {{ .Release.Namespace }} -w {{ template "osclass.fullname" . }}' + + export APP_HOST=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "osclass.fullname" . }} --template "{{ "{{ range (index .status.loadBalancer.ingress 0) }}{{ . }}{{ end }}" }}") +{{- else }} + + export APP_HOST=127.0.0.1 +{{- end }} + export APP_PASSWORD=$(kubectl get secret --namespace {{ .Release.Namespace }} {{ template "osclass.fullname" . }} -o jsonpath="{.data.osclass-password}" | base64 --decode) + + ## PLEASE UPDATE THE EXTERNAL DATABASE CONNECTION PARAMETERS IN THE FOLLOWING COMMAND AS NEEDED ## + + helm upgrade {{ .Release.Name }} stable/osclass \ + --set osclassPassword=$APP_PASSWORD,osclassHost=$APP_HOST,serviceType={{ .Values.serviceType }},mariadb.enabled=false{{- if not (empty .Values.externalDatabase.user) }},externalDatabase.user={{ .Values.externalDatabase.user }}{{- end }}{{- if not (empty .Values.externalDatabase.password) }},externalDatabase.password={{ .Values.externalDatabase.password }}{{- end }}{{- if not (empty .Values.externalDatabase.database) }},externalDatabase.database={{ .Values.externalDatabase.database }}{{- end }},externalDatabase.host=YOUR_EXTERNAL_DATABASE_HOST +{{- end }} diff --git a/stable/osclass/templates/deployment.yaml b/stable/osclass/templates/deployment.yaml index 3f349af219..03bf8224c3 100644 --- a/stable/osclass/templates/deployment.yaml +++ b/stable/osclass/templates/deployment.yaml @@ -19,15 +19,37 @@ spec: image: "{{ .Values.image }}" imagePullPolicy: {{ default "" .Values.imagePullPolicy | quote }} env: + - name: ALLOW_EMPTY_PASSWORD + value: {{ .Values.allowEmptyPassword | quote }} + {{- if .Values.mariadb.enabled }} - name: MARIADB_HOST value: {{ template "osclass.mariadb.fullname" . }} - name: MARIADB_PORT_NUMBER value: "3306" - - name: MARIADB_PASSWORD + - name: OSCLASS_DATABASE_NAME + value: {{ .Values.mariadb.mariadbDatabase | quote }} + - name: OSCLASS_DATABASE_USER + value: {{ .Values.mariadb.mariadbUser | quote }} + - name: OSCLASS_DATABASE_PASSWORD valueFrom: secretKeyRef: name: {{ template "osclass.mariadb.fullname" . }} - key: mariadb-root-password + key: mariadb-password + {{- else }} + - name: MARIADB_HOST + value: {{ .Values.externalDatabase.host | quote }} + - name: MARIADB_PORT_NUMBER + value: {{ .Values.externalDatabase.port | quote }} + - name: OSCLASS_DATABASE_NAME + value: {{ .Values.externalDatabase.database | quote }} + - name: OSCLASS_DATABASE_USER + value: {{ .Values.externalDatabase.user | quote }} + - name: OSCLASS_DATABASE_PASSWORD + valueFrom: + secretKeyRef: + name: {{ printf "%s-%s" .Release.Name "externaldb" }} + key: db-password + {{- end }} - name: OSCLASS_HOST value: {{ include "osclass.host" . | quote }} - name: OSCLASS_USERNAME diff --git a/stable/osclass/templates/externaldb-secrets.yaml b/stable/osclass/templates/externaldb-secrets.yaml new file mode 100644 index 0000000000..4ceb148898 --- /dev/null +++ b/stable/osclass/templates/externaldb-secrets.yaml @@ -0,0 +1,14 @@ +{{- if not .Values.mariadb.enabled }} +apiVersion: v1 +kind: Secret +metadata: + name: {{ printf "%s-%s" .Release.Name "externaldb" }} + labels: + app: {{ printf "%s-%s" .Release.Name "externaldb" }} + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +type: Opaque +data: + db-password: {{ default "" .Values.externalDatabase.password | b64enc | quote }} +{{- end }} \ No newline at end of file diff --git a/stable/osclass/values.yaml b/stable/osclass/values.yaml index 2481ec45cf..26fc9c994d 100644 --- a/stable/osclass/values.yaml +++ b/stable/osclass/values.yaml @@ -1,7 +1,7 @@ ## Bitnami Osclass image version ## ref: https://hub.docker.com/r/bitnami/osclass/tags/ ## -image: bitnami/osclass:3.7.4-r3 +image: bitnami/osclass:3.7.4-r4 ## Specify a imagePullPolicy ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images @@ -47,6 +47,30 @@ osclassPingEngines: 1 ## osclassSaveStats: 1 +## Set to `yes` to allow the container to be started with blank passwords +## ref: https://github.com/bitnami/bitnami-docker-osclass#environment-variables +allowEmptyPassword: "yes" + +## +## External database configuration +## +externalDatabase: + ## Database host + host: + + ## Database host + port: 3306 + + ## Database user + user: bn_osclass + + ## Database password + password: + + ## Database name + database: bitnami_osclass + + ## SMTP mail delivery configuration ## ref: https://github.com/bitnami/bitnami-docker-osclass/#smtp-configuration ## @@ -60,6 +84,24 @@ osclassSaveStats: 1 ## MariaDB chart configuration ## mariadb: + ## Whether to deploy a mariadb server to satisfy the applications database requirements. To use an external database set this to false and configure the externalDatabase parameters + enabled: true + + ## Create a database + ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-on-first-run + ## + mariadbDatabase: bitnami_osclass + + ## Create a database user + ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-user-on-first-run + ## + mariadbUser: bn_osclass + + ## Password for mariadbUser + ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#creating-a-database-user-on-first-run + ## + # mariadbPassword: + ## MariaDB admin password ## ref: https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#setting-the-root-password-on-first-run ##