Skip to content

Commit 9fad830

Browse files
leonardocemnencia
leonardoce
authored and
mnencia
committed
Use v1 API instead of v1alpha1 in documentation
Co-authored-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com>
1 parent 89b5d95 commit 9fad830

19 files changed

Lines changed: 39 additions & 39 deletions

‎docs/src/api_reference.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom resources:
77
- [Cluster](#cluster)
88
- [ScheduledBackup](#scheduledbackup)
99

10-
All the resources are defined in the `postgresql.k8s.enterprisedb.io/v1alpha1`
10+
All the resources are defined in the `postgresql.k8s.enterprisedb.io/v1`
1111
API.
1212

1313
Please refer to the ["Configuration Samples" page](samples.md)" of the

‎docs/src/backup_recovery.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Given that secret, you can configure your cluster like in
4848
the following example:
4949

5050
```yaml
51-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
51+
apiVersion: postgresql.k8s.enterprisedb.io/v1
5252
kind: Cluster
5353
[...]
5454
spec:
@@ -78,7 +78,7 @@ In this example, it will use the `bucket` bucket of Linode in the region
7878
`us-east1`.
7979

8080
```yaml
81-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
81+
apiVersion: postgresql.k8s.enterprisedb.io/v1
8282
kind: Cluster
8383
[...]
8484
spec:
@@ -190,7 +190,7 @@ Proceed by configuring MinIO Gateway service as the `endpointURL` in the `Cluste
190190
definition, then choose a bucket name to replace `BUCKET_NAME`:
191191

192192
```yaml
193-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
193+
apiVersion: postgresql.k8s.enterprisedb.io/v1
194194
kind: Cluster
195195
[...]
196196
spec:
@@ -217,7 +217,7 @@ To request a new backup, you need to create a new Backup resource
217217
like the following one:
218218

219219
```yaml
220-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
220+
apiVersion: postgresql.k8s.enterprisedb.io/v1
221221
kind: Backup
222222
metadata:
223223
name: backup-example
@@ -235,11 +235,11 @@ command:
235235
Name: backup-example
236236
Namespace: default
237237
Labels: <none>
238-
Annotations: API Version: postgresql.k8s.enterprisedb.io/v1alpha1
238+
Annotations: API Version: postgresql.k8s.enterprisedb.io/v1
239239
Kind: Backup
240240
Metadata:
241241
Creation Timestamp: 2020-10-26T13:57:40Z
242-
Self Link: /apis/postgresql.k8s.enterprisedb.io/v1alpha1/namespaces/default/backups/backup-example
242+
Self Link: /apis/postgresql.k8s.enterprisedb.io/v1/namespaces/default/backups/backup-example
243243
UID: ad5f855c-2ffd-454a-a157-900d5f1f6584
244244
Spec:
245245
Cluster:
@@ -257,11 +257,11 @@ like in the following example:
257257
Name: backup-example
258258
Namespace: default
259259
Labels: <none>
260-
Annotations: API Version: postgresql.k8s.enterprisedb.io/v1alpha1
260+
Annotations: API Version: postgresql.k8s.enterprisedb.io/v1
261261
Kind: Backup
262262
Metadata:
263263
Creation Timestamp: 2020-10-26T13:57:40Z
264-
Self Link: /apis/postgresql.k8s.enterprisedb.io/v1alpha1/namespaces/default/backups/backup-example
264+
Self Link: /apis/postgresql.k8s.enterprisedb.io/v1/namespaces/default/backups/backup-example
265265
UID: ad5f855c-2ffd-454a-a157-900d5f1f6584
266266
Spec:
267267
Cluster:
@@ -302,7 +302,7 @@ is the same used in Kubernetes CronJobs.
302302
This is an example of a scheduled backup:
303303

304304
```yaml
305-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
305+
apiVersion: postgresql.k8s.enterprisedb.io/v1
306306
kind: ScheduledBackup
307307
metadata:
308308
name: backup-example
@@ -323,7 +323,7 @@ If required, you can choose to compress WAL files as soon as they
323323
are uploaded and/or encrypt them:
324324

325325
```yaml
326-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
326+
apiVersion: postgresql.k8s.enterprisedb.io/v1
327327
kind: Cluster
328328
[...]
329329
spec:
@@ -352,11 +352,11 @@ following example:
352352
Name: backup-example
353353
Namespace: default
354354
Labels: <none>
355-
Annotations: API Version: postgresql.k8s.enterprisedb.io/v1alpha1
355+
Annotations: API Version: postgresql.k8s.enterprisedb.io/v1
356356
Kind: Backup
357357
Metadata:
358358
Creation Timestamp: 2020-10-26T13:57:40Z
359-
Self Link: /apis/postgresql.k8s.enterprisedb.io/v1alpha1/namespaces/default/backups/backup-example
359+
Self Link: /apis/postgresql.k8s.enterprisedb.io/v1/namespaces/default/backups/backup-example
360360
UID: ad5f855c-2ffd-454a-a157-900d5f1f6584
361361
Spec:
362362
Cluster:
@@ -382,7 +382,7 @@ Events: <none>
382382
Given the following cluster definition:
383383

384384
```yaml
385-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
385+
apiVersion: postgresql.k8s.enterprisedb.io/v1
386386
kind: Cluster
387387
metadata:
388388
name: cluster-restore

‎docs/src/bootstrap.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ specification.
1010
In the following example:
1111

1212
```yaml
13-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
13+
apiVersion: postgresql.k8s.enterprisedb.io/v1
1414
kind: Cluster
1515
metadata:
1616
name: cluster-example-initdb
@@ -42,7 +42,7 @@ scratch. It is the default one unless specified differently.
4242
The following example contains the full structure of the `initdb` configuration:
4343

4444
```yaml
45-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
45+
apiVersion: postgresql.k8s.enterprisedb.io/v1
4646
kind: Cluster
4747
metadata:
4848
name: cluster-example-initdb
@@ -128,7 +128,7 @@ add data checksums), you can add them to the `options` section like in
128128
the following example:
129129

130130
```yaml
131-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
131+
apiVersion: postgresql.k8s.enterprisedb.io/v1
132132
kind: Cluster
133133
metadata:
134134
name: cluster-example-initdb
@@ -156,7 +156,7 @@ The following example contains the full structure of the `recovery`
156156
section:
157157

158158
```yaml
159-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
159+
apiVersion: postgresql.k8s.enterprisedb.io/v1
160160
kind: Cluster
161161
metadata:
162162
name: cluster-example-initdb
@@ -206,7 +206,7 @@ feature to work if a recovery target is specified like in the following
206206
example:
207207

208208
```yaml
209-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
209+
apiVersion: postgresql.k8s.enterprisedb.io/v1
210210
kind: Cluster
211211
metadata:
212212
name: cluster-restore-pitr
@@ -250,7 +250,7 @@ stopping right after the recovery target, setting the `exclusive` parameter to
250250
`false` like in the following example:
251251

252252
```yaml
253-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
253+
apiVersion: postgresql.k8s.enterprisedb.io/v1
254254
kind: Cluster
255255
metadata:
256256
name: cluster-restore-pitr

‎docs/src/quickstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ disk space:
155155

156156
```yaml
157157
# Example of PostgreSQL cluster
158-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
158+
apiVersion: postgresql.k8s.enterprisedb.io/v1
159159
kind: Cluster
160160
metadata:
161161
name: cluster-example

‎docs/src/samples/backup-example.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
1+
apiVersion: postgresql.k8s.enterprisedb.io/v1
22
kind: Backup
33
metadata:
44
name: backup-example

‎docs/src/samples/cluster-example-custom.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
1+
apiVersion: postgresql.k8s.enterprisedb.io/v1
22
kind: Cluster
33
metadata:
44
name: cluster-example-custom

‎docs/src/samples/cluster-example-full.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ data:
2727
ACCESS_KEY_ID: a2V5X2lk
2828
ACCESS_SECRET_KEY: c2VjcmV0X2tleQ==
2929
---
30-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
30+
apiVersion: postgresql.k8s.enterprisedb.io/v1
3131
kind: Cluster
3232
metadata:
3333
name: cluster-example-full

‎docs/src/samples/cluster-example-initdb.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
1+
apiVersion: postgresql.k8s.enterprisedb.io/v1
22
kind: Cluster
33
metadata:
44
name: cluster-example-initdb

‎docs/src/samples/cluster-example-secret.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
1+
apiVersion: postgresql.k8s.enterprisedb.io/v1
22
kind: Cluster
33
metadata:
44
name: cluster-example-secret

‎docs/src/samples/cluster-example-syncreplicas.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
apiVersion: postgresql.k8s.enterprisedb.io/v1alpha1
1+
apiVersion: postgresql.k8s.enterprisedb.io/v1
22
kind: Cluster
33
metadata:
44
name: cluster-example-syncreplicas

0 commit comments

Comments
 (0)