c03850166706c251170c3addce9134b20de108dd
[cli.git] / docs / index.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_index:
6
7 ONAP CLI
8 ========
9
10 .. role:: blue
11
12 :blue:`One Command to command whole ONAP !`
13
14 Introduction
15 -------------
16
17 Both Information and Communication Technology customers prefer Command Line
18 Interface (CLI) over Graphical user interface (GUI) in many situations
19 such as automation, Devops, CI&CD. So CLI is always been as integral part
20 of software products and platforms.
21
22 ONAP CLI is built using industry first CLI platform :ref:`OCLIP` and provides
23 the commands for following ONAP functionalities:
24
25 * Micro-service discovery
26 * External system and VNF cloud on-boarding
27 * Customer and subscription management
28 * Product and service management
29 * Network service life-cycle management
30 * Policy management
31 * VNF/PNF management
32
33 Table of contents
34 ------------------
35
36 Following guidelines provides detailed information about CLI.
37
38 .. toctree::
39    :maxdepth: 1
40
41    cookbook.rst
42    console.rst
43    architecture.rst
44    developer_guide.rst
45    user_guide.rst
46    installation_guide.rst
47    OOM_and_HEAT_based_deployment.rst
48    logging.rst
49    release-notes.rst
50    trouble_shooting_guide.rst
51
52
53 ==========================
54
55 Powered by :ref:`OCLIP`