diff --git a/docs/content/_index.html b/docs/content/_index.html index 3de702914524..ef899294ea96 100644 --- a/docs/content/_index.html +++ b/docs/content/_index.html @@ -263,7 +263,7 @@

FAQs

-

CONTRIBUTOR GUIDES

+

CONTRIBUTE

diff --git a/docs/content/latest/admin/yb-admin.md b/docs/content/latest/admin/yb-admin.md index ce8d5da99fb1..0d49c27567b7 100644 --- a/docs/content/latest/admin/yb-admin.md +++ b/docs/content/latest/admin/yb-admin.md @@ -255,6 +255,12 @@ Returns tables in the following format: - *namespace*: Name of the database or keyspace. - *table_name*: Name of the table. +{{< note title="Tip" >}} + +To display a list of tables and their UUID (`table_id`) values, open the **YB-Master UI** (`:7000/`) and click **Tables** in the navigation bar. + +{{< /note >}} + **Example** ```sh @@ -543,7 +549,13 @@ yb-admin -master_addresses setup_universe_replication }} + +To display a list of tables and their UUID (`table_id`) values, open the **YB-Master UI** (`:7000/`) and click **Tables** in the navigation bar. + +{{< /note >}} **Example** @@ -730,6 +742,12 @@ yb-admin -master_addresses create_cdc_stream - *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default value is `localhost:7100`. - *table_id*: The identifier (ID) of the table. +{{< note title="Tip" >}} + +To display a list of tables and their UUID (`table_id`) values, open the **YB-Master UI** (`:7000/`) and click **Tables** in the navigation bar. + +{{< /note >}} + --- ### Decommissioning commands diff --git a/docs/content/latest/explore/_index.md b/docs/content/latest/explore/_index.md index 0e3aace5e642..d4b44b5b3fb4 100644 --- a/docs/content/latest/explore/_index.md +++ b/docs/content/latest/explore/_index.md @@ -86,4 +86,16 @@ menu:
+ +
+ +
+ +
Two data center (2DC) deployment
+
+
+ Replicate data changes between two data centers. +
+ +
diff --git a/docs/content/latest/explore/auto-sharding.md b/docs/content/latest/explore/auto-sharding.md index 544318b78d60..4da7acc8c571 100644 --- a/docs/content/latest/explore/auto-sharding.md +++ b/docs/content/latest/explore/auto-sharding.md @@ -1,7 +1,7 @@ --- -title: Auto sharding -linkTitle: 4. Auto sharding -description: Auto sharding +title: Auto-sharding +linkTitle: Auto-sharding +description: Auto-sharding aliases: - /explore/auto-sharding/ - /latest/explore/auto-sharding/ diff --git a/docs/content/latest/explore/binary/two-data-centers.md b/docs/content/latest/explore/binary/two-data-centers.md new file mode 100644 index 000000000000..ee32936030d7 --- /dev/null +++ b/docs/content/latest/explore/binary/two-data-centers.md @@ -0,0 +1,224 @@ +## Before you begin + +- YugabyteDB is installed and ready for use. If you are new to YugabyteDB, you can create a local YugabyteDB cluster in under five minutes by following the steps in the [Quick start](/quick-start/install/). + +- Verify that you have the required extra loopback addresses by reviewing the Configure section. + +- For the tutorial, use the default database `yugabyte` and the default user `yugabyte`. + +## 1. Create two "data centers" + +1. Create and start your first local cluster that will simulate "Data Center - East" by running the following `yb-ctl create` command from your YugabyteDB home directory. + +```sh +$ ./bin/yb-ctl create --data_dir /Users/yugabyte_user/yugabyte/yb-datacenter-east --ip_start 1 +``` + +This will start up a 1-node local cluster using the IP address of `127.0.0.1:7100` and create `yb-datacenter-east` as the data directory. Upon starting, you should see a screen like the following. + +``` +Creating cluster. +Waiting for cluster to be ready. +---------------------------------------------------------------------------------------------------- +| Node Count: 1 | Replication Factor: 1 | +---------------------------------------------------------------------------------------------------- +| JDBC : jdbc:postgresql://127.0.0.1:5433/postgres | +| YSQL Shell : bin/ysqlsh | +| YCQL Shell : bin/cqlsh | +| YEDIS Shell : bin/redis-cli | +| Web UI : http://127.0.0.1:7000/ | +| Cluster Data : /Users/yugabyte_user/yugabyte/yb-datacenter-east | +---------------------------------------------------------------------------------------------------- +``` + +2. Create and start your second local cluster that will simulate "Data Center = West" by running the following `yb-ctl create` command from your YugabyteDB home directory. + +```sh +$ ./bin/yb-ctl create --data_dir yb-datacenter-west --ip_start 2 +``` + +This will start up a 1-node cluster using IP address of `127.0.0.2` and create `yb-datacenter-west` as the data directory. Upon starting, you should see a screen like the following. + +``` +Creating cluster. +Waiting for cluster to be ready. +---------------------------------------------------------------------------------------------------- +| Node Count: 1 | Replication Factor: 1 | +---------------------------------------------------------------------------------------------------- +| JDBC : jdbc:postgresql://127.0.0.2:5433/postgres | +| YSQL Shell : bin/ysqlsh -h 127.0.0.2 | +| YCQL Shell : bin/cqlsh 127.0.0.2 | +| YEDIS Shell : bin/redis-cli -h 127.0.0.2 | +| Web UI : http://127.0.0.2:7000/ | +| Cluster Data : /Users/yugabyte_user/yugabyte/yb-datacenter-west | +---------------------------------------------------------------------------------------------------- +``` + +## 2. Create database tables + +In the default `yugabyte` database, create the database table `users` on the "Data Center - East" cluster. + +Open `ysqlsh` specifying the host IP address of `127.0.0.1`. + +```sh +$ ./bin/ysqlsh -h 127.0.0.1 +``` + +b. Run the following `CREATE TABLE` statement. + +```postgresql +CREATE TABLE users ( + email varchar(35) PRIMARY KEY, + username varchar(20)) + ; +``` + +Now create the identical database table on cluster B. + +Open `ysqlsh` for "Data Center - West" by specifying the host IP address of `127.0.0.2`. + +```sh +$ ./bin/ysqlsh -h 127.0.0.2 +``` + +Run the following `CREATE TABLE` statement. + +```postgresql +CREATE TABLE users ( + email varchar(35) PRIMARY KEY, + username varchar(20)) + ; +``` + +You now have the identical database table on each of your clusters and can now set up 2DC asynchronous replication. + +## 3. Configure unidirectional replication + +To configure "Data Center - West" to be the consumer of data changes from the "Data Center - East" cluster, you need to use the `yb-admin` `setup_universe_replication` command. Review the syntax and then you can run the command. + +```sh +yb-admin -master_addresses setup_universe_replication +``` + +- *consumer-master-addresses*: a comma-separated list of the YB-Master nodes. For this simulation, you have one YB-Master node for each cluster (typically, there are three). +- *producer-universe-uuid*: a unique identifier for the producer cluster. The UUID can be found in the YB-Master UI (`:7000`). +- *producer-table-ids*: A comma-separated list of `table_id` values (the generated UUIDs can be found in the YB-Master UI (`:7000`). + +Based on your actual values (which you got from the YB-Master UI page (`yb-master-ip>:7000`)), run the `yb-admin` `setup_universe_replication` command like in this example. + +*consumer-master-addresses*: `127.0.0.2:7100` +*producer-universe-uuid*: `7acd6399-657d-42dc-a90a-646869898c2d` +*producer-master-addresses*: `127.0.0.1:7100` +*producer-table-ids*: `000030a9000030008000000000004000` + +```sh +yb-admin -master_addresses 127.0.0.2:7100 setup_universe_replication 7acd6399-657d-42dc-a90a-646869898c2d 127.0.0.1:7100 000030a9000030008000000000004000 +``` + +You should see a message like the following: + +``` +I1113 12:02:46.443101 136273344 mem_tracker.cc:250] MemTracker: hard memory limit is 13.600000 GB +I1113 12:02:46.443816 136273344 mem_tracker.cc:252] MemTracker: soft memory limit is 11.560000 GB +Replication setup successfully +``` + +## Verify unidirectional replication + +Now that you've configured unidirectional replication, you can now add data to the `users` table on the "Data Center - West" cluster and see the data appear in the `users` table on "Data Center - East" cluster. + +To add data to the "Data Center - East" cluster, open the YSQL shell (`ysqlsh`) by running the following command, making sure you are pointing to the new producer host. + +```sh +$ ./bin/ysqlsh -host 127.0.0.1 +``` + +On the "producer" cluster, open the YSQL shell (`ysqlsh`) and run the following to quickly see that data has been replicated between clusters. + +```sh +$ ./bin/ysqlsh -host 127.0.0.2 +``` + +```postgresql +yugabyte=# INSERT INTO users(email, username) VALUES ('hector@example.com', 'hector'), ('steve@example.com', 'steve'); +``` + +```postgresql +yugabyte=# SELECT * FROM users; +``` + +You should see the following in the results. + +``` + email | username +---------------------+---------- + hector@example.com | hector + steve@example.com | steve +(2 rows) +``` + +## [Optional] Configure bidirectional replication + +Bidirectional asynchronous replication lets you insert data into the same table on either of the clusters and have the data changes added to the other cluster. + +To configure bidirectional asynchronous replication for the same table, you need to run the following `yb-admin` `setup_universe_replication` command to set up the "Data Center - East" cluster to be the consumer of the "Data Center - West" cluster. For this example, here are the values used and the command example. + +*consumer-master-addresses*: `127.0.0.1:7100` +*producer-universe-uuid*: `0a315687-e9bd-430f-b6f4-ac831193a394` +*producer-master-addresses*: `127.0.0.2:7100` +*producer-table-ids*: `000030a9000030008000000000004000` + +```sh +yb-admin -master_addresses 127.0.0.1:7100 setup_universe_replication 0a315687-e9bd-430f-b6f4-ac831193a394 127.0.0.2:7100 000030a9000030008000000000004000 +``` + +You should see a message like the following: + +``` +I1113 12:01:55.088129 366120384 mem_tracker.cc:250] MemTracker: hard memory limit is 13.600000 GB +I1113 12:01:55.088822 366120384 mem_tracker.cc:252] MemTracker: soft memory limit is 11.560000 GB +Replication setup successfully +``` + +## [Optional] Verify bidirectional replication + +Now that you've configured bidirectional replication, you can now add data to the `users` table on the "Data Center - West" cluster and see the data appear in the `users` table on "Data Center - East" cluster. + +To add data to the "Data Center - West" cluster, open the YSQL shell (`ysqlsh`) by running the following command, making sure you are pointing to the new producer host. + +```sh +$ ./bin/ysqlsh -host 127.0.0.2 +``` + +On the new "consumer" cluster, open the YSQL shell (`ysqlsh`) and run the following to quickly see that data has been replicated between clusters. + +```sh +$ ./bin/ysqlsh -host 127.0.0.1 +``` + +```postgresql +yugabyte=# INSERT INTO users(email, username) VALUES ('neha@example.com', 'neha'), ('mikhail@example.com', 'mikhail'); +``` + +```postgresql +yugabyte=# SELECT * FROM users; +``` + +You should see the following in the results. + +``` + email | username +---------------------+---------- + hector@example.com | hector + steve@example.com | steve + neha@example.com | neha + mikhail@example.com | mikhail +(4 rows) +``` + +## What's next + +For more information, see the following in the Architecture section: + +- [Two data center (2DC) deployments](../../architecture/2dc-deployments/) +- [Change data capture (CDC)](../../architecture/cdc-architecture) diff --git a/docs/content/latest/explore/fault-tolerance.md b/docs/content/latest/explore/fault-tolerance.md index e1cd54a9ea82..c64f18a68a07 100644 --- a/docs/content/latest/explore/fault-tolerance.md +++ b/docs/content/latest/explore/fault-tolerance.md @@ -1,6 +1,6 @@ --- title: Fault tolerance -linkTitle: 2. Fault tolerance +linkTitle: Fault tolerance description: Fault tolerance aliases: - /explore/fault-tolerance/ diff --git a/docs/content/latest/explore/global-distribution.md b/docs/content/latest/explore/global-distribution.md index d8f02eb35af2..8218342780ea 100644 --- a/docs/content/latest/explore/global-distribution.md +++ b/docs/content/latest/explore/global-distribution.md @@ -1,6 +1,6 @@ --- title: Global distribution -linkTitle: 3. Global distribution +linkTitle: Global distribution description: Global distribution aliases: - /explore/global-distribution/ diff --git a/docs/content/latest/explore/linear-scalability.md b/docs/content/latest/explore/linear-scalability.md index 6ce58d87ae6f..85c8ac3d014c 100644 --- a/docs/content/latest/explore/linear-scalability.md +++ b/docs/content/latest/explore/linear-scalability.md @@ -1,6 +1,6 @@ --- title: Linear scalability -linkTitle: 1. Linear scalability +linkTitle: Linear scalability description: Linear scalability aliases: - /explore/linear-scalability/ diff --git a/docs/content/latest/explore/observability.md b/docs/content/latest/explore/observability.md index 34e7899be3ca..37303e3eec4d 100644 --- a/docs/content/latest/explore/observability.md +++ b/docs/content/latest/explore/observability.md @@ -1,6 +1,6 @@ --- title: Observability with Prometheus -linkTitle: 6. Observability +linkTitle: Observability description: Observability with Prometheus aliases: - /latest/explore/cloud-native/observability/ diff --git a/docs/content/latest/explore/tunable-reads.md b/docs/content/latest/explore/tunable-reads.md index b798b82677fb..d32f97d04e2e 100644 --- a/docs/content/latest/explore/tunable-reads.md +++ b/docs/content/latest/explore/tunable-reads.md @@ -1,6 +1,6 @@ --- title: Tunable reads -linkTitle: 5. Tunable reads +linkTitle: Tunable reads description: Tunable read latency aliases: - /explore/tunable-reads/ diff --git a/docs/content/latest/explore/two-data-centers.md b/docs/content/latest/explore/two-data-centers.md new file mode 100644 index 000000000000..354d14f7fb19 --- /dev/null +++ b/docs/content/latest/explore/two-data-centers.md @@ -0,0 +1,39 @@ +--- +title: Two data center (2DC) deployment +linkTitle: Two data center (2DC) deployment +description: Two data center (2DC) deployment +menu: + latest: + identifier: tw0-data-centers + parent: explore + weight: 250 +--- + +By default, YugabyteDB universes provide synchronous replication and strong consistency across geo-distributed data centers. But sometimes asynchronous replication will meet your need for disaster recovery, auditing and compliance, and other applications. For more information, see [Two data center (2DC) deployments](../../architecture/2dc-deployments/) in the Architecture section. + +This tutorial simulates a geo-distributed two data center (2DC) deployment using two local YugabyteDB clusters, one representing "Data Center - East" and the other representing "Data Center - West." Explore unidirectional (one-way) asynchronous replication and bidirectional (two-way) asynchronous replication using the `yb-ctl` and `yb-admin` utilities on your laptop or another local machine. + + + +
+
+ {{% includeMarkdown "binary/two-data-centers.md" /%}} +
+
+ {{% includeMarkdown "binary/two-data-centers.md" /%}} +
+
+ diff --git a/docs/content/latest/secure/authentication/_index.md b/docs/content/latest/secure/authentication/_index.md index 5a0af4abfb52..6bb293bbdc5c 100644 --- a/docs/content/latest/secure/authentication/_index.md +++ b/docs/content/latest/secure/authentication/_index.md @@ -27,10 +27,10 @@ menu:
-
Client authentication
+
Fine-grained authentication
- Configure fine-grained access control for remote clients. + Configure advanced, host-based access control for clients.