Skip to content
This repository was archived by the owner on Jun 9, 2026. It is now read-only.

Commit 7e065fb

Browse files
authored
DOC-5707, DOC-5708 remove, update attributes (#239)
* update, remove attributes * re-create
1 parent 1302fa7 commit 7e065fb

10 files changed

Lines changed: 20 additions & 25 deletions

local-preview-playbook.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ asciidoc:
7272
astra-ui: 'Astra Portal'
7373
astra-url: 'https://astra.datastax.com'
7474
astra-ui-link: '{astra-url}[{astra-ui}^]'
75-
db-classic: 'Managed Cluster'
75+
db-classic: 'Astra Managed Clusters'
7676
db-serverless: 'Serverless (non-vector)'
7777
db-serverless-vector: 'Serverless (vector)'
7878
scb: 'Secure Connect Bundle (SCB)'
@@ -84,7 +84,6 @@ asciidoc:
8484
astra-stream: 'Astra Streaming'
8585
starlight-kafka: 'Starlight for Kafka'
8686
starlight-rabbitmq: 'Starlight for RabbitMQ'
87-
astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples'
8887
sstable-sideloader: '{astra-db} Sideloader'
8988
zdm: 'Zero Downtime Migration'
9089
zdm-short: 'ZDM'
@@ -223,10 +222,6 @@ asciidoc:
223222
capacity-service: 'Capacity Service'
224223
lcm: 'Lifecycle Manager (LCM)'
225224
lcm-short: 'LCM'
226-
cr: 'custom resource (CR)'
227-
cr-short: 'CR'
228-
crd: 'custom resource definition (CRD)'
229-
crd-short: 'CRD'
230225
# Antora Atlas
231226
primary-site-url: https://docs.datastax.com/en
232227
primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json

modules/ROOT/pages/create-target.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ After you review the xref:ROOT:feasibility-checklists.adoc[compatibility require
55
This includes the following:
66

77
* Create the new cluster that will be the target of your migration.
8-
* Recreate the schema from your origin cluster on the target cluster.
8+
* Re-create the schema from your origin cluster on the target cluster.
99
* Gather authentication credentials and connection details for the target cluster.
1010
1111
The preparation steps depend on your target platform.
@@ -53,7 +53,7 @@ For example, you could use `scp`:
5353
scp -i some-key.pem /path/to/scb.zip user@client-ip-or-host:
5454
----
5555

56-
. Recreate your client application's schema on your {astra-db} database, including each keyspace and table that you want to migrate.
56+
. Re-create your client application's schema on your {astra-db} database, including each keyspace and table that you want to migrate.
5757
+
5858
[IMPORTANT]
5959
====
@@ -96,7 +96,7 @@ Store the authentication credentials securely for use by your client application
9696

9797
. Note your cluster's connection details, including the contact points (IP addresses or hostnames) and port number.
9898

99-
. Recreate your origin cluster's schema on your new cluster, including each keyspace and table that you want to migrate.
99+
. Re-create your origin cluster's schema on your new cluster, including each keyspace and table that you want to migrate.
100100
+
101101
[IMPORTANT]
102102
====

modules/ROOT/pages/deploy-proxy-monitoring.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ Only modify the variables in `zdm_proxy_advanced_config.yml` if you have a speci
232232
====
233233
The following advanced configuration variables are immutable.
234234
If you need to change these variables, {company} recommends that you do so _before_ deploying {product-proxy}.
235-
Future changes require you to recreate your entire {product-proxy} deployment.
235+
Future changes require you to re-create your entire {product-proxy} deployment.
236236
For more information, see xref:ROOT:manage-proxy-instances.adoc#change-immutable-configuration-variables[Change immutable configuration variables].
237237
====
238238

@@ -257,7 +257,7 @@ This can be changed by setting `metrics_port` to a different value if desired.
257257

258258
All other advanced configuration variables in `zdm_proxy_advanced_config.yml` are mutable.
259259
You can seamlessly change them after deploying {product-proxy} with a rolling restart.
260-
Immutable variables require you to recreate the entire deployment and result in downtime for your {product-proxy} deployment.
260+
Immutable variables require you to re-create the entire deployment and result in downtime for your {product-proxy} deployment.
261261
For more information, see xref:manage-proxy-instances.adoc[].
262262

263263
[#enable-tls-encryption]

modules/ROOT/pages/feasibility-checklists.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ This means that any keyspace that your client application uses must exist on bot
128128
However, the keyspaces can have different replication strategies and durable write settings.
129129

130130
At the column level, the schema doesn't need to be a one-to-one match as long as the CQL statements can be executed successfully on both clusters.
131-
For example, if a table has 10 columns, and your client application uses only five of those columns, then you can recreate the table on the target cluster with only the five required columns.
131+
For example, if a table has 10 columns, and your client application uses only five of those columns, then you can re-create the table on the target cluster with only the five required columns.
132132
However, the data from the other columns won't be migrated to the target cluster if those columns don't exist on the target cluster.
133133
Before you decide to omit a column from the target cluster, make sure that it is acceptable to permanently lose that data after the migration.
134134

modules/ROOT/pages/manage-proxy-instances.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ ubuntu@52772568517c:~$
5454
ansible-playbook rolling_update_zdm_proxy.yml -i zdm_ansible_inventory
5555
----
5656
57-
The rolling restart playbook recreates each {product-proxy} container, one by one.
57+
The rolling restart playbook re-creates each {product-proxy} container, one by one.
5858
The {product-proxy} deployment remains available at all times, and you can safely use it throughout this operation.
5959
If you modified mutable configuration variables, the new containers use the updated configuration files.
6060
6161
The playbook performs the following actions automatically:
6262
6363
. {product-automation} stops one container gracefully, and then waits for it to shut down.
64-
. {product-automation} recreates the container, and then starts it.
64+
. {product-automation} re-creates the container, and then starts it.
6565
. {product-automation} calls the xref:ROOT:metrics.adoc#call-the-liveliness-and-readiness-endpoints[readiness endpoint] to check the container's status:
6666
+
6767
* If the status check fails, {product-automation} repeats the check up to six times at 5-second intervals.
@@ -271,7 +271,7 @@ ansible-playbook deploy_zdm_proxy.yml -i zdm_ansible_inventory
271271
----
272272

273273
You can re-run the deployment playbook as many times as necessary.
274-
However, this playbook decommissions and recreates _all_ {product-proxy} instances simultaneously.
274+
However, this playbook decommissions and re-creates _all_ {product-proxy} instances simultaneously.
275275
This results in a brief period of time where the entire {product-proxy} deployment is offline because no instances are available.
276276

277277
For more information, see xref:ROOT:troubleshooting-tips.adoc#configuration-changes-arent-applied-by-zdm-automation[Configuration changes aren't applied by {product-automation}].
@@ -280,7 +280,7 @@ For more information, see xref:ROOT:troubleshooting-tips.adoc#configuration-chan
280280
== Upgrade the proxy version
281281

282282
The same playbook that you use for configuration changes can also be used to upgrade the {product-proxy} version in a rolling fashion.
283-
All containers are recreated with the given image version.
283+
All containers are re-created with the given image version.
284284

285285
[IMPORTANT]
286286
====

modules/ROOT/pages/setup-ansible-playbooks.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This infrastructure can be on-premise or in any cloud provider of your choice.
2424
+
2525
If your {product-proxy} machines use private IPs, which are recommended for production deployments, configure these before running {product-utility}.
2626
If you enable private IPs later, you must reconfigure and redeploy your {product-proxy} instances.
27-
This is a disruptive operation that requires a small amount of downtime because the deployment playbook decommissions and recreates all {product-proxy} containers simultaneously.
27+
This is a disruptive operation that requires a small amount of downtime because the deployment playbook decommissions and re-creates all {product-proxy} containers simultaneously.
2828

2929
* https://docs.docker.com/engine/install/#server[Install Docker] on the machine that will run the Ansible Control Host container, and ensure that the `docker` command https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user[doesn't require superuser privileges].
3030
+

modules/ROOT/pages/troubleshooting-tips.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To tail (stream) the logs as they are written, use the `--follow` (`-f`) option:
5454
docker container logs zdm-proxy-container -f
5555
----
5656
57-
Keep in mind that Docker logs are deleted if the container is recreated.
57+
Keep in mind that Docker logs are deleted if the container is re-created.
5858
--
5959
6060
Collect logs for multiple instances::
@@ -116,7 +116,7 @@ For example, if you used Docker, you can use the following command to export a c
116116
docker logs my-container > log.txt
117117
----
118118
119-
Keep in mind that Docker logs are deleted if the container is recreated.
119+
Keep in mind that Docker logs are deleted if the container is re-created.
120120
--
121121
======
122122

@@ -270,8 +270,8 @@ Allowing these values to change from a rolling restart could propagate a misconf
270270

271271
If you change the value of an immutable configuration variable, you must run the `deploy_zdm_proxy.yml` playbook again.
272272
You can run this playbook as many times as needed.
273-
Each time, {product-automation} recreates your entire {product-proxy} deployment with the new configuration.
274-
However, this doesn't happen in a rolling fashion: The existing {product-proxy} instances are torn down simultaneously, and then they are recreated.
273+
Each time, {product-automation} re-creates your entire {product-proxy} deployment with the new configuration.
274+
However, this doesn't happen in a rolling fashion: The existing {product-proxy} instances are torn down simultaneously, and then they are re-created.
275275
This results in a brief period of downtime where the entire {product-proxy} deployment is unavailable.
276276

277277
=== Client application throws unsupported protocol version error

modules/sideloader/pages/migrate-sideloader.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Snapshots have a specific directory structure, such as `*KEYSPACE_NAME*/*TABLE_N
184184
[#record-schema]
185185
== Configure the target database
186186

187-
To prepare your target database for the migration, you must record the schema for each table in your origin cluster that you want to migrate, recreate these schemas in your target database, and then set environment variables required to connect to your database.
187+
To prepare your target database for the migration, you must record the schema for each table in your origin cluster that you want to migrate, re-create these schemas in your target database, and then set environment variables required to connect to your database.
188188

189189
[WARNING]
190190
====
@@ -229,7 +229,7 @@ CREATE TABLE smart_home.sensor_readings (
229229
) WITH CLUSTERING ORDER BY (room_id ASC, reading_timestamp DESC);
230230
----
231231

232-
. Recreate the schemas in your target database:
232+
. Re-create the schemas in your target database:
233233
+
234234
.. In the {astra-ui-link} navigation menu, click *Databases*, and then click the name of your {astra-db} database.
235235
.. xref:astra-db-serverless:databases:manage-keyspaces.adoc#keyspaces[Create a keyspace] with the exact same name as your origin cluster's keyspace.

modules/sideloader/pages/prepare-sideloader.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ If the schemas don't match, the migration fails.
266266
+
267267
You don't need to make any changes based on the number of nodes, as long as the keyspaces and table schemas are replicated in the target databases.
268268
+
269-
If you want to migrate the same data to multiple databases, you must recreate the schemas in each of those databases.
269+
If you want to migrate the same data to multiple databases, you must re-create the schemas in each of those databases.
270270
{sstable-sideloader} requires a schema to be present in the target database in order to migrate data.
271271
272272
. For each target database, initialize a migration to prompt {sstable-sideloader} to create migration buckets for each database.

modules/sideloader/pages/troubleshoot-sideloader.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ There are two reasons you might need to do this:
8989
+
9090
** The origin and target schemas don't match.
9191
** The migration reached a point that some data was loaded to the target database.
92-
This is unlikely, but, if this happens, you must xref:astra-db-serverless:databases:manage-collections.adoc#delete-a-table-in-the-astra-portal[drop the table] from your target database, and then recreate the table in the target database.
92+
This is unlikely, but, if this happens, you must xref:astra-db-serverless:databases:manage-collections.adoc#delete-a-table-in-the-astra-portal[drop the table] from your target database, and then re-create the table in the target database.
9393
+
9494
In this case, if the migration _didn't_ fail due to a problem with the snapshot data, you can potentially reuse the existing snapshots for the new migration.
9595

0 commit comments

Comments
 (0)