Documentation Discussion

What documents are needed and what should be the content?

Proposal (Jack)

• Kubernetes requirements (version, nodes, memory, etc.)

• Helm setup (version, ONAP deploy and undeploy plugins, configuring ONAP Helm repo)

• Helm installation using released charts from ONAP Helm repo

• Additional instructions for building Helm charts locally
     -- local repo setup
     -- cm-push installation
     -- using Makefiles to build charts
     -- deploying from local repo instead of ONAP Helm repo
  
  

Proposal (Andreas)

• ONAP Operations Manager Project
  - Project target, Overview

• OOM Developer Guide
   - Helm structure, principles,...

• ONAP Cloud Setup Guide
  - SW requirements K8S, Helm,…
  - HW Requirements

• ONAP Paas Setup
  - Strimzi, Cert Manager, Prometheus(o), Istio(o), Keycloak(o)…

• ONAP Ingress Setup
  - Nginx, Istio Gateway

• Customizing OOM Overrides
  - settings, enabling/disabling….

• ONAP Install (Quickstart) Guide
  - Using local Chart compilation
  - Using Nexus

• ONAP Access Guide ?
  - Access via Ingress
  - Postman ?

• ONAP Offline Installer (?)

• OOM Release Notes

How to structure ?

Proposal (Andreas)

• ONAP Operations Manager Project

• OOM Developer Guide

• ONAP Infrastructure Setup

  • ONAP Cloud Setup Guide

  • ONAP Paas Setup

  • ONAP Ingress Setup 

• ONAP Deployment

  • Customizing OOM Overrides

  • ONAP Install (Quickstart) Guide

  • ONAP Offline Installer (?)

• ONAP Access

• OOM Release Notes