Skip to content

Commit 5a60cd1

Browse files
thojkooithojkooi
committed
docs(dbaas): generate backup store, recovery, and restore command docs
Regenerate cobra docs so the new backup-stores, recovery, and restore commands, plus SEE ALSO links, match the CLI.
1 parent 2f2dd48 commit 5a60cd1

31 files changed

Lines changed: 759 additions & 22 deletions

File tree

‎docs/tcloud/dbaas/_index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ linkTitle: "tcloud dbaas"
33
title: "dbaas"
44
slug: tcloud_dbaas
55
url: /docs/tcloud/tcloud_dbaas/
6-
weight: 9955
6+
weight: 9941
77
cascade:
88
type: docs
99
---
@@ -48,10 +48,13 @@ tcloud dbaas versions --engine postgres
4848
* [tcloud](/docs/tcloud/tcloud/) - A CLI for working with the Thalassa Cloud Platform
4949
* [tcloud dbaas backup](/docs/tcloud/dbaas/backup/) - Manage database backups
5050
* [tcloud dbaas backup-schedules](/docs/tcloud/dbaas/backup-schedules/) - Manage database backup schedules
51+
* [tcloud dbaas backup-stores](/docs/tcloud/dbaas/backup-stores/) - Manage database backup stores
5152
* [tcloud dbaas create](/docs/tcloud/dbaas/create/) - Create a database cluster
5253
* [tcloud dbaas delete](/docs/tcloud/dbaas/delete/) - Delete database cluster(s)
5354
* [tcloud dbaas instance-types](/docs/tcloud/dbaas/instance-types/) - Get a list of database instance types
5455
* [tcloud dbaas list](/docs/tcloud/dbaas/list/) - Get a list of database clusters
56+
* [tcloud dbaas recovery](/docs/tcloud/dbaas/recovery/) - Inspect database backup recovery and PITR windows
57+
* [tcloud dbaas restore](/docs/tcloud/dbaas/restore/) - Restore a database cluster from a backup
5558
* [tcloud dbaas update](/docs/tcloud/dbaas/update/) - Update a database cluster
5659
* [tcloud dbaas versions](/docs/tcloud/dbaas/versions/) - Get a list of database engine versions
5760
* [tcloud dbaas view](/docs/tcloud/dbaas/view/) - View database cluster details

‎docs/tcloud/dbaas/backup-schedules/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ linkTitle: "tcloud dbaas backup-schedules"
33
title: "dbaas backup-schedules"
44
slug: tcloud_dbaas_backup-schedules
55
url: /docs/tcloud/dbaas/backup-schedules/
6-
weight: 9963
6+
weight: 9962
77
cascade:
88
type: docs
99
---

‎docs/tcloud/dbaas/backup-schedules_create/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ linkTitle: "tcloud dbaas backup-schedules create"
33
title: "dbaas backup-schedules create"
44
slug: tcloud_dbaas_backup-schedules_create
55
url: /docs/tcloud/dbaas/backup-schedules_create/
6-
weight: 9968
6+
weight: 9967
77
cascade:
88
type: docs
99
---

‎docs/tcloud/dbaas/backup-schedules_delete/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ linkTitle: "tcloud dbaas backup-schedules delete"
33
title: "dbaas backup-schedules delete"
44
slug: tcloud_dbaas_backup-schedules_delete
55
url: /docs/tcloud/dbaas/backup-schedules_delete/
6-
weight: 9967
6+
weight: 9966
77
cascade:
88
type: docs
99
---

‎docs/tcloud/dbaas/backup-schedules_list/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ linkTitle: "tcloud dbaas backup-schedules list"
33
title: "dbaas backup-schedules list"
44
slug: tcloud_dbaas_backup-schedules_list
55
url: /docs/tcloud/dbaas/backup-schedules_list/
6-
weight: 9966
6+
weight: 9965
77
cascade:
88
type: docs
99
---

‎docs/tcloud/dbaas/backup-schedules_update/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ linkTitle: "tcloud dbaas backup-schedules update"
33
title: "dbaas backup-schedules update"
44
slug: tcloud_dbaas_backup-schedules_update
55
url: /docs/tcloud/dbaas/backup-schedules_update/
6-
weight: 9965
6+
weight: 9964
77
cascade:
88
type: docs
99
---

‎docs/tcloud/dbaas/backup-schedules_view/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ linkTitle: "tcloud dbaas backup-schedules view"
33
title: "dbaas backup-schedules view"
44
slug: tcloud_dbaas_backup-schedules_view
55
url: /docs/tcloud/dbaas/backup-schedules_view/
6-
weight: 9964
6+
weight: 9963
77
cascade:
88
type: docs
99
---

‎docs/tcloud/dbaas/backup-stores/_index.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
linkTitle: "tcloud dbaas backup-stores"
3+
title: "dbaas backup-stores"
4+
slug: tcloud_dbaas_backup-stores
5+
url: /docs/tcloud/dbaas/backup-stores/
6+
weight: 9956
7+
cascade:
8+
type: docs
9+
---
10+
## tcloud dbaas backup-stores
11+
12+
Manage database backup stores
13+
14+
### Synopsis
15+
16+
Manage backup stores used by database clusters for Barman backups and point-in-time recovery
17+
18+
### Options
19+
20+
```
21+
-h, --help help for backup-stores
22+
```
23+
24+
### Options inherited from parent commands
25+
26+
```
27+
--access-token string Access Token authentication (overrides context)
28+
--api string API endpoint (overrides context)
29+
--client-id string OIDC client ID for OIDC authentication (overrides context)
30+
--client-secret string OIDC client secret for OIDC authentication (overrides context)
31+
-c, --context string Context name
32+
--debug Debug mode
33+
-O, --organisation string Organisation slug or identity (overrides context)
34+
-P, --project string Project identity (overrides context; slug is resolved to identity; use "root" for organisation scope)
35+
--token string Personal access token (overrides context)
36+
```
37+
38+
### SEE ALSO
39+
40+
* [tcloud dbaas](/docs/tcloud/tcloud_dbaas/) - Manage database clusters and related services
41+
* [tcloud dbaas backup-stores create](/docs/tcloud/dbaas/backup-stores_create/) - Create a database backup store
42+
* [tcloud dbaas backup-stores delete](/docs/tcloud/dbaas/backup-stores_delete/) - Delete a database backup store
43+
* [tcloud dbaas backup-stores list](/docs/tcloud/dbaas/backup-stores_list/) - List database backup stores
44+
* [tcloud dbaas backup-stores update](/docs/tcloud/dbaas/backup-stores_update/) - Update a database backup store
45+
* [tcloud dbaas backup-stores view](/docs/tcloud/dbaas/backup-stores_view/) - View backup store details
46+

‎docs/tcloud/dbaas/backup-stores_create/_index.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
linkTitle: "tcloud dbaas backup-stores create"
3+
title: "dbaas backup-stores create"
4+
slug: tcloud_dbaas_backup-stores_create
5+
url: /docs/tcloud/dbaas/backup-stores_create/
6+
weight: 9961
7+
cascade:
8+
type: docs
9+
---
10+
## tcloud dbaas backup-stores create
11+
12+
Create a database backup store
13+
14+
### Synopsis
15+
16+
Create a backup store for Barman backups and point-in-time recovery
17+
18+
```
19+
tcloud dbaas backup-stores create [flags]
20+
```
21+
22+
### Options
23+
24+
```
25+
--annotations strings Annotations in key=value format (can be specified multiple times)
26+
--delete-protection Enable delete protection
27+
--description string Description of the backup store
28+
-h, --help help for create
29+
--labels strings Labels in key=value format (can be specified multiple times)
30+
--name string Name of the backup store (required)
31+
--no-header Do not print the header
32+
--region string Region identity or slug (required)
33+
--retention-mode string Retention mode: retainForPointInTime or forceCleanupAfterExpiry (default "retainForPointInTime")
34+
--retention-policy string Retention policy in days, for example 30d
35+
```
36+
37+
### Options inherited from parent commands
38+
39+
```
40+
--access-token string Access Token authentication (overrides context)
41+
--api string API endpoint (overrides context)
42+
--client-id string OIDC client ID for OIDC authentication (overrides context)
43+
--client-secret string OIDC client secret for OIDC authentication (overrides context)
44+
-c, --context string Context name
45+
--debug Debug mode
46+
-O, --organisation string Organisation slug or identity (overrides context)
47+
-P, --project string Project identity (overrides context; slug is resolved to identity; use "root" for organisation scope)
48+
--token string Personal access token (overrides context)
49+
```
50+
51+
### SEE ALSO
52+
53+
* [tcloud dbaas backup-stores](/docs/tcloud/dbaas/backup-stores/) - Manage database backup stores
54+

‎docs/tcloud/dbaas/backup-stores_delete/_index.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
linkTitle: "tcloud dbaas backup-stores delete"
3+
title: "dbaas backup-stores delete"
4+
slug: tcloud_dbaas_backup-stores_delete
5+
url: /docs/tcloud/dbaas/backup-stores_delete/
6+
weight: 9960
7+
cascade:
8+
type: docs
9+
---
10+
## tcloud dbaas backup-stores delete
11+
12+
Delete a database backup store
13+
14+
### Synopsis
15+
16+
Delete a backup store by identity
17+
18+
```
19+
tcloud dbaas backup-stores delete [flags]
20+
```
21+
22+
### Options
23+
24+
```
25+
--force Force the deletion and skip the confirmation
26+
-h, --help help for delete
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
--access-token string Access Token authentication (overrides context)
33+
--api string API endpoint (overrides context)
34+
--client-id string OIDC client ID for OIDC authentication (overrides context)
35+
--client-secret string OIDC client secret for OIDC authentication (overrides context)
36+
-c, --context string Context name
37+
--debug Debug mode
38+
-O, --organisation string Organisation slug or identity (overrides context)
39+
-P, --project string Project identity (overrides context; slug is resolved to identity; use "root" for organisation scope)
40+
--token string Personal access token (overrides context)
41+
```
42+
43+
### SEE ALSO
44+
45+
* [tcloud dbaas backup-stores](/docs/tcloud/dbaas/backup-stores/) - Manage database backup stores
46+

0 commit comments

Comments
 (0)