diff options
author | 2020-08-18 21:20:37 +0530 | |
---|---|---|
committer | 2020-09-10 00:16:17 +0530 | |
commit | b189119586d1d3cf176c31402daa4b34830ec48b (patch) | |
tree | 93edc86b5d4c06df38d7c3ace74a13f7ba5fda2b /sdv/docs/docker/sdvconfig/user/userguide.rst | |
parent | 69f4c631e49c359338cff5c9f5b2c96c6fe6b280 (diff) |
sdv-prevalidation: added src, mapping, documentation, Dockerfile, and server files
Signed-off-by: Ashwin Nayak<ashwinnayak111@gmail.com>
Change-Id: I81ae24169a5f8ff79d2c129f30daf5c9f04e5da9
Diffstat (limited to 'sdv/docs/docker/sdvconfig/user/userguide.rst')
-rw-r--r-- | sdv/docs/docker/sdvconfig/user/userguide.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/sdv/docs/docker/sdvconfig/user/userguide.rst b/sdv/docs/docker/sdvconfig/user/userguide.rst new file mode 100644 index 0000000..f38303d --- /dev/null +++ b/sdv/docs/docker/sdvconfig/user/userguide.rst @@ -0,0 +1,42 @@ +========= +SDVConfig +========= +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. |