This is an old revision of the document!
Table of Contents
OPNFV Installation and Configuration guide
Document Purpose
The Installation and Configuration guide is an OPNFV release document that describes how to configure the system to an operational state. The document describes both the minimum configuration required to install the platform using the OPNFV installation tools, and associated project configration parameters to enable delivered platform features.
Working with the document
The document is structured around an index.rst file in the opnfvdocs repository. This file is used to construct and collate the various document elements both from the opnfvdocs repository and project specific configuration documentation.
If you intend to deliver features into the platform that requires specific components and or configurations to enable it you must provide input for this document. The document structure and methods of providing input are described below.
Document structure
The Installation and Configuration guide is hosted in the opnfvdocs repository and consists of these global files:
| * Installation and Configuration Manual directory: | opnfvdocs/docs/configguide/ |
| * Master index file for collating the document: | opnfvdocs/docs/configguide/index.rst |
| * Abstract explaining the Document: | opnfvdocs/docs/configguide/abstract.rst |
| * Introduction to installation and configuration: | opnfvdocs/docs/configguide/introduction.rst |
| * An overview of OPNFV system configuration: | opnfvdocs/docs/configguide/configoptions.rst |
The document is further compiled of project specific chapters, these include installation tool descriptions, feature configuration descriptions, and post installation validation procedures. Every project providing features into the platform that requires the configuration of specific components or features in the platform must provide a description in this document on how to enable the features. Please note: this covers only the configuration of the platform to enable the features or components, not the use of those features which is covered in the OPNFV user guide.
All project specific files to be compiled into the Installation and Configuration guide must be stored in your projects configguide folder.
- Installation and Configuration guide directory:
<repo>/docs/configguide/- Installer configuration guide:
<repo>/docs/configguide/installerconfig.rst - Feature configuration guide:
<repo>/docs/configguide/featureconfig.rst - Post installation procedures:
<repo>/docs/configguide/postinstall.rst
Including your Documentation
Once your features
