diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/OCLIP.rst | 13 | ||||
| -rw-r--r-- | docs/architecture.rst | 10 | ||||
| -rw-r--r-- | docs/console.rst | 10 | ||||
| -rw-r--r-- | docs/developer_guide.rst | 2 | ||||
| -rw-r--r-- | docs/index.rst | 13 | ||||
| -rw-r--r-- | docs/installation_guide.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes.rst | 14 | ||||
| -rw-r--r-- | docs/user_guide.rst | 4 |
8 files changed, 29 insertions, 41 deletions
diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst index 56d3b9d2..47e20c38 100644 --- a/docs/OCLIP.rst +++ b/docs/OCLIP.rst @@ -7,9 +7,7 @@ Open CLI Platform (OCLIP) ========================= -.. role:: blue - -:blue:`No coding, just texting !` +**No coding, just texting !** In Telco/IT world, Any software platform/platform with out CLI is considered as in-complete and as there is no platform exists today for implementing CLI, similar to Tomcat exists for HTTP applications, and followings are the main problems: @@ -28,10 +26,5 @@ Advantages * 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` diff --git a/docs/architecture.rst b/docs/architecture.rst index 6562dd85..fe17190f 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -10,15 +10,13 @@ CLI architecture Following diagram shows the high-level architecture of ONAP CLI. .. image:: images/portal-cli-arch.png - :height: 600px - :width: 800px -* **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. diff --git a/docs/console.rst b/docs/console.rst index 2b3b1345..5b65268e 100644 --- a/docs/console.rst +++ b/docs/console.rst @@ -11,14 +11,12 @@ Please install the CLI by following guidelines provided in :ref:`OOM_and_HEAT_ba After installation, ONAP CLI can be used in following form: -# Command Shell +Command Shell +-------------- .. image:: images/portal-cli-shell.png - :height: 600px - :width: 800px -# Web Command Console +Web Command Console +-------------------- .. image:: images/portal-cli-web-con.png - :height: 600px - :width: 800px diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index 2e2278e5..2a94a168 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -72,7 +72,7 @@ Note the following points: #. 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 --------- diff --git a/docs/index.rst b/docs/index.rst index 7a53a0b0..2ce041d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,11 +13,11 @@ ONAP CLI 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 @@ -25,14 +25,10 @@ Amesterdam release, it provides commands for following features: * 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 @@ -40,3 +36,8 @@ ONAP CLI is developed using the industry first CLI platform called OOM_and_HEAT_based_deployment.rst logging.rst release-notes.rst + + +========================== + +Powered by :ref:`OCLIP`
\ No newline at end of file diff --git a/docs/installation_guide.rst b/docs/installation_guide.rst index dc02bcc5..f1b99b13 100644 --- a/docs/installation_guide.rst +++ b/docs/installation_guide.rst @@ -46,14 +46,10 @@ Please follow the instructions given below, for installing CLI from portal. 1. After installing Portal, ONAP CLI will be available as Portal application as shown below: .. image:: images/portal-cli-app.png - :height: 600px - :width: 800px 2. Click on CLI application and it will show the following page and download the CLI as reported in this page. .. image:: images/portal-cli-dowload.png - :height: 600px - :width: 800px 3. After downloading, please follow the instruction given in this page to install ONAP CLI. diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 63b04422..49e4b7aa 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -8,26 +8,28 @@ Version: 1.1.0 :Release Date: 2017-11-16 -ONAP CLI helps user to perform any operations over ONAP from command line, Linux console and web-console and following features are only -available over CLI and portal/vid does not support them: +ONAP CLI helps user to perform any operations over ONAP from command line, Linux console and web-console. + +NOTE: ONAP portal does not support following features, so user is recommended to use them over CLI: * Customer and subscription management * VNF Cloud on-boarding * VNF tenant on-boarding **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`. -* Released first version of Open Command Line Interface Platform (OCLIP), industry first CLI platform for implementing CLI **just by texting (YAML) and no coding** . +* Released first version of **Open Command Line Interface Platform (OCLIP)**, industry first CLI platform for implementing CLI **just by texting (YAML) and no 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:`cli_cmd_help`. * All commands are tested completely and samples also provided for reference. - For more details, :ref:`cli_sample`. + For more details, :ref:`_cli_cmd_sample`. * User could develop new commands on-the-fly and deploy it and use. For more details, :ref:`cli_developer_guide`. @@ -36,4 +38,4 @@ available over CLI and portal/vid does not support them: * VF customizationUUID is not available over SDC REST API, so user is recommended to refer it from SDC portal * CLI impersonate VID as source while creating service, vf and vf-modules, due to SO limitation (SO-272) * vsp-add-artifact command sometime fails to upload the file, in that case, please use option -d to see the debug information -* + diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 37ac770d..919bb66c 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -33,7 +33,7 @@ And use the directive set to set the values for following parameters: 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 @@ -43,7 +43,7 @@ Run *onap [-v|--version]* to see the CLI and available product version details 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 ---- |