parallelvirtualcluster/pvc
1
0
Fork 0
Code Issues 11 Pull Requests Projects Releases 114 Wiki Activity

Update manuals with current information

Browse Source
This commit is contained in:
Joshua Boniface
2020-01-12 21:32:02 -05:00
parent c42ff46de9
commit 1665113ed4
3 changed files with 156 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/manuals/cli.md
View File

@ -1,9 +1,11 @@
# PVC CLI client manual
The PVC CLI client is built with Click, a Python framework for creating self-documenting CLI applications. It interfaces directly with the Zookeeper cluster to send and receive information about the cluster with no authentication.
The PVC CLI client is built with Click, a Python framework for creating self-documenting CLI applications. It interfaces with the PVC API.
Use the `-h` option at any level of the `pvc` CLI command to receive help about the available commands and options.
Before using the CLI on a non-PVC node system, at least one cluster must be added using the `pvc cluster` subcommands. Running the CLI on hosts which also run the PVC API (via its configuration at `/etc/pvc/pvc-api.yaml`) uses the special `local` cluster, reading information from the API configuration, by default.
## Configuration
The CLI client requires no configuration file. The only optional external environment variable is `PVC_ZOOKEEPER_HOST`, which accepts a Zookeeper connection string and replaces the argument `-z` to the CLI command.
The CLI client requires no configuration file. The only optional external environment variable is `PVC_CLUSTER`, which can be used to specify a cluster to connect to.