Juju Charm - OpenStack dashboard
Go to file
Michael Skalka 780381e6c4 Add default_domain config option.
This commit adds the default-domain config option to limit
the login page to only the specifed domain. For use with a single
domain environment where users are only given a login.

When considering a single domain usecase for users (admin_domain for
administration, then example_domain for all other users), it would
be handy for users not to input their domain name, but only username
and password to login.

By setting two lines below, we can create a separate dashboard instance
for non-admin users only.

OPENSTACK_KEYSTONE_MULTIDOMAIN_SUPPORT=False
OPENSTACK_KEYSTONE_DEFAULT_DOMAIN=example_domain

However, the current local_settings.py template does not allow that.

This change adds the 'default-domain' configuration option which modifies
local_policy.py to set the two configuration flags outlined in the bug.
If the config option is not set the charm will behave as before, enabling
the user to specify the domain at login.

This does no validation to ensure the domain exists, so it is up to the user
to supply a valid domain name.

Closes-Bug: 1712999
Change-Id: I316372ae305a4ba10e4d8ba047f23a317836b960
2017-10-04 13:44:20 -04:00
actions Re-license charm as Apache-2.0 2016-07-03 17:40:18 +01:00
hooks Add default_domain config option. 2017-10-04 13:44:20 -04:00
lib Update tox.ini files from release-tools gold copy 2016-09-09 19:22:14 +00:00
scripts Sync scripts/. 2013-04-09 11:40:10 -07:00
templates Add default_domain config option. 2017-10-04 13:44:20 -04:00
tests Disable apache mod_status when hardening apache 2017-09-15 17:58:19 -04:00
unit_tests Add default_domain config option. 2017-10-04 13:44:20 -04:00
.coveragerc Recover hooks testing, tweak coverage settings 2013-07-18 09:54:13 +01:00
.gitignore DNS HA 2016-06-23 09:24:49 +01:00
.gitreview Add gitreview prior to migration to openstack 2016-02-24 21:53:35 +00:00
.project Rebase on trunk 2014-02-24 17:46:45 +00:00
.pydevproject Rebase on trunk 2014-02-24 17:46:45 +00:00
.testr.conf Add tox support 2016-02-15 22:14:49 +00:00
LICENSE Re-license charm as Apache-2.0 2016-07-03 17:40:18 +01:00
Makefile Use bundletester for amulet test execution 2016-07-19 03:38:49 +00:00
README.md Typo fix: accross => across 2017-01-23 16:45:12 +07:00
actions.yaml Add pause/resume actions and sync charm-helpers 2016-03-29 07:20:36 +00:00
charm-helpers-hooks.yaml Add support for application version 2016-09-20 12:40:17 +01:00
charm-helpers-tests.yaml Fix alphanumeric comparisons for openstack and ubuntu releases 2017-03-29 10:52:42 +01:00
config.yaml Add default_domain config option. 2017-10-04 13:44:20 -04:00
copyright Re-license charm as Apache-2.0 2016-07-03 17:40:18 +01:00
hardening.yaml Disable apache mod_status when hardening apache 2017-09-15 17:58:19 -04:00
icon.svg Update charm icon 2017-08-02 18:11:30 +01:00
metadata.yaml Remove deprecated series metadata and tests 2017-08-23 09:55:29 -05:00
requirements.txt Enable Zesty-Ocata Amulet Tests 2017-04-28 08:42:59 -07:00
revision added syslog functionality 2014-02-03 13:34:56 +01:00
setup.cfg Test coverage tweaks, unit testing 2013-07-18 09:37:37 +01:00
test-requirements.txt Enable Zesty-Ocata Amulet Tests 2017-04-28 08:42:59 -07:00
tox.ini Fix alphanumeric comparisons for openstack and ubuntu releases 2017-03-29 10:52:42 +01:00

README.md

Overview

The OpenStack Dashboard provides a Django based web interface for use by both administrators and users of an OpenStack Cloud.

It allows you to manage Nova, Glance, Cinder and Neutron resources within the cloud.

Usage

The OpenStack Dashboard is deployed and related to keystone:

juju deploy openstack-dashboard
juju add-relation openstack-dashboard keystone

The dashboard will use keystone for user authentication and authorization and to interact with the catalog of services within the cloud.

The dashboard is accessible on:

http(s)://service_unit_address/horizon

At a minimum, the cloud must provide Glance and Nova services.

SSL configuration

To fully secure your dashboard services, you can provide a SSL key and certificate for installation and configuration. These are provided as base64 encoded configuration options::

juju set openstack-dashboard ssl_key="$(base64 my.key)" \
    ssl_cert="$(base64 my.cert)"

The service will be reconfigured to use the supplied information.

HA/Clustering

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases, a relationship to hacluster is required which provides the corosync back end HA functionality.

To use virtual IP(s) the clustered nodes must be on the same subnet such that the VIP is a valid IP on the subnet for one of the node's interfaces and each node has an interface in said subnet. The VIP becomes a highly-available API endpoint.

At a minimum, the config option 'vip' must be set in order to use virtual IP HA. If multiple networks are being used, a VIP should be provided for each network, separated by spaces. Optionally, vip_iface or vip_cidr may be specified.

To use DNS high availability there are several prerequisites. However, DNS HA does not require the clustered nodes to be on the same subnet. Currently the DNS HA feature is only available for MAAS 2.0 or greater environments. MAAS 2.0 requires Juju 2.0 or greater. The clustered nodes must have static or "reserved" IP addresses registered in MAAS. The DNS hostname(s) must be pre-registered in MAAS before use with DNS HA.

At a minimum, the config option 'dns-ha' must be set to true and at least one of 'os-public-hostname', 'os-internal-hostname' or 'os-internal-hostname' must be set in order to use DNS HA. One or more of the above hostnames may be set.

The charm will throw an exception in the following circumstances: If neither 'vip' nor 'dns-ha' is set and the charm is related to hacluster If both 'vip' and 'dns-ha' are set as they are mutually exclusive If 'dns-ha' is set and none of the os-{admin,internal,public}-hostname(s) are set

Whichever method has been used to cluster the charm the 'secret' option should be set to ensure that the Django secret is consistent across all units.

Keystone V3

If the charm is being deployed into a keystone v3 enabled environment then the charm needs to be related to a database to store session information. This is only supported for Mitaka or later.

Use with a Load Balancing Proxy

Instead of deploying with the hacluster charm for load balancing, its possible to also deploy the dashboard with load balancing proxy such as HAProxy:

juju deploy haproxy
juju add-relation haproxy openstack-dashboard
juju add-unit -n 2 openstack-dashboard

This option potentially provides better scale-out than using the charm in conjunction with the hacluster charm.