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
63 lines
3.0 KiB
ReStructuredText
63 lines
3.0 KiB
ReStructuredText
==============
|
|
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 <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.
|
|
|
|
Communication
|
|
-------------
|
|
|
|
* Join us on `Slack <http://slack.k8s.io/>`_ - #openstack-helm
|
|
* Join us on `IRC <irc://chat.freenode.net:6697/openstack-helm>`_:
|
|
#openstack-helm on freenode
|
|
* Community IRC Meetings: [Every Tuesday @ 3PM UTC],
|
|
#openstack-meeting-5 on freenode
|
|
* Meeting Agenda Items: `Agenda
|
|
<https://etherpad.openstack.org/p/openstack-helm-meeting-agenda>`_
|
|
* Community Roadmap Items: `Roadmap Docs
|
|
<https://docs.google.com/spreadsheets/d/1N5AdAdLbvpZ9Tzi1TuqeJbHyczfZRysBIYE_ndnZx6c/edit?usp=sharing>`_
|
|
|
|
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 <https://launchpad.net/openstack-helm>`_, and `Releases
|
|
<https://github.com/openstack/openstack-helm/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
|
|
<https://github.com/openstack/openstack-helm/blob/master/doc/source/guides-install/readme.md>`_
|
|
documentation, complete with verification procedures. Feel free to ask
|
|
questions or check out our current `Issues and Bugs
|
|
<https://bugs.launchpad.net/openstack-helm>`_.
|
|
|
|
Openstack-Helm is intended to be packaged and served from your own Helm
|
|
`repository <https://github.com/kubernetes/helm/blob/master/docs/chart_repository.md>`_.
|
|
However, for quick installation, evaluation, and convenience, you can use our
|
|
online Helm repository. After you've configured your environment for `Minikube
|
|
<https://github.com/openstack/openstack-helm/blob/master/doc/source/guides-install/developer/install-minikube.md#openstack-helm-minikube-deployment>`_
|
|
(for hostPath) or `Bare Metal
|
|
<https://github.com/openstack/openstack-helm/blob/master/doc/source/guides-install/install-multinode.md#overview>`_.
|