Skip to content

Commit 0b45d28

Browse files
authored
Merge pull request #210 from datastax/doc-5439-pt2-0
links pt 2
2 parents bb0a715 + 8f3f46d commit 0b45d28

File tree

5 files changed

+19
-45
lines changed

5 files changed

+19
-45
lines changed

docs/modules/ROOT/pages/backfill-cli.adoc

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
When CDC is enabled on a table, the data topic doesn't contain any data from before CDC was enabled.
44
The backfill CLI solves this problem by exporting the table's primary key to a Comma Separated Values (CSV) file, storing the CSV file on disk, and sending the primary key from the CSV file to the event topic.
55
The Cassandra Source Connector reads the primary key from the event topic and populates the data topic with historical data.
6-
The backfill CLI is powered by the https://docs.datastax.com/en/dsbulk/docs/reference/dsbulkCmd.html[DataStax Bulk Loader], a battle-tested data loader tool. This means the CLI takes full advantage of optimizations done in DSBulk when exporting data from table to disk.
6+
The backfill CLI is powered by the xref:dsbulk:overview:dsbulk-about.adoc[DataStax Bulk Loader], a battle-tested data loader tool. This means the CLI takes full advantage of optimizations done in DSBulk when exporting data from table to disk.
77

88
Developers can also use the backfill CLI to trigger change events for downstream applications without having to insert new data.
99

@@ -64,7 +64,7 @@ The Pulsar-admin extension is packaged with the IBM Elite Support for Apache Pul
6464

6565
. Move the generated NAR archive to the /cliextensions folder of your Pulsar installation (e.g. /pulsar/cliextensions).
6666
. Modify the client.conf file of your Pulsar installation to include: `customCommandFactories=cassandra-cdc`.
67-
. Run the following command (this assumes the https://docs.datastax.com/en/installing/docs/installTARdse.html[default installation] of DSE Cassandra):
67+
. Run the following command (this assumes the https://docs.datastax.com/en/dse/6.8/installing/tarball-dse.html[default tarball installation of DSE]):
6868
+
6969
[source,shell]
7070
----
@@ -80,11 +80,11 @@ This test quickly confirms your CDC backfill is working correctly.
8080

8181
*Prerequisites:*
8282

83-
* A running https://docs.datastax.com/en/installing/docs/installTARdse.html[DSE Cassandra cluster]
83+
* A running DSE cluster
8484
* A running Pulsar cluster (https://pulsar.apache.org/docs/getting-started-standalone/[standalone] is fine)
8585
* Backfill CLI built with Gradle (see <<install>>)
8686

87-
. Start DSE Cassandra from the https://docs.datastax.com/en/installing/docs/installTARdse.html[installation directory].
87+
. Start DSE:
8888
+
8989
[source,bash]
9090
----
@@ -299,7 +299,7 @@ value.
299299
|An extra DSBulk option to use when exporting. Any valid DSBulk option
300300
can be specified here, and it will be passed as-is to the DSBulk
301301
process. DSBulk options, including driver options, must be passed as
302-
'--long.option.name=<value>'. Short options are not supported. For more DSBulk options, see https://docs.datastax.com/en/dsbulk/docs/reference/commonOptions.html[here].
302+
'--long.option.name=<value>'. Short options are not supported.
303303

304304
|--export-host=HOST[:PORT]
305305
|The host name or IP and, optionally, the port of a node from the
@@ -380,10 +380,4 @@ These parameters should be passed as command line arguments in the standalone Ja
380380
|The path to the trusted TLS certificate file.
381381
|--pulsar-ssl-use-key-store-tls
382382
|If TLS is enabled, specifies whether to use KeyStore type as TLS configuration parameter.
383-
|===
384-
385-
== What's next?
386-
387-
* xref:index.adoc[CDC Home]
388-
* https://docs.datastax.com/en/dsbulk/docs/reference/dsbulkCmd.html[DataStax Bulk Loader]
389-
* For more on using CDC with Apache Pulsar, including schema management and consumption patterns, see our https://docs.datastax.com/en/streaming/streaming-learning/use-cases-architectures/change-data-capture/index.html[Streaming learning page].
383+
|===

docs/modules/ROOT/pages/cdcExample.adoc

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ Capture schema changes in your C* tables and pass them to Apache Pulsar(R) with
44

55
This installation requires the following. Latest version artifacts are available https://github.com/datastax/cdc-apache-cassandra/releases/latest[here]. Use image:https://img.shields.io/github/v/release/datastax/cdc-apache-cassandra?color=green&display_name=tag[link="https://github.com/datastax/cdc-apache-cassandra/releases/latest"] for the latest version.
66

7-
* C* or DSE environment
8-
** https://downloads.datastax.com/#enterprise[DSE 6.8.16+]
9-
** https://cassandra.apache.org/_/download.html[OSS C*]
7+
* DSE 6.8.16 or later
8+
* OSS Apache Cassandra(R)
109
* CDC Agent
1110
** DSE - use `agent-dse4-<version>-all.jar`
1211
** OSS C* - use `agent-c4-<version>-all.jar`
@@ -29,7 +28,8 @@ bin/pulsar standalone
2928
====
3029
We recommend using the latest CDC agent version (at least version `1.0.4`+) to support C* collection data types.
3130
====
32-
. Install C*/DSE with your preferred https://docs.datastax.com/en/install/6.8/install/installWhichOne.html[installation method].
31+
32+
. Install C*/DSE.
3333

3434
. After installing C*/DSE, but before starting the C*/DSE service, set the `Cassandra-env.sh` configuration:
3535
+
@@ -181,7 +181,6 @@ Any captured CDC events from the C* table will be reflected in the command line
181181
pulsar-client consume -s mysub -st auto_consume -n 0 persistent://public/default/data-<keyspace>.<table>
182182
----
183183

184-
== What's next?
184+
== See also
185185

186-
For more on monitoring your {cdc_cass} deployment, see xref:monitor.adoc[Monitor {cdc_cass}]. +
187-
For using CDC with Astra DB, see https://docs.datastax.com/en/astra-streaming/docs/astream-cdc.html[CDC for Astra DB].
186+
* xref:monitor.adoc[]

docs/modules/ROOT/pages/index.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,4 @@ To ensure the data sent to all datacenters are delivered to the data topic, make
159159
For example, given a Cassandra cluster with three datacenters (DC1, DC2, and DC3), you would enable CDC and install the change agent in only DC1.
160160
To ensure all updates in DC2 and DC3 are propagated to the data topic, configure the table's keyspace to replicate data from DC2 and DC3 to DC1.
161161
For example, `replication = {'class': 'NetworkTopologyStrategy', 'dc1': 3, 'dc2': 3, 'dc3': 3})`.
162-
The data replicated to DC1 will be processed by the change agent and eventually end up in the data topic.
163-
164-
== What's next?
165-
166-
* For more on using CDC with Apache Pulsar, including schema management and consumption patterns, see our https://docs.datastax.com/en/streaming/streaming-learning/use-cases-architectures/change-data-capture/index.html[Streaming learning page].
167-
* If you've got more questions about {cdc_cass_first}, see xref::faqs.adoc[].
162+
The data replicated to DC1 will be processed by the change agent and eventually end up in the data topic.

docs/modules/ROOT/pages/install.adoc

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
= Installing {cdc_cass} for VM deployment
22

3-
== Download the DataStax Change Data Capture (CDC) Agent for Apache Cassandra(R)
4-
5-
[IMPORTANT]
6-
====
7-
By downloading this DataStax product, you agree to the terms of the open-source https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0 license agreement].
8-
====
9-
10-
Perform the following steps:
11-
12-
. Download the change agent tar file from the https://downloads.datastax.com/#cassandra-change-agent[DataStax downloads page]. +
3+
. Download the `cassandra-source-agents` tar file from the https://github.com/datastax/cdc-apache-cassandra/releases[{cdc_cass} GitHub repository].
134
The following files are available in the tar file:
145
+
156
[cols="1,1"]
@@ -89,12 +80,7 @@ include::partial$agentParams.adoc[]
8980

9081
== Download {cdc_pulsar}
9182

92-
IMPORTANT
93-
====
94-
By downloading this DataStax product, you agree to the terms of the open-source https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0 license agreement].
95-
====
96-
97-
Download the `cassandra-source-connectors-<version>.tar` file from the https://downloads.datastax.com/#cassandra-source-connector[DataStax downloads page].
83+
Download the `cassandra-source-connectors` tar file from the https://github.com/datastax/cdc-apache-cassandra/releases[{cdc_cass} GitHub repository].
9884

9985
For Apache Pulsar and IBM Elite Support for Apache Pulsar (formerly DataStax Luna Streaming) 2.8, the `pulsar-cassandra-source-<version>.nar` file is available.
10086

@@ -198,7 +184,7 @@ The following table identifies functionally equivalent {cdc_pulsar} and DataStax
198184
NOTE: If you define both in your configuration, the {cdc_pulsar} setting take precedence over the `datastax-java-driver.property-name`.
199185
If you do not provide either in your configuration, {cdc_pulsar} defaults are in effect.
200186

201-
For information about the Java properties, refer to the link:https://docs.datastax.com/en/developer/java-driver-dse/2.3/manual/core/configuration/[DataStax Java driver documentation].
187+
For information about the Java properties, refer to the https://docs.datastax.com/en/developer/java-driver/4.3/manual/core/configuration/reference/index.html[DataStax Java driver documentation].
202188

203189
|===
204190
| {csc_pulsar_first} | Using datastax-java-driver prefix
@@ -238,7 +224,7 @@ datastax-java-driver.basic.contact-points = 127.0.0.1:9042, 127.0.0.2:9042
238224

239225
=== Java driver reference
240226

241-
For more information, refer to the link:https://docs.datastax.com/en/developer/java-driver/4.3/manual/core/configuration/reference/[Java driver reference configuration] topic.
227+
For more information, refer to the https://docs.datastax.com/en/developer/java-driver/4.3/manual/core/configuration/reference/index.html[Java driver reference configuration] topic.
242228

243229
== Scaling up your configuration
244230

docs/modules/ROOT/pages/monitor.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ pulsar_source_user_metric__sum{tenant="public",namespace="public/default",name="
146146

147147
== Monitoring and Alerting resources
148148

149-
* The change agent exposes metrics with https://docs.datastax.com/en/landing_page/doc/landing_page/metricsandalerts.html[JMX], a technology within Java that provides tools for managing and monitoring applications.
150-
* https://docs.datastax.com/en/opscenter/6.8/[DSE Ops Center] can collect these exposed metrics for visualization and alerts, and pass them on to https://docs.datastax.com/en/monitoring/doc/monitoring/opsUseMetricsCollector.html[DSE Metrics Collector] for additional integration with Prometheus and Grafana.
149+
* The change agent exposes metrics with https://docs.datastax.com/en/planning/dse/metrics-alerts.html[JMX], a technology within Java that provides tools for managing and monitoring applications.
150+
* https://docs.datastax.com/en/opscenter/6.8/overview/opscenter-about.html[DSE Ops Center] can collect these exposed metrics for visualization and alerts, and pass them on to https://docs.datastax.com/en/monitoring/ops-use-metrics-collector.html[DSE Metrics Collector] for additional integration with Prometheus and Grafana.
151151
* The https://github.com/datastax/metric-collector-for-apache-cassandra[Metrics Collector for Apache Cassandra] with Prometheus and Grafana dashboards provides the same functionality as DSE Metrics Collector, built on the well-supported collectd agent.
152152
* Other monitoring tools like https://github.com/prometheus/jmx_exporter[JMX Exporter] by Prometheus are available, but may require additional tuning.

0 commit comments

Comments
 (0)