diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2016-01-12 16:12:35 +0100 |
|---|---|---|
| committer |   Bin Hu <bh526r@att.com> | 2016-01-13 18:56:39 +0000 |
| commit | 9a2c0854c902f49e4186a81440ed32c880f18616 (patch) | |
| tree | 4ee7d6d729bfaf20d574e0b6b7f6d7fe5547d4fc /docs/configguide/featureconfig.rst | |
| parent | 7e0a4c125fcc9e45364cfe8ece3371dd114cb773 (diff) | |
Added templates for feature configuration description/reference
The featureconfig.rst document should be used to describe the configuration of
the <XYZ> feature.
The content will be added to the Brahmaputra configuration guide which intends
to describe how to configure the Brahmaputra release to a stable and ready state
For feature projects this should refer to the use of deployment tool scenario
selections and post deployment configuration specific to the feature.
Also added is the postinstall.rst document for features to describe how to
check and analyze the result of test cases for respective feature.
Change-Id: Idf700026792efb2dfd9b72fe5dd49e605e41a84a
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
(cherry picked from commit c7f20d6f115677bd3965d484667eb654be5104c9)
Diffstat (limited to 'docs/configguide/featureconfig.rst')
| -rw-r--r-- | docs/configguide/featureconfig.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst new file mode 100644 index 0000000..9189902 --- /dev/null +++ b/docs/configguide/featureconfig.rst @@ -0,0 +1,24 @@ +<Project> configuration +======================= +Add a brief introduction to configure OPNFV with this specific feature including +dependancies on platform components, this description should be at a level that +will apply to any installer providing the pre-requisite components. + +Pre-configuration activities +---------------------------- +Describe specific pre-configuration activities. This should include ensuring the +right components are installed by the installation tools as required for your +feature to function. Refer to the previous installer configuration chapters, +installations guide and release notes + +Hardware configuration +---------------------- +Describe the hardware configuration needed for this specific feature + +Feature configuration +--------------------- +Describe the procedures to configure your feature on the platform in order +that it is ready to use according to the feature instructions in the platform +user guide. Where applicable you should add content in the postinstall.rst +to validate the feature is configured for use. +(checking components are installed correctly etc...) |