docs/architecture.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 Huawei Technologies Co., Ltd.
   4
   5 .. _cli_architecture:
   6
   7 CLI architecture
   8 ================
   9
  10 Following diagram shows the high-level architecture of OCLIP.
  11
  12 .. image:: images/portal-cli-arch.png
  13
  14 * **Command Registrar** :  Registrar keeps track of the commands registered in OCLIP and when user invokes the command,
  15 it identify the corresponding command and helps to invoke the corresponding command plug-in.
  16
  17 * **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register
  18 them into Registrar.
  19
  20 * **Command Plug-in** : Implement the command as plug-in. More details :ref:`cli_developer_guide`
  21
  22 * **HTTP Command** : Plug-in for implementing all Rest based command as YAML without any coding.
  23
  24 * **SNMP Command** : Plug-in for implementing all SNMP based command as YAML without any coding.
  25
  26 * **Command Shell** : Provides the interactive command line console from Linux
  27
  28 * **Web Command Console** : Provides the interactive command line console from web-browser
  29
  30 * **Cache** : Provides an persistent storage for discoverer to store the meta-data about the discovered Commands.
  31
  32 * **open cli schemas** : Set of command YAML provides the CLI definitions.