Skip to content

Commit

Permalink
formatting changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@aishwarya24
aishwarya24 committed Jul 12, 2022
1 parent 521e996 commit 8549a5e
Showing 1 changed file with 41 additions and 42 deletions.
83 changes: 41 additions & 42 deletions docs/content/preview/reference/configuration/yugabyted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The following commands are available:

### start

Use the `yugabyted start` command to start a one-node YugabyteDB cluster in your local environment. This allows developers to quickly get started with a YugabyteDB cluster for running [YSQL](../../../architecture/layered-architecture/#yugabyte-sql-ysql) and [YCQL](/preview/architecture/layered-architecture/#yugabyte-cloud-ql-ycql) workloads.
Use the `yugabyted start` command to start a one-node YugabyteDB cluster in your local environment. This allows developers to quickly get started with a YugabyteDB cluster for running [YSQL](../../../architecture/layered-architecture/#yugabyte-sql-ysql) and [YCQL](../../../architecture/layered-architecture/#yugabyte-cloud-ql-ycql) workloads.

#### Syntax

Expand Down Expand Up @@ -108,28 +108,28 @@ yugabyted start --join=host:port,[host:port]

--data_dir *data-directory*
: The directory where yugabyted stores data. Must be an absolute path. Can be
configured to a different directory than where the configurations and
logs are stored.
configured to a directory different from the one where configurations and logs are stored.

--log_dir *log-directory*
: The directory to store yugabyted logs. Must be an absolute path. This flag
controls where the logs of the YugabyteDB nodes are stored.
: The directory to store yugabyted logs. Must be an absolute path. This flag controls where the logs of the YugabyteDB nodes are stored.

--background *bool*
: Enable or disable running `yugabyted` in the background as a daemon. Does not persist on restart. Default is `true`.
: Enable or disable running `yugabyted` in the background as a daemon. Does not persist on restart.
Default: `true`

--cloud_location *cloud-location*
: Cloud location of the Yugabyted node in form of `cloudprovider.region.zone`. This information is used for multi-zone, multi-region and multi-cloud deployments of YugabyteDB Clusters.
: Cloud location of the Yugabyted node in the format `cloudprovider.region.zone`. This information is used for multi-zone, multi-region and multi-cloud deployments of YugabyteDB clusters.

--fault_tolerance *fault_tolerance*
: Determines the fault tolerance constraint to be applied on the data placement policy of the YugabyteDB cluster. This flag can take on the following values - None, Zone, Region, and Cloud.
: Determines the fault tolerance constraint to be applied on the data placement policy of the YugabyteDB cluster. This flag can accept the following values - none, zone, region, and cloud.

--ui *bool*
: Enable or disable the webserver UI. Default is `false`.
: Enable or disable the webserver UI.
Default: `false`

#### Advanced Flags

Advanced flags can be set by using the configuration file in the `--config` flag. Following the advance flags support for the `start` command -
Advanced flags can be set by using the configuration file in the `--config` flag. The advance flags support for the `start` command is as follows:

--ycql_port *ycql-port*
: The port on which YCQL will run.
Expand All @@ -153,7 +153,8 @@ Advanced flags can be set by using the configuration file in the `--config` flag
: The port on which main webserver will run.

--callhome *bool*
: Enable or disable the "call home" feature that sends analytics data to Yugabyte. Default is `true`.
: Enable or disable the *call home* feature that sends analytics data to Yugabyte.
Default: `true`.

--master_flags *master_flags*
: Specify extra [master flags](../../../reference/configuration/yb-master#configuration-flags) as a set of key value pairs. Format (key=value,key=value).
Expand All @@ -178,7 +179,8 @@ Advanced flags can be set by using the configuration file in the `--config` flag
#### Deprecated Flags

--daemon *bool*
: Enable or disable running `yugabyted` in the background as a daemon. Does not persist on restart. Default is `true`.
: Enable or disable running `yugabyted` in the background as a daemon. Does not persist on restart.
Default: `true`.

--listen *bind-ip*
: The IP address or localhost name to which `yugabyted` will listen.
Expand All @@ -187,16 +189,15 @@ Advanced flags can be set by using the configuration file in the `--config` flag

### configure

Use the `yugabyted configure` command to configure the data placement constraints
on the YugabyteDB cluster.
Use the `yugabyted configure` command to configure the data placement constraints on the YugabyteDB cluster.

#### Syntax

```sh
Usage: yugabyted configure [flags]

Examples:
# create a multi zone YugabyteDB Cluster
# create a multi zone YugabyteDB cluster
yugabyted configure --fault_tolerance=zone
```

Expand All @@ -206,14 +207,13 @@ yugabyted configure --fault_tolerance=zone
: Print the command line help and exit.

--fault_tolerance *fault_tolerance*
: Specify the fault tolerance associated with cluster. This flag can take
the following values - zone, region, or cloud. `For example`: When the flag is configured with `zone`, `--fault_tolerance=zone`, Yugabyted will apply the `zone` data placement constraint on the YugabyteDB cluster to place the data in 3 different zones, if available.
: Specify the fault tolerance associated with cluster. This flag can accept one of these values - zone, region, or cloud. `For example`: When the flag is configured with `zone`, `--fault_tolerance=zone`, Yugabyted will apply the `zone` data placement constraint on the YugabyteDB cluster to place the data in 3 different zones, if available.

--data_placement_constraint *data-placement-constraint*
: Specify the data placement constraint to be applied on the YugabyteDB cluster. This is an optional flag. This flag takes the comma seperated values in the following format `cloud.region.zone`.
: Specify the data placement constraint to be applied on the YugabyteDB cluster. This is an optional flag. This flag takes the comma-seperated values in the format `cloud.region.zone`.

--rf *replication-factor*
: Specify the replication factor of the cluster. This is an optional flag. This takes value `3` or `5`.
: Specify the replication factor of the cluster. This is an optional flag which takes a value of `3` or `5`.

--config *config-file*
: The path to the configuration file of the yugabyted server that needs to be stopped.
Expand Down Expand Up @@ -358,7 +358,7 @@ Usage: yugabyted collect_logs [-h] [--config CONFIG]
: The data directory for the yugabyted server whose logs are desired.

--base_dir *base-directory*
: The base directory for the yugabyted server that whose logs are desired.
: The base directory for the yugabyted server whose logs are desired.

-----

Expand Down Expand Up @@ -529,37 +529,37 @@ bin/yugabyted destroy --base_dir=/Users/username/yugabyte-2.3.3.0/data3

#### Multi-node deployment

Create a multi-node cluster for YugabyteDB. Start the first Yugabyted node by running the `yugabyted start` command, pass in the `--cloud_location` and `--fault_tolerance` flag for setting the node location details. Run the following command -
Create a multi-node cluster for YugabyteDB. Start the first Yugabyted node by running the `yugabyted start` command, pass in the `--cloud_location` and `--fault_tolerance` flag for setting the node location details. Run the following command:

```sh
bin/yugabyted start --advertise_address=<host-ip> --cloud_location=aws.us-east.us-east-1a --fault_tolerance=zone
```

Start second and third node on two separate VMs -
Start the second and the third node on two separate VMs:

```sh
bin/yugabyted start --advertise_address=<host-ip> --join=<ip-address-first-yugabyted-node> --cloud_location=aws.us-east.us-east-2a --fault_tolerance=zone

bin/yugabyted start --advertise_address=<host-ip> --join=<ip-address-first-yugabyted-node> --cloud_location=aws.us-east.us-east-3a --fault_tolerance=zone
```

After starting the Yugabyted processes in all the Nodes, configure the data placement constraint of the YugabyteDB cluster:
After starting the Yugabyted processes on all the nodes, configure the data placement constraint of the YugabyteDB cluster:

```sh
bin/yugabyted configure --fault_tolerance=zone
```

This command will automatically determine the data placement constraint based on the `--cloud_location` of each node in the cluster. If there are 3 or more zones available in the cluster, configure command will be successful in configuring the cluster to survive at least 1 availability zone failure. Otherwise it will print out the appropriate warning messages.
This command will automatically determine the data placement constraint based on the `--cloud_location` of each node in the cluster. If there are 3 or more zones available in the cluster, configure command will be successful in configuring the cluster to survive at least 1 availability zone failure. Otherwise, it will print the appropriate warning messages.

Also the replication factor of the cluster will be default to `3`. Both of which can be manually set using `--data_placement_constraint` and `--rf` flags.
Also, the replication factor of the cluster will be set to a default of `3`.

Data placement constraint can be manually set with `--data_placement_constraint` flag which takes the comma separated value of `cloud.region.zone`. Example Usage:
The data placement constraint can be manually set with the `--data_placement_constraint` flag, which takes the comma-separated value of `cloud.region.zone`. An example usage is as follows:

```sh
bin/yugabyted configure --fault_tolerance=zone --data_placement_constraint=aws.us-east.us-east-1a,aws.us-east.us-east-2a,aws.us-east.us-east-3a
```

Replication factor of the YugabyteDB cluster can be manually set with `--rf` flag. Example Usage:
Replication factor of the YugabyteDB cluster can be manually set with `--rf` flag. An example usage is as follows:

```sh
./yugabyted configure --fault_tolerance=zone --data_placement_constraint=aws.us-east.us-east-1a,aws.us-east.us-east-2a,aws.us-east.us-east-3a --rf=3
Expand All @@ -573,31 +573,31 @@ Create a multi-node cluster for YugabyteDB. Start the first Yugabyted node by ru
bin/yugabyted start --advertise_address=<host-ip> --cloud_location=aws.us-east.us-east-1a --fault_tolerance=region
```

Start second and third node on two separate VMs -
Start the second and the third node on two separate VMs -

```sh
bin/yugabyted start --advertise_address=<host-ip> --join=<ip-address-first-yugabyted-node> --cloud_location=aws.us-west.us-west-1a --fault_tolerance=region

bin/yugabyted start --advertise_address=<host-ip> --join=<ip-address-first-yugabyted-node> --cloud_location=aws.us-central.us-central-1a --fault_tolerance=region
```

After starting the Yugabyted processes in all the Nodes, configure the data placement constraint of the YugabyteDB cluster:
After starting the Yugabyted processes on all the nodes, configure the data placement constraint of the YugabyteDB cluster:

```sh
bin/yugabyted configure --fault_tolerance=region
```

This command will automatically determine the data placement constraint based on the `--cloud_location` of each node in the cluster. If there are 3 or more regions available in the cluster, configure command will be successful in configuring the cluster to survive at least 1 region failure. Otherwise it will print out the appropriate warning messages.
This command will automatically determine the data placement constraint based on the `--cloud_location` of each node in the cluster. If there are 3 or more regions available in the cluster, configure command will be successful in configuring the cluster to survive at least 1 region failure. Otherwise, it will print the appropriate warning messages.

Also the replication factor of the cluster will be default to `3`. Both of which can be manually set using `--data_placement_constraint` and `--rf` flags.
Also, the replication factor of the cluster will be set to a default of `3`.

Data placement constraint can be manually set with `--data_placement_constraint` flag which takes the comma separated value of `cloud.region.zone`. Example Usage:
The data placement constraint can be manually set with `--data_placement_constraint` flag, which takes the comma-separated value of `cloud.region.zone`. An example usage is as follows:

```sh
bin/yugabyted configure --fault_tolerance=zone --data_placement_constraint=aws.us-east.us-east-1a,aws.us-west.us-west-1a,aws.us-central.us-central-1a
```

Replication factor of the YugabyteDB cluster can be manually set with `--rf` flag. Example Usage:
Replication factor of the YugabyteDB cluster can be manually set with `--rf` flag. An example usage is as follows:

```sh
./yugabyted configure --fault_tolerance=zone --data_placement_constraint=aws.us-east.us-east-1a,aws.us-west.us-west-1a,aws.us-central.us-central-1a --rf=3
Expand All @@ -607,19 +607,19 @@ Replication factor of the YugabyteDB cluster can be manually set with `--rf` fla

## YugabyteDB cluster upgrade

In order to use the latest features of the database and also apply the latest security fixes, it's prudent to upgrade your YugabyteDB cluster to the latest available release as when they are available. This sections talks about doing a rolling upgrade of your YugabyteDB cluster using yugabyted. Upgrading a existing YugabyteDB cluster will involve the following steps -
To use the latest features of the database and apply the latest security fixes, it's prudent to upgrade your YugabyteDB cluster to the latest available release when its available. This section describes about rolling out upgrades to your YugabyteDB cluster using yugabyted. Upgrading an existing YugabyteDB cluster includes the following steps:

- Step 1: [Download](https://download.yugabyte.com/) the latest release of YugabyteDB and extract the release to home directory
- Step 1: Download the current [YugabyteDB preview release](https://download.yugabyte.com/).

- Step 2: Stop the running YugabyteDB node using `yugabyted stop` command
- Step 2: Stop the running YugabyteDB node, using `yugabyted stop` command.

- Step 3: Start the new YugabyteDB process by executing the `yugabyted start` command from the `bin` directory. Use the previously configured `--base_dir` while restarting the YugabyteDB instance.

Repeat the above steps on all the nodes of a YugabyteDB cluster, one node at a time.

### Examples

#### Steps for upgrading a YugabyteDB cluster from Single zone to Multi Zone configuration
#### Steps for upgrading a YugabyteDB cluster from a single zone to a multi zone configuration

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

Expand All @@ -629,7 +629,7 @@ Repeat the above steps on all the nodes of a YugabyteDB cluster, one node at a t

These steps assume that you already have a running YugabyteDB cluster deployed using `yugabyted`.

Step 1: Stop the first node by using `yugabyted stop` command
Step 1: Stop the first node by using `yugabyted stop` command.

```sh
bin/yugabyted stop
Expand All @@ -643,15 +643,14 @@ Step 3: Start the YugabyteDB node by using `yugabyted start` command by providin
bin/yugabyted start --advertise_address=<host-ip> --cloud_location=aws.us-east.us-east-1a --fault_tolerance=zone
```

Repeat the above steps one by one on all the nodes of the YugabyteDB cluster. Once these steps are completed successfully, run the following
configure command to specify the data placement constraint on the cluster -
Repeat the above steps on all the nodes of a YugabyteDB cluster, one node at a time. After completing them successfully, run the following configure command, to specify the data placement constraint on the cluster:

```sh
bin/yugabyted configure --fault_tolerance=zone
```

For manually specifying the data placement constraint, use the below command -
For manually specifying the data placement constraint, use the following command:

```sh
./yugabyted configure --fault_tolerance=zone --data_placement_constraint=aws.us-east.us-east-1a,aws.us-east.us-east-2a,aws.us-east.us-east-3a --rf=3
```
```

0 comments on commit 8549a5e

Please sign in to comment.