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

Revamp architecture documentation

Browse Source 
Include completed provisioner documentation as well as updated CLI and
cluster architecture descriptions.
This commit is contained in:
Joshua Boniface
2020-01-12 21:11:25 -05:00
parent b68f09f787
commit c42ff46de9
3 changed files with 175 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/architecture/cli.md
View File

@ -1,7 +1,7 @@
# PVC CLI architecture
The PVC CLI is a standalone client application for PVC. It interfaces directly with the Zookeeper database to manage state.
The PVC CLI is a standalone client application for PVC. It interfaces with the PVC API, via a configurable list of clusters with customizable hosts, ports, addresses, and authentication.
The CLI is build using Click and is packaged in the Debian package `pvc-client-cli`. The CLI depends on the common client functions of the `pvc-client-common` package.
The CLI is build using Click and is packaged in the Debian package `pvc-client-cli`. The CLI does not depend on any other PVC components and can be used independently on arbitrary systems.
The CLI is self-documenting, however [the manual](/manuals/cli) details the required configuration.