e795466247
This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340 |
||
|---|---|---|
| .. | ||
| appendix | ||
| guides-developer | ||
| guides-install | ||
| guides-operator | ||
| guides-welcome | ||
| conf.py | ||
| contributing.rst | ||
| index.rst | ||
| readme.md | ||
| readme.rst | ||
Openstack-Helm
Welcome to the Openstack-Helm project!
Mission Statement
Openstack-Helm is a project that provides a flexible, production-grade Kubernetes deployment of Openstack Services using Kubernetes/Helm deployment primitives. The charts contained within the Openstack-Helm project are designed to be a plenary framework of self-contained, service-level manifest templates for development, operations, and troubleshooting, leveraging upstream Kubernetes and Helm best practices with third-party add-ons treated as a last resort.
Table of Contents
The documentation provided for Openstack-Helm are provided in the following role-specific guides:
- Welcome Guide
- Mission - Openstack-Helm Mission Statement
- Project Overview
- Resiliency Philosophy
- Scalability Philosophy
- Installation Guides - Various Installation Options
- Developer Installation - Environment for Openstack-Helm Development
- All-in-One - Evaluation of Openstack-Helm
- Multinode - Multinode or Production Deployments
- Developer Guides - Resources for Openstack-Helm Developers
- Getting Started - Development Philosophies
- Helm Development Handbook - Hands-On Development Guide
- Getting Started - Development Philosophies
- Helm-Toolkit Overview - Overview of Helm-Toolkit
- User Registration
- Domain Registration
- Host Registration
- Endpoint Registration
- Service Registration
- Kubernetes Development Handbook
- Operator Guides - Resources for Openstack-Helm Developers
- Helm Operations - Helm Operator Guides
- Kubernetes Operations
- Openstack Operations
- Config Generation - Openstack-Helm Configuration Management
- Networking Guides - Network Operations
- Security Guides - Security Operations
- Troubleshooting Guides
- Appendix A: Helm Resources - Curated List of Helm Resources
- Appendix B: Kubernetes Resources - Curated List of Kubernetes Resources