summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSpyros Trigazis <spyridon.trigazis@cern.ch>2017-12-10 16:16:14 +0100
committerSpyros Trigazis (strigazi) <strigazi@gmail.com>2017-12-12 08:14:04 +0000
commit45273110cc7adcb25e694a7344c73b2171bee137 (patch)
tree0133862e6845528d490af178ce694ab3ea962a3c
parentd02469528e3864214a0c718a941eb7e9756138ed (diff)
[doc-migration] Consolidate install guide
The legacy install-guide directory is removed, projects host thei install-guide under /doc/source/install/. It should have been done in: Ifdeb7c669e7f2351aff837f43f2fa3515a89e086 Change-Id: Ia65804cd01ada25f6b61c1c4bcb246d5a4c9c570
Notes
Notes (review): Code-Review+2: yatin <ykarel@redhat.com> Workflow+1: Spyros Trigazis (strigazi) <strigazi@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 14 Dec 2017 10:03:44 +0000 Reviewed-on: https://review.openstack.org/526926 Project: openstack/magnum Branch: refs/heads/master
-rw-r--r--doc/source/install/common/configure_2_edit_magnum_conf.rst (renamed from install-guide/source/common/configure_2_edit_magnum_conf.rst)0
-rw-r--r--doc/source/install/common/configure_3_populate_database.rst (renamed from install-guide/source/common/configure_3_populate_database.rst)0
-rw-r--r--doc/source/install/common/prerequisites.rst (renamed from install-guide/source/common/prerequisites.rst)0
-rw-r--r--doc/source/install/get_started.rst (renamed from install-guide/source/get_started.rst)0
-rw-r--r--doc/source/install/index.rst30
-rw-r--r--doc/source/install/install-debian-manual.rst (renamed from install-guide/source/install-debian-manual.rst)0
-rw-r--r--doc/source/install/install-guide-from-source.rst564
-rw-r--r--doc/source/install/install-obs.rst (renamed from install-guide/source/install-obs.rst)0
-rw-r--r--doc/source/install/install-rdo.rst (renamed from install-guide/source/install-rdo.rst)0
-rw-r--r--doc/source/install/install-ubuntu.rst (renamed from install-guide/source/install-ubuntu.rst)0
-rw-r--r--doc/source/install/install.rst (renamed from install-guide/source/install.rst)1
-rw-r--r--doc/source/install/launch-instance.rst (renamed from install-guide/source/launch-instance.rst)4
-rw-r--r--doc/source/install/next-steps.rst (renamed from install-guide/source/next-steps.rst)0
-rw-r--r--doc/source/install/verify.rst (renamed from install-guide/source/verify.rst)0
-rw-r--r--install-guide/source/conf.py301
-rw-r--r--install-guide/source/index.rst24
16 files changed, 118 insertions, 806 deletions
diff --git a/install-guide/source/common/configure_2_edit_magnum_conf.rst b/doc/source/install/common/configure_2_edit_magnum_conf.rst
index 0c1eb6e..0c1eb6e 100644
--- a/install-guide/source/common/configure_2_edit_magnum_conf.rst
+++ b/doc/source/install/common/configure_2_edit_magnum_conf.rst
diff --git a/install-guide/source/common/configure_3_populate_database.rst b/doc/source/install/common/configure_3_populate_database.rst
index dac69fd..dac69fd 100644
--- a/install-guide/source/common/configure_3_populate_database.rst
+++ b/doc/source/install/common/configure_3_populate_database.rst
diff --git a/install-guide/source/common/prerequisites.rst b/doc/source/install/common/prerequisites.rst
index 6ce4bd9..6ce4bd9 100644
--- a/install-guide/source/common/prerequisites.rst
+++ b/doc/source/install/common/prerequisites.rst
diff --git a/install-guide/source/get_started.rst b/doc/source/install/get_started.rst
index d5964fb..d5964fb 100644
--- a/install-guide/source/get_started.rst
+++ b/doc/source/install/get_started.rst
diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst
index 82fd44e..e64f188 100644
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
@@ -2,18 +2,24 @@
2Magnum Installation Guide 2Magnum Installation Guide
3========================= 3=========================
4 4
5The Container Infrastructure Management service is a collection of components
6that provides support to manage different container orchestration engines(COE)
7like Kubernetes, Mesos and Swarm.
8
9This chapter assumes a working setup of OpenStack following the
10`OpenStack Installation Guides <http://docs.openstack.org/#install-guides>`_.
11It is recommended to follow the `Container Infrastructure Management Service
12<https://docs.openstack.org/project-install-guide/container-infrastructure-management>`_
13section from the OpenStack Installation Tutorials. This chapter contains the
14following sections:
15 5
16.. toctree:: 6.. toctree::
17 :maxdepth: 1 7 :maxdepth: 2
8
9 get_started.rst
10 install.rst
11 verify.rst
12 launch-instance.rst
13 next-steps.rst
14
15The Container Infrastructure Management service codenamed (magnum) is an
16OpenStack API service developed by the OpenStack Containers Team making
17container orchestration engines (COE) such as Docker Swarm, Kubernetes
18and Mesos available as first class resources in OpenStack. Magnum uses
19Heat to orchestrate an OS image which contains Docker and Kubernetes and
20runs that image in either virtual machines or bare metal in a cluster
21configuration.
22
23This chapter assumes a working setup of OpenStack following `OpenStack
24Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
18 25
19 install-guide-from-source
diff --git a/install-guide/source/install-debian-manual.rst b/doc/source/install/install-debian-manual.rst
index 557c7a6..557c7a6 100644
--- a/install-guide/source/install-debian-manual.rst
+++ b/doc/source/install/install-debian-manual.rst
diff --git a/doc/source/install/install-guide-from-source.rst b/doc/source/install/install-guide-from-source.rst
index 912d002..17d4df5 100644
--- a/doc/source/install/install-guide-from-source.rst
+++ b/doc/source/install/install-guide-from-source.rst
@@ -1,481 +1,144 @@
1.. _install: 1.. _install-guide-from-source:
2 2
3=================================================================== 3Install from source code and configure
4Install the Container Infrastructure Management service from source 4~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5===================================================================
6
7Install and configure
8~~~~~~~~~~~~~~~~~~~~~
9 5
10This section describes how to install and configure the Container 6This section describes how to install and configure the Container
11Infrastructure Management service, code-named magnum, on the controller node. 7Infrastructure Management service for from source code.
12
13This section assumes that you already have a working OpenStack environment with
14at least the following components installed: Identity service, Image service,
15Compute service, Networking service, Block Storage service and Orchestration
16service. See `OpenStack Install Guides <http://docs.openstack.org/
17#install-guides>`__.
18
19To provide access to Docker Swarm or Kubernetes using the native clients
20(docker or kubectl respectively) magnum uses TLS certificates. To store the
21certificates, it is recommended to use the `Key Manager service, code-named
22barbican <http://docs.openstack.org/project-install-guide/key-manager/
23draft/>`__, or you can save them in magnum's database.
24
25Optionally, you can install the following components:
26
27- `Load Balancer as a Service (LBaaS v2) <http://docs.openstack.org/
28 networking-guide/config-lbaas.html>`__ to create clusters with multiple
29 masters
30- `Bare Metal service <http://docs.openstack.org/project-install-guide/
31 baremetal/draft/>`__ to create baremetal clusters
32- `Object Storage service <http://docs.openstack.org/project-install-guide/
33 object-storage/draft/>`__ to make private Docker registries available to
34 users
35- `Telemetry Data Collection service <http://docs.openstack.org/
36 project-install-guide/telemetry/draft/>`__ to periodically send
37 magnum-related metrics
38
39.. important::
40
41 Magnum creates clusters of compute instances on the Compute service (nova).
42 These instances must have basic Internet connectivity and must be able to
43 reach magnum's API server. Make sure that the Compute and Network services
44 are configured accordingly.
45
46Prerequisites
47-------------
48
49Before you install and configure the Container Infrastructure Management
50service, you must create a database, service credentials, and API endpoints.
51
52#. To create the database, complete these steps:
53
54 * Use the database access client to connect to the database
55 server as the ``root`` user:
56
57 .. code-block:: console
58
59 $ mysql -u root -p
60
61 * Create the ``magnum`` database:
62
63 .. code-block:: console
64
65 CREATE DATABASE magnum;
66
67 * Grant proper access to the ``magnum`` database:
68
69 .. code-block:: console
70
71 GRANT ALL PRIVILEGES ON magnum.* TO 'magnum'@'controller' \
72 IDENTIFIED BY 'MAGNUM_DBPASS';
73 GRANT ALL PRIVILEGES ON magnum.* TO 'magnum'@'%' \
74 IDENTIFIED BY 'MAGNUM_DBPASS';
75
76 Replace ``MAGNUM_DBPASS`` with a suitable password.
77
78 * Exit the database access client.
79
80#. Source the ``admin`` credentials to gain access to
81 admin-only CLI commands:
82
83 .. code-block:: console
84
85 $ . admin-openrc
86
87#. To create the service credentials, complete these steps:
88
89 * Create the ``magnum`` user:
90
91 .. code-block:: console
92
93
94 $ openstack user create --domain default \
95 --password-prompt magnum
96 User Password:
97 Repeat User Password:
98 +-----------+----------------------------------+
99 | Field | Value |
100 +-----------+----------------------------------+
101 | domain_id | default |
102 | enabled | True |
103 | id | a8ebafc275c54d389dfc1bff8b4fe286 |
104 | name | magnum |
105 +-----------+----------------------------------+
106 8
107 * Add the ``admin`` role to the ``magnum`` user: 9.. include:: common/prerequisites.rst
108
109 .. code-block:: console
110
111 $ openstack role add --project service --user magnum admin
112
113 .. note::
114
115 This command provides no output.
116
117 * Create the ``magnum`` service entity:
118
119 .. code-block:: console
120
121 $ openstack service create --name magnum \
122 --description "OpenStack Container Infrastructure Management Service" \
123 container-infra
124 +-------------+-------------------------------------------------------+
125 | Field | Value |
126 +-------------+-------------------------------------------------------+
127 | description | OpenStack Container Infrastructure Management Service |
128 | enabled | True |
129 | id | 194faf83e8fd4e028e5ff75d3d8d0df2 |
130 | name | magnum |
131 | type | container-infra |
132 +-------------+-------------------------------------------------------+
133
134#. Create the Container Infrastructure Management service API endpoints:
135
136 .. code-block:: console
137
138 $ openstack endpoint create --region RegionOne \
139 container-infra public http://CONTROLLER_IP:9511/v1
140 +--------------+----------------------------------+
141 | Field | Value |
142 +--------------+----------------------------------+
143 | enabled | True |
144 | id | cb137e6366ad495bb521cfe92d8b8858 |
145 | interface | public |
146 | region | RegionOne |
147 | region_id | RegionOne |
148 | service_id | 0f7f62a1f1a247d2a4cb237642814d0e |
149 | service_name | magnum |
150 | service_type | container-infra |
151 | url | http://CONTROLLER_IP:9511/v1 |
152 +--------------+----------------------------------+
153
154 $ openstack endpoint create --region RegionOne \
155 container-infra internal http://CONTROLLER_IP:9511/v1
156 +--------------+----------------------------------+
157 | Field | Value |
158 +--------------+----------------------------------+
159 | enabled | True |
160 | id | 17cbc3b6f51449a0a818118d6d62868d |
161 | interface | internal |
162 | region | RegionOne |
163 | region_id | RegionOne |
164 | service_id | 0f7f62a1f1a247d2a4cb237642814d0e |
165 | service_name | magnum |
166 | service_type | container-infra |
167 | url | http://CONTROLLER_IP:9511/v1 |
168 +--------------+----------------------------------+
169
170 $ openstack endpoint create --region RegionOne \
171 container-infra admin http://CONTROLLER_IP:9511/v1
172 +--------------+----------------------------------+
173 | Field | Value |
174 +--------------+----------------------------------+
175 | enabled | True |
176 | id | 30f8888e6b6646d7b5cd14354c95a684 |
177 | interface | admin |
178 | region | RegionOne |
179 | region_id | RegionOne |
180 | service_id | 0f7f62a1f1a247d2a4cb237642814d0e |
181 | service_name | magnum |
182 | service_type | container-infra |
183 | url | http://CONTROLLER_IP:9511/v1 |
184 +--------------+----------------------------------+
185
186 Replace ``CONTROLLER_IP`` with the IP magnum listens to. Alternatively,
187 you can use a hostname which is reachable by the Compute instances.
188
189#. Magnum requires additional information in the Identity service to
190 manage clusters. To add this information, complete these steps:
191
192 * Create the ``magnum`` domain that contains projects and users:
193
194 .. code-block:: console
195
196 $ openstack domain create --description "Owns users and projects \
197 created by magnum" magnum
198 +-------------+-------------------------------------------+
199 | Field | Value |
200 +-------------+-------------------------------------------+
201 | description | Owns users and projects created by magnum |
202 | enabled | True |
203 | id | 66e0469de9c04eda9bc368e001676d20 |
204 | name | magnum |
205 +-------------+-------------------------------------------+
206
207 * Create the ``magnum_domain_admin`` user to manage projects and users
208 in the ``magnum`` domain:
209
210 .. code-block:: console
211
212 $ openstack user create --domain magnum --password-prompt \
213 magnum_domain_admin
214 User Password:
215 Repeat User Password:
216 +-----------+----------------------------------+
217 | Field | Value |
218 +-----------+----------------------------------+
219 | domain_id | 66e0469de9c04eda9bc368e001676d20 |
220 | enabled | True |
221 | id | 529b81cf35094beb9784c6d06c090c2b |
222 | name | magnum_domain_admin |
223 +-----------+----------------------------------+
224
225 * Add the ``admin`` role to the ``magnum_domain_admin`` user in the
226 ``magnum`` domain to enable administrative management privileges
227 by the ``magnum_domain_admin`` user:
228
229 .. code-block:: console
230
231 $ openstack role add --domain magnum --user-domain magnum \
232 --user magnum_domain_admin admin
233
234 .. note::
235
236 This command provides no output.
237 10
238Install and configure components 11Install and configure components
239-------------------------------- 12--------------------------------
240 13
241#. Install OS-specific prerequisites: 141. Install Magnum from source:
242 15
243 * Ubuntu 14.04 (trusty) or higher, Debian 8: 16 a. Install OS-specific prerequisites:
244 17
245 .. code-block:: console 18 * Ubuntu 16.04 (xenial) or higher:
246 19
247 # apt-get update 20 .. code-block:: console
248 # apt-get install python-dev libssl-dev libxml2-dev \
249 libmysqlclient-dev libxslt-dev libpq-dev git \
250 libffi-dev gettext build-essential
251 21
252 * Fedora 21 / Centos 7 / RHEL 7 22 # apt update
23 # apt install python-dev libssl-dev libxml2-dev \
24 libmysqlclient-dev libxslt-dev libpq-dev git \
25 libffi-dev gettext build-essential
253 26
254 .. code-block:: console 27 * Fedora 21 / Centos 7 / RHEL 7
255 28
256 # yum install python-devel openssl-devel mysql-devel \ 29 .. code-block:: console
257 libxml2-devel libxslt-devel postgresql-devel git \
258 libffi-devel gettext gcc
259 30
260 * Fedora 22 or higher 31 # yum install python-devel openssl-devel mysql-devel \
32 libxml2-devel libxslt-devel postgresql-devel git \
33 libffi-devel gettext gcc
261 34
262 .. code-block:: console 35 * Fedora 22 or higher
263 36
264 # dnf install python-devel openssl-devel mysql-devel \ 37 .. code-block:: console
265 libxml2-devel libxslt-devel postgresql-devel git \
266 libffi-devel gettext gcc
267 38
268 * openSUSE Leap 42.1 39 # dnf install python-devel openssl-devel mysql-devel \
40 libxml2-devel libxslt-devel postgresql-devel git \
41 libffi-devel gettext gcc
269 42
270 .. code-block:: console 43 * openSUSE Leap 42.1
271 44
272 # zypper install git libffi-devel libmysqlclient-devel \ 45 .. code-block:: console
273 libopenssl-devel libxml2-devel libxslt-devel \
274 postgresql-devel python-devel gettext-runtime gcc
275 46
2762. Create magnum user and necessary directories: 47 # zypper install git libffi-devel libmysqlclient-devel \
48 libopenssl-devel libxml2-devel libxslt-devel \
49 postgresql-devel python-devel gettext-runtime gcc
277 50
278 * Create user: 51 b. Create magnum user and necessary directories:
279 52
280 .. code-block:: console 53 * Create user:
281 54
282 # groupadd --system magnum 55 .. code-block:: console
283 # useradd --home-dir "/var/lib/magnum" \
284 --create-home \
285 --system \
286 --shell /bin/false \
287 -g magnum \
288 magnum
289 56
290 * Create directories: 57 # groupadd --system magnum
58 # useradd --home-dir "/var/lib/magnum" \
59 --create-home \
60 --system \
61 --shell /bin/false \
62 -g magnum \
63 magnum
291 64
292 .. code-block:: console 65 * Create directories:
293 66
294 # mkdir -p /var/log/magnum 67 .. code-block:: console
295 # mkdir -p /etc/magnum
296 68
297 * Set ownership to directories: 69 # mkdir -p /var/log/magnum
70 # mkdir -p /etc/magnum
298 71
299 .. code-block:: console 72 * Set ownership to directories:
300 73
301 # chown magnum:magnum /var/log/magnum 74 .. code-block:: console
302 # chown magnum:magnum /var/lib/magnum
303 # chown magnum:magnum /etc/magnum
304 75
3053. Install virtualenv and python prerequisites: 76 # chown magnum:magnum /var/log/magnum
77 # chown magnum:magnum /var/lib/magnum
78 # chown magnum:magnum /etc/magnum
306 79
307 * Install virtualenv and create one for magnum's installation: 80 c. Install virtualenv and python prerequisites:
308 81
309 .. code-block:: console 82 * Install virtualenv and create one for magnum's installation:
310
311 # easy_install -U virtualenv
312 # su -s /bin/sh -c "virtualenv /var/lib/magnum/env" magnum
313
314 * Install python prerequisites:
315
316 .. code-block:: console
317
318 # su -s /bin/sh -c "/var/lib/magnum/env/bin/pip install tox pymysql \
319 python-memcached" magnum
320
3214. Clone and install magnum:
322
323 .. code-block:: console
324
325 # cd /var/lib/magnum
326 # git clone https://git.openstack.org/openstack/magnum.git
327 # chown -R magnum:magnum magnum
328 # cd magnum
329 # su -s /bin/sh -c "/var/lib/magnum/env/bin/pip install -r requirements.txt" magnum
330 # su -s /bin/sh -c "/var/lib/magnum/env/bin/python setup.py install" magnum
331
3325. Copy api-paste.ini:
333
334 .. code-block:: console
335
336 # su -s /bin/sh -c "cp etc/magnum/api-paste.ini /etc/magnum" magnum
337
3386. Generate a sample configuration file:
339
340 .. code-block:: console
341 83
342 # su -s /bin/sh -c "/var/lib/magnum/env/bin/tox -e genconfig" magnum 84 .. code-block:: console
343 # su -s /bin/sh -c "cp etc/magnum/magnum.conf.sample /etc/magnum/magnum.conf" magnum
344 85
3457. Optionally, if you want to customize the policies for Magnum API accesses, 86 # easy_install -U virtualenv
346 you can generate a sample policy file, put it into ``/etc/magnum`` folder 87 # su -s /bin/sh -c "virtualenv /var/lib/magnum/env" magnum
347 for further modifications:
348 88
349 .. code-block:: console 89 * Install python prerequisites:
350
351 # su -s /bin/sh -c "/var/lib/magnum/env/bin/tox -e genpolicy" magnum
352 # su -s /bin/sh -c "cp etc/magnum/policy.yaml.sample /etc/magnum/policy.yaml" magnum
353 90
3548. Edit the ``/etc/magnum/magnum.conf``: 91 .. code-block:: console
355 92
356 * In the ``[DEFAULT]`` section, 93 # su -s /bin/sh -c "/var/lib/magnum/env/bin/pip install tox pymysql \
357 configure ``RabbitMQ`` message queue access: 94 python-memcached" magnum
358 95
359 .. code-block:: ini 96 d. Clone and install magnum:
360
361 [DEFAULT]
362 ...
363 transport_url = rabbit://openstack:RABBIT_PASS@controller
364 97
365 Replace ``RABBIT_PASS`` with the password you chose for the 98 .. code-block:: console
366 ``openstack`` account in ``RabbitMQ``.
367 99
368 * In the ``[api]`` section, configure the host: 100 # cd /var/lib/magnum
369 101 # git clone https://git.openstack.org/openstack/magnum.git
370 .. code-block:: ini 102 # chown -R magnum:magnum magnum
371 103 # cd magnum
372 [api] 104 # su -s /bin/sh -c "/var/lib/magnum/env/bin/pip install -r requirements.txt" magnum
373 ... 105 # su -s /bin/sh -c "/var/lib/magnum/env/bin/python setup.py install" magnum
374 host = CONTROLLER_IP
375 106
376 Replace ``CONTROLLER_IP`` with the IP address on which you wish magnum api 107 e. Copy api-paste.ini:
377 should listen.
378 108
379 * In the ``[certificates]`` section, select ``barbican`` (or ``local`` if 109 .. code-block:: console
380 you don't have barbican installed):
381 110
382 * Use barbican to store certificates: 111 # su -s /bin/sh -c "cp etc/magnum/api-paste.ini /etc/magnum" magnum
383 112
384 .. code-block:: ini 113 f. Generate a sample configuration file:
385 114
386 [certificates] 115 .. code-block:: console
387 ...
388 cert_manager_type = barbican
389 116
390 .. important:: 117 # su -s /bin/sh -c "/var/lib/magnum/env/bin/tox -e genconfig" magnum
118 # su -s /bin/sh -c "cp etc/magnum/magnum.conf.sample /etc/magnum/magnum.conf" magnum
391 119
392 Barbican is recommended for production environments, local store should 120 e. Optionally, if you want to customize the policies for Magnum API accesses,
393 be used for evaluation purposes. 121 you can generate a sample policy file, put it into ``/etc/magnum`` folder
122 for further modifications:
394 123
395 * To use local store for certificates, you have to create and specify the 124 .. code-block:: console
396 directory to use:
397 125
398 .. code-block:: console 126 # su -s /bin/sh -c "/var/lib/magnum/env/bin/tox -e genpolicy" magnum
127 # su -s /bin/sh -c "cp etc/magnum/policy.yaml.sample /etc/magnum/policy.yaml" magnum
399 128
400 # su -s /bin/sh -c "mkdir -p /var/lib/magnum/certificates/" magnum 129.. include:: common/configure_2_edit_magnum_conf.rst
401 130
402 .. code-block:: ini 131* Additionally, edit the ``/etc/magnum/magnum.conf`` file:
403 132
404 [certificates] 133 * In the ``[oslo_concurrency]`` section, configure the ``lock_path``:
405 ...
406 cert_manager_type = local
407 storage_path = /var/lib/magnum/certificates/
408 134
409 * In the ``[cinder_client]`` section, configure the region name: 135 .. code-block:: ini
410 136
411 .. code-block:: ini 137 [oslo_concurrency]
412 138 ...
413 [cinder_client] 139 lock_path = /var/lib/magnum/tmp
414 ...
415 region_name = RegionOne
416
417 * In the ``[database]`` section, configure database access:
418
419 .. code-block:: ini
420
421 [database]
422 ...
423 connection = mysql+pymysql://magnum:MAGNUM_DBPASS@controller/magnum
424 140
425 Replace ``MAGNUM_DBPASS`` with the password you chose for 141 * If you decide to customize Magnum policies in ``1.e``, then in the
426 the magnum database.
427
428 * In the ``[keystone_authtoken]`` and ``trust`` sections, configure
429 Identity service access:
430
431 .. code-block:: ini
432
433 [keystone_authtoken]
434 ...
435 memcached_servers = controller:11211
436 auth_version = v3
437 auth_uri = http://controller:5000/v3
438 project_domain_name = default
439 project_name = service
440 user_domain_name = default
441 password = MAGNUM_PASS
442 username = magnum
443 auth_url = http://controller:35357
444 auth_type = password
445 admin_user = magnum
446 admin_password = MAGNUM_PASS
447 admin_tenant_name = service
448
449 [trust]
450 ...
451 trustee_domain_name = magnum
452 trustee_domain_admin_name = magnum_domain_admin
453 trustee_domain_admin_password = DOMAIN_ADMIN_PASS
454
455 ``trustee_domain_name`` is the name of the ``magnum`` domain and
456 ``trustee_domain_admin_name`` is the name of the ``magnum_domain_admin``
457 user. Replace MAGNUM_PASS with the password you chose for the magnum user in the
458 Identity service and DOMAIN_ADMIN_PASS with the password you chose for the
459 ``magnum_domain_admin`` user.
460
461 * In the ``[oslo_concurrency]`` section, configure the ``lock_path``:
462
463 .. code-block:: ini
464
465 [oslo_concurrency]
466 ...
467 lock_path = /var/lib/magnum/tmp
468
469 * In the ``[oslo_messaging_notifications]`` section, configure the
470 ``driver``:
471
472 .. code-block:: ini
473
474 [oslo_messaging_notifications]
475 ...
476 driver = messaging
477
478 * If you decide to customize Magnum policies in ``step 7``, then in the
479 ``[oslo_policy]`` section, configure the ``policy_file``: 142 ``[oslo_policy]`` section, configure the ``policy_file``:
480 143
481 .. code-block:: ini 144 .. code-block:: ini
@@ -491,13 +154,13 @@ Install and configure components
491 154
492 # chown magnum:magnum /etc/magnum/magnum.conf 155 # chown magnum:magnum /etc/magnum/magnum.conf
493 156
4949. Populate Magnum database: 1573. Populate Magnum database:
495 158
496 .. code-block:: console 159 .. code-block:: console
497 160
498 # su -s /bin/sh -c "/var/lib/magnum/env/bin/magnum-db-manage upgrade" magnum 161 # su -s /bin/sh -c "/var/lib/magnum/env/bin/magnum-db-manage upgrade" magnum
499 162
50010. Set magnum for log rotation: 1634. Set magnum for log rotation:
501 164
502 .. code-block:: console 165 .. code-block:: console
503 166
@@ -509,18 +172,8 @@ Finalize installation
509 172
510#. Create init scripts and services: 173#. Create init scripts and services:
511 174
512 * Ubuntu 14.04 (trusty): 175 * Ubuntu 16.04 or higher, Fedora 21 or higher/RHEL 7/CentOS 7 or openSUSE
513 176 Leap 42.1:
514 .. code-block:: console
515
516 # cd /var/lib/magnum/magnum
517 # cp doc/examples/etc/init/magnum-api.conf \
518 /etc/init/magnum-api.conf
519 # cp doc/examples/etc/init/magnum-conductor.conf \
520 /etc/init/magnum-conductor.conf
521
522 * Ubuntu 14.10 or higher, Fedora 21 or higher/RHEL 7/CentOS 7, openSUSE
523 Leap 42.1 or Debian 8:
524 177
525 .. code-block:: console 178 .. code-block:: console
526 179
@@ -532,15 +185,8 @@ Finalize installation
532 185
533#. Start magnum-api and magnum-conductor: 186#. Start magnum-api and magnum-conductor:
534 187
535 * Ubuntu 14.04 (trusty): 188 * Ubuntu 16.04 or higher, Fedora 21 or higher/RHEL 7/CentOS 7 or openSUSE
536 189 Leap 42.1:
537 .. code-block:: console
538
539 # start magnum-api
540 # start magnum-conductor
541
542 * Ubuntu 14.10 or higher, Fedora 21 or higher/RHEL 7/CentOS 7, openSUSE
543 Leap 42.1 or Debian 8:
544 190
545 .. code-block:: console 191 .. code-block:: console
546 192
@@ -554,15 +200,8 @@ Finalize installation
554 200
555#. Verify that magnum-api and magnum-conductor services are running: 201#. Verify that magnum-api and magnum-conductor services are running:
556 202
557 * Ubuntu 14.04 (trusty): 203 * Ubuntu 16.04 or higher, Fedora 21 or higher/RHEL 7/CentOS 7 or openSUSE
558 204 Leap 42.1:
559 .. code-block:: console
560
561 # status magnum-api
562 # status magnum-conductor
563
564 * Ubuntu 14.10 or higher, Fedora 21 or higher/RHEL 7/CentOS 7, openSUSE
565 Leap 42.1 or Debian 8:
566 205
567 .. code-block:: console 206 .. code-block:: console
568 207
@@ -588,13 +227,13 @@ Install the command-line client
588 # dnf install python-devel openssl-devel python-virtualenv \ 227 # dnf install python-devel openssl-devel python-virtualenv \
589 libffi-devel git gcc 228 libffi-devel git gcc
590 229
591 * Ubuntu/Debian 230 * Ubuntu
592 231
593 .. code-block:: console 232 .. code-block:: console
594 233
595 # apt-get update 234 # apt update
596 # apt-get install python-dev libssl-dev python-virtualenv \ 235 # apt install python-dev libssl-dev python-virtualenv \
597 libffi-dev git gcc 236 libffi-dev git gcc
598 237
599 * openSUSE Leap 42.1 238 * openSUSE Leap 42.1
600 239
@@ -625,12 +264,3 @@ Install the command-line client
625 The command-line client can be installed on the controller node or 264 The command-line client can be installed on the controller node or
626 on a different host than the service. It is good practice to install it 265 on a different host than the service. It is good practice to install it
627 as a non-root user. 266 as a non-root user.
628
629Next Steps
630----------
631
632Since you have the Container Infrastructure Management service running, you
633can `Verify Operation <http://docs.openstack.org/project-install-guide/
634container-infrastructure-management/draft/verify.html>`__ and `Launch an
635instance <http://docs.openstack.org/project-install-guide/
636container-infrastructure-management/draft/launch-instance.html>`__.
diff --git a/install-guide/source/install-obs.rst b/doc/source/install/install-obs.rst
index 69a9831..69a9831 100644
--- a/install-guide/source/install-obs.rst
+++ b/doc/source/install/install-obs.rst
diff --git a/install-guide/source/install-rdo.rst b/doc/source/install/install-rdo.rst
index 95bfe71..95bfe71 100644
--- a/install-guide/source/install-rdo.rst
+++ b/doc/source/install/install-rdo.rst
diff --git a/install-guide/source/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst
index ed09de5..ed09de5 100644
--- a/install-guide/source/install-ubuntu.rst
+++ b/doc/source/install/install-ubuntu.rst
diff --git a/install-guide/source/install.rst b/doc/source/install/install.rst
index 6005099..bbf2867 100644
--- a/install-guide/source/install.rst
+++ b/doc/source/install/install.rst
@@ -50,3 +50,4 @@ Optionally, you can install the following components:
50 install-obs.rst 50 install-obs.rst
51 install-rdo.rst 51 install-rdo.rst
52 install-ubuntu.rst 52 install-ubuntu.rst
53 install-guide-from-source.rst
diff --git a/install-guide/source/launch-instance.rst b/doc/source/install/launch-instance.rst
index abba321..9bc8e96 100644
--- a/install-guide/source/launch-instance.rst
+++ b/doc/source/install/launch-instance.rst
@@ -5,8 +5,8 @@ Launch an instance
5 5
6In environments that include the Container Infrastructure Management service, 6In environments that include the Container Infrastructure Management service,
7you can provision container clusters made up of virtual machines or baremetal 7you can provision container clusters made up of virtual machines or baremetal
8servers. The Container Infrastructure Management service uses `Cluster Templates 8servers. The Container Infrastructure Management service uses
9<http://docs.openstack.org/developer/magnum/userguide.html#clustertemplate>`__ 9`Cluster Templates <http://docs.openstack.org/developer/magnum/userguide.html#clustertemplate>`__
10to describe how a `Cluster <http://docs.openstack.org/developer/magnum/ 10to describe how a `Cluster <http://docs.openstack.org/developer/magnum/
11userguide.html#cluster>`__ is constructed. In each of the following examples 11userguide.html#cluster>`__ is constructed. In each of the following examples
12you will create a Cluster Template for a specific COE and then you will 12you will create a Cluster Template for a specific COE and then you will
diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst
index 6583c0f..6583c0f 100644
--- a/install-guide/source/next-steps.rst
+++ b/doc/source/install/next-steps.rst
diff --git a/install-guide/source/verify.rst b/doc/source/install/verify.rst
index e39a6c7..e39a6c7 100644
--- a/install-guide/source/verify.rst
+++ b/doc/source/install/verify.rst
diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py
deleted file mode 100644
index ba96a51..0000000
--- a/install-guide/source/conf.py
+++ /dev/null
@@ -1,301 +0,0 @@
1# Licensed under the Apache License, Version 2.0 (the "License");
2# you may not use this file except in compliance with the License.
3# You may obtain a copy of the License at
4#
5# http://www.apache.org/licenses/LICENSE-2.0
6#
7# Unless required by applicable law or agreed to in writing, software
8# distributed under the License is distributed on an "AS IS" BASIS,
9# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10# implied.
11# See the License for the specific language governing permissions and
12# limitations under the License.
13
14# This file is execfile()d with the current directory set to its
15# containing dir.
16#
17# Note that not all possible configuration values are present in this
18# autogenerated file.
19#
20# All configuration values have a default; values that are commented out
21# serve to show the default.
22
23import os
24
25
26import openstackdocstheme
27
28# If extensions (or modules to document with autodoc) are in another directory,
29# add these directories to sys.path here. If the directory is relative to the
30# documentation root, use os.path.abspath to make it absolute, like shown here.
31# sys.path.insert(0, os.path.abspath('.'))
32
33# -- General configuration ------------------------------------------------
34
35# If your documentation needs a minimal Sphinx version, state it here.
36# needs_sphinx = '1.0'
37
38# Add any Sphinx extension module names here, as strings. They can be
39# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40# ones.
41# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
42# extensions =
43
44# Add any paths that contain templates here, relative to this directory.
45# templates_path = ['_templates']
46
47# The suffix of source filenames.
48source_suffix = '.rst'
49
50# The encoding of source files.
51# source_encoding = 'utf-8-sig'
52
53# The master toctree document.
54master_doc = 'index'
55
56# General information about the project.
57project = u'Installation Guide for Container Infrastructure Management Service'
58bug_tag = u'install-guide'
59copyright = u'2016, OpenStack contributors'
60
61# The version info for the project you're documenting, acts as replacement for
62# |version| and |release|, also used in various other places throughout the
63# built documents.
64#
65# The short X.Y version.
66from magnum.version import version_info as magnum_version
67version = magnum_version.canonical_version_string()
68# The full version, including alpha/beta/rc tags.
69release = magnum_version.version_string_with_vcs()
70
71# A few variables have to be set for the log-a-bug feature.
72# giturl: The location of conf.py on Git. Must be set manually.
73# gitsha: The SHA checksum of the bug description. Automatically extracted
74# from git log.
75# bug_tag: Tag for categorizing the bug. Must be set manually.
76# These variables are passed to the logabug code via html_context.
77giturl = u'https://git.openstack.org/cgit/openstack/magnum/tree/'
78giturl += u'install-guide/source'
79git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
80gitsha = os.popen(git_cmd).read().strip('\n')
81html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
82 "giturl": giturl, "bug_project": "magnum"}
83
84# The language for content autogenerated by Sphinx. Refer to documentation
85# for a list of supported languages.
86# language = None
87
88# There are two options for replacing |today|: either, you set today to some
89# non-false value, then it is used:
90# today = ''
91# Else, today_fmt is used as the format for a strftime call.
92# today_fmt = '%B %d, %Y'
93
94# List of patterns, relative to source directory, that match files and
95# directories to ignore when looking for source files.
96exclude_patterns = ["common/*.rst"]
97
98# The reST default role (used for this markup: `text`) to use for all
99# documents.
100# default_role = None
101
102# If true, '()' will be appended to :func: etc. cross-reference text.
103# add_function_parentheses = True
104
105# If true, the current module name will be prepended to all description
106# unit titles (such as .. function::).
107# add_module_names = True
108
109# If true, sectionauthor and moduleauthor directives will be shown in the
110# output. They are ignored by default.
111# show_authors = False
112
113# The name of the Pygments (syntax highlighting) style to use.
114pygments_style = 'sphinx'
115
116# A list of ignored prefixes for module index sorting.
117# modindex_common_prefix = []
118
119# If true, keep warnings as "system message" paragraphs in the built documents.
120# keep_warnings = False
121
122
123# -- Options for HTML output ----------------------------------------------
124
125# The theme to use for HTML and HTML Help pages. See the documentation for
126# a list of builtin themes.
127html_theme = 'openstackdocs'
128
129# Theme options are theme-specific and customize the look and feel of a theme
130# further. For a list of options available for each theme, see the
131# documentation.
132# html_theme_options = {}
133
134# Add any paths that contain custom themes here, relative to this directory.
135html_theme_path = [openstackdocstheme.get_html_theme_path()]
136
137# The name for this set of Sphinx documents. If None, it defaults to
138# "<project> v<release> documentation".
139# html_title = None
140
141# A shorter title for the navigation bar. Default is the same as html_title.
142# html_short_title = None
143
144# The name of an image file (relative to this directory) to place at the top
145# of the sidebar.
146# html_logo = None
147
148# The name of an image file (within the static path) to use as favicon of the
149# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
150# pixels large.
151# html_favicon = None
152
153# Add any paths that contain custom static files (such as style sheets) here,
154# relative to this directory. They are copied after the builtin static files,
155# so a file named "default.css" will overwrite the builtin "default.css".
156# html_static_path = []
157
158# Add any extra paths that contain custom files (such as robots.txt or
159# .htaccess) here, relative to this directory. These files are copied
160# directly to the root of the documentation.
161# html_extra_path = []
162
163# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
164# using the given strftime format.
165# So that we can enable "log-a-bug" links from each output HTML page, this
166# variable must be set to a format that includes year, month, day, hours and
167# minutes.
168html_last_updated_fmt = '%Y-%m-%d %H:%M'
169
170
171# If true, SmartyPants will be used to convert quotes and dashes to
172# typographically correct entities.
173# html_use_smartypants = True
174
175# Custom sidebar templates, maps document names to template names.
176# html_sidebars = {}
177
178# Additional templates that should be rendered to pages, maps page names to
179# template names.
180# html_additional_pages = {}
181
182# If false, no module index is generated.
183# html_domain_indices = True
184
185# If false, no index is generated.
186html_use_index = False
187
188# If true, the index is split into individual pages for each letter.
189# html_split_index = False
190
191# If true, links to the reST sources are added to the pages.
192html_show_sourcelink = False
193
194# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
195# html_show_sphinx = True
196
197# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
198# html_show_copyright = True
199
200# If true, an OpenSearch description file will be output, and all pages will
201# contain a <link> tag referring to it. The value of this option must be the
202# base URL from which the finished HTML is served.
203# html_use_opensearch = ''
204
205# This is the file name suffix for HTML files (e.g. ".xhtml").
206# html_file_suffix = None
207
208# Output file base name for HTML help builder.
209htmlhelp_basename = 'install-guide'
210
211# If true, publish source files
212html_copy_source = False
213
214# -- Options for LaTeX output ---------------------------------------------
215
216latex_elements = {
217 # The paper size ('letterpaper' or 'a4paper').
218 # 'papersize': 'letterpaper',
219
220 # The font size ('10pt', '11pt' or '12pt').
221 # 'pointsize': '10pt',
222
223 # Additional stuff for the LaTeX preamble.
224 # 'preamble': '',
225}
226
227# Grouping the document tree into LaTeX files. List of tuples
228# (source start file, target name, title,
229# author, documentclass [howto, manual, or own class]).
230latex_documents = [
231 ('index', 'InstallGuide.tex', u'Install Guide',
232 u'OpenStack contributors', 'manual'),
233]
234
235# The name of an image file (relative to this directory) to place at the top of
236# the title page.
237# latex_logo = None
238
239# For "manual" documents, if this is true, then toplevel headings are parts,
240# not chapters.
241# latex_use_parts = False
242
243# If true, show page references after internal links.
244# latex_show_pagerefs = False
245
246# If true, show URL addresses after external links.
247# latex_show_urls = False
248
249# Documents to append as an appendix to all manuals.
250# latex_appendices = []
251
252# If false, no module index is generated.
253# latex_domain_indices = True
254
255
256# -- Options for manual page output ---------------------------------------
257
258# One entry per manual page. List of tuples
259# (source start file, name, description, authors, manual section).
260man_pages = [
261 ('index', 'installguide', u'Install Guide',
262 [u'OpenStack contributors'], 1)
263]
264
265# If true, show URL addresses after external links.
266# man_show_urls = False
267
268
269# -- Options for Texinfo output -------------------------------------------
270
271# Grouping the document tree into Texinfo files. List of tuples
272# (source start file, target name, title, author,
273# dir menu entry, description, category)
274texinfo_documents = [
275 ('index', 'InstallGuide', u'Install Guide',
276 u'OpenStack contributors', 'InstallGuide',
277 'This guide shows OpenStack end users how to install '
278 'an OpenStack cloud.', 'Miscellaneous'),
279]
280
281# Documents to append as an appendix to all manuals.
282# texinfo_appendices = []
283
284# If false, no module index is generated.
285# texinfo_domain_indices = True
286
287# How to display URL addresses: 'footnote', 'no', or 'inline'.
288# texinfo_show_urls = 'footnote'
289
290# If true, do not generate a @detailmenu in the "Top" node's menu.
291# texinfo_no_detailmenu = False
292
293# -- Options for Internationalization output ------------------------------
294locale_dirs = ['locale/']
295
296# -- Options for PDF output --------------------------------------------------
297
298pdf_documents = [
299 ('index', u'InstallGuide', u'Install Guide',
300 u'OpenStack contributors')
301]
diff --git a/install-guide/source/index.rst b/install-guide/source/index.rst
deleted file mode 100644
index 17a1545..0000000
--- a/install-guide/source/index.rst
+++ /dev/null
@@ -1,24 +0,0 @@
1===========================================
2Container Infrastructure Management service
3===========================================
4
5.. toctree::
6 :maxdepth: 2
7
8 get_started.rst
9 install.rst
10 verify.rst
11 launch-instance.rst
12 next-steps.rst
13
14The Container Infrastructure Management service codenamed (magnum) is an
15OpenStack API service developed by the OpenStack Containers Team making
16container orchestration engines (COE) such as Docker Swarm, Kubernetes
17and Mesos available as first class resources in OpenStack. Magnum uses
18Heat to orchestrate an OS image which contains Docker and Kubernetes and
19runs that image in either virtual machines or bare metal in a cluster
20configuration.
21
22This chapter assumes a working setup of OpenStack following `OpenStack
23Installation Tutorial <http://docs.openstack.org/#install-guides>`_.
24