From 16ce059e3e35d983a4f8d4782965446d95e6f01b Mon Sep 17 00:00:00 2001 From: sayalilunkad Date: Tue, 27 Mar 2018 15:47:22 +0200 Subject: [PATCH] Adding glossary.rst This patch attemps to take some of the content from the guides and make a glossary which can then be referenced where needed. Change-Id: Ifb360401556fb0aacd4136e7a08ee1440b7c9d62 Partially-Implements: blueprint docs-refactor --- doc/source/index.rst | 1 + doc/source/user/glossary.rst | 80 ++++++++++++++++++++++++++++++++++++ doc/source/user/index.rst | 55 +------------------------ 3 files changed, 83 insertions(+), 53 deletions(-) create mode 100644 doc/source/user/glossary.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 14153d03fe..8d7b42a02e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -59,6 +59,7 @@ User Documentation :maxdepth: 1 user/index + user/glossary.rst Contributor Guide ================= diff --git a/doc/source/user/glossary.rst b/doc/source/user/glossary.rst new file mode 100644 index 0000000000..22bdabd205 --- /dev/null +++ b/doc/source/user/glossary.rst @@ -0,0 +1,80 @@ +======== +Glossary +======== + +Magnum Terminology +~~~~~~~~~~~~~~~~~~ + +.. glossary:: + +Cluster (previously Bay) + A cluster is the construct in which Magnum launches container orchestration + engines. After a cluster has been created the user is able to add containers + to it either directly, or in the case of the Kubernetes container + orchestration engine within pods - a logical construct specific to that + implementation. A cluster is created based on a ClusterTemplate. + +ClusterTemplate (previously BayModel) + A ClusterTemplate in Magnum is roughly equivalent to a flavor in Nova. It + acts as a template that defines options such as the container orchestration + engine, keypair and image for use when Magnum is creating clusters using + the given ClusterTemplate. + +Container Orchestration Engine (COE) + A container orchestration engine manages the lifecycle of one or more + containers, logically represented in Magnum as a cluster. Magnum supports a + number of container orchestration engines, each with their own pros and cons, + including Docker Swarm, Kubernetes, and Mesos. + +Labels + Labels is a general method to specify supplemental parameters that are + specific to certain COE or associated with certain options. Their + format is key/value pair and their meaning is interpreted by the + drivers that uses them. + +Cluster Drivers + A cluster driver is a collection of python code, heat templates, scripts, + images, and documents for a particular COE on a particular distro. Magnum + presents the concept of ClusterTemplates and clusters. The implementation + for a particular cluster type is provided by the cluster driver. In other + words, the cluster driver provisions and manages the infrastructure for the + COE. + +Kubernetes Terminology +~~~~~~~~~~~~~~~~~~~~~~ + +.. glossary:: + +Kubernetes uses a range of terminology that we refer to in this guide. We +define these common terms for your reference: + +Pod + When using the Kubernetes container orchestration engine, a pod is the + smallest deployable unit that can be created and managed. A pod is a + co-located group of application containers that run with a shared context. + When using Magnum, pods are created and managed within clusters. Refer to the + `pods section + `_ in the `Kubernetes + User Guide`_ for more information. + +Replication controller + A replication controller is used to ensure that at any given time a certain + number of replicas of a pod are running. Pods are automatically created and + deleted by the replication controller as necessary based on a template to + ensure that the defined number of replicas exist. Refer to the `replication + controller section + `_ in + the `Kubernetes User Guide`_ for more information. + +Service + A service is an additional layer of abstraction provided by the Kubernetes + container orchestration engine which defines a logical set of pods and a + policy for accessing them. This is useful because pods are created and + deleted by a replication controller, for example, other pods needing to + discover them can do so via the service abstraction. Refer to the + `services section + `_ in the + `Kubernetes User Guide`_ for more information. + +.. _Kubernetes User Guide: http://kubernetes.io/v1.0/docs/user-guide/ + diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 995f02078d..ea4454b3a0 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -34,28 +34,6 @@ created and managed by Magnum to support the COE's. #. `Container Monitoring`_ #. `Kubernetes External Load Balancer`_ -Terminology -=========== - -Cluster (previously Bay) - A cluster is the construct in which Magnum launches container orchestration - engines. After a cluster has been created the user is able to add containers - to it either directly, or in the case of the Kubernetes container - orchestration engine within pods - a logical construct specific to that - implementation. A cluster is created based on a ClusterTemplate. - -ClusterTemplate (previously BayModel) - A ClusterTemplate in Magnum is roughly equivalent to a flavor in Nova. It - acts as a template that defines options such as the container orchestration - engine, keypair and image for use when Magnum is creating clusters using - the given ClusterTemplate. - -Container Orchestration Engine (COE) - A container orchestration engine manages the lifecycle of one or more - containers, logically represented in Magnum as a cluster. Magnum supports a - number of container orchestration engines, each with their own pros and cons, - including Docker Swarm, Kubernetes, and Mesos. - Overview ======== @@ -974,37 +952,8 @@ look for the attribute *coe_version* and *container_version*:: Kubernetes ========== Kubernetes uses a range of terminology that we refer to in this guide. We -define these common terms for your reference: - -Pod - When using the Kubernetes container orchestration engine, a pod is the - smallest deployable unit that can be created and managed. A pod is a - co-located group of application containers that run with a shared context. - When using Magnum, pods are created and managed within clusters. Refer to the - `pods section - `_ in the `Kubernetes - User Guide`_ for more information. - -Replication controller - A replication controller is used to ensure that at any given time a certain - number of replicas of a pod are running. Pods are automatically created and - deleted by the replication controller as necessary based on a template to - ensure that the defined number of replicas exist. Refer to the `replication - controller section - `_ in - the `Kubernetes User Guide`_ for more information. - -Service - A service is an additional layer of abstraction provided by the Kubernetes - container orchestration engine which defines a logical set of pods and a - policy for accessing them. This is useful because pods are created and - deleted by a replication controller, for example, other pods needing to - discover them can do so via the service abstraction. Refer to the - `services section - `_ in the - `Kubernetes User Guide`_ for more information. - -.. _Kubernetes User Guide: http://kubernetes.io/v1.0/docs/user-guide/ +define these common terms in the `Glossary +`_ for your reference. When Magnum deploys a Kubernetes cluster, it uses parameters defined in the ClusterTemplate and specified on the cluster-create command, for example::