diff options
| -rw-r--r-- | deployment/http/web/images/onap-cli-ad-1.png | bin | 0 -> 99553 bytes | |||
| -rw-r--r-- | deployment/http/web/images/onap-cli-ad-2.png | bin | 0 -> 322649 bytes | |||
| -rw-r--r-- | deployment/http/web/images/onap-cli-ad-3.png | bin | 0 -> 138512 bytes | |||
| -rw-r--r-- | deployment/http/web/images/onap-cli-ad-4.png | bin | 0 -> 152808 bytes | |||
| -rw-r--r-- | deployment/http/web/images/onap-cli-ad-5.png | bin | 0 -> 163765 bytes | |||
| -rw-r--r-- | deployment/http/web/images/onap-cli-ad-6.png | bin | 0 -> 183224 bytes | |||
| -rw-r--r-- | deployment/http/web/index.html | 123 | ||||
| -rw-r--r-- | docs/OOM_and_HEAT_based_deployment.rst | 2 | ||||
| -rw-r--r-- | docs/developer_guide.rst | 53 | ||||
| -rw-r--r-- | docs/images/portal-cli-app.png | bin | 70566 -> 177080 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-arch.png | bin | 135975 -> 253879 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-dowload.png | bin | 70566 -> 178221 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-shell.png | bin | 60357 -> 76348 bytes | |||
| -rw-r--r-- | docs/images/portal-cli-web-con.png | bin | 101711 -> 121037 bytes | |||
| -rw-r--r-- | docs/release-notes.rst | 45 |
15 files changed, 146 insertions, 77 deletions
diff --git a/deployment/http/web/images/onap-cli-ad-1.png b/deployment/http/web/images/onap-cli-ad-1.png Binary files differnew file mode 100644 index 00000000..a26529e5 --- /dev/null +++ b/deployment/http/web/images/onap-cli-ad-1.png diff --git a/deployment/http/web/images/onap-cli-ad-2.png b/deployment/http/web/images/onap-cli-ad-2.png Binary files differnew file mode 100644 index 00000000..f1683ee9 --- /dev/null +++ b/deployment/http/web/images/onap-cli-ad-2.png diff --git a/deployment/http/web/images/onap-cli-ad-3.png b/deployment/http/web/images/onap-cli-ad-3.png Binary files differnew file mode 100644 index 00000000..1ae855de --- /dev/null +++ b/deployment/http/web/images/onap-cli-ad-3.png diff --git a/deployment/http/web/images/onap-cli-ad-4.png b/deployment/http/web/images/onap-cli-ad-4.png Binary files differnew file mode 100644 index 00000000..f019527d --- /dev/null +++ b/deployment/http/web/images/onap-cli-ad-4.png diff --git a/deployment/http/web/images/onap-cli-ad-5.png b/deployment/http/web/images/onap-cli-ad-5.png Binary files differnew file mode 100644 index 00000000..280511c7 --- /dev/null +++ b/deployment/http/web/images/onap-cli-ad-5.png diff --git a/deployment/http/web/images/onap-cli-ad-6.png b/deployment/http/web/images/onap-cli-ad-6.png Binary files differnew file mode 100644 index 00000000..dc12b6df --- /dev/null +++ b/deployment/http/web/images/onap-cli-ad-6.png diff --git a/deployment/http/web/index.html b/deployment/http/web/index.html index 9eece011..ca4d0445 100644 --- a/deployment/http/web/index.html +++ b/deployment/http/web/index.html @@ -4,56 +4,103 @@ function redirectToConsole(){ window.location.href="http://"+ window.location.hostname + ":9090"; } + +var slideIndex = 0; + +function showSlides() { + var i; + var slides = document.getElementsByClassName("mySlides"); + for (i = 0; i < slides.length; i++) { + slides[i].style.display = "none"; + } + slideIndex++; + if (slideIndex > slides.length) {slideIndex = 1} + slides[slideIndex-1].style.display = "block"; + setTimeout(showSlides, 2000); // Change image every 2 seconds +} + </script> +<style> + +body { + margin: 0 1% 0; + background-color: black +} + +.readme { + display: inline-block; + float: left; + color: white +} + +* {box-sizing:border-box} + +.slideshow-container { + display: inline-block; + float: right; + max-width: 700px; + position: relative; + margin: 5% 3% 0; +} + +.mySlides { + display: none; +} + +</style> + </head> -<body id="preview"> -<h1><a id="ONAP_Commandline_interface_CLI_0"></a>ONAP Command-line interface (CLI)</h1> -<p style="color:blue"><strong>One Command to command whole Onap !!</strong></p> -<p>Provides unified commands to operate ONAP from Linux console and Web console.</p> +<body onload="showSlides()"> +<div class="readme"> +<h1>ONAP Command-Line Interface (CLI)</h1> + +<p style="color: blue;"><strong>One Command to command whole Onap !!</strong></p> +<p>Provides unified commands to operate ONAP using CLI.</p> +<p>Powered by Open CLI Platform (OCLIP)</p> +<p><a href="http://onap.readthedocs.io/en/latest/submodules/cli.git/docs/index.htmlhttps://wiki.onap.org" +target="_blank" rel="noopener">More details</a></p> +<br> -<h2><a id="Download_42"></a>To download</h2> -<p style="color:red">Please download ONAP CLI <a href="./onap-cli.zip">here</a></p> +<h2 >Web Command Console</h2> +<p>To access ONAP shell from browser, <button class="button" onclick="redirectToConsole();">Click Me !</button></p> +<br> -<h3><a id="Download_42"></a>To install</h3> +<h2>Linux Command Shell</h2> <p>Please follow the instructions given below for installing ONAP CLI.</p> <ol> -<li>Un-zip the above download file into <b>/opt/onap/cli folder</b></li> -<li>Run the following commands: -<br>export ONAP_CLI_HOME=$CLI_INSTALL_DIR -<br>export CLI_PRODUCT_VERSION=onap-1.1 -<br> -<br>cd $CLI_INSTALL_DIR -<br> -<br>if [ ! -d ./data ]; then mkdir ./data; fi -<br>if [ ! -d ./onap-cli-schema ]; then mkdir ./onap-cli-schema; fi -<br> -<br>chmod +x ./bin/onap.sh -<br> -<br>#Make onap available in path -<br>ln ./bin/onap.sh $CLI_BIN -<br> -<br>#Print the version -<br>onap -v</li> +<li>Download ONAP CLI <a href="./onap-cli.zip">here</a></li> +<li>Un-zip into folder <strong>/opt/onap/cli</strong></li> +<li>Run command <strong>/opt/onap/cli/cli-init.sh</strong></li> +<li>For more details, refer <strong>/opt/onap/cli/README.md</strong></li> </ol> +<br> +</div> -<h2><a id="Console_42"></a>Web Command console</h2> -<p style="color:blue">To open Console, Click <img src="./onap-cli.png" alt="Web Command console" style="width:30px;height:22px;" onclick="redirectToConsole();"> </p> +<div class="slideshow-container"> + <div class="mySlides"> + <img src="images/onap-cli-ad-1.png" style="width:100%"> + </div> -<h2><a id="To_Run_a_command_12"></a>To Run a command</h2> + <div class="mySlides"> + <img src="images/onap-cli-ad-2.png" style="width:100%"> + </div> -<p>Configure the following environment variables, before using it in Linux console:</p> -<ol> -<li><strong>ONAP_HOST_URL</strong> - Onap service URL</li> -<li><strong>ONAP_USERNAME</strong> - Onap user name</li> -<li><strong>ONAP_PASSWORD</strong> - Onap user password</li> -</ol> + <div class="mySlides"> + <img src="images/onap-cli-ad-3.png" style="width:100%"> + </div> + + <div class="mySlides"> + <img src="images/onap-cli-ad-4.png" style="width:100%"> + </div> -<p>Type <strong>onap <command></strong> from Linux console.</p> + <div class="mySlides"> + <img src="images/onap-cli-ad-5.png" style="width:100%"> + </div> -<h2><a id="To_Run_in_Interactive_mode_16"></a>To Run in Interactive mode</h2> -<p>Type <strong>onap</strong> from linux console</p> + <div class="mySlides"> + <img src="images/onap-cli-ad-6.png" style="width:100%"> + </div> -<h2><a id="More_details_42"></a>More details</h2> -<p><a href="https://wiki.onap.org">https://wiki.onap.org</a></p> +</div> </body></html>
\ No newline at end of file diff --git a/docs/OOM_and_HEAT_based_deployment.rst b/docs/OOM_and_HEAT_based_deployment.rst index 14197f8a..52e1aad4 100644 --- a/docs/OOM_and_HEAT_based_deployment.rst +++ b/docs/OOM_and_HEAT_based_deployment.rst @@ -13,7 +13,7 @@ HEAT based deployment ---------------------- As part of HEAT based deployment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is -successfully installed, it will be available at http://portal_vm-ip:8080 +successfully installed, it will be available at http://portal.api.simpledemo.openecomp.org:8080 To troubleshoot any issues in CLI, please login to portal_vm and CLI docker runs with image onap/cli diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index e345e624..2e2278e5 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -87,6 +87,57 @@ Follow the steps below to implement new commands in ONAP using YAML: #. Use the command 'onap schema-validate' to validate the YAML before testing its functionality. -#. Run 'onap schema-refresh' command to take the new YAML file. We recommed validating the YAML before running this command. +#. Run 'onap schema-refresh' command to take the new YAML file. We recommended validating the YAML before running this command. #. To test this command, run the command 'onap CMD-NAME --help'. + +Sample YAML +~~~~~~~~~~~~ + +Find more details about YAML specification at :ref:`open_cli_schema_version_1_0`. + +Sample hello-world YAML :: + + open_cli_schema_version: 1.0 + + name: hello-world-http + + description: First cmd hello world using http running under lighttpd in cli at http://<cli-ip>:8080/version.json + + version: sample-1.0 + + service: + name: sample-service + version: 1.0.0 + auth: none + mode: direct + + parameters: + - name: name + description: name of the person + long_option: name + short_option: b + default_value: ${DEMO_NAME} + type: string + is_optional: false + + results: + direction: landscape + attributes: + - name: output + description: hello world output + type: string + scope: short + + http: + request: + uri: /version.json + method: GET + success_codes: + - 200 + - 201 + result_map: + output: Hello ${name}, You are running on $b{$.name} $b{$.version} + + sample_response: + body: {"name": "oclip", "version": "1.0"} diff --git a/docs/images/portal-cli-app.png b/docs/images/portal-cli-app.png Binary files differindex be833ea9..05ac8fbd 100644 --- a/docs/images/portal-cli-app.png +++ b/docs/images/portal-cli-app.png diff --git a/docs/images/portal-cli-arch.png b/docs/images/portal-cli-arch.png Binary files differindex d027e68f..4370183d 100644 --- a/docs/images/portal-cli-arch.png +++ b/docs/images/portal-cli-arch.png diff --git a/docs/images/portal-cli-dowload.png b/docs/images/portal-cli-dowload.png Binary files differindex be833ea9..f57cf204 100644 --- a/docs/images/portal-cli-dowload.png +++ b/docs/images/portal-cli-dowload.png diff --git a/docs/images/portal-cli-shell.png b/docs/images/portal-cli-shell.png Binary files differindex eb49e328..696046e3 100644 --- a/docs/images/portal-cli-shell.png +++ b/docs/images/portal-cli-shell.png diff --git a/docs/images/portal-cli-web-con.png b/docs/images/portal-cli-web-con.png Binary files differindex 97c54aaf..87af9874 100644 --- a/docs/images/portal-cli-web-con.png +++ b/docs/images/portal-cli-web-con.png diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 39389326..da4584b7 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -3,46 +3,17 @@ CLI Release Notes ================= -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z +Version: 1.1.0 -------------- - -:Release Date: yyyy-mm-dd - +:Release Date: 2017-11-16 (DRAFT) **New Features** -One or two sentences explaining the purpose of this Release. - -**Bug Fixes** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. -**Known Issues** - - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. - -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ - - -**Upgrade Notes** - -**Deprecation Notes** - -**Other** - -=========== - -End of Release Notes +* Release first version of Open Command Line Interface Platform (OCLIP), an CLI platform for implementing CLI using YAML file without coding + For more details, :ref:`OCLIP`. +* It provides Open Command Specification (OCS) 1.0 for defining the commands in YAML format, similar to Open API Specification (API). + For more details, :ref:`open_cli_schema_version_1_0`. +* All Onap commands are developed using OCLIP by authoring set of YAML files. + For more details, :ref:`cmd_help`. |
