Juju Charm - OpenStack dashboard
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Zuul c2c1be3070 Merge "Force resolve configs after openstack-upgrade action" 3 weeks ago
actions Force resolve configs after openstack-upgrade action 2 months ago
charmhelpers Merge "Validate X509 certificate inputs" 3 weeks ago
docs Policyd override implementation 3 years ago
files Sync charm/ceph helpers, tox, and requirements 3 years ago
hooks Add CREATE_INSTNACE_FLAVOR_SORT option 1 month ago
lib Update tox.ini files from release-tools gold copy 6 years ago
scripts Sync scripts/. 9 years ago
templates Add CREATE_INSTNACE_FLAVOR_SORT option 1 month ago
tests Update to classic charms to build using charmcraft in CI 3 months ago
unit_tests Merge "Force resolve configs after openstack-upgrade action" 3 weeks ago
.gitignore Update to classic charms to build using charmcraft in CI 3 months ago
.gitreview OpenDev Migration Patch 3 years ago
.project Rebase on trunk 8 years ago
.pydevproject Rebase on trunk 8 years ago
.stestr.conf Replace ostestr with stestr in testing framework. 3 years ago
.zuul.yaml Updates to enable jammy and finalise charmcraft builds 2 months ago
LICENSE Re-license charm as Apache-2.0 6 years ago
Makefile Sync helpers for 20.05 2 years ago
README.md Streamline the custom theme steps in README.md 4 months ago
actions.yaml Add security-checklist action 3 years ago
build-requirements.txt Update to classic charms to build using charmcraft in CI 3 months ago
charm-helpers-hooks.yaml charmhelpers sync for yoga release 2 months ago
charmcraft.yaml Updates to enable jammy and finalise charmcraft builds 2 months ago
config.yaml Add CREATE_INSTNACE_FLAVOR_SORT option 1 month ago
copyright Re-license charm as Apache-2.0 6 years ago
hardening.yaml Disable apache mod_status when hardening apache 5 years ago
icon.svg Update charm icon 5 years ago
metadata.yaml Updates to enable jammy and finalise charmcraft builds 2 months ago
osci.yaml Updates to enable jammy and finalise charmcraft builds 2 months ago
pip.sh Add xena bundles 8 months ago
rename.sh Update to classic charms to build using charmcraft in CI 3 months ago
requirements.txt Updates to enable jammy and finalise charmcraft builds 2 months ago
revision added syslog functionality 8 years ago
setup.cfg setup.cfg: Replace dashes with underscores 5 months ago
test-requirements.txt Use unittest.mock instead of mock 5 months ago
tox.ini Updates to enable jammy and finalise charmcraft builds 2 months ago

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:identity-service \
                  keystone:identity-service

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 config openstack-dashboard ssl_key="$(base64 my.key)" \
    ssl_cert="$(base64 my.cert)"

The service will be reconfigured to use the supplied information.

High availability

When more than one unit is deployed with the hacluster application the charm will bring up an HA active/active cluster.

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases the hacluster subordinate charm is used to provide the Corosync and Pacemaker backend HA functionality.

See OpenStack high availability in the OpenStack Charms Deployment Guide for details.

Note: Regardless of which HA method has been chosen, 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.

Custom Theme

This charm supports providing a custom theme as documented in the themes configuration. In order to enable this capability the configuration options 'ubuntu-theme' must be turned off and the option 'custom-theme' turned on.

juju config openstack-dashboard ubuntu-theme=no
juju config openstack-dashboard custom-theme=true

Once the option is enabled a custom theme can be provided via a juju resource. The resource should be a .tgz file with the contents of your custom theme. If the file 'local_settings.py' is included it will be sourced.

juju attach-resource openstack-dashboard theme=theme.tgz

Repeating the attach-resource will update the theme and turning off the custom-theme option will return to the default.

Optionally, the uploaded custom theme can be set as the default theme.

juju config openstack-dashboard default-theme='custom'

Policy Overrides

Policy overrides is an advanced feature that allows an operator to override the default policy of an OpenStack service. The policies that the service supports, the defaults it implements in its code, and the defaults that a charm may include should all be clearly understood before proceeding.

Caution: It is possible to break the system (for tenants and other services) if policies are incorrectly applied to the service.

Policy statements are placed in a YAML file. This file (or files) is then placed into an appropriately-name directory (or directories) and (ZIP) compressed into a single file. This compressed file is then used as an application resource. Finally, the override is enabled via a Boolean charm option.

The directory names correspond to the OpenStack services that Horizon has policy override support for:

directory name service charm
compute Nova nova-cloud-controller
identity Keystone keystone
image Glance glance
network Neutron neutron-api
volume Cinder cinder

Important: The exact same overrides must also be implemented at the service level using the appropriate charm. See the Policy Overrides section of each charm's README.

For example, to provide overrides for Nova and Keystone, the compressed file should have a structure similar to the following (the YAML filenames are arbitrary):

\ compute - compute-override1.yaml
|         \ compute-override2.yaml
|
\ identity - identity-override1.yaml
           | identity-override2.yaml
           \ identity-override3.yaml

Here are the essential commands:

zip -r overrides.zip compute identity
juju attach-resource openstack-dashboard policyd-override=overrides.zip
juju config openstack-dashboard use-policyd-override=true

See appendix Policy Overrides in the OpenStack Charms Deployment Guide for a thorough treatment of this feature.

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.