openstack/openstack-helm
Code Issues Proposed changes
c9df7ff353
openstack-helm/docs
History
Brandon B. Jozsa 3e62cd54e2 docs: general updates to documentation (#247) 
* doc mods and etcd-rabbitmq additions

* second pass doc updates

* removal of 0.1.0 references in minikube and gs docs
2017-03-13 06:44:09 -07:00
..
developer docs: general updates to documentation (#247) 2017-03-13 06:44:09 -07:00
installation docs: general updates to documentation (#247) 2017-03-13 06:44:09 -07:00
troubleshooting docs: general updates to documentation (#247) 2017-03-13 06:44:09 -07:00
helm_overrides.md Final Edits with Feedback incorporated 2017-02-12 10:51:08 -05:00
mission.md grammatical changes 2017-02-06 22:13:02 -05:00
README.md Update README.md 2017-02-09 07:22:16 -05:00

README.md

Openstack-Helm Documentation

Table of Contents

 1. Openstack-Helm Design Principles

   1.1 Mission

     1.1.1 Resiliency
     1.1.2 Scaling

   1.2 Helm Overrides

     1.2.1 Values Philosophy
     1.2.1 Replicas
     1.2.1 Labels
     1.2.1 Images
     1.2.1 Upgrades
     1.2.1 [Resource Limits](helm_overrides.md#resource limits)
     1.2.2 Endpoints
     1.2.2 [Common Conditionals](helm_overrides.md#common 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

    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

   6.1 Contributions and Guidelines

   6.2 Development Tools

    6.2.1 Minikube Development

   6.3 Tips and Considerations