Introduction to the OpenStack Dashboard
An overview of the OpenStack dashboard graphical user interface
Abstract
Preface Copy linkLink copied to clipboard!
This document provides an outline of the options available in the OpenStack dashboard graphical user interface.
Chapter 1. The OpenStack Dashboard Copy linkLink copied to clipboard!
The OpenStack dashboard is a web-based graphical user interface for managing OpenStack services.
To access the browser dashboard, the dashboard service must be installed, and you must know the dashboard host name (or IP) and login password. The dashboard URL is:
http://HOSTNAME/dashboard/
http://HOSTNAME/dashboard/
Chapter 2. The Admin Tab Copy linkLink copied to clipboard!
The Admin tab provides an interface where administrative users can view usage and manage instances, volumes, flavors, images, projects, users, services, and quotas.
The Admin tab displays in the main window only if you have logged in as a user with administrative privileges.
The following options are available in the Admin tab:
| Parameter Name | Description |
|---|---|
| Overview | View basic reports. |
| Resource Usage | Use the following tabs to view the following usages:
|
| Hypervisors | View the hypervisor summary. |
| Host Aggregates | View, create, and edit host aggregates. View the list of availability zones. |
| Instances | View, pause, resume, suspend, migrate, soft or hard reboot, and delete running instances that belong to users of some, but not all, projects. Also, view the log for an instance or access an instance using the console. |
| Volumes | View, create, edit, and delete volumes, and volume types. |
| Flavors | View, create, edit, view extra specs for, and delete flavors. Flavors are the virtual hardware templates in OpenStack. |
| Images | View, create, edit properties for, and delete custom images. |
| Networks | View, create, edit properties for, and delete networks. |
| Routers | View, create, edit properties for, and delete routers. |
| Defaults | View and edit the default quotas (maximum limits) for resources in the environment. |
| Metadata Definitions | Import, view, and edit metadata definition namespaces, and associate the metadata definitions with specific resource types. |
| System Information | Contains the following tabs:
|
In Red Hat OpenStack Platform 8, the Resource Usage Ceilometer panel is disabled by default. To enable the panel:
Remove the configuration files that disable the panel.
sudo rm /usr/share/openstack-dashboard/openstack_dashboard/enabled/_99_disable_metering_dashboard.py*
$ sudo rm /usr/share/openstack-dashboard/openstack_dashboard/enabled/_99_disable_metering_dashboard.py*Copy to Clipboard Copied! Toggle word wrap Toggle overflow Restart the
httpdservice.sudo systemctl restart httpd
$ sudo systemctl restart httpdCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 3. The Project Tab Copy linkLink copied to clipboard!
The Project tab provides an interface for viewing and managing the resources of a project. Set a project as active in Identity > Projects to view and manage resources in that project.
The following options are available in the Project tab:
| Parameter Name | Description |
|---|---|
| Overview | View reports for the project. |
| Instances | View, launch, create a snapshot from, stop, pause, or reboot instances, or connect to them through the console. |
| Volumes | Use the following tabs to complete these tasks:
|
| Images | View images, instance snapshots, and volume snapshots created by project users, and any images that are publicly available. Create, edit, and delete images, and launch instances from images and snapshots. |
| Access & Security | Use the following tabs to complete these tasks:
|
| Parameter Name | Description |
|---|---|
| Network Topology | View the interactive topology of the network. |
| Networks | Create and manage public and private networks and subnets. |
| Routers | Create and manage routers. |
| Parameter Name | Description |
|---|---|
| Containers | Create and manage storage containers. A container is a storage compartment for data, and provides a way for you to organize your data. It is similar to the concept of a Linux file directory, but it cannot be nested. |
| Parameter Name | Description |
|---|---|
| Stacks | Orchestrate multiple composite cloud applications using templates, through both an OpenStack-native REST API and a CloudFormation-compatible Query API. |
Chapter 4. The Identity Tab Copy linkLink copied to clipboard!
The Identity tab provides an interface for viewing and managing projects and users.
The following options are available in the Identity tab:
- Projects - View, create, edit, and delete projects/tenants, view project usage, add or remove users as project members, modify quotas, and set an active project.
- Users - View, create, edit, disable, and delete users, and change user passwords. The Users tab displays only if you are logged in as a user with administrative privileges.
For more information on procedures to manage your cloud using the OpenStack Dashboard, see the following guides:
- Instances and Images guide (also has procedures for volumes and containers)
- Networking guide
- Users and Identity Management guide
Chapter 5. Customizing the Dashboard Copy linkLink copied to clipboard!
After you have the OpenStack dashboard installed, you can customize its look and feel to suit your own needs. The customization options here focuses on the settings included in the local_settings.py file, stored in /openstack-dashboard/openstack_dashboard/local/.
The OpenStack dashboard by default installs the openstack-dashboard-theme package.
If you do not want to use this theme you can remove it and its dependencies using the following command:
rpm -e --nodeps openstack-dashboard-theme
# rpm -e --nodeps openstack-dashboard-theme
You can customize the following elements of the dashboard. Note that for a Director deployment, you will need to log in to each controller node as heat-admin to make the changes.
- Logo
- Site colors
- HTML title
- Site branding link
- Help URL
- Stylesheets
Logo and Site Colors:
Create two logo files in png format with transparent backgrounds of the following sizes:
- Login screen (Example: login_logo.png): 365 x 50
- Logged in banner (Example: banner_logo.png): 216 x 35
-
Upload your new images to the following location:
/usr/share/openstack-dashboard/openstack_dashboard/static/dashboard/img/ -
Create a SCSS style sheet in the following directory:
/usr/share/openstack-dashboard/openstack_dashboard/static/dashboard/scss/ Change the colors and image file names as appropriate. Note that the relative directory paths should be the same. The following example file demonstrates how to customize your SCSS file:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Open the following HTML template in an editor of your choice:
/usr/share/openstack-dashboard/openstack_dashboard/templates/_stylesheets.html Add a line to include your newly created style sheet. For example,
custom.scssfile:<link href='bootstrap/css/bootstrap.min.scss' media='screen' rel='stylesheet' /> <link href='dashboard/css/{% choose_scss %}' media='screen' rel='stylesheet' /> <link href='dashboard/css/custom.scss' media='screen' rel='stylesheet' /><link href='bootstrap/css/bootstrap.min.scss' media='screen' rel='stylesheet' /> <link href='dashboard/css/{% choose_scss %}' media='screen' rel='stylesheet' /> <link href='dashboard/css/custom.scss' media='screen' rel='stylesheet' />Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Restart the Apache server:
# systemctl restart httpd
# # systemctl restart httpd
- To view your changes simply reload your dashboard. If necessary, go back and modify your SCSS file as appropriate.
HTML Title:
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"
SITE_BRANDING = "Example, Inc. Cloud"Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Restart the Apache server.
Site Branding Link:
The logo also acts as a hyperlink. The default behavior is to redirect to
horizon:user_home. To change this, add the following attribute with the desired URL target tolocal_settings.py.SITE_BRANDING_LINK = "http://example.com"
SITE_BRANDING_LINK = "http://example.com"Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Restart the Apache server.
Help URL:
By default the help URL points to https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux_OpenStack_Platform/7/index.html. 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.mycompany.org",
'help_url': "http://openstack.mycompany.org",Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Restart the Apache server.
Custom Stylesheets:
It is possible to define custom stylesheets for your dashboard. Dashboard’s base template, openstack_dashboard/templates/base.html, defines multiple blocks that can be overridden. To define custom SCSS files that apply only to a specific dashboard, create a base template in your dashboard’s templates folder, which extends the dashboard’s base template.
Example: openstack_dashboard/dashboards/my_custom_dashboard/templates/my_custom_dashboard/base.html. In this template, you can redefine block CSS:
Don’t forget to include _stylesheets.html which includes all default stylesheets for the dashboard.