diff options
author | 2018-04-18 06:10:17 +0000 | |
---|---|---|
committer | 2018-04-18 06:10:17 +0000 | |
commit | 3fd14ba470bee167f01e2c29be02607085220044 (patch) | |
tree | 3249775cf929d982151dd48a9d51ec92c8caf10a /docs | |
parent | eda59089e0d05bac852093c24db6dc34e4c0c89d (diff) | |
parent | 60de9607d95ed3c0733e2dac436cc39da1d13289 (diff) |
Merge changes Ib986931f,I3abfe1a5,I2df477bb,Iae51b3c6,Id22e629a, ...
* changes:
Update OCLIP commands details
Update the architecture document with cache
Remove unused images in docs
Add onap cmd alias in CLI docker
Set CLI version to 2.0.0
Set logging level to INFO by default
Add onap cmd alias to oclip
Disable debug while starting cli in ALL mode
Diffstat (limited to 'docs')
-rw-r--r-- | docs/architecture.rst | 13 | ||||
-rw-r--r-- | docs/cmd_help.rst | 8 | ||||
-rw-r--r-- | docs/images/portal-cli-app-1.png | bin | 177080 -> 0 bytes | |||
-rw-r--r-- | docs/images/portal-cli-dowload-1.png | bin | 178221 -> 0 bytes | |||
-rw-r--r-- | docs/images/portal-cli-shell-1.png | bin | 76348 -> 0 bytes | |||
-rw-r--r-- | docs/images/portal-cli-web-con-1.png | bin | 121037 -> 0 bytes |
6 files changed, 14 insertions, 7 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index 839fe6bb..771836d2 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -11,15 +11,20 @@ Following diagram shows the high-level architecture of OCLIP. .. image:: images/portal-cli-arch.png -* **Command Registrar** : Registrar keeps track of the commands registered in OCLIP and when user invokes the command, it identify - the corresponding command route the request to that command plug-in. +* **Command Registrar** : Registrar keeps track of the commands registered in OCLIP and when user invokes the command, +it identify the corresponding command and helps to invoke the corresponding command plug-in. -* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically 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-ing** : Implement the command as plug-in. More details :ref:`cli_developer_guide` +* **Command Plug-in** : 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. * **Command Shell** : Provides the interactive command line console from Linux * **Web Command Console** : Provides the interactive command line console from web-browser + +* **Cache** : Provides an persistent storage for discoverer to store the meta-data about the discovered Commands. + +* **open cli schemas** : Set of command YAML provides the CLI definitions. diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index d5f69024..eee3f4af 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -10,7 +10,9 @@ .. _cli_cmd_help: open-cli -========================== + +Open CLI is the OCLIP platform facilitates creating the commands from YAMLs. Currently it supports commands +for refreshing the existing command YAMLs and validating the YAMLs. [1] schema-refresh ----------------------------------------------- @@ -18,7 +20,7 @@ open-cli usage: oclip schema-refresh -Oclip command to refresh schemas stored in open-cli-schema folders. +OCLIP command to refresh schemas stored in open-cli-schema folders. Product: open-cli Service: schema @@ -66,7 +68,7 @@ Error:: usage: oclip schema-validate -Oclip command to validate schema +OCLIP command to validate schema Product: open-cli Service: schema diff --git a/docs/images/portal-cli-app-1.png b/docs/images/portal-cli-app-1.png Binary files differdeleted file mode 100644 index 05ac8fbd..00000000 --- a/docs/images/portal-cli-app-1.png +++ /dev/null diff --git a/docs/images/portal-cli-dowload-1.png b/docs/images/portal-cli-dowload-1.png Binary files differdeleted file mode 100644 index f57cf204..00000000 --- a/docs/images/portal-cli-dowload-1.png +++ /dev/null diff --git a/docs/images/portal-cli-shell-1.png b/docs/images/portal-cli-shell-1.png Binary files differdeleted file mode 100644 index 696046e3..00000000 --- a/docs/images/portal-cli-shell-1.png +++ /dev/null diff --git a/docs/images/portal-cli-web-con-1.png b/docs/images/portal-cli-web-con-1.png Binary files differdeleted file mode 100644 index 87af9874..00000000 --- a/docs/images/portal-cli-web-con-1.png +++ /dev/null |