aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sdvconfig/user/userguide.rst
diff options
context:
space:
mode:
authoropensource-tnbt <sridhar.rao@spirent.com>2020-11-30 23:30:03 +0530
committeropensource-tnbt <sridhar.rao@spirent.com>2020-11-30 23:31:22 +0530
commite0a327b8e02c9202732752cbb14ca4900c49bc52 (patch)
tree6dbdcf171ace5d1084f719e609f557646e5f293c /docs/sdvconfig/user/userguide.rst
parenta848ae411a7e3a69bf00042166392c5a0d45a7e0 (diff)
DOCS: Update the Documentation.
This patch updates the documentation for Jerma. Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com> Change-Id: Ic0d61a74b1c8d31c8facaa16837894fc816ac739
Diffstat (limited to 'docs/sdvconfig/user/userguide.rst')
-rw-r--r--docs/sdvconfig/user/userguide.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/sdvconfig/user/userguide.rst b/docs/sdvconfig/user/userguide.rst
new file mode 100644
index 0000000..917ea8d
--- /dev/null
+++ b/docs/sdvconfig/user/userguide.rst
@@ -0,0 +1,42 @@
+====================
+SDVConfig User Guide
+====================
+Welcome to the SDVConfig user Guide!
+
+Who should use this guide?
+
+If you are searching for a way to run the sdvconfig code and don't know how, this guide is for you.
+
+Currently there exists two functionalities, extrapolation and validation.
+
+To do a extrapolate POST request, use following command.
+
+```
+curl --header "Content-Type: application/json" --request POST --data '{"pdf_fn":"<>", "store_at":"<>"}' http://localhost:8000/extrapolate
+```
+
+To run this on commandline, use the following command
+
+```
+python extrapolation.py --pdf_fn="path/to/pdf_fn" --store-at="path/to/storage"
+```
+
+The pdf_fn key expects absolute filepath to pdf or a raw github file url.
+the store_at key expects absolute filepath to which the new generated pdf should be stored at.
+
+To do a validation POST request, use following command
+
+```
+curl --header "Content-Type: application/json" --request POST --data '{"pdf_file":"<>", "inst_dir":"<>", "inst_type":"<>", "sitename":"<>"}' http://localhost:8000/validate
+```
+
+To run this on commandline, use the following command.
+
+```
+python cli_validation.py --inst_dir=path/to/mani_dir --inst_type=type --pdf=path/to/pdf --sitename=sitename
+```
+
+The pdf_file key expects absolute filepath to pdf or a raw github file url.
+The inst_dir key expects absolute filepath to installer directory or a github clone url.
+The inst_type key expects installer type string ("airship", "tripleo", etc.)
+sitename: intel-pod10, intel-pod15 etc.