From e2aa4006706aa46e088ca94c8f54600a3efb676b Mon Sep 17 00:00:00 2001 From: Tomas Pizarro Date: Fri, 16 Mar 2018 18:15:24 +0100 Subject: [PATCH] [stable/jasperreports] Allow use of external database (#4181) * [stable/jasperreports] Allow use of external database * Fix typo * Add mariabdRootPassword property * Fix image tag * Fix typo * Update image tag * Update requirements.lock --- stable/jasperreports/Chart.yaml | 2 +- stable/jasperreports/README.md | 12 ++++- stable/jasperreports/requirements.lock | 4 +- stable/jasperreports/requirements.yaml | 1 + stable/jasperreports/templates/NOTES.txt | 18 +++++++- .../jasperreports/templates/deployment.yaml | 42 +++++++++++++----- .../templates/externaldb-secrets.yaml | 14 ++++++ stable/jasperreports/values.yaml | 44 ++++++++++++++++++- 8 files changed, 121 insertions(+), 16 deletions(-) create mode 100644 stable/jasperreports/templates/externaldb-secrets.yaml diff --git a/stable/jasperreports/Chart.yaml b/stable/jasperreports/Chart.yaml index d2c111668e..a772225bc1 100644 --- a/stable/jasperreports/Chart.yaml +++ b/stable/jasperreports/Chart.yaml @@ -1,5 +1,5 @@ name: jasperreports -version: 0.2.6 +version: 0.3.0 appVersion: 6.4.2 description: The JasperReports server can be used as a stand-alone or embedded reporting and BI server that offers web-based reporting, analytic tools and visualization, diff --git a/stable/jasperreports/README.md b/stable/jasperreports/README.md index af8a4255c6..6b2b2e92be 100644 --- a/stable/jasperreports/README.md +++ b/stable/jasperreports/README.md @@ -59,10 +59,20 @@ The following tables lists the configurable parameters of the JasperReports char | `smtpUser` | SMTP user | `nil` | | `smtpPassword` | SMTP password | `nil` | | `smtpProtocol` | SMTP protocol [`ssl`, `none`] | `nil` | +| `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_jasperreports` | +| `externalDatabase.password` | Password for the above username | `nil` | +| `externalDatabase.database` | Name of the existing databse | `bitnami_jasperreports` | +| `mariadb.enabled` | Wheter to use or not the mariadb chart | `true` | +| `mariadb.mariadbDatabase` | Database name to create | `bitnami_jasperreports` | +| `mariadb.mariadbUser` | Database user to create | `bn_jasperreports` | +| `mariadb.mariadbPassword` | Password for the database | `nil` | | `mariadb.mariadbRootPassword` | MariaDB admin password | `nil` | | `serviceType` | Kubernetes Service type | `LoadBalancer` | | `persistence.enabled` | Enable persistence using PVC | `true` | -| `persistence.storageClass` | PVC Storage Class for JasperReports volume | `nil` (uses alpha storage annotation) | +| `persistence.storageClass` | PVC Storage Class for JasperReports volume | `nil` (uses alpha storage annotation) | | `persistence.accessMode` | PVC Access Mode for JasperReports volume | `ReadWriteOnce` | | `persistence.size` | PVC Storage Request for JasperReports volume | `8Gi` | | `resources` | CPU/Memory resource requests/limits | Memory: `512Mi`, CPU: `300m` | diff --git a/stable/jasperreports/requirements.lock b/stable/jasperreports/requirements.lock index 84486b1355..491ddb05a4 100644 --- a/stable/jasperreports/requirements.lock +++ b/stable/jasperreports/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:49.897385868-04:00 +digest: sha256:f59f68030aa5c50b9e776b813804875fac911f91c2aa384e991f37a795c5ae34 +generated: 2018-03-16T15:44:56.555248+01:00 diff --git a/stable/jasperreports/requirements.yaml b/stable/jasperreports/requirements.yaml index 4896aa89de..f726174b20 100644 --- a/stable/jasperreports/requirements.yaml +++ b/stable/jasperreports/requirements.yaml @@ -2,3 +2,4 @@ dependencies: - name: mariadb version: 0.7.0 repository: https://kubernetes-charts.storage.googleapis.com/ + condition: mariadb.enabled \ No newline at end of file diff --git a/stable/jasperreports/templates/NOTES.txt b/stable/jasperreports/templates/NOTES.txt index 28e8edbacd..f132a9ff94 100644 --- a/stable/jasperreports/templates/NOTES.txt +++ b/stable/jasperreports/templates/NOTES.txt @@ -1,4 +1,4 @@ - +{{- if or .Values.mariadb.enabled .Values.externalDatabase.host -}} ** Please be patient while the chart is being deployed ** 1. Get the JasperReports URL by running: @@ -27,3 +27,19 @@ echo Username: {{ .Values.jasperreportsUsername }} echo Password: $(kubectl get secret --namespace {{ .Release.Namespace }} {{ template "jasperreports.fullname" . }} -o jsonpath="{.data.jasperreports-password}" | base64 --decode) + +{{- else -}} + +######################################################################################## +### ERROR: You did not provide an external database host in your 'helm install' call ### +######################################################################################## + +This deployment will be incomplete until you configure JasperReports with a resolvable database +host. To configure JasperReports to use and external database host: + + +1. Complete your JasperReports deployment by running: + + helm upgrade {{ .Release.Name }} --set serviceType={{ .Values.serviceType }},mariadb.enabled=false,externalDatabase.host=YOUR_EXTERNAL_DATABASE_HOST stable/jasperreports + +{{- end }} \ No newline at end of file diff --git a/stable/jasperreports/templates/deployment.yaml b/stable/jasperreports/templates/deployment.yaml index c5b3232433..d89e1a230c 100644 --- a/stable/jasperreports/templates/deployment.yaml +++ b/stable/jasperreports/templates/deployment.yaml @@ -16,41 +16,63 @@ spec: containers: - name: {{ template "jasperreports.fullname" . }} image: "{{ .Values.image }}" - imagePullPolicy: {{ default "" .Values.imagePullPolicy | quote }} + imagePullPolicy: {{ .Values.imagePullPolicy | quote }} env: + - name: ALLOW_EMPTY_PASSWORD + value: {{ .Values.allowEmptyPassword | quote }} + {{- if .Values.mariadb.enabled }} - name: MARIADB_HOST value: {{ template "jasperreports.mariadb.fullname" . }} - name: MARIADB_PORT_NUMBER value: "3306" - - name: MARIADB_PASSWORD + - name: JASPERREPORTS_DATABASE_NAME + value: {{ .Values.mariadb.mariadbDatabase | quote }} + - name: JASPERREPORTS_DATABASE_USER + value: {{ .Values.mariadb.mariadbUser | quote }} + - name: JASPERREPORTS_DATABASE_PASSWORD valueFrom: secretKeyRef: name: {{ template "jasperreports.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: JASPERREPORTS_DATABASE_NAME + value: {{ .Values.externalDatabase.database | quote }} + - name: JASPERREPORTS_DATABASE_USER + value: {{ .Values.externalDatabase.user | quote }} + - name: JASPERREPORTS_DATABASE_PASSWORD + valueFrom: + secretKeyRef: + name: {{ printf "%s-%s" .Release.Name "externaldb" }} + key: db-password + {{- end }} - name: JASPERREPORTS_USERNAME - value: {{ default "" .Values.jasperreportsUsername | quote }} + value: {{ .Values.jasperreportsUsername | quote }} - name: JASPERREPORTS_PASSWORD valueFrom: secretKeyRef: name: {{ template "jasperreports.fullname" . }} key: jasperreports-password - name: JASPERREPORTS_EMAIL - value: {{ default "" .Values.jasperreportsEmail | quote }} + value: {{ .Values.jasperreportsEmail | quote }} - name: SMTP_HOST - value: {{ default "" .Values.smtpHost | quote }} + value: {{ .Values.smtpHost | quote }} - name: SMTP_PORT - value: {{ default "" .Values.smtpPort | quote }} + value: {{ .Values.smtpPort | quote }} - name: SMTP_EMAIL - value: {{ default "" .Values.smtpEmail| quote }} + value: {{ .Values.smtpEmail| quote }} - name: SMTP_USER - value: {{ default "" .Values.smtpUser | quote }} + value: {{ .Values.smtpUser | quote }} - name: SMTP_PASSWORD valueFrom: secretKeyRef: name: {{ template "jasperreports.fullname" . }} key: smtp-password - name: SMTP_PROTOCOL - value: {{ default "" .Values.smtpProtocol | quote }} + value: {{ .Values.smtpProtocol | quote }} ports: - name: http containerPort: 8080 diff --git a/stable/jasperreports/templates/externaldb-secrets.yaml b/stable/jasperreports/templates/externaldb-secrets.yaml new file mode 100644 index 0000000000..4ceb148898 --- /dev/null +++ b/stable/jasperreports/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/jasperreports/values.yaml b/stable/jasperreports/values.yaml index f50cae284f..69773903d4 100644 --- a/stable/jasperreports/values.yaml +++ b/stable/jasperreports/values.yaml @@ -1,7 +1,7 @@ ## Bitnami JasperReports image version ## ref: https://hub.docker.com/r/bitnami/jasperreports/tags/ ## -image: bitnami/jasperreports:6.4.2-r3 +image: bitnami/jasperreports:6.4.2-r4 ## Specify a imagePullPolicy ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images @@ -24,6 +24,30 @@ jasperreportsUsername: user ## jasperreportsEmail: user@example.com +## Set to `yes` to allow the container to be started with blank passwords +## ref: https://github.com/bitnami/bitnami-docker-jasperreports#environment-variables +allowEmptyPassword: "yes" + +## +## External database configuration +## +externalDatabase: + ## Database host + host: + + ## Database host + port: 3306 + + ## Database user + user: bn_jasperreports + + ## Database password + password: + + ## Database name + database: bitnami_jasperreports + + ## SMTP mail delivery configuration ## ref: https://github.com/bitnami/bitnami-docker-jasperreports#smtp-configuration ## @@ -38,6 +62,24 @@ jasperreportsEmail: user@example.com ## 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_jasperreports + + ## 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_jasperreports + + ## 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 ##