From e978fceacbfb49fb637727913f081e28a4c9f2fe Mon Sep 17 00:00:00 2001 From: Pengfei Ni Date: Fri, 4 Aug 2017 10:32:50 +0800 Subject: [PATCH] Fix document format, e.g. numbers and paragraph Change-Id: I914ea3968513af77d8aacfc21973f06b2065608e Signed-off-by: Pengfei Ni --- doc/source/architecture.rst | 7 +++-- doc/source/conf.py | 2 -- doc/source/stackube_scope_clarification.rst | 33 ++++++++++++++------- 3 files changed, 26 insertions(+), 16 deletions(-) diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index 89717f6..b26e364 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -16,13 +16,13 @@ Hyper, and offers built-in soft/hard multi-tenancy (depending on the container r Components =========== -#. Standard OpenStack Compoents +1. Standard OpenStack Compoents * OpenStack Keytone * OpenStack Neutron * OpenStack Cinder -#. Standard Kubernetes Components +2. Standard Kubernetes Components * Etcd: the storage of kubernetes. * Kube-apiserver: the API, authn/authz and admission control of kubernetes. @@ -32,8 +32,9 @@ Components * Frakti&HyperContainer: a hypervisor-based container runtime. * Docker: docker container runtime. -#. Stackube addons +3. Stackube addons * Stackube-controller: tenant and network manager. * Stackube-proxy: service discovery and load balancing, replacement of kube-proxy. * Kubestack: the CNI network plugin, which connects containers to Neutron network. + diff --git a/doc/source/conf.py b/doc/source/conf.py index 9b5f17b..bd7754c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -51,8 +51,6 @@ extensions = ['sphinx.ext.autodoc', 'openstackdocstheme', 'oslosphinx', 'support_matrix', - 'oslo_config.sphinxext', - 'oslo_config.sphinxconfiggen', ] # openstackdocstheme options diff --git a/doc/source/stackube_scope_clarification.rst b/doc/source/stackube_scope_clarification.rst index 362bd14..7f13477 100644 --- a/doc/source/stackube_scope_clarification.rst +++ b/doc/source/stackube_scope_clarification.rst @@ -87,29 +87,40 @@ us (and we’d like to) integrate it with any OpenStack-Kubernetes plugin. But right now, we hope to keep everything as simple as possible and focus on the core components. -A typical deployment workflow of Stackube +Deployment workflow ========================================= -On control nodes: +----------------- +On control nodes +----------------- -#. Install standalone Keystone, Neutron, Cinder (ceph rbd) +Install standalone Keystone, Neutron, Cinder (ceph rbd). +This can be done by any existing tools like devstack, RDO etc. - * This can be done by any existing tool like devstack, RDO etc +---------------- +On other nodes +---------------- -On other nodes: +1. Install neutron L2 agents -#. Install Kubernetes + This can be done by any existing tools like devstack, RDO etc. + +2. Install Kubernetes * Including container runtimes, CRI shims, CNI etc - * This can be done by any existing tool like kubeadm etc + * This can be done by any existing tools like kubeadm etc -Deploy Stackube: +3. Deploy Stackube -#. *kubectl apply -f stackube.yaml* +:: - * This will deploy all Stackube plugins as Pods and DaemonSets to the cluster + kubectl create -f stackube-configmap.yaml + kubectl create -f deployment/stackube-proxy.yaml + kubectl create -f deployment/stackube.yaml -(You can also deploy all these components in a single node) + +This will deploy all Stackube plugins as Pods and DaemonSets to the +cluster. You can also deploy all these components in a single node. After that, users can use Kubernetes API to manage containers with hypervisor isolation, Neutron network, Cinder volume and tenant