diff --git a/doc/source/install-guide-from-source.rst b/doc/source/install-guide-from-source.rst index 5abdd0f4b7..9a0bb57df1 100644 --- a/doc/source/install-guide-from-source.rst +++ b/doc/source/install-guide-from-source.rst @@ -1,8 +1,8 @@ .. _install: -========================== -Install Magnum from source -========================== +=================================================================== +Install the Container Infrastructure Management service from source +=================================================================== Install and configure ~~~~~~~~~~~~~~~~~~~~~ @@ -11,29 +11,35 @@ This section describes how to install and configure the Container Infrastructure Management service, code-named magnum, on the controller node. This section assumes that you already have a working OpenStack environment with -at least the following components installed: Compute, Image Service, Identity, -Networking, Block Storage, Orchestration and Neutron/LBaaS. See `OpenStack -Install Guides `__ for all the above -services apart from Neutron/LBaaS. For Neutron/LBaaS see -`Neutron/LBaaS/HowToRun -`__. +at least the following components installed: Identity service, Image service, +Compute service, Networking service, Block Storage service and Orchestration +service. See `OpenStack Install Guides `__. -To store certificates, you can use Barbican (which is recommended) or save -them locally on the controller node. To install Barbican see `Setting up a -Barbican Development Environment `__ +To provide access to Docker Swarm or Kubernetes using the native clients +(docker or kubectl respectively) magnum uses TLS certificates. To store the +certificates, it is recommended to use the `Key Manager service, code-named +barbican `__, or you can save them in magnum's database. -Optionally, you can install the following components: Object Storage to make -private Docker registries available to users and Telemetry to send periodically -magnum related metrics. See `OpenStack Install Guides -`__. +Optionally, you can install the following components: +* `Load Balancer as a Service (LBaaS v2) `__ to create clusters with multiple +masters +* `Bare Metal service `__ to create baremetal clusters +* `Object Storage service `__ to make private Docker registries available to users +* `Telemetry Data Collection service `__ to periodically send magnum-related +metrics .. important:: - Magnum creates groupings of Nova compute instances, called clusters. These - VMs must have basic Internet connectivity and must be able to reach magnum's - API server. Make sure that Compute and Network services are configured - accordingly. + Magnum creates clusters of compute instances on the Compute service (nova). + These instances must have basic Internet connectivity and must be able to + reach magnum's API server. Make sure that the Compute and Network services + are configured accordingly. Prerequisites ------------- diff --git a/install-guide/source/common/prerequisites.rst b/install-guide/source/common/prerequisites.rst index 38dc92d120..484c47fb08 100644 --- a/install-guide/source/common/prerequisites.rst +++ b/install-guide/source/common/prerequisites.rst @@ -139,8 +139,7 @@ service, you must create a database, service credentials, and API endpoints. +--------------+----------------------------------+ #. Magnum requires additional information in the Identity service to - manage COE clusters (bays). To add this information, complete these - steps: + manage COE clusters. To add this information, complete these steps: * Create the ``magnum`` domain that contains projects and users: diff --git a/install-guide/source/get_started.rst b/install-guide/source/get_started.rst index 0441593341..d5964fbb97 100644 --- a/install-guide/source/get_started.rst +++ b/install-guide/source/get_started.rst @@ -7,8 +7,8 @@ following components: ``magnum`` command-line client A CLI that communicates with the ``magnum-api`` to create and manage - container clusters (i.e. bays in magnum terminology). End developers - can directly use the magnum REST API. + container clusters. End developers can directly use the magnum + REST API. ``magnum-api`` service An OpenStack-native REST API that processes API requests by sending @@ -16,5 +16,5 @@ following components: ``magnum-conductor`` service Runs on a controller machine and connects to heat to orchestrate a - magnum bay. Additionally, it connects to a Docker Swarm, Kubernetes + cluster. Additionally, it connects to a Docker Swarm, Kubernetes or Mesos REST API endpoint. diff --git a/install-guide/source/install.rst b/install-guide/source/install.rst index c72be055c6..29ebd88e08 100644 --- a/install-guide/source/install.rst +++ b/install-guide/source/install.rst @@ -7,22 +7,28 @@ This section describes how to install and configure the Container Infrastructure Management service, code-named magnum, on the controller node. This section assumes that you already have a working OpenStack environment with -at least the following components installed: Compute, Image Service, Identity, -Networking, Block Storage, Orchestration and Neutron/LBaaS. See `OpenStack -Install Guides `__ for all the above -services apart from Neutron/LBaaS. For Neutron/LBaaS see -`Neutron/LBaaS/HowToRun -`__. +at least the following components installed: Identity service, Image service, +Compute service, Networking service, Block Storage service and Orchestration +service. See `OpenStack Install Guides `__. -To store certificates, you can use Barbican (which is recommended) or save -them locally on the controller node. To install Barbican see `Setting up a -Barbican Development Environment `__ +To provide access to Docker Swarm or Kubernetes using the native clients +(docker or kubectl, respectively) magnum uses TLS certificates. To store the +certificates, it is recommended to use the `Key Manager service, code-named +barbican `__, or you can save them in magnum's database. -Optionally, you can install the following components: Object Storage to make -private Docker registries available to users and Telemetry to send periodically -magnum related metrics. See `OpenStack Install Guides -`__. +Optionally, you can install the following components: +* `Load Balancer as a Service (LBaaS v2) `__ to create clusters with multiple +masters +* `Bare Metal service `__ to create baremetal clusters +* `Object Storage service `__ to make private Docker registries available to users +* `Telemetry Data Collection service `__ to periodically send magnum-related +metrics .. note:: @@ -30,10 +36,10 @@ magnum related metrics. See `OpenStack Install Guides .. important:: - Magnum creates VM clusters on the Compute service (nova), called bays. These - VMs must have basic Internet connectivity and must be able to reach magnum's - API server. Make sure that Compute and Network services are configured - accordingly. + Magnum creates clusters of compute instances on the Compute service (nova). + These instances must have basic Internet connectivity and must be able to + reach magnum's API server. Make sure that the Compute and Network services + are configured accordingly. .. toctree:: :maxdepth: 2