diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2016-01-08 13:21:10 +0100 |
|---|---|---|
| committer |   Brady Johnson <brady.allen.johnson@ericsson.com> | 2016-01-29 16:36:42 +0000 |
| commit | 08e07a77edcfaa5d172bec087d8a3566309c6bb3 (patch) | |
| tree | 0eabe95daaca66b8352f767c2d12ea667dea5244 /docs/configguide/featureconfig.rst | |
| parent | 51f1c01d34888b48694e3c4ea67f707706532310 (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 ran test cases for respective feature.
Change-Id: Ia78659dedd8da5c57aa6e6b21db9ac597fb5eb88
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
(cherry picked from commit 560c8d8d36304fb3dafcf148c101a7839ec58c60)
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 00000000..9189902c --- /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...) |