From 9a88c2919ae3dc8a9bd59f14df11e2067bf36148 Mon Sep 17 00:00:00 2001 From: Steven Dake <sdake@redhat.com> Date: Sat, 20 Sep 2014 21:10:29 -0700 Subject: [PATCH] Improve README.md This improves the README.md file to document what has been completed. --- README.md | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 74dbe98081..e1a9f8e1df 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,48 @@ superhappyfunshow ================= A proof of concept demonstrating deployment of OpenStack Services within Docker -containers using Kubernetes on Project Atomic. +containers using Kubernetes. Getting Started -================= +=============== Kubernetes deployment on bare metal is a complex topic which is beyond the scope of this project at this time. The developers still require a test environment. As a result, one of the developers has created a Heat based -deployment tool that can be found here: +deployment tool that can be +found [here](https://github.com/larsks/heat-kubernetes). -https://github.com/larsks/heat-kubernetes + +Build Docker Images +------------------- + +Within the docker directory is a tool called build. This tool will build +all of the docker images that have been implemented. Each OpenStack service is +implemented as a separate container that can later be registered with +Kubernetes. + +** [sdake@bigiron docker]$ sudo ./build ** + +A 20-30 minute build process will begin where containers will be built for +each OpenStack service. Once finished the docker images can be examined with +the docker CLI. + +** [sdake@bigiron docker]$ sudo docker images ** + +A list of the built docker images will be shown. + +Note at this time the images do not yet work correctly or operate on their +defined environment variables. They are essentially placeholders. + + +Use Kubernetes to Deploy OpenStack +---------------------------------- + +This has not been implemented. Directories -================= +=========== -* docker - contains artifacts for use with docker build to build appropriate images +* docker - contains artifacts for use with docker build to build appropriate images