Michał Dulko e795466247 Beggining of docs conversion to OpenStack format

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

2017-04-27 17:04:17 +02:00

3.0 KiB

Raw Blame History

Openstack-Helm

Openstack-Helm is a fully self-contained Helm-based OpenStack deployment on Kubernetes. It will provide baremetal provisioning, persistent storage, full-stack resiliency, full-stack scalability, performance monitoring and tracing, and an optional development pipeline (using Jenkins). This project, along with the tools used within are community-based and open sourced.

Mission

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 dependancies. It heavily borrows concepts from Stackanetes and other complex Helm application deployments. This project is meant to be a collaborative project that brings Openstack applications into a Cloud-Native model.

Communication

Join us on Slack - #openstack-helm
Join us on IRC: #openstack-helm on freenode
Community IRC Meetings: [Every Tuesday @ 3PM UTC], #openstack-meeting-5 on freenode
Meeting Agenda Items: Agenda
Community Roadmap Items: Roadmap Docs

Open Releases

Until a 1.0.0 release, this collection is a work in progress and components will continue to be added or modified over time. Please review our Milestones, and Releases for more information.

Installation and Development

This project is under heavy development. We encourage anyone who is interested in Openstack-Helm to review our Installation documentation, complete with verification procedures. Feel free to ask questions or check out our current Issues and Bugs.

Openstack-Helm is intended to be packaged and served from your own Helm repository. However, for quick installation, evaluation, and convenience, you can use our online Helm repository. After you've configured your environment for Minikube (for hostPath) or Bare Metal.