Create templates for global storage use
Two helper functions are defined:
- common.storageClass: will print the right storage class according to
properties set or not:
* if no storage class set --> use previous behavior (storage class
named `common.fullname-data`.
* if a "persistence.storageClassOverride" is set for this specific chart,
we use it (if it's "-", we set to default one)
* if a "global.persistence.storageClass" has been set (and no
storageClassOverride for this chart), we use it (same specificity than
storageClassOverride)
* if a "persistence.storageClass) has been set (and no
storageClassOverride nor global one), we use it (same specificity
than storageClassOverride)
- common.needPV: will print "True" if we need a PV (no storageClass and
storageClassOverride being set).
an implementation example with mariadb-galera is provided.
Issue-ID: OOM-1500
Change-Id: I20a667e17b00c255c4b828e3c66f9c0df7c8755c
Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
diff --git a/kubernetes/common/common/templates/_storageClass.tpl b/kubernetes/common/common/templates/_storageClass.tpl
new file mode 100644
index 0000000..8fd1f97
--- /dev/null
+++ b/kubernetes/common/common/templates/_storageClass.tpl
@@ -0,0 +1,57 @@
+{{/*
+# Copyright © 2019 Amdocs, Bell Canada, Orange
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+*/}}
+
+{{/*
+ Expand the name of the storage class.
+ The value "common.fullname"-data is used by default,
+ unless either override mechanism is used.
+
+ - .Values.global.persistence.storageClass : override default storageClass for all charts
+ - .Values.persistence.storageClassOverride : override global and default storage class on a per chart basis
+ - .Values.persistence.storageClass : override default storage class on a per chart basis
+*/}}
+{{- define "common.storageClass" -}}
+ {{- if .Values.persistence.storageClassOverride -}}
+ {{- if ne "-" .Values.persistence.storageClassOverride -}}
+ {{- printf "%s" .Values.persistence.storageClassOverride -}}
+ {{- else -}}
+ {{- $storage_class := "" -}}
+ {{- printf "%q" $storage_class -}}
+ {{- end -}}
+ {{- else -}}
+ {{- if or .Values.persistence.storageClass .Values.global.persistence.storageClass }}
+ {{- if ne "-" (default .Values.persistence.storageClass .Values.global.persistence.storageClass) -}}
+ {{- printf "%s" (default .Values.persistence.storageClass .Values.global.persistence.storageClass) -}}
+ {{- else -}}
+ {{- $storage_class := "" -}}
+ {{- printf "%q" $storage_class -}}
+ {{- end -}}
+ {{- else -}}
+ {{- printf "%s-data" (include "common.fullname" .) -}}
+ {{- end -}}
+ {{- end -}}
+{{- end -}}
+
+{{/*
+ Calculate if we need a PV. If a storageClass is provided, then we don't need.
+*/}}
+{{- define "common.needPV" -}}
+{{- if or (or .Values.persistence.storageClassOverride .Values.persistence.storageClass) .Values.global.persistence.storageClass -}}
+ False
+{{- else -}}
+ True
+{{- end -}}
+{{- end -}}
diff --git a/kubernetes/common/mariadb-galera/.helmignore b/kubernetes/common/mariadb-galera/.helmignore
index f0c1319..f3d010c 100644
--- a/kubernetes/common/mariadb-galera/.helmignore
+++ b/kubernetes/common/mariadb-galera/.helmignore
@@ -19,3 +19,6 @@
.project
.idea/
*.tmproj
+
+# Unit tests folder
+tests
diff --git a/kubernetes/common/mariadb-galera/templates/configmap.yaml b/kubernetes/common/mariadb-galera/templates/configmap.yaml
index 9c9a248..ff6e119 100644
--- a/kubernetes/common/mariadb-galera/templates/configmap.yaml
+++ b/kubernetes/common/mariadb-galera/templates/configmap.yaml
@@ -12,19 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-apiVersion: v1
-kind: ConfigMap
-metadata:
- name: {{ include "common.fullname" . }}-confd
- namespace: {{ include "common.namespace" . }}
- labels:
- app: {{ include "common.name" . }}
- chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}
- release: {{ .Release.Name }}
- heritage: {{ .Release.Service }}
-data:
-{{ tpl (.Files.Glob "resources/config/mariadb/conf.d/*").AsConfig . | indent 2 }}
----
{{- if .Values.externalConfig }}
apiVersion: v1
kind: ConfigMap
@@ -39,4 +26,4 @@
data:
my_extra.cnf: |
{{ .Values.externalConfig | indent 4 }}
-{{- end -}}
\ No newline at end of file
+{{- end -}}
diff --git a/kubernetes/common/mariadb-galera/templates/pv.yaml b/kubernetes/common/mariadb-galera/templates/pv.yaml
index a2096fd..96bd94e 100644
--- a/kubernetes/common/mariadb-galera/templates/pv.yaml
+++ b/kubernetes/common/mariadb-galera/templates/pv.yaml
@@ -1,5 +1,5 @@
{{/*
-# Copyright © 2017 Amdocs, Bell Canada
+# Copyright © 2019 Amdocs, Bell Canada, Orange
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -14,12 +14,13 @@
# limitations under the License.
*/}}
{{- $global := . }}
-{{- if and $global.Values.persistence.enabled (not $global.Values.persistence.existingClaim) -}}
-{{- range $i, $t := until (int $global.Values.replicaCount)}}
+{{- if and $global.Values.persistence.enabled (not $global.Values.persistence.existingClaim) }}
+{{- if eq "True" (include "common.needPV" .) -}}
+{{- range $i := until (int $global.Values.replicaCount)}}
kind: PersistentVolume
apiVersion: v1
metadata:
- name: {{ include "common.fullname" $global }}-data{{$i}}
+ name: {{ include "common.fullname" $global }}-data-{{$i}}
namespace: {{ include "common.namespace" $global }}
labels:
app: {{ include "common.fullname" $global }}
@@ -35,7 +36,10 @@
persistentVolumeReclaimPolicy: {{ $global.Values.persistence.volumeReclaimPolicy }}
storageClassName: "{{ include "common.fullname" $global }}-data"
hostPath:
- path: {{ $global.Values.global.persistence.mountPath | default $global.Values.persistence.mountPath }}/{{ $global.Release.Name }}/{{ $global.Values.persistence.mountSubPath }}{{$i}}
+ path: {{ $global.Values.global.persistence.mountPath | default $global.Values.persistence.mountPath }}/{{ $global.Release.Name }}/{{ $global.Values.persistence.mountSubPath }}-{{$i}}
+{{if ne $i (int $global.Values.replicaCount) }}
---
{{- end -}}
{{- end -}}
+{{- end -}}
+{{- end -}}
diff --git a/kubernetes/common/mariadb-galera/templates/statefulset.yaml b/kubernetes/common/mariadb-galera/templates/statefulset.yaml
index b0b7174..2e77036 100644
--- a/kubernetes/common/mariadb-galera/templates/statefulset.yaml
+++ b/kubernetes/common/mariadb-galera/templates/statefulset.yaml
@@ -130,11 +130,8 @@
spec:
accessModes:
- {{ .Values.persistence.accessMode | quote }}
- storageClassName: {{ include "common.fullname" . }}-data
+ storageClassName: {{ include "common.storageClass" . }}
resources:
requests:
storage: {{ .Values.persistence.size | quote }}
- selector:
- matchLabels:
- name: {{ include "common.fullname" . }}
{{- end }}
diff --git a/kubernetes/common/mariadb-galera/tests/pv_test.yaml b/kubernetes/common/mariadb-galera/tests/pv_test.yaml
new file mode 100644
index 0000000..cd40079
--- /dev/null
+++ b/kubernetes/common/mariadb-galera/tests/pv_test.yaml
@@ -0,0 +1,35 @@
+---
+suite: test pv behavior
+templates:
+ - pv.yaml
+tests:
+ - it: 'should render "" (global case))'
+ values:
+ - ./values/persistence.yaml
+ set:
+ global.persistence.storageClass: "-"
+ asserts:
+ - isEmpty:
+
+ - it: 'should "" (override case)'
+ values:
+ - ./values/persistence.yaml
+ set:
+ global.persistence.storageClass: "global"
+ persistence.storageClassOverride: "-"
+ asserts:
+ - isEmpty:
+
+ - it: 'should "" (local case)'
+ values:
+ - ./values/persistence.yaml
+ set:
+ persistence.storageClass: "-"
+ asserts:
+ - isEmpty:
+
+ - it: 'should render "RELEASE-NAME-mariadb-galera-data" as storageClassname'
+ asserts:
+ - equal:
+ path: spec.storageClassName
+ value: "RELEASE-NAME-mariadb-galera-data"
diff --git a/kubernetes/common/mariadb-galera/tests/storage_class_test.yaml b/kubernetes/common/mariadb-galera/tests/storage_class_test.yaml
new file mode 100644
index 0000000..9b7bdcb
--- /dev/null
+++ b/kubernetes/common/mariadb-galera/tests/storage_class_test.yaml
@@ -0,0 +1,67 @@
+---
+suite: test storage class behavior
+templates:
+ - statefulset.yaml
+tests:
+ - it: 'should render "" as storageClassname (global case)'
+ values:
+ - ./values/persistence.yaml
+ set:
+ global.persistence.storageClass: "-"
+ asserts:
+ - isEmpty:
+ path: spec.volumeClaimTemplates[0].spec.storageClassName
+
+ - it: 'should "" as storageClassname (override case)'
+ values:
+ - ./values/persistence.yaml
+ set:
+ global.persistence.storageClass: "global"
+ persistence.storageClassOverride: "-"
+ asserts:
+ - isEmpty:
+ path: spec.volumeClaimTemplates[0].spec.storageClassName
+
+ - it: 'should "" as storageClassname (local case)'
+ values:
+ - ./values/persistence.yaml
+ set:
+ persistence.storageClass: "-"
+ asserts:
+ - isEmpty:
+ path: spec.volumeClaimTemplates[0].spec.storageClassName
+
+ - it: 'should render "global" as storageClassname'
+ values:
+ - ./values/persistence.yaml
+ set:
+ global.persistence.storageClass: "global"
+ asserts:
+ - equal:
+ path: spec.volumeClaimTemplates[0].spec.storageClassName
+ value: "global"
+
+ - it: 'should render "local" as storageClassname'
+ values:
+ - ./values/persistence.yaml
+ asserts:
+ - equal:
+ path: spec.volumeClaimTemplates[0].spec.storageClassName
+ value: "local"
+
+ - it: 'should render "override" as storageClassname'
+ values:
+ - ./values/persistence.yaml
+ set:
+ global.persistence.storageClass: "global"
+ persistence.storageClassOverride: "override"
+ asserts:
+ - equal:
+ path: spec.volumeClaimTemplates[0].spec.storageClassName
+ value: "override"
+
+ - it: 'should render "RELEASE-NAME-mariadb-galera-data" as storageClassname'
+ asserts:
+ - equal:
+ path: spec.volumeClaimTemplates[0].spec.storageClassName
+ value: "RELEASE-NAME-mariadb-galera-data"
diff --git a/kubernetes/common/mariadb-galera/tests/values/persistence.yaml b/kubernetes/common/mariadb-galera/tests/values/persistence.yaml
new file mode 100644
index 0000000..a282f74
--- /dev/null
+++ b/kubernetes/common/mariadb-galera/tests/values/persistence.yaml
@@ -0,0 +1,6 @@
+---
+persistence:
+ enabled: true
+ existingClaim: false
+ size: 10Gb
+ storageClass: "local"
diff --git a/kubernetes/common/mariadb-galera/values.yaml b/kubernetes/common/mariadb-galera/values.yaml
index a662b1e..14215e4 100644
--- a/kubernetes/common/mariadb-galera/values.yaml
+++ b/kubernetes/common/mariadb-galera/values.yaml
@@ -35,7 +35,7 @@
#repository: mysql
repository: nexus3.onap.org:10001
image: adfinissygroup/k8s-mariadb-galera-centos:v002
-backupImage: library/mariadb:10.1.38
+backupImage: library/mariadb:10.1.38
imageInit: busybox
pullPolicy: IfNotPresent
@@ -91,7 +91,7 @@
mountSubPath: "mariadb-galera/data"
mysqlPath: /var/lib/mysql
backup:
- mountPath: /dockerdata-nfs/backup
+ mountPath: /dockerdata-nfs/backup{{- if or (or .Values.storageClassOverride .Values.persistence.storageClass) .Values.global.persistence.storageClass -}}
service:
internalPort: 3306