openstack-helm/docs/README.md
Eiden, Elise (ee550x) aa400cca74 Resolves issue #165
2017-02-01 08:44:18 -06:00

52 lines
2.8 KiB
Markdown

# Openstack-Helm Documentation
## Table of Contents
##  1. [Openstack-Helm Design Principles]()
###    1.1 [Mission](mission.md)
#####      1.1.1 [Resiliency](mission.md#resiliency)
#####      1.1.2 [Scaling](mission.md#scaling)
###    1.2 [Helm Overrides]()
#####      1.2.1 [Resource Limits]()
#####      1.2.2 [Conditionals]()
###    1.3 [Init-Containers]()
#####      1.3.1 [Dependency Checking]()
###    1.4 [Kubernetes Jobs]()
#####      1.4.1 [Service Registration]()
#####      1.4.2 [User Registration]()
#####      1.4.3 [Database Creation]()
#####      1.4.4 [Database Migration]()
###    1.5 [Complimentary Efforts]()
####      1.5.1 [Image-Based Project Considerations]()
###    1.6 [Kubernetes State]()
####      1.6.1 [Third Party Resources]()
####      1.6.2 [Add-Ons]()
##  2. [Repository Structure]()
###    2.1 [Infrastructure Components]()
###    2.2 [Openstack-Helm Core Services]()
###    2.3 [Openstack-Helm Add-Ons]()
##  3. [Operator Resources]()
###     3.1 [Installation](https://github.com/att-comdev/openstack-helm/blob/master/docs/installation/getting-started.md)
###     3.2 [Openstack-Helm Chart Definition Overrides]()
###     3.2 [Openstacak-Helm Upgrades]()
##  4. [Openstack-Helm Networking]()
###    4.1 [Kubernetes Control Plane]()
####     4.1.1 [CNI SDN Considerations]()
####     4.1.2 [Calico Networking]()
###    4.2 [Ingress Philosophy]()
###    4.3 [Openstack Networking]()
####     4.3.1 [Flat Networking]()
####     4.3.1 [L2 Networking]()
##  5. [Security Guidelines]()
###    5.1 [Network Policies]()
###    5.2 [Advanced Network Policies]()
###    5.3 [Role-Based Access Controls]()
###    5.4 [Security Contexts]()
###    5.5 [Security Add-Ons]()
##  6. [Developer Resources](https://github.com/att-comdev/openstack-helm/tree/master/docs/developer)
###    6.1 [Contributions and Guidelines]()
###    6.2 [Development Tools]()
####     6.2.1 [Minikube Development](https://github.com/att-comdev/openstack-helm/blob/master/docs/developer/minikube.md)
###    6.3 [Tips and Considerations]()