From da1df3aa62e987a5f84e85fd8b239da4a6d8d968 Mon Sep 17 00:00:00 2001 From: Steve Wilkerson Date: Mon, 3 Jul 2017 10:59:19 -0500 Subject: [PATCH] Update README Updates the README with links to blueprints, bugs, and removes redundant information. Also updates references to evaluating openstack-helm Change-Id: I2d5dcba8e73bc91d35411584b9d649e4d6fdbcf7 --- README.rst | 52 ++++++++++++++++++---------------------------------- 1 file changed, 18 insertions(+), 34 deletions(-) diff --git a/README.rst b/README.rst index ee9c820b12..a99edfe77d 100644 --- a/README.rst +++ b/README.rst @@ -2,25 +2,12 @@ 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. +The goal of OpenStack-Helm is to enable deployment, maintenance, and upgrading +of loosely coupled OpenStack services and their dependencies individually or as +part of complex environments. Communication ------------- @@ -32,31 +19,28 @@ Communication #openstack-meeting-5 on freenode * Meeting Agenda Items: `Agenda `_ -* Community Roadmap Items: `Roadmap Docs - `_ -Open Releases -------------- +Launchpad +--------- -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. +Bugs and blueprints are tracked via OpenStack-Helm's Launchpad. + +* `Bugs `_ +* `Blueprints `_ 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 -`_. - Please review our documentation at `Read the Docs `_. -For quick installation, evaluation, and convenience, you can use our -online Helm repository and configure your environment with `Kubeadm-AIO -`_. +For quick installation, evaluation, and convenience, we have provided a kubeadm +based all-in-one solution that runs in a Docker container. The Kubeadm-AIO set +up can be found `here. `_ -For a production-like install, follow the +This project is under active development. We encourage anyone 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 `_. + +To evaluate a multinode installation, follow the `Bare Metal `_ install guide.