Add basic architecture docs

2019-07-28 18:22:33 -04:00
parent 2f186f9d67
commit 67704198e4
3 changed files with 64 additions and 0 deletions
--- a/docs/architecture/api.md
+++ b/docs/architecture/api.md
@ -0,0 +1,7 @@
+# PVC API architecture
+
+The PVC API is a standalone client application for PVC. It interfaces directly with the Zookeeper database to manage state.
+
+The API is built using Flask and is packaged in the Debian package `pvc-client-api`. The API depends on the common client functions of the `pvc-client-common` package as does the CLI client.
+
+Details of the API interface can be found in [the manual](/manuals/api).