1
1
<!-- vim: set ft=markdown: --> # teuto-cnpg
2
2
3
- ![ Version: 2.1 .0] ( https://img.shields.io/badge/Version-2.1 .0-informational?style=flat-square ) ![ Type: application] ( https://img.shields.io/badge/Type-application-informational?style=flat-square )
3
+ ![ Version: 3.0 .0] ( https://img.shields.io/badge/Version-3.0 .0-informational?style=flat-square ) ![ Type: application] ( https://img.shields.io/badge/Type-application-informational?style=flat-square )
4
4
5
5
A Helm chart to abstract the managing of cnpg-databases from the original resource.
6
6
@@ -24,6 +24,29 @@ Databases need to be migrated manually:
24
24
- update helmchart
25
25
- start cnpg-operator
26
26
27
+ ### 2.x.x -> 3.x.x
28
+
29
+ Cloudnative-PG made the in-operator backup deprecated.
30
+
31
+ Therefore a migration has to happen where the Backup block is moved
32
+ into the Objectstore.
33
+
34
+ In the values you need to remove .values.backup.barmanObjectStore block.
35
+ Those values now need to be set under .values.backup.s3 like this:
36
+
37
+ ```
38
+ values:
39
+ backup:
40
+ s3:
41
+ endpointURL: https://api.ffm3.teutostack.de:6780
42
+ path: s3://backup/
43
+ secret:
44
+ name: backup-credentials
45
+ ```
46
+
47
+ accessKeyId and accessSecretKey are set to ` ACCESS_KEY_ID ` and ` accessSecretKeyEY ` by default
48
+ but can be overwritten with .values.backup.s3.accessKeyId or .values.backup.s3.accessSecretKey.
49
+
27
50
# cnpg-wrapper configuration
28
51
29
52
** Title:** cnpg-wrapper configuration
@@ -186,16 +209,17 @@ Must be one of:
186
209
187
210
## <a name =" backup " ></a >7. ![ Optional] ( https://img.shields.io/badge/Optional-yellow ) Property ` cnpg-wrapper configuration > backup `
188
211
189
- | | |
190
- | ------------------------- | --------------------------------------------------------------------------- |
191
- | ** Type** | ` object ` |
192
- | ** Additional properties** | ![ Any type: allowed] ( https://img.shields.io/badge/Any%20type-allowed-green ) |
212
+ | | |
213
+ | ------------------------- | -------------------------------------------------------------- |
214
+ | ** Type** | ` object ` |
215
+ | ** Additional properties** | ![ Not allowed] ( https://img.shields.io/badge/Not%20allowed-red ) |
193
216
194
217
** Description:** See: https://cloudnative-pg.io/documentation/1.16/backup_recovery/
195
218
196
- | Property | Pattern | Type | Deprecated | Definition | Title/Description |
197
- | ------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
198
- | - [ schedule] ( #backup_schedule ) | No | string | No | - | cron syntax |
219
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
220
+ | ------------------------------- | ------- | ------ | ---------- | ---------- | ------------------ |
221
+ | - [ schedule] ( #backup_schedule ) | No | string | No | - | cron syntax |
222
+ | + [ s3] ( #backup_s3 ) | No | object | No | - | s3 related options |
199
223
200
224
### <a name =" backup_schedule " ></a >7.1. ![ Optional] ( https://img.shields.io/badge/Optional-yellow ) Property ` cnpg-wrapper configuration > backup > schedule `
201
225
@@ -211,6 +235,70 @@ Must be one of:
211
235
0 0 0 * * *
212
236
```
213
237
238
+ ### <a name =" backup_s3 " ></a >7.2. ![ Required] ( https://img.shields.io/badge/Required-blue ) Property ` cnpg-wrapper configuration > backup > s3 `
239
+
240
+ | | |
241
+ | ------------------------- | -------------------------------------------------------------- |
242
+ | ** Type** | ` object ` |
243
+ | ** Additional properties** | ![ Not allowed] ( https://img.shields.io/badge/Not%20allowed-red ) |
244
+
245
+ ** Description:** s3 related options
246
+
247
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
248
+ | ---------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------- |
249
+ | + [ path] ( #backup_s3_path ) | No | string | No | - | s3 path to write files to |
250
+ | + [ endpointURL] ( #backup_s3_endpointURL ) | No | string | No | - | url of the api endpoint |
251
+ | - [ secret] ( #backup_s3_secret ) | No | object | No | - | - |
252
+
253
+ #### <a name =" backup_s3_path " ></a >7.2.1. ![ Required] ( https://img.shields.io/badge/Required-blue ) Property ` cnpg-wrapper configuration > backup > s3 > path `
254
+
255
+ | | |
256
+ | -------- | -------- |
257
+ | ** Type** | ` string ` |
258
+
259
+ ** Description:** s3 path to write files to
260
+
261
+ #### <a name =" backup_s3_endpointURL " ></a >7.2.2. ![ Required] ( https://img.shields.io/badge/Required-blue ) Property ` cnpg-wrapper configuration > backup > s3 > endpointURL `
262
+
263
+ | | |
264
+ | -------- | -------- |
265
+ | ** Type** | ` string ` |
266
+
267
+ ** Description:** url of the api endpoint
268
+
269
+ #### <a name =" backup_s3_secret " ></a >7.2.3. ![ Optional] ( https://img.shields.io/badge/Optional-yellow ) Property ` cnpg-wrapper configuration > backup > s3 > secret `
270
+
271
+ | | |
272
+ | ------------------------- | -------------------------------------------------------------- |
273
+ | ** Type** | ` object ` |
274
+ | ** Additional properties** | ![ Not allowed] ( https://img.shields.io/badge/Not%20allowed-red ) |
275
+
276
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
277
+ | ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
278
+ | + [ name] ( #backup_s3_secret_name ) | No | string | No | - | - |
279
+ | - [ accessKeyId] ( #backup_s3_secret_accessKeyId ) | No | string | No | - | - |
280
+ | - [ accessSecretKey] ( #backup_s3_secret_accessSecretKey ) | No | string | No | - | - |
281
+
282
+ ##### <a name =" backup_s3_secret_name " ></a >7.2.3.1. ![ Required] ( https://img.shields.io/badge/Required-blue ) Property ` cnpg-wrapper configuration > backup > s3 > secret > name `
283
+
284
+ | | |
285
+ | -------- | -------- |
286
+ | ** Type** | ` string ` |
287
+
288
+ ##### <a name =" backup_s3_secret_accessKeyId " ></a >7.2.3.2. ![ Optional] ( https://img.shields.io/badge/Optional-yellow ) Property ` cnpg-wrapper configuration > backup > s3 > secret > accessKeyId `
289
+
290
+ | | |
291
+ | ----------- | ----------------- |
292
+ | ** Type** | ` string ` |
293
+ | ** Default** | ` "ACCESS_KEY_ID" ` |
294
+
295
+ ##### <a name =" backup_s3_secret_accessSecretKey " ></a >7.2.3.3. ![ Optional] ( https://img.shields.io/badge/Optional-yellow ) Property ` cnpg-wrapper configuration > backup > s3 > secret > accessSecretKey `
296
+
297
+ | | |
298
+ | ----------- | --------------------- |
299
+ | ** Type** | ` string ` |
300
+ | ** Default** | ` "ACCESS_SECRET_KEY" ` |
301
+
214
302
## <a name =" databaseImage " ></a >8. ![ Optional] ( https://img.shields.io/badge/Optional-yellow ) Property ` cnpg-wrapper configuration > databaseImage `
215
303
216
304
| | |
0 commit comments