Este contenido no está disponible en el idioma seleccionado.

Managing cloud resources with the OpenStack Dashboard


Red Hat OpenStack Platform 17.1

Viewing and configuring the OpenStack Dashboard GUI

OpenStack Documentation Team

Abstract

This guide provides an outline of the options available in the Red Hat OpenStack Platform Dashboard user interface.

Providing feedback on Red Hat documentation

We appreciate your feedback. Tell us how we can improve the documentation.

To provide documentation feedback for Red Hat OpenStack Platform (RHOSP), create a Jira issue in the OSPRH Jira project.

Procedure

  1. Log in to the Red Hat Atlassian Jira.
  2. Click the following link to open a Create Issue page: Create issue
  3. Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue.
  4. Click Create.
  5. Review the details of the bug you created.

The Red Hat OpenStack Platform (RHOSP) Dashboard (horizon) is a web-based graphical user interface that you can use to manage RHOSP services.

To access the browser dashboard, you must install the Dashboard service, and you must know the dashboard host name or IP, and login password. The dashboard URL is:

http://<hostname>/dashboard/
  • Replace <hostname> with the Dashboard host name or IP.

Federation allows users to log in to the OpenStack Dashboard by using Red Hat’s single sign-on (SSO) technology. For more information, see Deploying Red Hat OpenStack Platform with single sign-on.

Note

By default, users who log out of the OpenStack Dashboard are not logged out of SSO.

1.1. The Admin tab

In the Admin tab of the OpenStack Dashboard you can view usage and manage instances, volumes, flavors, images, projects, users, services, and quotas.

Note

The Admin tab displays in the main window when you log in as an admin user.

The following options are available in the Admin tab:

Expand
Table 1.1. System Panel
Parameter nameDescription

Overview

View basic reports.

Resource Usage

Use the following tabs to view the following usages:

  • Usage Report - View the usage report.
  • Stats - View the statistics of all resources.

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 with the console.

Volumes

View, create, edit, and delete volumes, and volume types.

Flavors

View, create, edit, view extra specifications for, and delete flavors. Flavors are the virtual hardware templates in Red Hat OpenStack Platform (RHOSP).

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.

Floating IPs

View allocated floating IP addresses for all projects.

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:

  • Services - View a list of the services.
  • Compute Services - View a list of all Compute services.
  • Network Agents - View the network agents.
  • Block Storage Services - View a list of all Block Storage services.
  • Orchestration Services - View a list of all Orchestration services.

1.1.1. Viewing allocated floating IP addresses

You can use the Floating IPs panel to view a list of allocated floating IP addresses. You can access the same information from the command line with the nova list --all-projects command.

1.2. The Project tab

In the Project tab of the OpenStack Dashboard you can view and manage project resources. 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:

Expand
Table 1.2. The Compute tab
Parameter nameDescription

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:

  • Volumes - View, create, edit, and delete volumes.
  • Volume Snapshots - View, create, edit, and delete volume snapshots.

Images

View images, instance snapshots, and volume snapshots that project users create, 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:

  • Security Groups - View, create, edit, and delete security groups and security group rules.
  • Key Pairs - View, create, edit, import, and delete key pairs.
  • Floating IPs - Allocate an IP address to or release it from a project.
  • API Access - View API endpoints, download the OpenStack RC file, download EC2 credentials, and view credentials for the current project user.
Expand
Table 1.3. The Network tab
Parameter nameDescription

Network Topology

View the interactive topology of the network.

Networks

Create and manage public and private networks and subnets.

Routers

Create and manage routers.

Trunks

Create and manage trunks. Requires the trunk extension enabled in OpenStack Networking (neutron).

Expand
Table 1.4. The Object Store tab
Parameter nameDescription

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.

Expand
Table 1.5. The Orchestration tab
Parameter nameDescription

Stacks

Orchestrate multiple composite cloud applications with templates, through both an OpenStack-native REST API and a CloudFormation-compatible Query API.

1.3. The Identity tab

In the Identity tab of the OpenStack Dashboard you can view and manage projects and users.

The following options are available in the Identity tab:

  • Projects - View, create, edit, and delete projects, 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 is available when you log in as an admin user.

For more information about managing your cloud with the Red Hat OpenStack Platform dashboard, see the following guides:

Chapter 2. Customizing the dashboard

By default, the Red Hat OpenStack Platform (RHOSP) dashboard (horizon) uses the Red Hat Common User Experience (RCUE) theme, which is stored inside the horizon container. But you can create your theme based on this RCUE theme and change the following dashboard elements:

  • Logo
  • Site colors
  • Stylesheets
  • HTML title
  • Site branding link
  • Help URL
Note

To ensure continued support for modified RHOSP container images, the resulting images must comply with the Red Hat Container Support Policy.

2.1. Obtaining the horizon container image

To obtain a copy of the horizon container image, pull the image either into the undercloud or a separate client system that is running podman.

Procedure

  • Pull the horizon container image:

    $ sudo podman pull registry.redhat.io/rhosp-rhel9/openstack-horizon:17.1

    You can use this image as a basis for a modified image.

2.2. Obtaining the RCUE theme

The horizon container image uses the Red Hat Common User Experience (RCUE) theme by default. You can use this theme as a basis for your own theme and extract a copy from the container image.

Procedure

  1. Create a directory for your theme:

    $ mkdir ~/horizon-themes
    $ cd ~/horizon-themes
  2. Start a container that executes a null loop. For example, run the following command:

    $ sudo podman run --rm -d --name horizon-temp registry.redhat.io/rhosp-rhel9/openstack-horizon /usr/bin/sleep infinity
  3. Copy the RCUE theme from the container to your local directory:

    $ sudo podman cp horizon-temp:/usr/share/openstack-dashboard/openstack_dashboard/themes/rcue .
  4. Terminate the container:

    $ sudo podman kill horizon-temp

    Result: You now have a local copy of the RCUE theme.

2.3. Creating your own theme based on RCUE

To use the Red Hat Common User Experience (RCUE) theme as a basis, copy the entire RCUE theme directory rcue to a new location. This procedure uses mytheme as an example name.

Procedure

  • Copy the theme:

    $ cp -r rcue mytheme

    To change the colors, graphics, fonts, and other elements of a theme, edit the files in mytheme. When you edit this theme, check for all instances of rcue including paths, files, and directories to ensure that you change them to the new mytheme name.

2.4. Creating a file to enable your theme and customize the dashboard

To enable your theme in the dashboard container, you must create a file to override the AVAILABLE_THEMES parameter.

Procedure

  1. Create a new file called _12_mytheme_theme.py in the horizon-themes directory and add the following content:

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

    The 12 in the file name ensures this file is loaded after the default RCUE theme configuration file, which uses 11, to override its settings.

  2. Optional: You can also set custom parameters in the _12_mytheme_theme.py file. Use the following examples as a guide:

    SITE_BRANDING

    Set the HTML title that appears at the top of the browser window.

    SITE_BRANDING = "Example, Inc. Cloud"
    SITE_BRANDING_LINK

    Changes the hyperlink of the theme logo, which normally redirects to horizon:user_home by default.

    SITE_BRANDING_LINK = "http://example.com"

2.5. Generating a modified horizon image

When your custom theme is ready, you can create a new container image that uses your theme.

Important

If you update or upgrade Red Hat OpenStack Platform, you must reapply the theme to the new horizon image and push a new version of the modified image to the undercloud.

Procedure

  1. Use a Dockerfile to generate a new container image using the original horizon image as a basis, as shown in the following example:

    FROM registry.redhat.io/rhosp-rhel9/openstack-horizon
    MAINTAINER Acme
    LABEL name="rhosp-rhel9/openstack-horizon-mytheme" vendor="Acme" version="0" release="1"
    COPY mytheme /usr/share/openstack-dashboard/openstack_dashboard/themes/mytheme
    COPY _12_mytheme_theme.py /etc/openstack-dashboard/local_settings.d/_12_mytheme_theme.py
    RUN sudo chown apache:apache /etc/openstack-dashboard/local_settings.d/_12_mytheme_theme.py
  2. Save this file in your horizon-themes directory as Dockerfile.
  3. Use the Dockerfile to generate the new image:

    $ sudo podman build . -t "172.24.10.10:8787/rhosp-rhel9/openstack-horizon:0-5" --log-level debug

    The -t option names and tags the resulting image. It uses the following syntax:

    [LOCATION]/[NAME]:[TAG]
    LOCATION
    This is usually the location of the container registry that the overcloud eventually uses to pull images. In this instance, you push this image to the container registry of the undercloud, so set this to the undercloud IP and port.
    NAME
    For consistency, this is usually the same name as the original container image followed by the name of your theme. In this instance, it is rhosp-rhel9/openstack-horizon-mytheme.
    TAG
    The tag for the image. Red Hat uses the version and release labels as a basis for this tag. If you generate a new version of this image, increment the release, for example,0-2.
  4. Push the image to the container registry of the undercloud:

    $ sudo openstack tripleo container image push --local 172.24.10.10:8787/rhosp-rhel9/openstack-horizon:0-5
  5. Verify that the image has uploaded to the local registry:

      [stack@director horizon-themes]$ curl http://172.24.10.10:8787/v2/_catalog | jq .repositories[] | grep -i hori
      "rhosp-rhel9/openstack-horizon"
      [stack@director horizon-themes]$
    
      [stack@director ~]$ sudo openstack tripleo container image list | grep hor
      | docker://director.ctlplane.localdomain:8787/rhosp-rhel9/openstack-horizon:16.0-84
      | docker://director.ctlplane.localdomain:8787/rhosp-rhel9/openstack-horizon:0-5  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<,Uploaded
      [stack@director ~]$

2.6. Using the modified container image in the overcloud

To use the container image that you modified with your overcloud deployment, edit the environment file that contains the list of container image locations. This environment file is usually named overcloud-images.yaml.

Procedure

  1. Edit the DockerHorizonConfigImage and DockerHorizonImage parameters to point to your modified container image:

    parameter_defaults:
      ...
      ContainerHorizonConfigImage: 192.168.24.1:8787/rhosp-rhel9/openstack-horizon-mytheme:0-1
      ContainerHorizonImage: 192.168.24.1:8787/rhosp-rhel9/openstack-horizon-mytheme:0-1
      ...
  2. Save this new version of the overcloud-images.yaml file.

2.7. Editing puppet parameters

Director provides a set of dashboard parameters that you can modify with environment files.

Procedure

Additional resources

You can customize the list of available share protocols in the Manila UI plugin for OpenStack Dashboard (horizon) by using the ExtraConfig parameter in a custom environment file. Modify the ExtraConfig parameter to integrate the puppet parameter that you can use to customize the dashboard options for the Shared File Systems service (manila).

Procedure

  1. Log in to the undercloud host as the stack user.
  2. Source the stackrc undercloud credentials file:

    $ source ~/stackrc
  3. Create or open a YAML environment file to configure the share protocols that you want to be available to cloud users in the dashboard :

    $ vi /home/stack/templates/<share_protocols>.yaml
    • Replace <share_protocols> with the name of your file.
  4. Configure the puppet parameter that you can use to customize the options for the Shared File Systems service:

    parameter_defaults:
      ControllerExtraConfig:
        horizon::dashboards::manila::manila_options:
    Note

    If you use a custom role, use the [role_name]ExtraConfig parameter instead of the ControllerExtraConfig parameter. Replace [role_name] with the name of your custom role.

  5. Configure the list of enabled_share_protocols with the protocols you want to use, for example, the CephFS protocol:

    parameter_defaults:
      ControllerExtraConfig:
        horizon::dashboards::manila::manila_options:
          enabled_share_protocols: ['CEPHFS']
  6. Add your <share_protocols>.yaml file to the stack with your other environment files, and then deploy the overcloud:

    (undercloud)$ openstack overcloud deploy --templates \
    -e [your environment files] \
    -e /home/stack/templates/<share_protocols>.yaml

2.9. Deploying an overcloud with a customized dashboard

You can deploy an overcloud with your dashboard customizations.

Procedure

  • Include the following environment files in the openstack overcloud deploy command:

    • The environment file with your modified container image locations.
    • The environment file with additional dashboard modifications.
    • Any other environment files that are relevant to your overcloud configuration.

      $ openstack overcloud deploy --templates \
          -e /home/stack/templates/overcloud-images.yaml \
          -e /home/stack/templates/help_url.yaml \
          [OTHER OPTIONS]

Legal Notice

Copyright © Red Hat.
Except as otherwise noted below, the text of and illustrations in this documentation are licensed by Red Hat under the Creative Commons Attribution–Share Alike 3.0 Unported license . If you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, the Red Hat logo, JBoss, Hibernate, and RHCE are trademarks or registered trademarks of Red Hat, LLC. or its subsidiaries in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
XFS is a trademark or registered trademark of Hewlett Packard Enterprise Development LP or its subsidiaries in the United States and other countries.
The OpenStack® Word Mark and OpenStack logo are trademarks or registered trademarks of the Linux Foundation, used under license.
All other trademarks are the property of their respective owners.
Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de la documentación de Red Hat

Legal Notice

Theme

© 2026 Red Hat
Volver arriba