Chapter 5. Customizing the Dashboard

The look and feel of the OpenStack dashboard can be customized using the settings defined in /openstack-dashboard/openstack_dashboard/local/local_settings.py. You can customize the following elements of the dashboard:

  • HTML title
  • Site branding link
  • Help URL

In addition, you can create a custom theme and further customize the look and feel of the dashboard, including the following components:

  • Logo
  • Site colors
  • Stylesheets
Note

The OpenStack dashboard installs a default theme. If you do not want to use this theme, remove it using the following commands: 

# cd /usr/share/openstack-dashboard/openstack_dashboard/enabled
# cp _99_customization.py _999_remove_theme.py
# echo "DISABLED = True" >> _999_remove_theme.py
# systemctl restart httpd

For a director deployment, you will need to log in to each controller node as heat-admin to make the changes.

5.1. Logo, Site Colors, and Stylesheets

  1. Copy the entire RCUE theme directory /usr/share/openstack-dashboard/openstack_dashboard/themes/rcue to a new location, for example /usr/share/openstack-dashboard/openstack_dashboard/themes/mytheme.

  2. Create a new file /etc/openstack-dashboard/local_settings.d/_12_mytheme_theme.py and add the following line: 

    AVAILABLE_THEMES = [('mytheme', 'My Custom Theme', 'themes/mytheme')]

  3. Change all paths inside /usr/share/openstack-dashboard/openstack_dashboard/themes/mytheme/static/ replacing rcue with the new mytheme name. 

    To change a theme's colors, graphics, fonts, among others, edit the files in `/usr/share/openstack-dashboard/openstack_dashboard/themes/mytheme`.

  4. If you deployed OpenStack with High Availability, restart the httpd service using pacemaker: 

    # pcs resource restart httpd-clone

    Otherwise, run: 

    # systemctl restart httpd

To view your changes, reload your dashboard.

5.2. HTML Title

  1. To set the HTML title that appears at the top of the browser window, add the following line to local_settings.py. 

    SITE_BRANDING = "Example, Inc. Cloud"
  2. Restart the httpd server.

5.4. Help URL

  1. By default the help URL points to https://access.redhat.com/documentation/en/red-hat-openstack-platform. You can change the help URL by editing the following attribute to the URL of your choice in local_settings.py: 

    'help_url': "http://openstack.example.com",
  2. Restart the httpd server.