From 85646b2d1c490710c53047f5e1910810127044c7 Mon Sep 17 00:00:00 2001 From: "Brandon B. Jozsa" Date: Tue, 4 Apr 2017 17:23:13 -0400 Subject: [PATCH] docs/bugfix: openstack documentation preparation fixes (#327) **What is the purpose of this pull request?**: Fix documentation broken links **What issue does this pull request address?**: Fixes #323 **Notes for reviewers to consider**: @renmak had some comments on this, @larryrensing noticed it originally. --- docs/appendix/resources-helm.md | 0 docs/appendix/resources-kubernetes.md | 0 .../dev-helm/function-endpoints.md | 1 - .../dev-helm/function-hosts.md | 1 - .../guides-developer/dev-helm/helm-toolkit.md | 2 +- docs/guides-developer/dev-helm/readme.md | 17 ++-- .../dev-helm/registration-domain.md | 2 +- .../dev-helm/registration-endpoint.md | 2 +- .../dev-helm/registration-host.md | 1 + .../dev-helm/registration-service.md | 2 +- .../dev-helm/registration-user.md | 2 +- .../dev-helm/tips-development.md | 2 +- .../dev-kubernetes/considerations.md | 1 + docs/guides-developer/readme.md | 21 +++++ .../{ => developer}/install-minikube.md | 2 +- .../developer/install-vagrant.md | 41 ++++++++++ docs/guides-install/developer/readme.md | 3 + docs/guides-install/install-development.md | 1 + docs/guides-install/readme.md | 13 +++- .../armada.md | 0 .../third-party-tools/readme.md | 5 ++ .../guides-kubernetes/readme.md | 5 -- .../guides-operator/guides-security/readme.md | 8 -- .../helm-addons.md => ops-helm/osh-addons.md} | 0 .../ops-helm/osh-operations.md | 0 .../{guides-helm => ops-helm}/readme.md | 0 .../kb-init-containers.md | 0 .../kb-jobs.md | 0 docs/guides-operator/ops-kubernetes/readme.md | 5 ++ .../net-ingress.md | 0 .../net-nodeport.md | 0 .../{guides-network => ops-network}/readme.md | 0 .../ops-openstack/os-config/os-config-gen.md | 7 ++ docs/guides-operator/ops-openstack/readme.md | 3 + docs/guides-operator/ops-security/readme.md | 6 ++ .../ops-security/sec-appsec.md | 1 + .../sec-namespaces.md | 0 .../sec-rbac.md | 0 docs/guides-operator/readme.md | 21 +++++ .../{ts-minikube.md => ts-development.md} | 0 docs/guides-welcome/project-overview.md | 4 - docs/guides-welcome/readme.md | 8 +- docs/guides-welcome/welcome-overview.md | 2 +- docs/guides-welcome/welcome-resiliency.md | 2 +- docs/guides-welcome/welcome-scaling.md | 2 +- docs/readme.md | 77 ++++++++++++------- 46 files changed, 197 insertions(+), 73 deletions(-) create mode 100644 docs/appendix/resources-helm.md create mode 100644 docs/appendix/resources-kubernetes.md delete mode 100644 docs/guides-developer/dev-helm/function-endpoints.md delete mode 100644 docs/guides-developer/dev-helm/function-hosts.md create mode 100644 docs/guides-developer/dev-helm/registration-host.md create mode 100644 docs/guides-developer/dev-kubernetes/considerations.md rename docs/guides-install/{ => developer}/install-minikube.md (99%) create mode 100644 docs/guides-install/developer/install-vagrant.md create mode 100644 docs/guides-install/developer/readme.md create mode 100644 docs/guides-install/install-development.md rename docs/guides-install/{third-pary-tools => third-party-tools}/armada.md (100%) create mode 100644 docs/guides-install/third-party-tools/readme.md delete mode 100644 docs/guides-operator/guides-kubernetes/readme.md delete mode 100644 docs/guides-operator/guides-security/readme.md rename docs/guides-operator/{guides-helm/helm-addons.md => ops-helm/osh-addons.md} (100%) create mode 100644 docs/guides-operator/ops-helm/osh-operations.md rename docs/guides-operator/{guides-helm => ops-helm}/readme.md (100%) rename docs/guides-operator/{guides-kubernetes => ops-kubernetes}/kb-init-containers.md (100%) rename docs/guides-operator/{guides-kubernetes => ops-kubernetes}/kb-jobs.md (100%) create mode 100644 docs/guides-operator/ops-kubernetes/readme.md rename docs/guides-operator/{guides-network => ops-network}/net-ingress.md (100%) rename docs/guides-operator/{guides-network => ops-network}/net-nodeport.md (100%) rename docs/guides-operator/{guides-network => ops-network}/readme.md (100%) create mode 100644 docs/guides-operator/ops-openstack/os-config/os-config-gen.md create mode 100644 docs/guides-operator/ops-openstack/readme.md create mode 100644 docs/guides-operator/ops-security/readme.md create mode 100644 docs/guides-operator/ops-security/sec-appsec.md rename docs/guides-operator/{guides-security => ops-security}/sec-namespaces.md (100%) rename docs/guides-operator/{guides-security => ops-security}/sec-rbac.md (100%) create mode 100644 docs/guides-operator/readme.md rename docs/guides-operator/troubleshooting/{ts-minikube.md => ts-development.md} (100%) delete mode 100644 docs/guides-welcome/project-overview.md diff --git a/docs/appendix/resources-helm.md b/docs/appendix/resources-helm.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/appendix/resources-kubernetes.md b/docs/appendix/resources-kubernetes.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/guides-developer/dev-helm/function-endpoints.md b/docs/guides-developer/dev-helm/function-endpoints.md deleted file mode 100644 index 706449103a..0000000000 --- a/docs/guides-developer/dev-helm/function-endpoints.md +++ /dev/null @@ -1 +0,0 @@ -# TBD diff --git a/docs/guides-developer/dev-helm/function-hosts.md b/docs/guides-developer/dev-helm/function-hosts.md deleted file mode 100644 index 706449103a..0000000000 --- a/docs/guides-developer/dev-helm/function-hosts.md +++ /dev/null @@ -1 +0,0 @@ -# TBD diff --git a/docs/guides-developer/dev-helm/helm-toolkit.md b/docs/guides-developer/dev-helm/helm-toolkit.md index 706449103a..9f910039de 100644 --- a/docs/guides-developer/dev-helm/helm-toolkit.md +++ b/docs/guides-developer/dev-helm/helm-toolkit.md @@ -1 +1 @@ -# TBD +# Overview: Helm-Toolkit diff --git a/docs/guides-developer/dev-helm/readme.md b/docs/guides-developer/dev-helm/readme.md index c008468685..4dfd7093ac 100644 --- a/docs/guides-developer/dev-helm/readme.md +++ b/docs/guides-developer/dev-helm/readme.md @@ -1,8 +1,11 @@ -# Openstack-Helm development +# Openstack-Helm: Helm Development -## Conceptual Guides: Kubernetes -#### [Helm-Toolkit](helm-toolkit.md) -##### [User Registration](registration-user.md) -##### [Domain Registration](registration-domain.md) -##### [Service Registration](registration-service.md) -##### [Endpoint Registration](registration-endpoint.md) +- [Helm-Toolkit Overview](helm-toolkit.md) - Overview of Helm-Toolkit +- [User Registration](registration-user.md) +- [Domain Registration](registration-domain.md) +- [Host Registration](registration-host.md) +- [Service Registration](registration-service.md) +- [Endpoint Registration](registration-endpoint.md) +- [Tips and Tricks](tips-development.md) - Suggestions and Tips for Development of Openstack-Helm + +# Overview diff --git a/docs/guides-developer/dev-helm/registration-domain.md b/docs/guides-developer/dev-helm/registration-domain.md index 706449103a..e844e80891 100644 --- a/docs/guides-developer/dev-helm/registration-domain.md +++ b/docs/guides-developer/dev-helm/registration-domain.md @@ -1 +1 @@ -# TBD +# Registration: Domains diff --git a/docs/guides-developer/dev-helm/registration-endpoint.md b/docs/guides-developer/dev-helm/registration-endpoint.md index 706449103a..9080393d07 100644 --- a/docs/guides-developer/dev-helm/registration-endpoint.md +++ b/docs/guides-developer/dev-helm/registration-endpoint.md @@ -1 +1 @@ -# TBD +# Registration: Endpoints diff --git a/docs/guides-developer/dev-helm/registration-host.md b/docs/guides-developer/dev-helm/registration-host.md new file mode 100644 index 0000000000..7fc6309510 --- /dev/null +++ b/docs/guides-developer/dev-helm/registration-host.md @@ -0,0 +1 @@ +# Registration: Hosts diff --git a/docs/guides-developer/dev-helm/registration-service.md b/docs/guides-developer/dev-helm/registration-service.md index 706449103a..578daa7382 100644 --- a/docs/guides-developer/dev-helm/registration-service.md +++ b/docs/guides-developer/dev-helm/registration-service.md @@ -1 +1 @@ -# TBD +# Registration: Services diff --git a/docs/guides-developer/dev-helm/registration-user.md b/docs/guides-developer/dev-helm/registration-user.md index 706449103a..74854719a8 100644 --- a/docs/guides-developer/dev-helm/registration-user.md +++ b/docs/guides-developer/dev-helm/registration-user.md @@ -1 +1 @@ -# TBD +# Registration: Users diff --git a/docs/guides-developer/dev-helm/tips-development.md b/docs/guides-developer/dev-helm/tips-development.md index 706449103a..6648c9ba09 100644 --- a/docs/guides-developer/dev-helm/tips-development.md +++ b/docs/guides-developer/dev-helm/tips-development.md @@ -1 +1 @@ -# TBD +# Development: Tips and Tricks diff --git a/docs/guides-developer/dev-kubernetes/considerations.md b/docs/guides-developer/dev-kubernetes/considerations.md new file mode 100644 index 0000000000..2d4432579a --- /dev/null +++ b/docs/guides-developer/dev-kubernetes/considerations.md @@ -0,0 +1 @@ +# Openstack-Helm: Kubernetes Development Considerations diff --git a/docs/guides-developer/readme.md b/docs/guides-developer/readme.md index f886a96f9c..483d8810e8 100644 --- a/docs/guides-developer/readme.md +++ b/docs/guides-developer/readme.md @@ -1 +1,22 @@ # Table of Contents + +- [Getting Started](getting-started/readme.md) - Development Philosophies + - [Default Values](getting-started/gs-values.md) + - [Chart Overrides](getting-started/gs-overrides.md) + - [Replica Guidelines](getting-started/gs-replicas.md) + - [Image Guidelines](getting-started/gs-images.md) + - [Resource Guidelines](getting-started/gs-resources.md) + - [Labeling Guidelines](getting-started/gs-labels.md) + - [Endpoint Considerations](getting-started/gs-endpoints.md) + - [Helm Upgrades Considerations](getting-started/gs-upgrades.md) + - [Using Conditionals](getting-started/gs-conditionals.md) +- [Helm Development Handbook](dev-helm/readme.md) - Hands-On Development Guide + - [Helm-Toolkit Overview](dev-helm/helm-toolkit.md) - Overview of Helm-Toolkit + - [User Registration](dev-helm/registration-user.md) + - [Domain Registration](dev-helm/registration-domain.md) + - [Host Registration](dev-helm/registration-host.md) + - [Service Registration](dev-helm/registration-service.md) + - [Endpoint Registration](dev-helm/registration-endpoint.md) + - [Tips and Tricks](dev-helm/tips-development.md) - Suggestions and Tips for Development of Openstack-Helm +- [Kubernetes Development Handbook](dev-kubernetes/readme.md) + - *More coming soon* diff --git a/docs/guides-install/install-minikube.md b/docs/guides-install/developer/install-minikube.md similarity index 99% rename from docs/guides-install/install-minikube.md rename to docs/guides-install/developer/install-minikube.md index e42fb8cb89..09fcccbfb7 100644 --- a/docs/guides-install/install-minikube.md +++ b/docs/guides-install/developer/install-minikube.md @@ -1,4 +1,4 @@ -# Development of Openstack-Helm +# Openstack-Helm: Minikube Deployment Community development is extremely important to us. As an open source development team, we want the development of Openstack-Helm to be an easy experience. Please evaluate, and make recommendations. We want developers to feel welcome to contribute to this project. Below are some instructions and suggestions to help you get started. diff --git a/docs/guides-install/developer/install-vagrant.md b/docs/guides-install/developer/install-vagrant.md new file mode 100644 index 0000000000..bf9fe88755 --- /dev/null +++ b/docs/guides-install/developer/install-vagrant.md @@ -0,0 +1,41 @@ +# Openstack-Helm: Vagrant Deployment + +**Requirements:** + +- Hardware + - 16GB RAM + - 32GB HDD Space +- Software + - Vagrant >= 1.8.0 + - VirtualBox >= 5.1.0 + - Kubectl + - Helm + - Git + +## Deploy + +Make sure you are in the directory containing the Vagrantfile before running the following commands. + +## Create VM + +vagrant up --provider virtualbox + +## Deploy NFS Provisioner for development PVCs + +``` +vagrant ssh --command "sudo docker exec kubeadm-aio kubectl create -R -f /opt/nfs-provisioner/" +``` + +## Setup Clients and deploy Helm's tiller + +``` +./setup-dev-host.sh +``` + +## Label VM node(s) for OpenStack-Helm Deployment + +``` +kubectl label nodes openstack-control-plane=enabled --all --namespace=openstack +kubectl label nodes openvswitch=enabled --all --namespace=openstack +kubectl label nodes openstack-compute-node=enabled --all --namespace=openstack +``` diff --git a/docs/guides-install/developer/readme.md b/docs/guides-install/developer/readme.md new file mode 100644 index 0000000000..ec57ead11d --- /dev/null +++ b/docs/guides-install/developer/readme.md @@ -0,0 +1,3 @@ +# Openstack-Helm: Development environments +- [Minikube](install-minikube.md) +- [Vagrant](install-vagrant.md) diff --git a/docs/guides-install/install-development.md b/docs/guides-install/install-development.md new file mode 100644 index 0000000000..e7ddf57570 --- /dev/null +++ b/docs/guides-install/install-development.md @@ -0,0 +1 @@ +# Development: Getting Started diff --git a/docs/guides-install/readme.md b/docs/guides-install/readme.md index 4679e0c916..180d205fa0 100644 --- a/docs/guides-install/readme.md +++ b/docs/guides-install/readme.md @@ -1,6 +1,11 @@ # Installation Guides -## Installation Guides -#### [Development: Minikube](install-minikube.md) -#### [Evaluation: AIO](install-aio.md) -#### [Multinode: Multi-Server](install-multinode.md) +- [Development: Getting Started](install-development.md) + - [Minikube](developer/install-minikube.md) + - [Vagrant](developer/install-vagrant.md) +- [Evaluation: AIO](install-aio.md) +- [Multinode: Multi-Server](install-multinode.md) +- [Third-Party Tools](third-party-tools/readme.md) - Optional resources for the deployment of Openstack-Helm + - [Armada](third-party-tools/armada.md) - Multi-Chart fetch and deploy tool from AT&T + +## Overview diff --git a/docs/guides-install/third-pary-tools/armada.md b/docs/guides-install/third-party-tools/armada.md similarity index 100% rename from docs/guides-install/third-pary-tools/armada.md rename to docs/guides-install/third-party-tools/armada.md diff --git a/docs/guides-install/third-party-tools/readme.md b/docs/guides-install/third-party-tools/readme.md new file mode 100644 index 0000000000..6a0fb59dd2 --- /dev/null +++ b/docs/guides-install/third-party-tools/readme.md @@ -0,0 +1,5 @@ +# Third-Party Installation Tools + +- [Armada](armada.md) - Multi-Chart fetch and deploy tool from AT&T + +## Overview diff --git a/docs/guides-operator/guides-kubernetes/readme.md b/docs/guides-operator/guides-kubernetes/readme.md deleted file mode 100644 index 68205646bd..0000000000 --- a/docs/guides-operator/guides-kubernetes/readme.md +++ /dev/null @@ -1,5 +0,0 @@ -# Openstack-Helm development - -## Conceptual Guides: Kubernetes -#### [Init Containers](init-containers.md) -#### [User Registration](registration-user.md) diff --git a/docs/guides-operator/guides-security/readme.md b/docs/guides-operator/guides-security/readme.md deleted file mode 100644 index f2a2b5037e..0000000000 --- a/docs/guides-operator/guides-security/readme.md +++ /dev/null @@ -1,8 +0,0 @@ -# Table of Contents - -##  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 diff --git a/docs/guides-operator/guides-helm/helm-addons.md b/docs/guides-operator/ops-helm/osh-addons.md similarity index 100% rename from docs/guides-operator/guides-helm/helm-addons.md rename to docs/guides-operator/ops-helm/osh-addons.md diff --git a/docs/guides-operator/ops-helm/osh-operations.md b/docs/guides-operator/ops-helm/osh-operations.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/guides-operator/guides-helm/readme.md b/docs/guides-operator/ops-helm/readme.md similarity index 100% rename from docs/guides-operator/guides-helm/readme.md rename to docs/guides-operator/ops-helm/readme.md diff --git a/docs/guides-operator/guides-kubernetes/kb-init-containers.md b/docs/guides-operator/ops-kubernetes/kb-init-containers.md similarity index 100% rename from docs/guides-operator/guides-kubernetes/kb-init-containers.md rename to docs/guides-operator/ops-kubernetes/kb-init-containers.md diff --git a/docs/guides-operator/guides-kubernetes/kb-jobs.md b/docs/guides-operator/ops-kubernetes/kb-jobs.md similarity index 100% rename from docs/guides-operator/guides-kubernetes/kb-jobs.md rename to docs/guides-operator/ops-kubernetes/kb-jobs.md diff --git a/docs/guides-operator/ops-kubernetes/readme.md b/docs/guides-operator/ops-kubernetes/readme.md new file mode 100644 index 0000000000..de1a6ff82a --- /dev/null +++ b/docs/guides-operator/ops-kubernetes/readme.md @@ -0,0 +1,5 @@ +# Openstack-Helm Operations: Kubernetes + +## Conceptual Guides: Kubernetes +- [Init-Containers](kb-init-containers.md) +- [Jobs](kb-jobs.md) diff --git a/docs/guides-operator/guides-network/net-ingress.md b/docs/guides-operator/ops-network/net-ingress.md similarity index 100% rename from docs/guides-operator/guides-network/net-ingress.md rename to docs/guides-operator/ops-network/net-ingress.md diff --git a/docs/guides-operator/guides-network/net-nodeport.md b/docs/guides-operator/ops-network/net-nodeport.md similarity index 100% rename from docs/guides-operator/guides-network/net-nodeport.md rename to docs/guides-operator/ops-network/net-nodeport.md diff --git a/docs/guides-operator/guides-network/readme.md b/docs/guides-operator/ops-network/readme.md similarity index 100% rename from docs/guides-operator/guides-network/readme.md rename to docs/guides-operator/ops-network/readme.md diff --git a/docs/guides-operator/ops-openstack/os-config/os-config-gen.md b/docs/guides-operator/ops-openstack/os-config/os-config-gen.md new file mode 100644 index 0000000000..68218e0762 --- /dev/null +++ b/docs/guides-operator/ops-openstack/os-config/os-config-gen.md @@ -0,0 +1,7 @@ +# Openstack-Helm Operations: Openstack + +## Openstack-Helm Configuration Management + +### Configuration Overrides + +## Oslo Config Generation Tool diff --git a/docs/guides-operator/ops-openstack/readme.md b/docs/guides-operator/ops-openstack/readme.md new file mode 100644 index 0000000000..7e976136f3 --- /dev/null +++ b/docs/guides-operator/ops-openstack/readme.md @@ -0,0 +1,3 @@ +# Openstack-Helm Operations: Openstack + +## Overview diff --git a/docs/guides-operator/ops-security/readme.md b/docs/guides-operator/ops-security/readme.md new file mode 100644 index 0000000000..a33c0b41fe --- /dev/null +++ b/docs/guides-operator/ops-security/readme.md @@ -0,0 +1,6 @@ +# Table of Contents + + +- [Using Namespaces](sec-namespaces.md) +- [SELinux and SECCOMP](sec-appsec.md) +- [Role-Based Access Control](sec-rbac.md) diff --git a/docs/guides-operator/ops-security/sec-appsec.md b/docs/guides-operator/ops-security/sec-appsec.md new file mode 100644 index 0000000000..ef3d0a6500 --- /dev/null +++ b/docs/guides-operator/ops-security/sec-appsec.md @@ -0,0 +1 @@ +# SECCOMP and SELinux diff --git a/docs/guides-operator/guides-security/sec-namespaces.md b/docs/guides-operator/ops-security/sec-namespaces.md similarity index 100% rename from docs/guides-operator/guides-security/sec-namespaces.md rename to docs/guides-operator/ops-security/sec-namespaces.md diff --git a/docs/guides-operator/guides-security/sec-rbac.md b/docs/guides-operator/ops-security/sec-rbac.md similarity index 100% rename from docs/guides-operator/guides-security/sec-rbac.md rename to docs/guides-operator/ops-security/sec-rbac.md diff --git a/docs/guides-operator/readme.md b/docs/guides-operator/readme.md new file mode 100644 index 0000000000..4bf389e3af --- /dev/null +++ b/docs/guides-operator/readme.md @@ -0,0 +1,21 @@ +# Openstack-Helm: Operations Guides +- [Helm Operations](ops-helm/readme.md) - Helm Operator Guides + - [Openstack-Helm Operations](ops-helm/osh-operations.md) + - [Addons and Plugins](ops-helm/osh-addons.md) +- [Kubernetes Operations](ops-kubernetes/readme.md) + - [Init-Containers](ops-kubernetes/kb-init-containers.md) + - [Jobs](ops-kubernetes/kb-jobs.md) +- [Openstack Operations](ops-openstack/readme.md) + - [Config Generation](ops-openstack/os-config/os-config-gen.md) - Openstack-Helm Configuration Management +- [Networking Guides](ops-network/readme.md) - Network Operations + - [Ingress](ops-network/net-ingress.md) + - [Nodeports](ops-network/net-nodeport.md) +- [Security Guides](readme.md) - Security Operations + - [Using Namespaces](ops-security/sec-namespaces.md) + - [SELinux and SECCOMP](ops-security/sec-appsec.md) + - [Role-Based Access Control](ops-security/sec-rbac.md) +- [Troubleshooting Guides](troubleshooting/readme.md) + - [Database Issues](troubleshooting/ts-database.md) + - [Development Issues](troubleshooting/ts-development.md) + - [Networking Issues](troubleshooting/ts-networking.md) + - [Storage Issues](troubleshooting/ts-persistent-storage.md) diff --git a/docs/guides-operator/troubleshooting/ts-minikube.md b/docs/guides-operator/troubleshooting/ts-development.md similarity index 100% rename from docs/guides-operator/troubleshooting/ts-minikube.md rename to docs/guides-operator/troubleshooting/ts-development.md diff --git a/docs/guides-welcome/project-overview.md b/docs/guides-welcome/project-overview.md deleted file mode 100644 index 486cd11919..0000000000 --- a/docs/guides-welcome/project-overview.md +++ /dev/null @@ -1,4 +0,0 @@ -##  2. Repository Structure -###    2.1 Infrastructure Components -###    2.2 Openstack-Helm Core Services -###    2.3 Openstack-Helm Add-Ons diff --git a/docs/guides-welcome/readme.md b/docs/guides-welcome/readme.md index 89a69fa416..359cb241ba 100644 --- a/docs/guides-welcome/readme.md +++ b/docs/guides-welcome/readme.md @@ -1,6 +1,6 @@ ## Table of Contents: Welcome Guide -- [Mission Statement](../readme.me#mission_statement) -- [Overview]](welcome-overview.md) -- [Resiliency]](welcome-resiliency.md) -- [Scaling]](welcome-scaling.md) +- [Mission Statement](../readme.md#mission-statement) +- [Overview](welcome-overview.md) +- [Resiliency](welcome-resiliency.md) +- [Scaling](welcome-scaling.md) diff --git a/docs/guides-welcome/welcome-overview.md b/docs/guides-welcome/welcome-overview.md index 5d10d04bc7..ed899c66ef 100644 --- a/docs/guides-welcome/welcome-overview.md +++ b/docs/guides-welcome/welcome-overview.md @@ -1,3 +1,3 @@ -## Project Overview +## Welcome: Project Overview The goal for OpenStack-Helm is to provide an incredibly customizable *framework* for operators and developers alike. This framework will enable end-users to deploy, maintain, and upgrade a fully functioning OpenStack environment for both simple and complex environments. Administrators or developers can either deploy all or individual OpenStack components along with their required dependencies. It heavily borrows concepts from [Stackanetes](https://github.com/stackanetes/stackanetes) and [other complex Helm application deployments](https://github.com/sapcc/openstack-helm). This project is meant to be a collaborative project that brings Openstack applications into a [Cloud-Native](https://www.cncf.io/about/charter) model. diff --git a/docs/guides-welcome/welcome-resiliency.md b/docs/guides-welcome/welcome-resiliency.md index 27b09fc050..fea0ba9e82 100644 --- a/docs/guides-welcome/welcome-resiliency.md +++ b/docs/guides-welcome/welcome-resiliency.md @@ -1,4 +1,4 @@ -## Resiliency +## Welcome: Resiliency Philosophy One of the goals of this project is to produce a set of charts that can be used in a production setting to deploy and upgrade OpenStack. To achieve this goal, all components must be resilient, including both OpenStack and Infrastructure components leveraged by this project. In addition, this also includes Kubernetes itself. It is part of our mission to ensure that all infrastructure components are highly available and that a deployment can withstand a physical host failure out of the box. This means that: diff --git a/docs/guides-welcome/welcome-scaling.md b/docs/guides-welcome/welcome-scaling.md index 76d7bab7c7..39bb511491 100644 --- a/docs/guides-welcome/welcome-scaling.md +++ b/docs/guides-welcome/welcome-scaling.md @@ -1,4 +1,4 @@ -## Scaling +## Welcome: Scaling Philosophy Scaling is another first class citizen in openstack-helm. We will be working to ensure that we support various deployment models that can support hyperscale, such as: diff --git a/docs/readme.md b/docs/readme.md index c9fb57fd18..034037b29a 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -10,14 +10,16 @@ Openstack-Helm is a project that provides a flexible, production-grade Kubernet The documentation provided for Openstack-Helm are provided in the following role-specific guides: -- [Welcome Guide](guides_welcome/readme.md) - - [Mission](guides_welcome/mission.md) - Openstack-Helm Mission Statement - - [Project Overview](guides_welcome/welcome-overview.md) - - [Resiliency Philosophy](guides_welcome/welcome-resiliency.md) - - [Scalability Philosophy](guides_welcome/welcome-scaling.md) -- [Installation Guides](guides-install/readme.md) - +- [Welcome Guide](guides-welcome/readme.md) + - [Mission](#mission-statement) - Openstack-Helm Mission Statement + - [Project Overview](guides-welcome/welcome-overview.md) + - [Resiliency Philosophy](guides-welcome/welcome-resiliency.md) + - [Scalability Philosophy](guides-welcome/welcome-scaling.md) +- [Installation Guides](guides-install/readme.md) - Various Installation Options + - [Developer Installation](guides-install/developer/readme.md) - Environment for Openstack-Helm Development + - [Minikube](guides-install/developer/install-minikube.md) + - [Vagrant](guides-install/developer/install-vagrant.md) - [All-in-One](guides-install/install-aio.md) - Evaluation of Openstack-Helm - - [Developer Installation](guides-install/install-minikube.md) - Envirnment for Openstack-Helm Development - [Multinode](guides-install/install-multinode.md) - Multinode or Production Deployments - [Developer Guides](guides-developer/readme.md) - Resources for Openstack-Helm Developers - [Getting Started](guides-developer/getting-started/readme.md) - Development Philosophies @@ -30,28 +32,45 @@ The documentation provided for Openstack-Helm are provided in the following role - [Endpoint Considerations](guides-developer/getting-started/gs-endpoints.md) - [Helm Upgrades Considerations](guides-developer/getting-started/gs-upgrades.md) - [Using Conditionals](guides-developer/getting-started/gs-conditionals.md) - - [Helm Development Handbook](guides-developer/install-minikube.md) - Hands-On Development Guide - - [Helm-Toolkit Overview](guides-developer/) - Overview of Helm-Toolkit - - [User Registration](guides-developer/guides-devs-helm/registration-user.md) - - [Domain Registration](guides-developer/guides-devs-helm/registration-domain.md) - - [Host Registration](guides-developer/guides-devs-helm/registration-host.md) - - [Service Registration](guides-developer/guides-devs-helm/registration-service.md) - - [Kubernetes Development Handbook](guides-developer/install-multinode.md) - + - [Helm Development Handbook](guides-developer/readme.md) - Hands-On Development Guide + - [Getting Started](guides-developer/getting-started/readme.md) - Development Philosophies + - [Default Values](guides-developer/getting-started/gs-values.md) + - [Chart Overrides](guides-developer/getting-started/gs-overrides.md) + - [Replica Guidelines](guides-developer/getting-started/gs-replicas.md) + - [Image Guidelines](guides-developer/getting-started/gs-images.md) + - [Resource Guidelines](guides-developer/getting-started/gs-resources.md) + - [Labeling Guidelines](guides-developer/getting-started/gs-labels.md) + - [Endpoint Considerations](guides-developer/getting-started/gs-endpoints.md) + - [Helm Upgrades Considerations](guides-developer/getting-started/gs-upgrades.md) + - [Using Conditionals](guides-developer/getting-started/gs-conditionals.md) + - [Helm-Toolkit Overview](guides-developer/dev-helm/helm-toolkit.md) - Overview of Helm-Toolkit + - [User Registration](guides-developer/dev-helm/registration-user.md) + - [Domain Registration](guides-developer/dev-helm/registration-domain.md) + - [Host Registration](guides-developer/dev-helm/registration-host.md) + - [Endpoint Registration](guides-developer/dev-helm/registration-endpoint.md) + - [Service Registration](guides-developer/dev-helm/registration-service.md) + - [Kubernetes Development Handbook](guides-developer/dev-kubernetes/readme.md) + - [Kubernetes Development Considerations](guides-developer/dev-kubernetes/considerations.md) - [Operator Guides](guides-operator/readme.md) - Resources for Openstack-Helm Developers - - [Helm Operations](guides-operator/getting-started/readme.md) - Helm Operator Guides - - [Addons and Plugins](guides-operator/getting-started/helm-addons.md) - - [Kubernetes Operations](guides-operator/readme.md) - - [Init Containers](guides-operator/readme.md) - - [Jobs](guides-operator/readme.md) + - [Helm Operations](guides-operator/ops-helm/readme.md) - Helm Operator Guides + - [Openstack-Helm Operations](guides-operator/ops-helm/osh-operations.md) + - [Addons and Plugins](guides-operator/ops-helm/osh-addons.md) + - [Kubernetes Operations](guides-operator/ops-kubernetes/readme.md) + - [Init-Containers](guides-operator/ops-kubernetes/kb-init-containers.md) + - [Jobs](guides-operator/ops-kubernetes/kb-jobs.md) - [Openstack Operations](guides-operator/readme.md) - - [Config Generation](guides-operator/readme.md) - Openstack-Helm Configuration Management - - [Networking Guides](guides-operator/readme.md) - Network Operations - - [Ingress](guides-operator/readme.md) - - [Nodeports](guides-operator/readme.md) + - [Config Generation](guides-operator/ops-openstack/os-config/os-config-gen.md) - Openstack-Helm Configuration Management + - [Networking Guides](guides-operator/ops-network/readme.md) - Network Operations + - [Ingress](guides-operator/ops-network/net-ingress.md) + - [Nodeports](guides-operator/ops-network/net-nodeport.md) - [Security Guides](guides-operator/readme.md) - Security Operations - - [Namespace Isolation](guides-operator/readme.md) - - [SELinux and SECCOMP](guides-operator/readme.md) - - [Role-Based Access Control](guides-operator/readme.md) -- [Troubleshooting Guides](charts.md) -- [Appendix A: Helm Resources](charts.md) - Curated List of Helm Resources -- [Appendix B: Kubernetes Resources](charts.md) - Curated List of Kubernetes Resources + - [Using Namespaces](guides-operator/ops-security/sec-namespaces.md) + - [SELinux and SECCOMP](guides-operator/ops-security/sec-appsec.md) + - [Role-Based Access Control](guides-operator/ops-security/sec-rbac.md) +- [Troubleshooting Guides](guides-operator/troubleshooting/readme.md) + - [Database Issues](guides-operator/troubleshooting/ts-database.md) + - [Development Issues](troubleshooting/ts-development.md) + - [Networking Issues](guides-operator/troubleshooting/ts-networking.md) + - [Storage Issues](guides-operator/troubleshooting/ts-persistent-storage.md) +- [Appendix A: Helm Resources](appendix/resources-helm.md) - Curated List of Helm Resources +- [Appendix B: Kubernetes Resources](appendix/resources-kubernetes.md) - Curated List of Kubernetes Resources