From a848ae411a7e3a69bf00042166392c5a0d45a7e0 Mon Sep 17 00:00:00 2001 From: opensource-tnbt Date: Tue, 27 Oct 2020 08:19:07 +0530 Subject: DOCS: Re-Organize Documentation. This patch organizes documentation for Jerma Release. Signed-off-by: Sridhar K. N. Rao Change-Id: I653c8c4b4e0092059f19314631a0fcab4941e134 --- .../userguide/docker/sdvconfig/user/userguide.rst | 42 ++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/release/userguide/docker/sdvconfig/user/userguide.rst (limited to 'docs/release/userguide/docker/sdvconfig/user/userguide.rst') diff --git a/docs/release/userguide/docker/sdvconfig/user/userguide.rst b/docs/release/userguide/docker/sdvconfig/user/userguide.rst new file mode 100644 index 0000000..f38303d --- /dev/null +++ b/docs/release/userguide/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. -- cgit 1.2.3-korg