openstack-helm/docs/readme.md

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
    • Minikube
    • Vagrant
  • All-in-One - Evaluation of Openstack-Helm
  • Multinode - Multinode or Production Deployments
• Developer Guides - Resources for Openstack-Helm Developers
  • Getting Started - Development Philosophies
    • Default Values
    • Chart Overrides
    • Replica Guidelines
    • Image Guidelines
    • Resource Guidelines
    • Labeling Guidelines
    • Endpoint Considerations
    • Helm Upgrades Considerations
    • Using Conditionals
  • Helm Development Handbook - Hands-On Development Guide
    • Getting Started - Development Philosophies
      • Default Values
      • Chart Overrides
      • Replica Guidelines
      • Image Guidelines
      • Resource Guidelines
      • Labeling Guidelines
      • Endpoint Considerations
      • Helm Upgrades Considerations
      • Using Conditionals
    • Helm-Toolkit Overview - Overview of Helm-Toolkit
    • User Registration
    • Domain Registration
    • Host Registration
    • Endpoint Registration
    • Service Registration
  • Kubernetes Development Handbook
    • Kubernetes Development Considerations
• Operator Guides - Resources for Openstack-Helm Developers
  • Helm Operations - Helm Operator Guides
    • Openstack-Helm Operations
    • Addons and Plugins
  • Kubernetes Operations
    • Init-Containers
    • Jobs
  • Openstack Operations
    • Config Generation - Openstack-Helm Configuration Management
  • Networking Guides - Network Operations
    • Ingress
    • Nodeports
  • Security Guides - Security Operations
    • Using Namespaces
    • SELinux and SECCOMP
    • Role-Based Access Control
• Troubleshooting Guides
  • Database Issues
  • Development Issues
  • Networking Issues
  • Storage Issues
• Appendix A: Helm Resources - Curated List of Helm Resources
• Appendix B: Kubernetes Resources - Curated List of Kubernetes Resources