Skip to content

Commit f102ac6

Browse files
committed
Updated the cluster command to the new syntax with a ,
1 parent e67d287 commit f102ac6

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

src/docs/03-concepts/08-cross-dc-replication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The best way is to use Cadence [docker-compose](https://github.com/uber/cadence/
116116

117117
## Running in Production
118118

119-
Enable global domain feature needs to be enabled in [static config](/docs/operation-guide/setup/#static-configs).
119+
Enable global domain feature needs to be enabled in [static config](/docs/operation-guide/setup/#static-configs).
120120

121121
Here we use clusterDCA and clusterDCB as an example. We pick clusterDCA as the primary(used to called "master") cluster.
122122
The only difference of being a primary cluster is that it is responsible for domain registration. Primary can be changed later but it needs to be the same across all clusters.
@@ -173,13 +173,13 @@ clusterMetadata:
173173
After the configuration is deployed:
174174
175175
1. Register a global domain
176-
`cadence --do <domain_name> domain register --global_domain true --clusters clusterDCA clusterDCB --active_cluster clusterDCA`
176+
`cadence --do <domain_name> domain register --global_domain true --clusters clusterDCA,clusterDCB --active_cluster clusterDCA`
177177

178178

179179
2. Run some workflow and failover domain from one to another
180180
`cadence --do <domain_name> domain update --active_cluster clusterDCB`
181181

182-
Then the domain should be failed over to clusterDCB. Now worklfows are read-only in clusterDCA. So your workers polling tasks from clusterDCA will become idle.
182+
Then the domain should be failed over to clusterDCB. Now worklfows are read-only in clusterDCA. So your workers polling tasks from clusterDCA will become idle.
183183

184184
Note 1: that even though clusterDCA is standy/read-only for this domain, it can be active for another domain. So being active/standy is per domain basis not per clusters. In other words, for example if you use XDC in case of DC failure of clusterDCA, you need to failover all domains from clusterDCA to clusterDCB.
185185

src/docs/06-cli/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ After the installation is done, you can use CLI:
2121
```
2222
cadence --help
2323
```
24-
This will always install the latest version. Follow [this instructions](https://github.com/uber/cadence/discussions/4457) if you need to install older versions of Cadence CLI.
24+
This will always install the latest version. Follow [this instructions](https://github.com/uber/cadence/discussions/4457) if you need to install older versions of Cadence CLI.
2525

2626
### Docker
2727
The Cadence :CLI: can be used directly from the Docker Hub image *ubercadence/cli* or by building the :CLI: tool
@@ -36,9 +36,9 @@ docker run -it --rm ubercadence/cli:master --address <frontendAddress> --domain
3636
```bash
3737
docker run -it --rm ubercadence/cli:<version> --address <frontendAddress> --domain samples-domain domain describe
3838
```
39-
For example `docker run --rm ubercadence/cli:0.21.3 --domain samples-domain domain describe` will be the CLI that is released as part of the [v0.21.3 release](https://github.com/uber/cadence/releases/tag/v0.21.3).
40-
See [docker hub page](https://hub.docker.com/r/ubercadence/cli/tags?page=1&ordering=last_updated) for all the CLI image tags.
41-
Note that CLI versions of 0.20.0 works for all server versions of 0.12 to 0.19 as well. That's because [the CLI version doesn't change in those versions](https://stackoverflow.com/questions/68217385/what-is-clientversionnotsupportederror-and-how-to-resolve-it).
39+
For example `docker run --rm ubercadence/cli:0.21.3 --domain samples-domain domain describe` will be the CLI that is released as part of the [v0.21.3 release](https://github.com/uber/cadence/releases/tag/v0.21.3).
40+
See [docker hub page](https://hub.docker.com/r/ubercadence/cli/tags?page=1&ordering=last_updated) for all the CLI image tags.
41+
Note that CLI versions of 0.20.0 works for all server versions of 0.12 to 0.19 as well. That's because [the CLI version doesn't change in those versions](https://stackoverflow.com/questions/68217385/what-is-clientversionnotsupportederror-and-how-to-resolve-it).
4242

4343
NOTE: On Docker versions 18.03 and later, you may get a "connection refused" error when connecting to local server. You can work around this by setting the host to "host.docker.internal" (see [here](https://docs.docker.com/docker-for-mac/networking/#use-cases-and-workarounds) for more info).
4444

@@ -55,17 +55,17 @@ docker exec -it docker_cadence_1 /bin/bash
5555
# cadence --address $(hostname -i):7933 --do samples domain register
5656
```
5757

58-
### Build it yourself
58+
### Build it yourself
5959
To build the :CLI: tool locally, clone the [Cadence server repo](https://github.com/uber/cadence), check out the version tag (e.g. `git checkout v0.21.3`) and run
6060
`make tools`. This produces an executable called `cadence`. With a local build, the same command to
6161
describe a :domain: would look like this:
6262
```bash
6363
cadence --domain samples-domain domain describe
6464
```
6565

66-
Alternatively, you can build the CLI image, see [instructions](docker/README.md#diy-building-an-image-for-any-tag-or-branch)
66+
Alternatively, you can build the CLI image, see [instructions](docker/README.md#diy-building-an-image-for-any-tag-or-branch)
6767

68-
## Documentation
68+
## Documentation
6969
CLI are documented by `--help` or `-h` in ANY tab of all levels:
7070

7171
```
@@ -94,7 +94,7 @@ GLOBAL OPTIONS:
9494
--help, -h show help
9595
--version, -v print the version
9696
```
97-
And
97+
And
9898
```
9999
$cadence workflow -h
100100
NAME:
@@ -173,11 +173,11 @@ Run `cadence tasklist` for help on tasklist operations
173173
```bash
174174
cadence --domain samples-domain domain register
175175
# OR using short alias
176-
cadence --do samples-domain d re
176+
cadence --do samples-domain d re
177177
```
178178
If your Cadence cluster has enable [global domain(XDC replication)](https://cadenceworkflow.io/docs/concepts/cross-dc-replication/), then you have to specify the replicaiton settings when registering a domain:
179179
```bash
180-
cadence --domains amples-domain domain register --active_cluster clusterNameA --clusters clusterNameA clusterNameB
180+
cadence --domains amples-domain domain register --active_cluster clusterNameA --clusters clusterNameA,clusterNameB
181181
```
182182

183183
- View "samples-domain" details:

0 commit comments

Comments
 (0)