docs/release/installation/installation.instruction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) Akraino Project, Inc. and its contributors
   4
   5 ************************************
   6 Akraino IEC Installation Instruction
   7 ************************************
   8
   9
  10 Introduction
  11 ============
  12
  13 License
  14 =======
  15
  16 How to use this document
  17 ========================
  18
  19 Deployment Architecture
  20 =======================
  21
  22 Pre-Installation Requirements
  23 =============================
  24
  25 Hardware Requirements
  26 ---------------------
  27
  28 Minimum Hardware Requirements
  29 `````````````````````````````
  30
  31 Recommended Hardware Requirements
  32 `````````````````````````````````
  33
  34 Software Prerequisites
  35 ----------------------
  36
  37 Database Prerequisites
  38 ----------------------
  39
  40 Schema scripts
  41 ``````````````
  42
  43 Other Installation Requirements
  44 -------------------------------
  45
  46 Jump Host Requirements
  47 ``````````````````````
  48
  49 Network Requirements
  50 ````````````````````
  51
  52 Bare Metal Node Requirements
  53 ````````````````````````````
  54
  55 Execution Requirements (Bare Metal Only)
  56 ````````````````````````````````````````
  57
  58 Installation High-Level Overview
  59 ================================
  60
  61 Bare Metal Deployment Guide
  62 ---------------------------
  63
  64 Install Bare Metal Jump Host
  65 ````````````````````````````
  66
  67 Creating a Node Inventory File
  68 ``````````````````````````````
  69
  70 Creating the Settings Files
  71 ```````````````````````````
  72
  73 Running
  74 ```````
  75
  76 Virtual Deployment Guide
  77 ------------------------
  78
  79 Standard Deployment Overview
  80 ````````````````````````````
  81
  82 Snapshot Deployment Overview
  83 ````````````````````````````
  84
  85 Special Requirements for Virtual Deployments
  86 ````````````````````````````````````````````
  87
  88 Install Jump Host
  89 '''''''''''''''''
  90
  91 Verifying the Setup - VMs
  92 '''''''''''''''''''''''''
  93
  94 Upstream Deployment Guide
  95 -------------------------
  96
  97 Upstream Deployment Key Features
  98 ````````````````````````````````
  99
 100 Special Requirements for Upstream Deployments
 101 `````````````````````````````````````````````
 102
 103 Scenarios and Deploy Settings for Upstream Deployments
 104 ``````````````````````````````````````````````````````
 105
 106 Including Upstream Patches with Deployment
 107 ``````````````````````````````````````````
 108
 109 Running
 110 ```````
 111
 112 Interacting with Containerized Overcloud
 113 ````````````````````````````````````````
 114
 115 Verifying the Setup
 116 ===================
 117
 118 OpenStack Verification
 119 ======================
 120
 121 Developer Guide and Troubleshooting
 122 ===================================
 123
 124 Utilization of Images
 125 ---------------------
 126
 127 Post-deployment Configuration
 128 -----------------------------
 129
 130 OpenDaylight Integration
 131 ------------------------
 132
 133 Debugging Failures
 134 ------------------
 135
 136 Reporting a Bug
 137 ---------------
 138
 139 Uninstall Guide
 140 ===============
 141
 142 Troubleshooting
 143 ===============
 144
 145 Error Message Guide
 146 -------------------
 147
 148 Maintenance
 149 ===========
 150
 151 Frequently Asked Questions
 152 ==========================
 153
 154 License
 155 =======
 156
 157 References
 158 ==========
 159
 160 Definitions, acronyms and abbreviations
 161 =======================================