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.
This commit is contained in:
Brandon B. Jozsa
Pete Birley
parent
e337f288e3
commit
85646b2d1c
0
docs/appendix/resources-helm.md
Normal file
0
docs/appendix/resources-helm.md
Normal file
0
docs/appendix/resources-kubernetes.md
Normal file
0
docs/appendix/resources-kubernetes.md
Normal file
@ -1 +0,0 @@
|
||||
# TBD
|
||||
@ -1 +0,0 @@
|
||||
# TBD
|
||||
@ -1 +1 @@
|
||||
# TBD
|
||||
# Overview: Helm-Toolkit
|
||||
|
||||
@ -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
|
||||
|
||||
@ -1 +1 @@
|
||||
# TBD
|
||||
# Registration: Domains
|
||||
|
||||
@ -1 +1 @@
|
||||
# TBD
|
||||
# Registration: Endpoints
|
||||
|
||||
1
docs/guides-developer/dev-helm/registration-host.md
Normal file
1
docs/guides-developer/dev-helm/registration-host.md
Normal file
@ -0,0 +1 @@
|
||||
# Registration: Hosts
|
||||
@ -1 +1 @@
|
||||
# TBD
|
||||
# Registration: Services
|
||||
|
||||
@ -1 +1 @@
|
||||
# TBD
|
||||
# Registration: Users
|
||||
|
||||
@ -1 +1 @@
|
||||
# TBD
|
||||
# Development: Tips and Tricks
|
||||
|
||||
1
docs/guides-developer/dev-kubernetes/considerations.md
Normal file
1
docs/guides-developer/dev-kubernetes/considerations.md
Normal file
@ -0,0 +1 @@
|
||||
# Openstack-Helm: Kubernetes Development Considerations
|
||||
@ -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*
|
||||
|
||||
@ -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.
|
||||
|
||||
41
docs/guides-install/developer/install-vagrant.md
Normal file
41
docs/guides-install/developer/install-vagrant.md
Normal file
@ -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
|
||||
```
|
||||
3
docs/guides-install/developer/readme.md
Normal file
3
docs/guides-install/developer/readme.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Openstack-Helm: Development environments
|
||||
- [Minikube](install-minikube.md)
|
||||
- [Vagrant](install-vagrant.md)
|
||||
1
docs/guides-install/install-development.md
Normal file
1
docs/guides-install/install-development.md
Normal file
@ -0,0 +1 @@
|
||||
# Development: Getting Started
|
||||
@ -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
|
||||
|
||||
5
docs/guides-install/third-party-tools/readme.md
Normal file
5
docs/guides-install/third-party-tools/readme.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Third-Party Installation Tools
|
||||
|
||||
- [Armada](armada.md) - Multi-Chart fetch and deploy tool from AT&T
|
||||
|
||||
## Overview
|
||||
@ -1,5 +0,0 @@
|
||||
# Openstack-Helm development
|
||||
|
||||
## Conceptual Guides: Kubernetes
|
||||
#### [Init Containers](init-containers.md)
|
||||
#### [User Registration](registration-user.md)
|
||||
@ -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
|
||||
0
docs/guides-operator/ops-helm/osh-operations.md
Normal file
0
docs/guides-operator/ops-helm/osh-operations.md
Normal file
5
docs/guides-operator/ops-kubernetes/readme.md
Normal file
5
docs/guides-operator/ops-kubernetes/readme.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Openstack-Helm Operations: Kubernetes
|
||||
|
||||
## Conceptual Guides: Kubernetes
|
||||
- [Init-Containers](kb-init-containers.md)
|
||||
- [Jobs](kb-jobs.md)
|
||||
@ -0,0 +1,7 @@
|
||||
# Openstack-Helm Operations: Openstack
|
||||
|
||||
## Openstack-Helm Configuration Management
|
||||
|
||||
### Configuration Overrides
|
||||
|
||||
## Oslo Config Generation Tool
|
||||
3
docs/guides-operator/ops-openstack/readme.md
Normal file
3
docs/guides-operator/ops-openstack/readme.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Openstack-Helm Operations: Openstack
|
||||
|
||||
## Overview
|
||||
6
docs/guides-operator/ops-security/readme.md
Normal file
6
docs/guides-operator/ops-security/readme.md
Normal file
@ -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)
|
||||
1
docs/guides-operator/ops-security/sec-appsec.md
Normal file
1
docs/guides-operator/ops-security/sec-appsec.md
Normal file
@ -0,0 +1 @@
|
||||
# SECCOMP and SELinux
|
||||
21
docs/guides-operator/readme.md
Normal file
21
docs/guides-operator/readme.md
Normal file
@ -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)
|
||||
@ -1,4 +0,0 @@
|
||||
## 2. Repository Structure
|
||||
### 2.1 Infrastructure Components
|
||||
### 2.2 Openstack-Helm Core Services
|
||||
### 2.3 Openstack-Helm Add-Ons
|
||||
@ -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)
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user