From 2ce7d48bc5533231febcff9f4ca7b91df8bb6fe5 Mon Sep 17 00:00:00 2001 From: Proskurin Kirill Date: Fri, 2 Sep 2016 16:27:06 +0300 Subject: [PATCH] Update README doc a bit Change-Id: I91f0b7a135e7f45be83cc5a3678fe9a98c1d675c --- README.rst | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 0ef0f887..6b4a5eda 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,13 @@ -======== -fuel-ccp -======== +============================= +Welcome to CCP documentation! +============================= -Docker images builder for OpenStack services and infra. +CCP Overview +============ -Please feel here a long description which must be at least 3 lines wrapped on -80 cols, so that distribution package maintainers can use it in their packages. -Note that this is a hard requirement. +CCP stands for "Containerized Control Plane". The goal of this project is to +make building, running and managing production-ready OpenStack containers +on top of Kubernetes an easy task for operators. * Free software: Apache license * Documentation: http://docs.openstack.org/developer/fuel-ccp @@ -16,4 +17,14 @@ Note that this is a hard requirement. Features -------- -* TODO +* Build and customize OpenStack Docker images +* Run, manage and update OpenStack containers in Kubernetes cluster +* Monitoring and centralized logging system + +Directories +----------- + +- doc - Contains documentation. +- etc - Contains configuration examples. +- fuel_ccp - Contains source code of the project. +- tools - Contains usefull utilites for development purposes.