From f14318a804c0978f0018ddbd2ef87c8675c61678 Mon Sep 17 00:00:00 2001 From: Nicolas Bigler Date: Thu, 24 Oct 2024 17:05:53 +0200 Subject: [PATCH] Clarify Repack and Vacuum API docs Signed-off-by: Nicolas Bigler --- apis/vshn/v1/dbaas_vshn_postgresql.go | 4 +++- crds/vshn.appcat.vshn.io_vshnkeycloaks.yaml | 3 ++- crds/vshn.appcat.vshn.io_vshnnextclouds.yaml | 3 ++- crds/vshn.appcat.vshn.io_vshnpostgresqls.yaml | 3 ++- crds/vshn.appcat.vshn.io_xvshnkeycloaks.yaml | 8 ++++++-- crds/vshn.appcat.vshn.io_xvshnnextclouds.yaml | 8 ++++++-- crds/vshn.appcat.vshn.io_xvshnpostgresqls.yaml | 6 ++++-- 7 files changed, 25 insertions(+), 10 deletions(-) diff --git a/apis/vshn/v1/dbaas_vshn_postgresql.go b/apis/vshn/v1/dbaas_vshn_postgresql.go index 17a4589034..941cc35dc6 100644 --- a/apis/vshn/v1/dbaas_vshn_postgresql.go +++ b/apis/vshn/v1/dbaas_vshn_postgresql.go @@ -168,9 +168,11 @@ type VSHNPostgreSQLServiceSpec struct { EnableEnvoy bool `json:"enableEnvoy,omitempty"` // +kubebuilder:default=true - // This is default option if neither repack or vacuum are selected + // RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true. RepackEnabled bool `json:"repackEnabled,omitempty"` + // +kubebuilder:default=false + // VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false. VacuumEnabled bool `json:"vacuumEnabled,omitempty"` // Access defines additional users and databases for this instance. diff --git a/crds/vshn.appcat.vshn.io_vshnkeycloaks.yaml b/crds/vshn.appcat.vshn.io_vshnkeycloaks.yaml index 5e67b11116..fb5163c3c4 100644 --- a/crds/vshn.appcat.vshn.io_vshnkeycloaks.yaml +++ b/crds/vshn.appcat.vshn.io_vshnkeycloaks.yaml @@ -9526,7 +9526,7 @@ spec: x-kubernetes-preserve-unknown-fields: true repackEnabled: default: true - description: This is default option if neither repack or vacuum are selected + description: RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true. type: boolean serviceLevel: default: besteffort @@ -9548,6 +9548,7 @@ spec: default: {} vacuumEnabled: default: false + description: VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false. type: boolean type: object default: {} diff --git a/crds/vshn.appcat.vshn.io_vshnnextclouds.yaml b/crds/vshn.appcat.vshn.io_vshnnextclouds.yaml index b285a2c8b2..b044e585f4 100644 --- a/crds/vshn.appcat.vshn.io_vshnnextclouds.yaml +++ b/crds/vshn.appcat.vshn.io_vshnnextclouds.yaml @@ -9436,7 +9436,7 @@ spec: x-kubernetes-preserve-unknown-fields: true repackEnabled: default: true - description: This is default option if neither repack or vacuum are selected + description: RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true. type: boolean serviceLevel: default: besteffort @@ -9458,6 +9458,7 @@ spec: default: {} vacuumEnabled: default: false + description: VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false. type: boolean type: object default: {} diff --git a/crds/vshn.appcat.vshn.io_vshnpostgresqls.yaml b/crds/vshn.appcat.vshn.io_vshnpostgresqls.yaml index 6da1adb16c..bd40817f43 100644 --- a/crds/vshn.appcat.vshn.io_vshnpostgresqls.yaml +++ b/crds/vshn.appcat.vshn.io_vshnpostgresqls.yaml @@ -4859,7 +4859,7 @@ spec: x-kubernetes-preserve-unknown-fields: true repackEnabled: default: true - description: This is default option if neither repack or vacuum are selected + description: RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true. type: boolean serviceLevel: default: besteffort @@ -4881,6 +4881,7 @@ spec: default: {} vacuumEnabled: default: false + description: VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false. type: boolean type: object default: {} diff --git a/crds/vshn.appcat.vshn.io_xvshnkeycloaks.yaml b/crds/vshn.appcat.vshn.io_xvshnkeycloaks.yaml index 7a0bd80529..e41600ee68 100644 --- a/crds/vshn.appcat.vshn.io_xvshnkeycloaks.yaml +++ b/crds/vshn.appcat.vshn.io_xvshnkeycloaks.yaml @@ -11332,8 +11332,9 @@ spec: x-kubernetes-preserve-unknown-fields: true repackEnabled: default: true - description: This is default option if neither repack - or vacuum are selected + description: RepackEnabled defines if `pg_repack` + should be performed during the maintenance. Defaults + to true. type: boolean serviceLevel: default: besteffort @@ -11356,6 +11357,9 @@ spec: type: object vacuumEnabled: default: false + description: VacuumEnabled defines if `VACUUM` should + be performed during the maintenace. Defaults to + false. type: boolean type: object size: diff --git a/crds/vshn.appcat.vshn.io_xvshnnextclouds.yaml b/crds/vshn.appcat.vshn.io_xvshnnextclouds.yaml index 9851f023d5..94e7c44810 100644 --- a/crds/vshn.appcat.vshn.io_xvshnnextclouds.yaml +++ b/crds/vshn.appcat.vshn.io_xvshnnextclouds.yaml @@ -11226,8 +11226,9 @@ spec: x-kubernetes-preserve-unknown-fields: true repackEnabled: default: true - description: This is default option if neither repack - or vacuum are selected + description: RepackEnabled defines if `pg_repack` + should be performed during the maintenance. Defaults + to true. type: boolean serviceLevel: default: besteffort @@ -11250,6 +11251,9 @@ spec: type: object vacuumEnabled: default: false + description: VacuumEnabled defines if `VACUUM` should + be performed during the maintenace. Defaults to + false. type: boolean type: object size: diff --git a/crds/vshn.appcat.vshn.io_xvshnpostgresqls.yaml b/crds/vshn.appcat.vshn.io_xvshnpostgresqls.yaml index d171e8ec64..26b8636c99 100644 --- a/crds/vshn.appcat.vshn.io_xvshnpostgresqls.yaml +++ b/crds/vshn.appcat.vshn.io_xvshnpostgresqls.yaml @@ -5548,8 +5548,8 @@ spec: x-kubernetes-preserve-unknown-fields: true repackEnabled: default: true - description: This is default option if neither repack or vacuum - are selected + description: RepackEnabled defines if `pg_repack` should be + performed during the maintenance. Defaults to true. type: boolean serviceLevel: default: besteffort @@ -5572,6 +5572,8 @@ spec: type: object vacuumEnabled: default: false + description: VacuumEnabled defines if `VACUUM` should be performed + during the maintenace. Defaults to false. type: boolean type: object size: