docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2021 ONAP contributors, Nokia
   4
   5 Installation
   6 ============
   7
   8 ..
   9    * This section is used to describe how a software component is delivered and
  10    installed.
  11
  12    * This section is typically: provided for a platform-component and
  13    application; and referenced in user guides.
  14
  15 Preparations
  16 ------------
  17
  18 ..
  19   e.g. The software must be delivered as described in section Delivery.
  20
  21 Environment
  22 -----------
  23
  24 ..
  25   Cloud containers, public cloud, image formats, resource needs.
  26
  27 Installation
  28 ------------
  29
  30 Procedure
  31 +++++++++
  32
  33 #. Start the installation.
  34
  35 ..
  36   Include screenshots or specific commands as examples wherever possible.
  37   Add the expected result, as well.
  38
  39 #. Verify the installation.
  40
  41 Troubleshooting the installation
  42 ++++++++++++++++++++++++++++++++
  43
  44 ..
  45   Include both generic troubleshooting steps and ones specific to the
  46   installation steps.
  47
  48 Upgrade
  49 -------
  50
  51 ..
  52   If there are any dependencies, mention them here.
  53   Check compatibility between API versions.
  54
  55 Procedure
  56 +++++++++
  57
  58 #. (optional) Backup your data before starting the upgrade.
  59
  60 ..
  61   Either list the backup steps here or refer to a backup and restore guide (if
  62   it exists).
  63
  64 #. Start the upgrade.
  65
  66 #. Verify the success of the upgrade.
  67
  68 Troubleshooting the upgrade
  69 +++++++++++++++++++++++++++
  70
  71 ..
  72   Include both generic troubleshooting steps and ones specific to the upgrade
  73   steps.