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