blob: 6d1ec29baba632833776e59d565da4d3f1d7e6c9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
Configuration
=============
..
* This section is used to describe the options a software component offers
for configuration.
* Configuration is typically: provided for platform-component and sdk projects;
and referenced in developer and user guides.
Pre-requisites
--------------
..
List here any dependencies and pre-requisites, e.g. component has to be
deployed, necessary connections have been established, etc.
Editing the configuration file
------------------------------
..
Describe the parameters and their values included in the config file.
Configuration steps
-------------------
..
Add the necessary steps to configure the component, including all options/
alternatives.
Provide examples (screenshots for GUI, commands for CLI) wherever possible.
#. Add the configuration.
Example command:
.. code-block:: bash
example command <parameter>
Example screenshot:
.. figure:: https://www.onap.org/wp-content/uploads/sites/20/2017/02/logo_onap_2017.png
:alt: Example image
:width: 50 %
#. Validate the configuration.
.. code-block:: bash
example command to validate the configuration
Output for successful execution:
.. code-block:: bash
Example output
|
