summaryrefslogtreecommitdiff
path: root/doc/source/install/install-ubuntu.rst
blob: 7c618ec295f1df23aa3e6125766e1c6185b819df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
================================
Install and configure for Ubuntu
================================

This section describes how to install and configure the dashboard
on the controller node.

The only core service required by the dashboard is the Identity service.
You can use the dashboard in combination with other services, such as
Image service, Compute, and Networking. You can also use the dashboard
in environments with stand-alone services such as Object Storage.

.. note::

   This section assumes proper installation, configuration, and operation
   of the Identity service using the Apache HTTP server and Memcached
   service.

Install and configure components
--------------------------------

.. include:: note_configuration_vary_by_distribution.txt

1. Install the packages:

   .. code-block:: console

      # apt install openstack-dashboard

   .. end

2. Edit the
   ``/etc/openstack-dashboard/local_settings.py``
   file and complete the following actions:

   * Configure the dashboard to use OpenStack services on the
     ``controller`` node:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        OPENSTACK_HOST = "controller"

     .. end

   * In the Dashboard configuration section, allow your hosts to access
     Dashboard:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        ALLOWED_HOSTS = ['one.example.com', 'two.example.com']

     .. end

     .. note::

        - Do not edit the ``ALLOWED_HOSTS`` parameter under the Ubuntu
          configuration section.
        - ``ALLOWED_HOSTS`` can also be ``['*']`` to accept all hosts. This
          may be useful for development work, but is potentially insecure
          and should not be used in production. See the
          `Django documentation
          <https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts>`_
          for further information.

   * Configure the ``memcached`` session storage service:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        SESSION_ENGINE = 'django.contrib.sessions.backends.cache'

        CACHES = {
            'default': {
                 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
                 'LOCATION': 'controller:11211',
            }
        }

     .. end

     .. note::

        Comment out any other session storage configuration.

   * Enable the Identity API version 3:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        OPENSTACK_KEYSTONE_URL = "http://%s/identity/v3" % OPENSTACK_HOST

     .. end

   * Enable support for domains:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        OPENSTACK_KEYSTONE_MULTIDOMAIN_SUPPORT = True

     .. end

   * Configure API versions:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        OPENSTACK_API_VERSIONS = {
            "identity": 3,
            "image": 2,
            "volume": 3,
        }

     .. end

   * Configure ``Default`` as the default domain for users that you create
     via the dashboard:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        OPENSTACK_KEYSTONE_DEFAULT_DOMAIN = "Default"

     .. end

   * Configure ``user`` as the default role for
     users that you create via the dashboard:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        OPENSTACK_KEYSTONE_DEFAULT_ROLE = "user"

     .. end

   * If you chose networking option 1, disable support for layer-3
     networking services:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        OPENSTACK_NEUTRON_NETWORK = {
            ...
            'enable_router': False,
            'enable_quotas': False,
            'enable_ipv6': False,
            'enable_distributed_router': False,
            'enable_ha_router': False,
            'enable_fip_topology_check': False,
        }

     .. end

   * Optionally, configure the time zone:

     .. path /etc/openstack-dashboard/local_settings.py
     .. code-block:: python

        TIME_ZONE = "TIME_ZONE"

     .. end

     Replace ``TIME_ZONE`` with an appropriate time zone identifier.
     For more information, see the `list of time zones
     <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>`__.

3. Add the following line to
   ``/etc/apache2/conf-available/openstack-dashboard.conf`` if not included.

   .. code-block:: none

      WSGIApplicationGroup %{GLOBAL}

Finalize installation
---------------------


* Reload the web server configuration:

  .. code-block:: console

     # systemctl reload apache2.service

  .. end