diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2016-01-04 15:00:49 +0100 |
|---|---|---|
| committer |   Justin chi <chigang@huawei.com> | 2016-02-23 10:24:09 +0000 |
| commit | 30a025381e198416c6dc8cada24b53e1657dda04 (patch) | |
| tree | 33399be5690ce1ec156792fc6ab75619352889ad | |
| parent | c5dacee928da62ba18ff9f8a478c31802fc2e3b0 (diff) | |
Templates for configuration guide
Please use the installerconfig.rst to describe the configuration for each
installer. Removed configoptions from the patch, we will provide patches for
the post install procedures template during the day. Postinstall.rst is added,
please use this to describe the post install activities.
Change-Id: I37cae1344346b154017e3dc8b1a7acdb436114cd
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
(cherry picked from commit ebf474f7dd65ed8d098e80959aec777c202ee7be)
| -rw-r--r-- | docs/configguide/installerconfig.rst | 23 | ||||
| -rw-r--r-- | docs/configguide/postinstall.rst | 26 |
2 files changed, 49 insertions, 0 deletions
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst new file mode 100644 index 00000000..dd4a4333 --- /dev/null +++ b/docs/configguide/installerconfig.rst @@ -0,0 +1,23 @@ + +<Project> configuration +======================= +Add a brief introduction to configure OPNFV with this specific installer + +Pre-configuration activities +----------------------------- +Describe specific pre-configuration activities. Refer to Installations guide and release notes + +Hardware configuration +----------------------- +Describe the hardware configuration needed for this specific installer + +Jumphost configuration +----------------------- +Describe intial Jumphost configuration (network and software)needed in order to deploy the installer + +Platform components configuration +--------------------------------- +Describe the configuration of each component in the installer + + + diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst new file mode 100644 index 00000000..1702cea5 --- /dev/null +++ b/docs/configguide/postinstall.rst @@ -0,0 +1,26 @@ +<Project> post installation procedures +====================================== +Add a brief introduction to the methods of validating the installation +according to this specific installer or feature. + +Automated post installation activities +-------------------------------------- +Describe specific post installation activities performed by the OPNFV +deployment pipeline including testing activities and reports. Refer to +the relevant testing guides, results, and release notes. + +note: this section should be singular and derived from the test projects +once we have one test suite to run for all deploy tools. This is not the +case yet so each deploy tool will need to provide (hopefully very simillar) +documentation of this. + +<Project> post configuration procedures +-------------------------------------- +Describe any deploy tool or feature specific scripts, tests or procedures +that should be carried out on the deployment post install and configuration +in this section. + +Platform components validation +--------------------------------- +Describe any component specific validation procedures necessary for your +deployment tool in this section. |