.readme {
display: inline-block;
float: left;
- color: white
+ margin: 3% 3% 0;
+
}
* {box-sizing:border-box}
float: right;
max-width: 700px;
position: relative;
- margin: 5% 3% 0;
+ margin: 6% 3% 0;
}
.mySlides {
</head>
-<body onload="showSlides()">
+<body onload="showSlides()" style="background-color: white;color: black">
<div class="readme">
-<h1>ONAP Command-Line Interface (CLI)</h1>
+<h2>ONAP Command-Line Interface (CLI)</h2>
-<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>
+<p>Provides unified commands to operate ONAP from Linux shell and web-console.
-<h2 >Web Command Console</h2>
-<p>To access ONAP shell from browser, <button class="button" onclick="redirectToConsole();">Click Me !</button></p>
-<br>
+<h3 >Web Command Console</h3>
+<p>To open web command console for ONAP,
+<a onclick="redirectToConsole();" style="color: blue;cursor: pointer">Click here !</a>
-<h2>Linux Command Shell</h2>
+<h3>Linux Command Console</h3>
<p>Please follow the instructions given below for installing ONAP CLI.</p>
<ol>
-<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>
+<li>Download ONAP CLI from <a href="./onap-cli.zip">here</a></li>
+<li>Unzip into folder /opt/onap/cli</li>
+<li>Initialize CLI by running /opt/onap/cli/cli-init.sh</li>
+<li>Run ONAP CLI, by typing <strong>onap</strong> from command line
+<li>For more details, refer /opt/onap/cli/README.md</li>
</ol>
<br>
+<a href="http://onap.readthedocs.io/en/latest/submodules/cli.git/docs/index.html" style="color: blue;">
+<sub style="color: blue;"><strong>One Command to command whole Onap !!</strong></sub></a>
+<hr>
+<p><i>Powered by <strong>Open CLI Platform (OCLIP) </strong>
+<a href="http://onap.readthedocs.io/en/latest/submodules/cli.git/docs/OCLIP.html" style="color: blue;">1.0</a>
+</i></p>
</div>
<div class="slideshow-container">
<div class="mySlides">
- <img src="images/onap-cli-ad-1.png" style="width:100%">
+ <img src="images/onap-cli-ad-1.png" style="width:80%">
</div>
<div class="mySlides">
- <img src="images/onap-cli-ad-2.png" style="width:100%">
+ <img src="images/onap-cli-ad-2.png" style="width:80%">
</div>
<div class="mySlides">
- <img src="images/onap-cli-ad-3.png" style="width:100%">
+ <img src="images/onap-cli-ad-3.png" style="width:80%">
</div>
<div class="mySlides">
- <img src="images/onap-cli-ad-4.png" style="width:100%">
+ <img src="images/onap-cli-ad-4.png" style="width:80%">
</div>
<div class="mySlides">
- <img src="images/onap-cli-ad-5.png" style="width:100%">
+ <img src="images/onap-cli-ad-5.png" style="width:80%">
</div>
<div class="mySlides">
- <img src="images/onap-cli-ad-6.png" style="width:100%">
+ <img src="images/onap-cli-ad-6.png" style="width:80%">
</div>
</div>
+
+
</body></html>
\ No newline at end of file
* Helps Operator/user to create new commands/fix the existing commands just by modifying the YAML file, so User no need to wait for an release time to get the fix for a bug or new commands.
* Similar to Tomcat for deploying more than one webapps, on OCLIP, multiple's products commands could be deployed and executed.
-This platform defines Open Command Specification (OCS) for CLI, which is similar to the Open API specification (OAS) defined by swagger for REST API. It is like : **API for developers, CLI for admins/users/operators !** For more details of OCS :ref:`open_cli_schema_version_1_0`
-
-
-.. toctree::
- :maxdepth: 1
-
- open_cli_schema_version_1_0.rst
+This platform defines Open Command Specification (OCS) for CLI, which is similar to the Open API specification (OAS) defined by swagger for REST API. It is like : **API for developers, CLI for admins/users/operators !**
+For more details of OCS :ref:`open_cli_schema_version_1_0`
.. image:: images/portal-cli-arch.png
-* **Command Registrar** : Registrar keeps track of the commands regsitered in ONAP CLI and when user invokes the command, it identify
- the corresponding command route the request to that command plugin.
+* **Command Registrar** : Registrar keeps track of the commands registered in ONAP CLI and when user invokes the command, it identify
+ the corresponding command route the request to that command plug-in.
-* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and auto-matically register them into Registrar.
+* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register them into Registrar.
-* **Command Plug-ings** : Implement the command as plugin. More details :ref:`cli_developer_guide`
+* **Command Plug-ing** : Implement the command as plug-in. More details :ref:`cli_developer_guide`
* **HTTP Command** : Plug-in for implementing all Rest based command as YAML without any coding.
After installation, ONAP CLI can be used in following form:
-# Command Shell
+Command Shell
+--------------
.. image:: images/portal-cli-shell.png
-# Web Command Console
+Web Command Console
+--------------------
.. image:: images/portal-cli-web-con.png
#. Now the command is ready. Build the project by running 'mvn clean install'. ONAP CLI framework automatically delivers these commands as part of the ONAP CLI zip file as part of this build.
-#. To test this command, run the command 'onap hello-world --name amesterdam'
+#. To test this command, run the command 'onap hello-world --name amsterdam'
As a YAML
---------
Both Information and Communication Technology customers prefer Command Line
Interface (CLI) over Graphical user interface (GUI) in many situations
-such as automation, devops, CI&CD. So CLI is always been as integral part
+such as automation, Devops, CI&CD. So CLI is always been as integral part
of software products and platforms.
ONAP CLI provides the command line interface for ONAP functionalities and in
-Amesterdam release, it provides commands for following features:
+Amsterdam release, it provides commands for following features:
* ONAP micro-service discovery
* ONAP external system and VNF cloud on-boarding
* ONAP VSP on-boarding
* ONAP network service life-cycle management
-ONAP CLI is developed using the industry first CLI platform called
-**Open CLI Platform (oclip)** which is part of ONAP CLI deliverables.
-
.. toctree::
:maxdepth: 1
console.rst
- OCLIP.rst
architecture.rst
developer_guide.rst
user_guide.rst
OOM_and_HEAT_based_deployment.rst
logging.rst
release-notes.rst
+
+
+==========================
+
+Powered by :ref:`OCLIP`
\ No newline at end of file
**New Features**
-* ONAP CLI available as nexus artifacts and docker images.
+* ONAP CLI available as Nexus artifacts and docker images.
For more details, :ref:`cli_installation_guide`.
* It is delivered as part of portal installation during HEAT based installation. Also its supported in OOM as well.
For more details, :ref:`OOM_and_HEAT_based_deployment`.
Set the product version
------------------------
CLI framework is enhanced to handle multiple product versions at same
-time. so to choose the product version, set evironment variable
+time. so to choose the product version, set environment variable
**CLI_PROUDCT_VERSION**.
NOTE: In interactive mode, product version can be selected using
Set the parameter values
------------------------
-Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values.
+Use the directive 'set' for setting the values for parameters and 'unset' for reseting the values.
Help
----
Code Review / cli.git / commitdiff