openstack
/
magnum
Code Issues Proposed changes

Merge "[install] Update required services and remove bay"

This commit is contained in:
Jenkins 2016-09-14 19:24:33 +00:00 committed by Gerrit Code Review
parent 735db5401a 347b2aa76e
commit d9306042c9
4 changed files with 55 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
doc/source/install-guide-from-source.rst
View File

@ -1,8 +1,8 @@
.. _install: .. _install:
========================== ===================================================================
Install Magnum from source Install the Container Infrastructure Management service from source
========================== ===================================================================
Install and configure 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. Infrastructure Management service, code-named magnum, on the controller node.
This section assumes that you already have a working OpenStack environment with This section assumes that you already have a working OpenStack environment with
at least the following components installed: Compute, Image Service, Identity, at least the following components installed: Identity service, Image service,
Networking, Block Storage, Orchestration and Neutron/LBaaS. See `OpenStack Compute service, Networking service, Block Storage service and Orchestration
Install Guides <http://docs.openstack.org/#install-guides>`__ for all the above service. See `OpenStack Install Guides <http://docs.openstack.org/
services apart from Neutron/LBaaS. For Neutron/LBaaS see #install-guides>`__.
`Neutron/LBaaS/HowToRun
<https://wiki.openstack.org/wiki/Neutron/LBaaS/HowToRun>`__.
To store certificates, you can use Barbican (which is recommended) or save To provide access to Docker Swarm or Kubernetes using the native clients
them locally on the controller node. To install Barbican see `Setting up a (docker or kubectl respectively) magnum uses TLS certificates. To store the
Barbican Development Environment <http://docs.openstack.org/developer/barbican/ certificates, it is recommended to use the `Key Manager service, code-named
setup/dev.html#configuring-barbican>`__ barbican <http://docs.openstack.org/project-install-guide/key-manager/
draft/>`__, or you can save them in magnum's database.
Optionally, you can install the following components: Object Storage to make Optionally, you can install the following components:
private Docker registries available to users and Telemetry to send periodically * `Load Balancer as a Service (LBaaS v2) <http://docs.openstack.org/
magnum related metrics. See `OpenStack Install Guides networking-guide/config-lbaas.html>`__ to create clusters with multiple
<http://docs.openstack.org /#install-guides>`__. masters
* `Bare Metal service <http://docs.openstack.org/project-install-guide/
baremetal/draft/>`__ to create baremetal clusters
* `Object Storage service <http://docs.openstack.org/project-install-guide/
object-storage/draft/>`__ to make private Docker registries available to users
* `Telemetry Data Collection service <http://docs.openstack.org/
project-install-guide/telemetry/draft/>`__ to periodically send magnum-related
metrics
.. important:: .. important::
Magnum creates groupings of Nova compute instances, called clusters. These Magnum creates clusters of compute instances on the Compute service (nova).
VMs must have basic Internet connectivity and must be able to reach magnum's These instances must have basic Internet connectivity and must be able to
API server. Make sure that Compute and Network services are configured reach magnum's API server. Make sure that the Compute and Network services
accordingly. are configured accordingly.
Prerequisites Prerequisites
------------- -------------

3
install-guide/source/common/prerequisites.rst
View File

@ -139,8 +139,7 @@ service, you must create a database, service credentials, and API endpoints.
+--------------+----------------------------------+ +--------------+----------------------------------+
#. Magnum requires additional information in the Identity service to #. Magnum requires additional information in the Identity service to
manage COE clusters (bays). To add this information, complete these manage COE clusters. To add this information, complete these steps:
steps:
* Create the ``magnum`` domain that contains projects and users: * Create the ``magnum`` domain that contains projects and users:

6
install-guide/source/get_started.rst
View File

@ -7,8 +7,8 @@ following components:
``magnum`` command-line client ``magnum`` command-line client
A CLI that communicates with the ``magnum-api`` to create and manage A CLI that communicates with the ``magnum-api`` to create and manage
container clusters (i.e. bays in magnum terminology). End developers container clusters. End developers can directly use the magnum
can directly use the magnum REST API. REST API.
``magnum-api`` service ``magnum-api`` service
An OpenStack-native REST API that processes API requests by sending An OpenStack-native REST API that processes API requests by sending
@ -16,5 +16,5 @@ following components:
``magnum-conductor`` service ``magnum-conductor`` service
Runs on a controller machine and connects to heat to orchestrate a 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. or Mesos REST API endpoint.

42
install-guide/source/install.rst
View File

@ -7,22 +7,28 @@ This section describes how to install and configure the Container
Infrastructure Management service, code-named magnum, on the controller node. Infrastructure Management service, code-named magnum, on the controller node.
This section assumes that you already have a working OpenStack environment with This section assumes that you already have a working OpenStack environment with
at least the following components installed: Compute, Image Service, Identity, at least the following components installed: Identity service, Image service,
Networking, Block Storage, Orchestration and Neutron/LBaaS. See `OpenStack Compute service, Networking service, Block Storage service and Orchestration
Install Guides <http://docs.openstack.org/#install-guides>`__ for all the above service. See `OpenStack Install Guides <http://docs.openstack.org/
services apart from Neutron/LBaaS. For Neutron/LBaaS see #install-guides>`__.
`Neutron/LBaaS/HowToRun
<https://wiki.openstack.org/wiki/Neutron/LBaaS/HowToRun>`__.
To store certificates, you can use Barbican (which is recommended) or save To provide access to Docker Swarm or Kubernetes using the native clients
them locally on the controller node. To install Barbican see `Setting up a (docker or kubectl, respectively) magnum uses TLS certificates. To store the
Barbican Development Environment <http://docs.openstack.org/developer/barbican/ certificates, it is recommended to use the `Key Manager service, code-named
setup/dev.html#configuring-barbican>`__ barbican <http://docs.openstack.org/project-install-guide/key-manager/
draft/>`__, or you can save them in magnum's database.
Optionally, you can install the following components: Object Storage to make Optionally, you can install the following components:
private Docker registries available to users and Telemetry to send periodically * `Load Balancer as a Service (LBaaS v2) <http://docs.openstack.org/
magnum related metrics. See `OpenStack Install Guides networking-guide/config-lbaas.html>`__ to create clusters with multiple
<http://docs.openstack.org /#install-guides>`__. masters
* `Bare Metal service <http://docs.openstack.org/project-install-guide/
baremetal/draft/>`__ to create baremetal clusters
* `Object Storage service <http://docs.openstack.org/project-install-guide/
object-storage/draft/>`__ to make private Docker registries available to users
* `Telemetry Data Collection service <http://docs.openstack.org/
project-install-guide/telemetry/draft/>`__ to periodically send magnum-related
metrics
.. note:: .. note::
@ -30,10 +36,10 @@ magnum related metrics. See `OpenStack Install Guides
.. important:: .. important::
Magnum creates VM clusters on the Compute service (nova), called bays. These Magnum creates clusters of compute instances on the Compute service (nova).
VMs must have basic Internet connectivity and must be able to reach magnum's These instances must have basic Internet connectivity and must be able to
API server. Make sure that Compute and Network services are configured reach magnum's API server. Make sure that the Compute and Network services
accordingly. are configured accordingly.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2