Skip to content

Commit

Permalink
Update readme for CLI homebrew (uber#4135)
Browse files Browse the repository at this point in the history
Docs change only.
  • Loading branch information
longquanzheng authored Apr 16, 2021
1 parent d53e631 commit 45ef498
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 40 deletions.
2 changes: 1 addition & 1 deletion docs/setup/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Connected to Test Cluster at 127.0.0.1:9042.
Use HELP for help.
cqlsh>
```
>If you are running Cadence on top of [Mysql](MYSQL_SETUP.md) or [Postgres](POSTGRES_SETUP.md), you can follow the instructions to run the SQL DB and then run:
>If you are running Cadence on top of [Mysql](docs/setup/MYSQL_SETUP.md) or [Postgres](docs/setup/POSTGRES_SETUP.md), you can follow the instructions to run the SQL DB and then run:
Now you can setup the database schema
```bash
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,19 @@ Other clients are developed by community:
* [Ruby Client](https://github.com/coinbase/cadence-ruby)

### Use CLI Tools
Use [Cadence command-line tool](tools/cli/README.md) to perform various tasks on Cadence server cluster

For [manual setup or upgrading](docs/persistence.md) server schema --
* Use [Cadence command-line tool](https://cadenceworkflow.io/docs/cli/) to perform various tasks on Cadence server cluster
* Use brew to install CLI: `brew install cadence-workflow`
* Use docker image for CLI: `docker run --rm ubercadence/cli:master `. Be sure to update your image when you want to try new features: `docker pull ubercadence/cli:master `
* Check out the repo and run `make cadence` to build all tools. See [CONTRIBUTING](CONTRIBUTING.md) for prerequisite of make command.


* For [manual setup or upgrading](docs/persistence.md) server schema --
* Use brew to install CLI: `brew install cadence-workflow` which also includes `cadence-sql-tool` and `cadence-cassandra-tool`
* If server runs with Cassandra, Use [Cadence Cassandra tool](tools/cassandra/README.md) to perform various tasks on database schema of Cassandra persistence
* If server runs with SQL database, Use [Cadence SQL tool](tools/sql/README.md) to perform various tasks on database schema of SQL based persistence

* If server runs with Cassandra, Use [Cadence Cassandra tool](tools/cassandra/README.md) to perform various tasks on database schema of Cassandra persistence
* If server runs with SQL database, Use [Cadence SQL tool](tools/sql/README.md) to perform various tasks on database schema of SQL based persistence

TIPS: Run `make tools` to build all tools mentioned above.
> NOTE: See [CONTRIBUTING](docs/setup/CONTRIBUTING.md) for prerequisite of make command.
> Tips: Use `make tools` to build all tools
### Use Cadence Web

Expand All @@ -57,7 +61,7 @@ Join us in [Cadence Docs](https://github.com/uber/cadence-docs) project. Raise a

## Contributing

We'd love your help in making Cadence great. Please review our [contribution guide](docs/setup/CONTRIBUTING.md).
We'd love your help in making Cadence great. Please review our [contribution guide](CONTRIBUTING.md).

If you'd like to propose a new feature, first join the [Slack channel](http://t.uber.com/cadence-slack) to start a discussion and check if there are existing design discussions. Also peruse our [design docs](docs/design/index.md) in case a feature has been designed but not yet implemented. Once you're sure the proposal is not covered elsewhere, please follow our [proposal instructions](PROPOSALS.md).

Expand Down
2 changes: 1 addition & 1 deletion bench/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Setup
### Cadence server
Bench tests requires Cadence server with ElasticSearch. You can run it through:
- Docker: Instructions for running Cadence server through docker can be found in `docker/README.md`. Either `docker-compose-es-v7.yml` or `docker-compose-es.yml` can be used to start the server.
- Build from source: Please check `docs/setup/CONTRIBUTING.md` for how to build and run Cadence server from source. Please also make sure Kafka and ElasticSearch are running before starting the server with `./cadence-server --zone es start`. If ElasticSearch v7 is used, change the value for `--zone` flag to `es_v7`.
- Build from source: Please check [CONTRIBUTING](/CONTRIBUTING.md) for how to build and run Cadence server from source. Please also make sure Kafka and ElasticSearch are running before starting the server with `./cadence-server --zone es start`. If ElasticSearch v7 is used, change the value for `--zone` flag to `es_v7`.

### Search Attributes
One of the bench tests (called `Cron`), which is responsible for running other tests as a cron job and tracking the results, requires an search attribute named `Passed`.
Expand Down
2 changes: 1 addition & 1 deletion docs/persistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ brew services start cassandra
cd $GOPATH/github.com/uber/cadence
make install-schema
```
> NOTE: See [CONTRIBUTING](../CONTRIBUTING.md) for prerequisite of make command.
> NOTE: See [CONTRIBUTING](/CONTRIBUTING.md) for prerequisite of make command.
>
### Start cadence server
```
Expand Down
10 changes: 5 additions & 5 deletions tools/cassandra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ This package contains the tooling for cadence cassandra operations.
```
make install-schema
```
> NOTE: See [CONTRIBUTING](../../CONTRIBUTING.md) for prerequisite of make command.
> NOTE: See [CONTRIBUTING](/CONTRIBUTING.md) for prerequisite of make command.
## For production

### Create the binaries
- Run `make cadence-cassandra-tool`
- You should see an executable `cadence-cassandra-tool`
### Get the Cassandra Schema tool
* Use brew to install CLI: `brew install cadence-workflow` which includes `cadence-cassandra-tool`
* Or build yourself, with `make cadence-cassandra-tool`. See [CONTRIBUTING](/CONTRIBUTING.md) for prerequisite of make command.

> NOTE: See [CONTRIBUTING](../../CONTRIBUTING.md) for prerequisite of make command.
> Note: The binaries can also be found in the `ubercadence/server` docker images
### Do one time database creation and schema setup for a new cluster
This uses Cassandra's SimpleStratagey for replication. For production, we recommend using a replication factor of 3 with NetworkTopologyStrategy.
Expand Down
16 changes: 0 additions & 16 deletions tools/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
Documentation for the Cadence command line interface is located at our [main site](https://cadenceworkflow.io/docs/cli/).

## Quick Start
Run `make cadence` from the project root. You should see an executable file called `cadence`. Try a few example commands to
get started:
`./cadence` for help on top level commands and global options
`./cadence domain` for help on domain operations
`./cadence workflow` for help on workflow operations
`./cadence tasklist` for help on tasklist operations
(`./cadence help`, `./cadence help [domain|workflow]` will also print help messages)

**Note:** Make sure you have a Cadence server running before using the CLI.

## Homebrew
Cadence CLI homebrew formula is maintain by [a community project](https://github.com/git-hulk/homebrew-cadence):
```
% brew tap git-hulk/cadence
% brew install cadence-cli
```
12 changes: 4 additions & 8 deletions tools/sql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,13 @@ the sql interface. So, this same tool can be used against, say, OracleDB and MyS
```
SQL_USER=$USERNAME SQL_PASSWORD=$PASSWD make install-schema-mysql
```
> NOTE: See [CONTRIBUTING](../../CONTRIBUTING.md) for prerequisite of make command.
> NOTE: See [CONTRIBUTING](/CONTRIBUTING.md) for prerequisite of make command.
## For production

### Create the binaries
- Run `make cadence-sql-tool`
- You should see an executable `cadence-sql-tool`
- Cadence officially support MySQL and Postgres for SQL.
- For other SQL database, you can add it easily as we do for MySQL/Postgres following our code in sql-extensions

> NOTE: See [CONTRIBUTING](../../CONTRIBUTING.md) for prerequisite of make command.
### Get the SQL Schema tool
* Use brew to install CLI: `brew install cadence-workflow` which includes `cadence-sql-tool`
* Or build yourself, with `make cadence-sql-tool`. See [CONTRIBUTING](/CONTRIBUTING.md) for prerequisite of make command.

> Note: The binaries can also be found in the `ubercadence/server` docker images
Expand Down

0 comments on commit 45ef498

Please sign in to comment.