diff options
| author |   opensource-tnbt <sridhar.rao@spirent.com> | 2020-11-30 23:30:03 +0530 |
|---|---|---|
| committer | opensource-tnbt <sridhar.rao@spirent.com> | 2020-11-30 23:31:22 +0530 |
| commit | e0a327b8e02c9202732752cbb14ca4900c49bc52 (patch) | |
| tree | 6dbdcf171ace5d1084f719e609f557646e5f293c /docs/urls | |
| parent | a848ae411a7e3a69bf00042166392c5a0d45a7e0 (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/urls')
| -rw-r--r-- | docs/urls/userguide.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/urls/userguide.rst b/docs/urls/userguide.rst new file mode 100644 index 0000000..15d0724 --- /dev/null +++ b/docs/urls/userguide.rst @@ -0,0 +1,24 @@ +******************************************************** +CIRV-SDV: Validating the URLs in the Installer Manifests +******************************************************** + +Supported Installer Manifest: Airship. + +Building and starting the container: +* Go to folder sdv/docker/sdvurls +* Build the container with 'docker build' command. Consider naming/tagging the container properly. +* Run the container using docker run. The container creates a report under /tmp folder. Hence, consider mapping a volume to '/tmp' folder to get the report. + + +Interacting with the container +############################## +Inputs: + +* Installer Used. Keyword: "installer". Example Value: "airship". This is mandatory +* Link to the installer manifests. Keyword: "link". Example Value: "https://gerrit.opnfv.org/gerrit/airship". This is mandatory +* Version (For Airship, this refers to Treasuremap Version). Keyword: "version". Example Value: "v1.7". This is mandatory only for Airship. +* Name of the site. Keyword: "name". Example Value: "intel-pod10". This is mandatory only for Airship + +Assuming the container is running locally, the example command would be:: + + curl --header "Content-Type: application/json" --redata '{"installer":"airship", "link":"https://gerrit.opnfv.org/gerrit/airship", "version":"v1.7", "name":"intel-pod10"}' http://localhost:8989/airship |