Skip to content

Commit 3703fe6

Browse files
authored
Change usages of restore operations to restore jobs (#20209)
1 parent dbfe124 commit 3703fe6

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

src/current/_includes/cockroachcloud/backups/cloud-api-restore-endpoint.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ curl --request POST \
3131
}'
3232
~~~
3333

34-
By default, the restore operation uses the most recent backup stored within the last 7 days on the cluster specified in `source_cluster_id`. To restore a specific backup, include the `backup_id` field and specify a backup ID from the [managed backups list](#view-managed-backups):
34+
By default, the restore job uses the most recent backup stored within the last 7 days on the cluster specified in `source_cluster_id`. To restore a specific backup, include the `backup_id` field and specify a backup ID from the [managed backups list](#view-managed-backups):
3535

3636
{% include_cached copy-clipboard.html %}
3737
~~~ shell
@@ -58,7 +58,7 @@ curl --request POST \
5858
}'
5959
~~~
6060

61-
You can specify additional options for the restore operation in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
61+
You can specify additional options for the restore job in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
6262

6363
{% endif %}
6464

@@ -156,7 +156,7 @@ curl --request POST \
156156
}'
157157
~~~
158158

159-
You can specify additional options for the restore operations in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
159+
You can specify additional options for the restore jobs in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
160160

161161
If the request is successful, the client recieves a response containing JSON describing the request operation:
162162

@@ -266,7 +266,7 @@ curl --request POST \
266266
}'
267267
~~~
268268

269-
You can specify additional options for the restore operations in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
269+
You can specify additional options for the restore jobs in the `restore_opts` object. For more information, see the [API endpoint documentation](https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/v1/clusters/-cluster_id-/restores-config).
270270

271271
If the request is successful, the client recieves a response containing JSON describing the request operation:
272272

@@ -282,13 +282,13 @@ If the request is successful, the client recieves a response containing JSON des
282282
~~~
283283
{% endif %}
284284

285-
### Get status of a restore operation
285+
### Get status of a restore job
286286

287287
{{site.data.alerts.callout_info}}
288288
{% include feature-phases/limited-access.md %}
289289
{{site.data.alerts.end}}
290290

291-
To view the status of a restore operation using the cloud API, send a `GET` request to the `/v1/clusters/{cluster_id}/restores/{restore_id}` endpoint where `restore_id` is the `id` from the JSON response:
291+
To view the status of a restore job using the cloud API, send a `GET` request to the `/v1/clusters/{cluster_id}/restores/{restore_id}` endpoint where `restore_id` is the `id` from the JSON response:
292292

293293
{% include_cached copy-clipboard.html %}
294294
~~~ shell

src/current/_includes/cockroachcloud/backups/managed-backup-perms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
To restore a managed backup successfully in CockroachDB {{ site.data.products.cloud }}, you must have the appropriate [permissions]({% link cockroachcloud/authorization.md %}) on both the source and destination clusters:
22

3-
- You must have either the [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) or [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role on the **destination cluster**, or at the [organization level]({% link cockroachcloud/authorization.md %}#overview-of-the-cockroachdb-cloud-authorization-model). Without one of these roles, the restore operation will fail.
3+
- You must have either the [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) or [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role on the **destination cluster**, or at the [organization level]({% link cockroachcloud/authorization.md %}#overview-of-the-cockroachdb-cloud-authorization-model). Without one of these roles, the restore job will fail.
44
- You must also have either the [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) or [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role on the **source cluster** (the cluster from which the backup was taken), or at the [organization level]({% link cockroachcloud/authorization.md %}#overview-of-the-cockroachdb-cloud-authorization-model). If you do not have the required permissions on the source cluster, the restore will fail.
55

66
{{site.data.alerts.callout_info}}

src/current/cockroachcloud/cloud-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ Where `{cluster_id}` is the ID of your cluster and `{secret_key}` is your API ke
635635
{% include feature-phases/limited-access.md %}
636636
{{site.data.alerts.end}}
637637

638-
For information on using the Cloud API to handle [managed backups and restore operations]({% link cockroachcloud/backup-and-restore-overview.md %}), see the respective managed backup documentation for [Basic]({% link cockroachcloud/managed-backups-basic.md %}#cloud-api), [Standard]({% link cockroachcloud/managed-backups.md %}#cloud-api), and [Advanced]({% link cockroachcloud/managed-backups-advanced.md %}#cloud-api) plans.
638+
For information on using the Cloud API to handle [managed backups and restore jobs]({% link cockroachcloud/backup-and-restore-overview.md %}), see the respective managed backup documentation for [Basic]({% link cockroachcloud/managed-backups-basic.md %}#cloud-api), [Standard]({% link cockroachcloud/managed-backups.md %}#cloud-api), and [Advanced]({% link cockroachcloud/managed-backups-advanced.md %}#cloud-api) plans.
639639

640640
## Change a cluster's plan
641641

src/current/cockroachcloud/managed-backups-advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Users with the [Organization Admin]({% link cockroachcloud/authorization.md %}#o
145145
#### Restore an Advanced cluster
146146

147147
{{site.data.alerts.callout_info}}
148-
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore operation fails if the destination cluster contains any databases/schemas/tables.
148+
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore job fails if the destination cluster contains any databases/schemas/tables.
149149
{{site.data.alerts.end}}
150150

151151
To restore a cluster:

src/current/cockroachcloud/managed-backups-basic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ For each backup, the following details display:
5454
### Restore a cluster
5555

5656
{{site.data.alerts.callout_info}}
57-
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore operation fails if the destination cluster contains any databases/schemas/tables.
57+
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore job fails if the destination cluster contains any databases/schemas/tables.
5858
{{site.data.alerts.end}}
5959

6060
Performing a restore will cause your cluster to be unavailable for the duration of the restore. All current data is deleted, and the cluster will be restored to the state it was in at the time of the backup.

src/current/cockroachcloud/managed-backups.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ To modify the [retention](#retention) of backups, click on **Retain backups for*
108108
### Restore a cluster
109109

110110
{{site.data.alerts.callout_info}}
111-
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore operation fails if the destination cluster contains any databases/schemas/tables.
111+
Before a cluster can be restored from a managed backup, the destination cluster must be completely wiped of data. A cluster restore job fails if the destination cluster contains any databases/schemas/tables.
112112
{{site.data.alerts.end}}
113113

114114
Performing a restore will cause your cluster to be unavailable for the duration of the restore. All current data is deleted, and the cluster will be restored to the state it was in at the time of the backup.

0 commit comments

Comments
 (0)