openstack/openstack-helm
Code Issues Proposed changes

Update README

Browse Source 
Updates the README with links to blueprints, bugs, and removes
redundant information. Also updates references to evaluating
openstack-helm

Change-Id: I2d5dcba8e73bc91d35411584b9d649e4d6fdbcf7
This commit is contained in:
Steve Wilkerson 2017-07-03 10:59:19 -05:00
parent 8ff8e7aeb2
commit da1df3aa62
1 changed files with 18 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.rst
View File

@ -2,25 +2,12 @@
Openstack-Helm 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 Mission
------- -------
The goal for Openstack-Helm is to provide an incredibly customizable The goal of OpenStack-Helm is to enable deployment, maintenance, and upgrading
*framework* for operators and developers alike. This framework will enable of loosely coupled OpenStack services and their dependencies individually or as
end-users to deploy, maintain, and upgrade a fully functioning Openstack part of complex environments.
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 Communication
------------- -------------
@ -32,31 +19,28 @@ Communication
#openstack-meeting-5 on freenode #openstack-meeting-5 on freenode
* Meeting Agenda Items: `Agenda * Meeting Agenda Items: `Agenda
<https://etherpad.openstack.org/p/openstack-helm-meeting-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 Launchpad
------------- ---------
Until a 1.0.0 release, this collection is a work in progress and components Bugs and blueprints are tracked via OpenStack-Helm's Launchpad.
will continue to be added or modified over time. Please review our
`Milestones <https://launchpad.net/openstack-helm>`_, and `Releases * `Bugs <https://bugs.launchpad.net/openstack-helm>`_
<https://github.com/openstack/openstack-helm/releases>`_ for more information. * `Blueprints <https://blueprints.launchpad.net/openstack-helm>`_
Installation and Development Installation and Development
---------------------------- ----------------------------
This project is under heavy development. We encourage anyone who is interested
in Openstack-Helm to review our `Installation <http://openstack-helm.readthedocs.io/en/latest/install/index.html>`_
documentation, complete with verification procedures. Feel free to ask
questions or check out our current `Issues and Bugs
<https://bugs.launchpad.net/openstack-helm>`_.
Please review our documentation at `Read the Docs <http://openstack-helm.readthedocs.io/>`_. Please review our documentation at `Read the Docs <http://openstack-helm.readthedocs.io/>`_.
For quick installation, evaluation, and convenience, you can use our For quick installation, evaluation, and convenience, we have provided a kubeadm
online Helm repository and configure your environment with `Kubeadm-AIO based all-in-one solution that runs in a Docker container. The Kubeadm-AIO set
<http://openstack-helm.readthedocs.io/en/latest/install/all-in-one.html>`_. up can be found `here. <http://openstack-helm.readthedocs.io/en/latest/install/all-in-one.html>`_
For a production-like install, follow the This project is under active development. We encourage anyone interested in
OpenStack-Helm to review our `Installation <http://openstack-helm.readthedocs.io/en/latest/install/index.html>`_
documentation, complete with verification procedures. Feel free to ask questions
or check out our current `Issues and Bugs <https://bugs.launchpad.net/openstack-helm>`_.
To evaluate a multinode installation, follow the
`Bare Metal <http://openstack-helm.readthedocs.io/en/latest/install/multinode.html>`_ `Bare Metal <http://openstack-helm.readthedocs.io/en/latest/install/multinode.html>`_
install guide. install guide.