Add docs structure

[iec.git] / docs / release / installation / installation.instruction.rst

diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
new file mode 100644 (file)
index 0000000..01341e9
--- /dev/null
+++ b/docs/release/installation/installation.instruction.rst
@@ -0,0 +1,161 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+************************************
+Akraino IEC Installation Instruction
+************************************
+
+
+Introduction
+============
+
+License
+=======
+
+How to use this document
+========================
+
+Deployment Architecture
+=======================
+
+Pre-Installation Requirements
+=============================
+
+Hardware Requirements
+---------------------
+
+Minimum Hardware Requirements
+`````````````````````````````
+
+Recommended Hardware Requirements
+`````````````````````````````````
+
+Software Prerequisites
+----------------------
+
+Database Prerequisites
+----------------------
+
+Schema scripts
+``````````````
+
+Other Installation Requirements
+-------------------------------
+
+Jump Host Requirements
+``````````````````````
+
+Network Requirements
+````````````````````
+
+Bare Metal Node Requirements
+````````````````````````````
+
+Execution Requirements (Bare Metal Only)
+````````````````````````````````````````
+
+Installation High-Level Overview
+================================
+
+Bare Metal Deployment Guide
+---------------------------
+
+Install Bare Metal Jump Host
+````````````````````````````
+
+Creating a Node Inventory File
+``````````````````````````````
+
+Creating the Settings Files
+```````````````````````````
+
+Running
+```````
+
+Virtual Deployment Guide
+------------------------
+
+Standard Deployment Overview
+````````````````````````````
+
+Snapshot Deployment Overview
+````````````````````````````
+
+Special Requirements for Virtual Deployments
+````````````````````````````````````````````
+
+Install Jump Host
+'''''''''''''''''
+
+Verifying the Setup - VMs
+'''''''''''''''''''''''''
+
+Upstream Deployment Guide
+-------------------------
+
+Upstream Deployment Key Features
+````````````````````````````````
+
+Special Requirements for Upstream Deployments
+`````````````````````````````````````````````
+
+Scenarios and Deploy Settings for Upstream Deployments
+``````````````````````````````````````````````````````
+
+Including Upstream Patches with Deployment
+``````````````````````````````````````````
+
+Running
+```````
+
+Interacting with Containerized Overcloud
+````````````````````````````````````````
+
+Verifying the Setup
+===================
+
+OpenStack Verification
+======================
+
+Developer Guide and Troubleshooting
+===================================
+
+Utilization of Images
+---------------------
+
+Post-deployment Configuration
+-----------------------------
+
+OpenDaylight Integration
+------------------------
+
+Debugging Failures
+------------------
+
+Reporting a Bug
+---------------
+
+Uninstall Guide
+===============
+
+Troubleshooting
+===============
+
+Error Message Guide
+-------------------
+
+Maintenance
+===========
+
+Frequently Asked Questions
+==========================
+
+License
+=======
+
+References
+==========
+
+Definitions, acronyms and abbreviations
+=======================================