Child pages
  • Configuration guide
Skip to end of metadata
Go to start of metadata

OPNFV Installation and Configuration guide documentation instruction

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, templates for these files can be found in the opnfvdocs repo.

Installation and Configuration guide directory:

<repo>/docs/configguide/

 

Installer configuration guide:

<repo>/docs/configguide/installerconfig.rst

template

Feature configuration guide:

<repo>/docs/configguide/featureconfig.rst

template

Post installation procedures:

<repo>/docs/configguide/postinstall.rst

template

Including your Documentation

Add your documentation to your repository in the folder structure and according to the templates listed above. The documentation templates you will require are available in the opnfvdocs repository, you should copy the relevant templates to the /docs/configguide directory in your repository. For instance if I wanted to document enabling my feature set in the platform I would follow an example like:

  ' mkdir <my_repo>/docs/configguide '
  ' git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git '
  ' cp opnfvdocs/docs/configguide/featureconfig.rst <my_repo>/docs/configguide '
  ' cp opnfvdocs/docs/configguide/postinstall.rst <my_repo>/docs/configguide '

 

You should then add the relevant information to the template that will explain the configuration of your feature and instructions for validating that the feature was enabled successfully like checking the results of specific test cases. Be sure to maintain the creative commons license from the template and ensure all your documentation files include the license information.

Once your installer or feature documentation is ready you should ensure they are compiled into the master file by adding them to the master files in the opnfvdocs repository. The index.rst file is structured in such a way that it will pull composite material via a staging file, staging files are identifiable by the "-" in their file names. Examples of the staging files are feature-config.rst, installer-config.rst and post-install.rst. You should add references to your input documents in the correct locations in these staging files. The relevant staging files for compiling project specific information are:

Installer install and configuration documentation:

opnfvdocs/docs/configguide/installer-config.rst

Feature specific configuration documentation:

opnfvdocs/docs/configguide/feature-config.rst

Post installation procedures:

opnfvdocs/docs/configguide/post-install.rst

An example of how to add your documentation to the relevant sections of the post-install.rst file might be:

  ' git clone ssh://<your_id>@gerrit.opnfv.org:29418/opnfvdocs.git '
  ' cd opnfvdocs ' 
  ' git review -s '
  ' vim docs/configguide/post-install.rst '


At this point you should add the references to your files into the post-install.rst file, these should be added in alphabetical order based on the projects repository name. For instance in the post installation procedures staging file you would add an include line for your project as shown below:

  The following sections provide information on how to validate the features you have
  installed in your scenario:
  .. include:: ../projects/copper/configguide/postinstall.rst
  .. include:: ../projects/<my_repo>/configguide/postinstall.rst


If this is the first contribution from your project to the composite document files you will need to add your project to the build-composite.sh file in the opnfvdocs directory. This is done my editing the jsdgf file and adding your repository name to the get_repo_names() function of the script. Assuming you are still in the opnfvdocs directory edit the file with the following command:

  ' vim build-composite.sh '


Once you have the file open, add your projects repository to the get_repo_names() function:

  get_repo_names() {
    # NOTE: Not all repositories are ready for the composite docs,
    #       so we have the repo name list here to add project docs
    #       one by one. This will be replaced by the list in project.cfg .
    # grep -v '^#' releng/jjb/opnfvdocs/project.cfg | sort
    echo "sdnvpn"
    echo "<my_repo>"


Once you have made these changes you need to push the patch back to the opnfvdocs team for review and integration.

  ' git add . '
  ' git commit --signoff --all '
  ' git review '

 

Be sure to add the project leader of the opnfvdocs project as a reviewer of the change you just pushed in gerrit. Also be aware that once the text is available in the context of the broader release document it may require some revising and editorial work to prepare it for release.

  • No labels

1 Comment

  1. The links to templates are broken.