Wei Chen  clarification is needed.

//template

• 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 as defined the Akraino validation feature project plus any additional testing specific to the blue print

• Developer Guide and Troubleshooting

• Utilization of Images

• Post-deployment Configuration

• Debugging Failures

• Reporting a Bug

• Uninstall Guide

• Troubleshooting

• Error Message Guide

• Maintenance

  • Blue Print Package Maintenance

    • Software maintenance
    • Hardware maintenance
  • Blue Print Deployment Maintenance

• Frequently Asked Questions

• License

• References

• Definitions, acronyms and abbreviations

Introduction

xxx

Pre-Installation Requirements for PCEI Cluster

Hardware Requirements:

xxx

BIOS Requirements:

• xxx
• xxx

Network Requirements:

xxx

About user_config.yaml

xxx

Example user_config.yaml

YAML Requirements

• xxx

Note:  You have a better chance at creating a working YAML by editing an existing file or using the template rather than starting from scratch.

Installing PCEI

xxx

xxx

Uploading user_config.yaml

xxx

Monitoring Deployment Progress/Status

xxx

Verifying Deployment

xxx

Deployment Failures

xxx

To re-launch a failed deployment

xxxWei Chen  cmti CA 

Currently PCEI installation is a straightforward manual process:

• Start with a new installation of a Ubuntu server, or a Ubuntu VM (16.04 and later version is preferred)
• Install git by 'sudo apt install git'
• Install docker per the instructions from https://docs.docker.com/engine/install/ubuntu/
• Pull the PCEI source code from gerrit: git clone "https://gerrit.akraino.org/r/pcei"
• Build the docker image by 'cd pcei/locationAPI/nodejs && docker build -t pcei_api_docker .'
• Now you can start PCEI from the newly build docker image by 'docker run -p 8081:8081 pcei_api_docker'