Skip to content

Commit

Permalink
added Multi-DC deployment section to Deploy (#3295)
Browse files Browse the repository at this point in the history
  • Loading branch information
schoudhury authored Jan 8, 2020
1 parent a4f68ce commit 959b15b
Show file tree
Hide file tree
Showing 43 changed files with 576 additions and 200 deletions.
4 changes: 2 additions & 2 deletions docs/content/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ <h2> USER GUIDES </h2>
<a class="section-link icon-offset" href="/latest/develop/">
<div class="head">
<img class="icon" src="/images/section_icons/index/develop.png" aria-hidden="true" />
<div class="articles">4 chapters</div>
<div class="articles">5 chapters</div>
<div class="title">Develop</div>
</div>
<div class="body">
Expand Down Expand Up @@ -201,7 +201,7 @@ <h2>REFERENCE</h2>
<a class="section-link icon-offset" href="/latest/tools/">
<div class="head">
<img class="icon" src="/images/section_icons/troubleshoot/troubleshoot.png" aria-hidden="true" />
<div class="articles">4 chapters</div>
<div class="articles">5 chapters</div>
<div class="title">Tools</div>
</div>
<div class="body">
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<a class="section-link icon-offset" href="explore/">
<div class="head">
<img class="icon" src="/images/section_icons/index/explore.png" aria-hidden="true" />
<div class="articles">7 chapters</div>
<div class="articles">7 articles</div>
<div class="title">Explore</div>
</div>
<div class="body">
Expand Down
10 changes: 5 additions & 5 deletions docs/content/latest/admin/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@
<a class="section-link icon-offset" href="ysqlsh/">
<div class="head">
<img class="icon" src="/images/section_icons/api/ysql.png" aria-hidden="true" />
<div class="title">ysqlsh CLI</div>
<div class="title">ysqlsh shell</div>
</div>
<div class="body">
Command line interface for interacting with YugabyteDB using YSQL.
CLI shell for interacting with YugabyteDB using YSQL.
</div>
</a>
</div>
Expand All @@ -74,10 +74,10 @@
<a class="section-link icon-offset" href="cqlsh/">
<div class="head">
<img class="icon" src="/images/section_icons/api/ycql.png" aria-hidden="true" />
<div class="title">cqlsh CLI</div>
<div class="title">cqlsh shell</div>
</div>
<div class="body">
Command line interface for interacting with YugabyteDB using YCQL.
CLI shell for interacting with YugabyteDB using YCQL.
</div>
</a>
</div>
Expand All @@ -89,7 +89,7 @@
<div class="title">yb-admin</div>
</div>
<div class="body">
Command line interface for managing YugabyteDB clusters.
CLI for administering YugabyteDB clusters.
</div>
</a>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/content/latest/admin/cqlsh.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: cqlsh
linkTitle: cqlsh
description: cqlsh
description: cqlsh shell for YCQL
aliases:
- /develop/tools/cqlsh/
- /latest/develop/tools/cqlsh/
Expand All @@ -16,7 +16,7 @@ showAsideToc: true

## Overview

The YugabyteDB CQL shell (`cqlsh`) provides a command line interface (CLI) for interacting with YugabyteDB using [YCQL](../../api/ycql/).
The YugabyteDB CQL shell (`cqlsh`) provides a CLI for interacting with YugabyteDB using [YCQL](../../api/ycql/).

## Download

Expand Down Expand Up @@ -98,7 +98,7 @@ cqlsh> SHOW VERSION
### SHOW HOST
Prints the IP address and port of the YB-TServer service that `cqlsh` is connected to in addition to the cluster name. Example:
Prints the IP address and port of the YB-TServer server that `cqlsh` is connected to in addition to the cluster name. Example:
```sql
cqlsh> SHOW HOST
Expand Down
14 changes: 7 additions & 7 deletions docs/content/latest/admin/yb-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ yb-admin -master_addresses <master-addresses> change_master_config [ ADD_SERVER|
```

- master_addresses: Comma-separated list of YB-Master hosts and ports. Default value is `localhost:7100`.
- ADD_SERVER | REMOVE_SERVER: Adds or removes a new YB-Master service.
- After adding or removing a node, verify the status of the YB-Master service on the YB-Master UI page (http://node-ip:7000) or run the [`yb-admin dump_masters_state` command](#dump-masters-state).
- ADD_SERVER | REMOVE_SERVER: Adds or removes a new YB-Master server.
- After adding or removing a node, verify the status of the YB-Master server on the YB-Master UI page (http://node-ip:7000) or run the [`yb-admin dump_masters_state` command](#dump-masters-state).
- *ip_addr*: The IP address of the server node.
- *port*: The port of the server node.
- `0` | `1`: Disabled (`0`) or enabled (`1`). Default is `1`.
Expand Down Expand Up @@ -156,7 +156,7 @@ yb-admin -master_addresses <master-addresses> list_all_tablet_servers

#### list_all_masters

Displays a list of all YB-Master services in a table listing the master UUID, RPC host and port, state (`ALIVE` or `DEAD`), and role (`LEADER`, `FOLLOWER`, or `UNKNOWN_ROLE`).
Displays a list of all YB-Master servers in a table listing the master UUID, RPC host and port, state (`ALIVE` or `DEAD`), and role (`LEADER`, `FOLLOWER`, or `UNKNOWN_ROLE`).

**Syntax**

Expand Down Expand Up @@ -195,7 +195,7 @@ yb-admin -master_addresses <master-addresses> list_replica_type_counts <keyspace

#### dump_masters_state

Prints the status of the YB-Master services.
Prints the status of the YB-Master servers.

**Syntax**

Expand Down Expand Up @@ -868,9 +868,9 @@ $ ./bin/yb-admin -master_addresses ip1:7100,ip2:7100,ip3:7100 get_leader_blackli

#### change_blacklist

Changes the blacklist for YB-TServer services.
Changes the blacklist for YB-TServer servers.

After old YB-TServer services are terminated, you can use this command to clean up the blacklist.
After old YB-TServer servers are terminated, you can use this command to clean up the blacklist.

**Syntax**

Expand All @@ -879,7 +879,7 @@ yb-admin -master_addresses <master-addresses> change_blacklist [ ADD | REMOVE ]
```

- *master-addresses*: Comma-separated list of YB-Master hosts and ports. Default value is `localhost:7100`.
- ADD | REMOVE: Adds or removes the specified YB-TServer services.
- ADD | REMOVE: Adds or removes the specified YB-TServer server.
- *ip_addr:port*: The IP address and port of the YB-TServer.

**Example**
Expand Down
8 changes: 4 additions & 4 deletions docs/content/latest/admin/yb-ctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ and [Wipe and restart with placement info flags](#wipe-and-restart-with-placemen

Specifies the number of replicas for each tablet. Should be an odd number of least `3` or (for example, `3` or `5`) so that a majority consensus can be established.

Replication factor for the cluster as well as default number of YB-Master services.
Replication factor for the cluster as well as default number of YB-Master servers.

Default: `1`

Expand Down Expand Up @@ -194,7 +194,7 @@ To quickly create a local YugabyteDB cluster for development and learning, use t

In order to ensure that all of the replicas for a given tablet can be placed on different nodes, the number of nodes created with the initial create command is always equal to the replication factor. To expand or shrink the cluster, use the [`add_node`](#add-nodes) and [`remove_node`](#stop-remove-nodes) commands.

Each of these initial nodes run a `yb-tserver` service and a `yb-master` service. Note that the number of YB-Master services in a cluster must equal the replication factor for the cluster to be considered operating normally.
Each of these initial nodes run a `yb-tserver` server and a `yb-master` server. Note that the number of YB-Master servers in a cluster must equal the replication factor for the cluster to be considered operating normally.

### Create a local 1-node cluster with replication factor of 1

Expand Down Expand Up @@ -319,7 +319,7 @@ $ ./bin/yb-ctl setup_redis

### Add nodes

- Adding a new node to the cluster. This will start a new YB-TServer service and give it a new `node_id` for tracking purposes.
- Adding a new node to the cluster. This will start a new YB-TServer server and give it a new `node_id` for tracking purposes.

```sh
$ ./bin/yb-ctl add_node
Expand Down Expand Up @@ -370,7 +370,7 @@ $ ./bin/yb-ctl add_node --placement_info "cloud1.region1.zone1"

### Create a cluster with custom flags

You can also pass custom flags to the YB-Master and YB-TServer services.
You can also pass custom flags to the YB-Master and YB-TServer servers.

```sh
$ ./bin/yb-ctl --rf 1 create --master_flags "log_cache_size_limit_mb=128,log_min_seconds_to_retain=20,master_backup_svc_queue_length=70" --tserver_flags "log_inject_latency=false,log_segment_size_mb=128,raft_heartbeat_interval_ms=1000"
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/admin/yb-docker-ctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ isTocNested: true
showAsideToc: true
---

The YugabyteDB `yb-docker-ctl` utility provides a simple command line interface (CLI), or shell, for administering a local Docker-based cluster for development and learning. It manages the [YB-Master](../yb-master/) and [YB-TServer](../yb-tserver/) containers to perform the necessary administration.
The `yb-docker-ctl` utility provides a simple command line interface (CLI), or shell, for administering a local Docker-based cluster for development and learning. It manages the [YB-Master](../yb-master/) and [YB-TServer](../yb-tserver/) containers to perform the necessary administration.

## Download

Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/admin/ysql-dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ The data section contains actual table data, large-object contents, and sequence

Use a `serializable` transaction for the dump to ensure that the snapshot used is consistent with later database states by waiting for a point in the transaction stream at which no anomalies can be present, so that there is no risk of the dump failing or causing other transactions to roll back with a `serialization_failure`.

If there are active read-write transactions, the maximum wait time until the start of the dump will be `50ms` (based on the default [`--max_clock_skew_usec`](../../reference/configuration/yb-tserver/#max-clock-skew-usec) for YB-TServer and YB-Master services.) If there are no active read-write transactions when `ysql_dump` is started, this option will not make any difference. Once running, performance with or without the option is the same.
If there are active read-write transactions, the maximum wait time until the start of the dump will be `50ms` (based on the default [`--max_clock_skew_usec`](../../reference/configuration/yb-tserver/#max-clock-skew-usec) for YB-TServer and YB-Master servers.) If there are no active read-write transactions when `ysql_dump` is started, this option will not make any difference. Once running, performance with or without the option is the same.

#### --snapshot=*snapshotname*

Expand Down
4 changes: 2 additions & 2 deletions docs/content/latest/admin/ysqlsh.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ysqlsh
linkTitle: ysqlsh
description: ysqlsh
description: ysqlsh shell for YSQL
aliases:
- /develop/tools/ysqlsh/
- /latest/develop/tools/ysqlsh/
Expand All @@ -14,7 +14,7 @@ isTocNested: 5
showAsideToc: true
---

Use the `ysqlsh` command line interface (CLI) to connect to YugabyteDB and use [Yugabyte Structured Query Language (YSQL)](../../api/ysql/), the distributed SQL API for YugabyteDB that is compatible with the SQL dialect of PostgreSQL. `ysqlsh` provides a YSQL shell to enable you to:
The YugabyteDB SQL shell (`ysqlsh`) provides a CLI for interacting with YugabyteDB using [YSQL](../../api/ysql/). It enables you to:

- interactively enter SQL queries and see the query results
- input from a file or the command line
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/architecture/2dc-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ showAsideToc: true

YugabyteDB provides synchronous replication of data in clusters dispersed across multiple (three or more) data centers by leveraging the Raft consensus algorithm to achieve enhanced high availability and performance. However, many use cases and smaller enterprise applications do not require synchronous replication or justify the additional complexity and operation costs associated with managing three or more data centers. For these needs, YugabyteDB also supports two data center (2DC) deployments, which use asynchronous replication built on top of [change data capture (CDC)](../../architecture/cdc-architecture) in DocDB.

For details about configuring a 2DC deployment, see [Replicate between two data centers](../../deploy/replicate-2dc).
For details about configuring a 2DC deployment, see [Replicate between two data centers](../../deploy/multi-dc/2dc-deployment).

{{< note title="Note" >}}

Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/architecture/cdc-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Maintaining multiple data centers enables enterprises to provide:
- High availability (HA) — Redundant systems help ensure that your operations virtually never fail.
- Geo-redundancy — Geographically dispersed servers provide resiliency against catastrophic events and natural disasters.

Two data center (2DC), or dual data center, deployments are a common use of CDC that allows efficient management of two YugabyteDB universes that are geographically separated. For more information, see [Two data center (2DC) deployments](../2dc-deployments) and [Replicate between two data centers](../../deploy/replicate-2dc)
Two data center (2DC), or dual data center, deployments are a common use of CDC that allows efficient management of two YugabyteDB universes that are geographically separated. For more information, see [Two data center (2DC) deployments](../2dc-deployments) and [Replicate between two data centers](../../deploy/2dc-deployment)

### Compliance and auditing

Expand Down
4 changes: 1 addition & 3 deletions docs/content/latest/architecture/concepts/yb-tserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ showAsideToc: true
---

The YB-TServer (short for YugabyteDB Tablet Server) is the service that does the actual IO for end
user requests. Recall from the previous section that data for a table is split, or sharded, into tablets.
Each tablet is composed of one or more tablet-peers, depending on the replication factor. And each
YB-TServer hosts one or more tablet-peers.
user requests in a YugabyteDB cluster. Recall from the previous section that data for a table is split, or sharded, into tablets.Each tablet is composed of one or more tablet-peers, depending on the replication factor. And each YB-TServer hosts one or more tablet-peers.

Note: We will refer to the “tablet-peers hosted by a YB-TServer” simply as the “tablets hosted by a
YB-TServer”.
Expand Down
8 changes: 7 additions & 1 deletion docs/content/latest/architecture/docdb/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,20 @@
aliases:
- /architecture/concepts/docdb/
- /latest/architecture/concepts/docdb/
headcontent: YugabyteDB's distributed document store responsible for sharding, replication, transactions and persistence.
headcontent: YugabyteDB's distributed document store responsible for sharding, replication, transactions and persistence.
menu:
latest:
identifier: docdb
parent: architecture
weight: 1140
---

{{< note title="Note" >}}

YugabyteDB's sharding and replication architecture is inspired by <a href="https://research.google.com/archive/spanner-osdi2012.pdf">Google Spanner</a>.

{{</note >}}

<div class="row">
<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="sharding/">
Expand Down
2 changes: 1 addition & 1 deletion docs/content/latest/architecture/transactions/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

{{< note title="Note" >}}

YugabyteDB's ACID transaction models were inspired by <a href="https://cloud.google.com/spanner/docs/transactions">Google Spanner</a>.
YugabyteDB's distributed ACID transaction architecture is inspired by <a href="https://research.google.com/archive/spanner-osdi2012.pdf">Google Spanner</a>.

{{</note >}}

Expand Down
17 changes: 9 additions & 8 deletions docs/content/latest/deploy/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,25 +66,26 @@
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="cdc/">
<a class="section-link icon-offset" href="multi-dc/">
<div class="head">
<img class="icon" src="/images/deploy/cdc/deploy.png" aria-hidden="true" />
<div class="title">Change data capture (CDC)</div>
<img class="icon" src="/images/section_icons/explore/planet_scale.png" aria-hidden="true" />
<div class="articles">2 articles</div>
<div class="title">Multi-DC deployments</div>
</div>
<div class="body">
Use change data capture (CDC) to asynchronously replicate data changes between data centers.
Deploy across multiple data centers in 3DC or 2DC configurations.
</div>
</a>
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="replicate-2dc/">
<a class="section-link icon-offset" href="cdc/">
<div class="head">
<img class="icon" src="/images/deploy/cdc/deploy.png" aria-hidden="true" />
<div class="title">Two data center (2DC) replication</div>
<div class="title">Change data capture (CDC)</div>
</div>
<div class="body">
Replicate asynchronously between two data centers for high availability, geo-redundancy, disaster recovery, and more.
Use change data capture (CDC) to asynchronously replicate data changes between data centers.
</div>
</a>
</div>
Expand Down
18 changes: 15 additions & 3 deletions docs/content/latest/deploy/cdc/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Change data capture (CDC)
linkTitle: Change data capture (CDC)
description: Change data capture (CDC)
headcontent: Deploy YugabyteDB applications that use change data capture (CDC) to asynchronously replicate data changes between Yugabyte clusters and Apache Kafka or stdout.
headcontent: Asynchronously replicate data changes between YugabyteDB and Apache Kafka or stdout.
image: /images/section_icons/sample-data/s_s1-sampledata-3x.png
beta: /faq/product/#what-is-the-definition-of-the-beta-feature-tag
aliases:
Expand All @@ -16,10 +16,22 @@

<div class="row">

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="cdc-to-kafka/">
<div class="head">
<img class="icon" src="/images/section_icons/explore/json_documents.png" aria-hidden="true">
<div class="title">Using the YugabyteDB CDC Connector</div>
</div>
<div class="body">
Use change data capture (CDC) to replicate data changes in YugabyteDB to external systems.
</div>
</a>
</div>

<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="cdc-to-kafka/">
<div class="head">
<!-- img class="icon" src="/images/section_icons/explore/json_documents.png" aria-hidden="true" / -->
<img class="icon" src="/images/section_icons/explore/json_documents.png" aria-hidden="true">
<div class="title">CDC to Apache Kafka</div>
</div>
<div class="body">
Expand All @@ -31,7 +43,7 @@
<div class="col-12 col-md-6 col-lg-12 col-xl-6">
<a class="section-link icon-offset" href="cdc-to-stdout/">
<div class="head">
<!-- img class="icon" src="/images/section_icons/explore/json_documents.png" aria-hidden="true" / -->
<img class="icon" src="/images/section_icons/explore/json_documents.png" aria-hidden="true">
<div class="title">CDC to stdout</div>
</div>
<div class="body">
Expand Down
Loading

0 comments on commit 959b15b

Please sign in to comment.