diff options
| author |   Parth Yadav <parth.yadav@ramanujan.du.ac.in> | 2020-12-01 02:16:35 +0530 |
|---|---|---|
| committer | Parth Yadav <parth.yadav@ramanujan.du.ac.in> | 2020-12-01 02:17:48 +0530 |
| commit | f2aba340057a67a3b159aae36427bc60f49fd832 (patch) | |
| tree | ef0d744fb0e310304005f7e2657904f9d6449461 /docs/state/user/userguide.rst | |
| parent | e0a327b8e02c9202732752cbb14ca4900c49bc52 (diff) | |
Update Documentation
Signed-off-by: Parth Yadav<parthyadav3105@gmail.com>
Change-Id: I8d1f0fab022b54c26001cb78318340472d4023d2
Diffstat (limited to 'docs/state/user/userguide.rst')
| -rw-r--r-- | docs/state/user/userguide.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/state/user/userguide.rst b/docs/state/user/userguide.rst new file mode 100644 index 0000000..ef95584 --- /dev/null +++ b/docs/state/user/userguide.rst @@ -0,0 +1,22 @@ +==================== +SDVState User Guide +==================== + +Currently, SDVState supports validation of Airship 1.7. Before running checks you need two files: + - kubeconfig file which gives access to clusterAPI of Airship cluster. + - PDF(Pod Descriptor File) of the current Airship deployment. + +Create a config file of SDVState using the above files as values. Look at example conf-file at sdv/docker/sdvstate/example/state.yml + +To run checks use command: + + ``./state --conf-file state.yml`` + +The checks should complete in 11-14~ seconds. + +After running checks, you can find all results at ``/tmp`` directory by default. + +SDVState uses default settings stored at sdv/docker/sdvstate/settings. We can override default settings by adding those in our conf-file. + +To view help and all available options with the SDVState tool check help command: + ``./state --help``
\ No newline at end of file |