aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/common/common/templates/_storage.tpl
blob: 2114d677e62df2c6820475caf93cfe37d5e1834a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
{{/*
# 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.
*/}}

{{/*
  Give the root folder for ONAP when using host pathes

  The function takes up to two arguments (inside a dictionary):
    - .dot : environment (.)
    - .subPath: the sub path to use, default to
                ".Values.persistence.mountSubPath"

  Example calls:
    {{ include "common.storageClass" . }}
    {{ include "common.storageClass" (dict "dot" . "subPath" "my-awesome-subPath") }}
*/}}
{{- define "common.persistencePath" -}}
{{-   $dot := default . .dot -}}
{{-   $subPath := default $dot.Values.persistence.mountSubPath .subPath -}}
{{ $dot.Values.global.persistence.mountPath | default $dot.Values.persistence.mountPath }}/{{ include "common.release" $dot }}/{{ $subPath }}
{{- end -}}

{{/*
  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
                                               per chart basis

  The function takes up to two arguments (inside a dictionary):
     - .dot : environment (.)
     - .suffix: suffix to name. if not set, default to "data" when no override
        mechanism is used.
     - .persistenceInfos: the persitence values to use, default to
                          `.Values.persistence`.
                          Need to be the dict key from `.Values` in string
                          format.
                          let's say you have:

                              persistence:
                                logs:
                                  enabled: true
                                  size: 100Mi
                                  accessMode: ReadWriteOnce
                                  ...

                          then you have to put `.Values.persitence.logs` in
                          order to use it.


  Example calls:
    {{ include "common.storageClass" . }}
    {{ include "common.storageClass" (dict "dot" . "suffix" "my-awesome-suffix") }}
    {{ include "common.storageClass" (dict "dot" . "suffix" "my-awesome-suffix" "persistenceInfos" .Values.persistenceLog) }}
*/}}
{{- define "common.storageClass" -}}
{{-   $dot := default . .dot -}}
{{-   $suffix := default "data" .suffix -}}
{{- $persistenceInfos := default $dot.Values.persistence .persistenceInfos -}}
  {{- if $persistenceInfos.storageClassOverride -}}
    {{- if ne "-" $persistenceInfos.storageClassOverride -}}
      {{- $persistenceInfos.storageClassOverride -}}
    {{- else -}}
      {{- $storage_class := "" -}}
      {{- printf "%q" $storage_class -}}
    {{- end -}}
  {{- else -}}
    {{- if or $persistenceInfos.storageClass $dot.Values.global.persistence.storageClass }}
      {{- if ne "-" (default $persistenceInfos.storageClass $dot.Values.global.persistence.storageClass) -}}
        {{- default $persistenceInfos.storageClass $dot.Values.global.persistence.storageClass -}}
      {{- else -}}
        {{- $storage_class := "" -}}
        {{- printf "%q" $storage_class -}}
      {{- end -}}
    {{- else -}}
      {{- printf "%s-%s" (include "common.fullname" $dot) $suffix -}}
    {{- end -}}
  {{- end -}}
{{- end -}}

{{/*
  Calculate if we need a PV. If a storageClass is provided, then we don't need.
*/}}
{{- define "common.needPV" -}}
{{- if not (or (or .Values.persistence.storageClassOverride .Values.persistence.storageClass) .Values.global.persistence.storageClass) -}}
  True
{{- end -}}
{{- end -}}

{{/*
  Generate a PV

  The function takes up to three arguments (inside a dictionary):
     - .dot : environment (.)
     - .suffix: suffix to name. if not set, default to "data".
     - .persistenceInfos: the persitence values to use, default to
                          `.Values.persistence`.
                          Need to be the dict key from `.Values` in string
                          format.
                          let's say you have:

                              persistence:
                                logs:
                                  enabled: true
                                  size: 100Mi
                                  accessMode: ReadWriteOnce
                                  ...

                          then you have to put `.Values.persitence.logs` in
                          order to use it.

  Example calls:
    {{ include "common.PV" . }}
    {{ include "common.PV" (dict "dot" . "suffix" "my-awesome-suffix" "persistenceInfos".Values.persistenceLog ) }}
    {{ include "common.PV" (dict "dot" . "subPath" "persistenceInfos" .Values.persistence.log) }}
*/}}
{{- define "common.PV" -}}
{{- $dot := default . .dot -}}
{{- $suffix := default "data" .suffix -}}
{{- $metadata_suffix := ternary "" $suffix (eq $suffix "data") -}}
{{- $persistenceInfos := default $dot.Values.persistence .persistenceInfos -}}
{{- if and $persistenceInfos.enabled (not $persistenceInfos.existingClaim) -}}
{{- if (include "common.needPV" $dot) -}}
kind: PersistentVolume
apiVersion: v1
metadata: {{- include "common.resourceMetadata" (dict "dot" $dot "suffix" $suffix "labels" $persistenceInfos.labels) | nindent 2 }}
spec:
  capacity:
    storage: {{ $persistenceInfos.size }}
  accessModes:
    - {{ $persistenceInfos.accessMode }}
  persistentVolumeReclaimPolicy: {{ $persistenceInfos.volumeReclaimPolicy }}
  storageClassName: "{{ include "common.fullname" $dot }}-{{ $suffix }}"
  hostPath:
    path: {{ include "common.persistencePath" (dict "dot" $dot "subPath" $persistenceInfos.mountSubPath) }}
{{- end -}}
{{- end -}}
{{- end -}}

{{/*
  Generate N PV for a statefulset

  The function takes up to two arguments (inside a dictionary):
     - .dot : environment (.)
     - .suffix: suffix to name. if not set, default to "data".
     - .persistenceInfos: the persitence values to use, default to
                          `.Values.persistence`.
                          Need to be the dict key from `.Values` in string
                          format.
                          let's say you have:

                              persistence:
                                logs:
                                  enabled: true
                                  size: 100Mi
                                  accessMode: ReadWriteOnce
                                  ...

                          then you have to put `.Values.persitence.logs` in
                          order to use it.

  Example calls:
    {{ include "common.replicaPV" . }}
    {{ include "common.replicaPV" (dict "dot" . "suffix" "my-awesome-suffix" "persistenceInfos" .Values.persistenceLog) }}
    {{ include "common.replicaPV" (dict dot" . "subPath" "persistenceInfos" .Values.persistence.log) }}
*/}}
{{- define "common.replicaPV" -}}
{{- $dot := default . .dot -}}
{{- $suffix := default "data" .suffix -}}
{{- $metadata_suffix := ternary "" $suffix (eq $suffix "data") -}}
{{- $persistenceInfos := default $dot.Values.persistence .persistenceInfos -}}
{{- if and $persistenceInfos.enabled (not $persistenceInfos.existingClaim) -}}
{{- if (include "common.needPV" $dot) -}}
{{/* TODO: see if we can use "common.PV" after branching F release */}}
{{- range $i := until (int $dot.Values.replicaCount) }}
{{- $range_suffix := printf "%s-%d" $metadata_suffix $i }}
---
kind: PersistentVolume
apiVersion: v1
metadata: {{- include "common.resourceMetadata" (dict "dot" $dot "suffix" $range_suffix "labels" $persistenceInfos.labels) | nindent 2 }}
spec:
  capacity:
    storage: {{ $persistenceInfos.size }}
  accessModes:
    - {{ $persistenceInfos.accessMode }}
  persistentVolumeReclaimPolicy: {{ $persistenceInfos.volumeReclaimPolicy }}
  storageClassName: "{{ include "common.fullname" $dot }}-{{ $suffix }}"
  hostPath:
    path: {{ include "common.persistencePath"  (dict "dot" $dot "subPath" $persistenceInfos.mountSubPath) }}-{{ $i }}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}

{{/*
  Generate a PVC

  The function takes up to two arguments (inside a dictionary):
     - .dot : environment (.)
     - .suffix: suffix to name. if not set, default to "data".
     - .persistenceInfos: the persitence values to use, default to
                          `.Values.persistence`.
                          Need to be the dict key from `.Values` in string
                          format.
                          let's say you have:

                              persistence:
                                logs:
                                  enabled: true
                                  size: 100Mi
                                  accessMode: ReadWriteOnce
                                  ...

                          then you have to put `.Values.persitence.logs` in
                          order to use it.

  Example calls:
    {{ include "common.PVC" . }}
    {{ include "common.PVC" (dict "dot" . "suffix" "my-awesome-suffix" "persistenceInfos" .Values.persistenceLog) }}
    {{ include "common.PVC" (dict dot" . "subPath" "persistenceInfos" .Values.persistence.log) }}
*/}}
{{- define "common.PVC" -}}
{{- $dot := default . .dot -}}
{{- $persistenceInfos := default $dot.Values.persistence .persistenceInfos -}}
{{- $suffix := default "data" .suffix -}}
{{- $metadata_suffix := ternary "" $suffix (eq $suffix "data") -}}
{{- if and $persistenceInfos.enabled (not $persistenceInfos.existingClaim) -}}
kind: PersistentVolumeClaim
apiVersion: v1
{{ include "common.PVCTemplate" (dict "dot" $dot "suffix" $suffix "persistenceInfos" $persistenceInfos) }}
{{- end -}}
{{- end -}}

{{/*
  Generate a PVC template for a statefulset

  The function takes up to two arguments (inside a dictionary):
     - .dot : environment (.)
     - .suffix: suffix to name. if not set, default to "data".
     - .persistenceInfos: the persitence values to use, default to
                          `.Values.persistence`.
                          Need to be the dict key from `.Values` in string
                          format.
                          let's say you have:

                              persistence:
                                logs:
                                  enabled: true
                                  size: 100Mi
                                  accessMode: ReadWriteOnce
                                  ...

                          then you have to put `.Values.persitence.logs` in
                          order to use it.

  Example calls:
    {{ include "common.PVCTemplate" . }}
    {{ include "common.PVCTemplate" (dict "dot" . "suffix" "my-awesome-suffix" "persistenceInfos" .Values.persistenceLog) }}
    {{ include "common.PVCTemplate" (dict dot" . "subPath" "persistenceInfos" .Values.persistence.log) }}
*/}}
{{- define "common.PVCTemplate" -}}
{{- $dot := default . .dot -}}
{{- $persistenceInfos := default $dot.Values.persistence .persistenceInfos -}}
{{- $suffix := default "data" .suffix -}}
{{- $metadata_suffix := ternary "" $suffix (eq $suffix "data") -}}
metadata: {{- include "common.resourceMetadata" (dict "dot" $dot "suffix" $metadata_suffix "annotations" $persistenceInfos.annotations) | nindent 2 }}
spec:
  accessModes:
  - {{ $persistenceInfos.accessMode }}
  storageClassName: {{ include "common.storageClass" (dict "dot" $dot "suffix" $suffix "persistenceInfos" $persistenceInfos ) }}
  resources:
    requests:
      storage: {{ $persistenceInfos.size }}
{{- end -}}