Skip to content

Commit b230ebd

Browse files
github-actions[bot]github-actions[bot]
authored
Merge pull request #584 from vshn/fix/api_clarifications
Clarify Repack and Vacuum API docs
2 parents a1d20ec + f14318a commit b230ebd

7 files changed

+25
-10
lines changed

‎apis/vshn/v1/dbaas_vshn_postgresql.go‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,11 @@ type VSHNPostgreSQLServiceSpec struct {
168168
EnableEnvoy bool `json:"enableEnvoy,omitempty"`
169169

170170
// +kubebuilder:default=true
171-
// This is default option if neither repack or vacuum are selected
171+
// RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true.
172172
RepackEnabled bool `json:"repackEnabled,omitempty"`
173+
173174
// +kubebuilder:default=false
175+
// VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false.
174176
VacuumEnabled bool `json:"vacuumEnabled,omitempty"`
175177

176178
// Access defines additional users and databases for this instance.

‎crds/vshn.appcat.vshn.io_vshnkeycloaks.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9526,7 +9526,7 @@ spec:
95269526
x-kubernetes-preserve-unknown-fields: true
95279527
repackEnabled:
95289528
default: true
9529-
description: This is default option if neither repack or vacuum are selected
9529+
description: RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true.
95309530
type: boolean
95319531
serviceLevel:
95329532
default: besteffort
@@ -9548,6 +9548,7 @@ spec:
95489548
default: {}
95499549
vacuumEnabled:
95509550
default: false
9551+
description: VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false.
95519552
type: boolean
95529553
type: object
95539554
default: {}

‎crds/vshn.appcat.vshn.io_vshnnextclouds.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9436,7 +9436,7 @@ spec:
94369436
x-kubernetes-preserve-unknown-fields: true
94379437
repackEnabled:
94389438
default: true
9439-
description: This is default option if neither repack or vacuum are selected
9439+
description: RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true.
94409440
type: boolean
94419441
serviceLevel:
94429442
default: besteffort
@@ -9458,6 +9458,7 @@ spec:
94589458
default: {}
94599459
vacuumEnabled:
94609460
default: false
9461+
description: VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false.
94619462
type: boolean
94629463
type: object
94639464
default: {}

‎crds/vshn.appcat.vshn.io_vshnpostgresqls.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4859,7 +4859,7 @@ spec:
48594859
x-kubernetes-preserve-unknown-fields: true
48604860
repackEnabled:
48614861
default: true
4862-
description: This is default option if neither repack or vacuum are selected
4862+
description: RepackEnabled defines if `pg_repack` should be performed during the maintenance. Defaults to true.
48634863
type: boolean
48644864
serviceLevel:
48654865
default: besteffort
@@ -4881,6 +4881,7 @@ spec:
48814881
default: {}
48824882
vacuumEnabled:
48834883
default: false
4884+
description: VacuumEnabled defines if `VACUUM` should be performed during the maintenace. Defaults to false.
48844885
type: boolean
48854886
type: object
48864887
default: {}

‎crds/vshn.appcat.vshn.io_xvshnkeycloaks.yaml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11332,8 +11332,9 @@ spec:
1133211332
x-kubernetes-preserve-unknown-fields: true
1133311333
repackEnabled:
1133411334
default: true
11335-
description: This is default option if neither repack
11336-
or vacuum are selected
11335+
description: RepackEnabled defines if `pg_repack`
11336+
should be performed during the maintenance. Defaults
11337+
to true.
1133711338
type: boolean
1133811339
serviceLevel:
1133911340
default: besteffort
@@ -11356,6 +11357,9 @@ spec:
1135611357
type: object
1135711358
vacuumEnabled:
1135811359
default: false
11360+
description: VacuumEnabled defines if `VACUUM` should
11361+
be performed during the maintenace. Defaults to
11362+
false.
1135911363
type: boolean
1136011364
type: object
1136111365
size:

‎crds/vshn.appcat.vshn.io_xvshnnextclouds.yaml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11226,8 +11226,9 @@ spec:
1122611226
x-kubernetes-preserve-unknown-fields: true
1122711227
repackEnabled:
1122811228
default: true
11229-
description: This is default option if neither repack
11230-
or vacuum are selected
11229+
description: RepackEnabled defines if `pg_repack`
11230+
should be performed during the maintenance. Defaults
11231+
to true.
1123111232
type: boolean
1123211233
serviceLevel:
1123311234
default: besteffort
@@ -11250,6 +11251,9 @@ spec:
1125011251
type: object
1125111252
vacuumEnabled:
1125211253
default: false
11254+
description: VacuumEnabled defines if `VACUUM` should
11255+
be performed during the maintenace. Defaults to
11256+
false.
1125311257
type: boolean
1125411258
type: object
1125511259
size:

‎crds/vshn.appcat.vshn.io_xvshnpostgresqls.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5548,8 +5548,8 @@ spec:
55485548
x-kubernetes-preserve-unknown-fields: true
55495549
repackEnabled:
55505550
default: true
5551-
description: This is default option if neither repack or vacuum
5552-
are selected
5551+
description: RepackEnabled defines if `pg_repack` should be
5552+
performed during the maintenance. Defaults to true.
55535553
type: boolean
55545554
serviceLevel:
55555555
default: besteffort
@@ -5572,6 +5572,8 @@ spec:
55725572
type: object
55735573
vacuumEnabled:
55745574
default: false
5575+
description: VacuumEnabled defines if `VACUUM` should be performed
5576+
during the maintenace. Defaults to false.
55755577
type: boolean
55765578
type: object
55775579
size:

0 commit comments

Comments
 (0)