.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-=========================================
-OPNFV <Project Name> Installation Guide
-=========================================
+========
+Abstract
+========
This document describes how to install <Component>, it's dependencies and required system resources.
| | | | |
+--------------------+--------------------+--------------------+--------------------+
+
Introduction
--------------------
+============
<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
<EXAMPLE>:
The audience of this document is assumed to have good knowledge in network and Unix/Linux administration.
+
Preface
--------------
+=======
<DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
<EXAMPLE>:
This information will be needed for the configuration procedures provided in this document.
+
Hardware requirements
-------------------------
+=====================
<PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
<EXAMPLE>:
| | |
+--------------------+----------------------------------------------------+
+
Top of the rack (TOR) Configuration requirements
----------------------------------------------------
+================================================
<DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs>
<EXAMPLE>:
IP Address plan considerations and blue-print
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
OPNFV Software installation and deployment
---------------------------------------------
+==========================================
<DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT>
<EXAMPLE>:
Deploy the OPNFV environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
Installation health-check
----------------------------
+=========================
<DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL>
<EXAMPLE>:
**Change host OS password:**
Change the Host OS password by......
+
References
--------------
+==========
<PROVIDE NEEDED/USEFUL REFERENCES>
<EXAMPLES>: