diff options
| author |   opensource-tnbt <sridhar.rao@spirent.com> | 2020-10-27 08:19:07 +0530 |
|---|---|---|
| committer | opensource-tnbt <sridhar.rao@spirent.com> | 2020-10-27 08:21:39 +0530 |
| commit | a848ae411a7e3a69bf00042166392c5a0d45a7e0 (patch) | |
| tree | e4036c81351cdf76ab4e0bce1c7d7a977436ca41 /sdv/docs/docker/sdvconfig/user/userguide.rst | |
| parent | f12039ae1fb9ed773ddf3d8000c6645e5900c48e (diff) | |
DOCS: Re-Organize Documentation.
This patch organizes documentation for Jerma Release.
Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
Change-Id: I653c8c4b4e0092059f19314631a0fcab4941e134
Diffstat (limited to 'sdv/docs/docker/sdvconfig/user/userguide.rst')
| -rw-r--r-- | sdv/docs/docker/sdvconfig/user/userguide.rst | 42 |
1 files changed, 0 insertions, 42 deletions
diff --git a/sdv/docs/docker/sdvconfig/user/userguide.rst b/sdv/docs/docker/sdvconfig/user/userguide.rst deleted file mode 100644 index f38303d..0000000 --- a/sdv/docs/docker/sdvconfig/user/userguide.rst +++ /dev/null @@ -1,42 +0,0 @@ -========= -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. |