Este contenido no está disponible en el idioma seleccionado.
Managing cloud resources with the OpenStack Dashboard
Viewing and configuring the OpenStack Dashboard GUI
Abstract
Providing feedback on Red Hat documentation Copiar enlaceEnlace copiado en el portapapeles!
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
- Log in to the Red Hat Atlassian Jira.
- Click the following link to open a Create Issue page: Create issue
- 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.
- Click Create.
- Review the details of the bug you created.
Chapter 1. The Red Hat OpenStack Platform Dashboard service (horizon) Copiar enlaceEnlace copiado en el portapapeles!
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.
By default, users who log out of the OpenStack Dashboard are not logged out of SSO.
1.1. The Admin tab Copiar enlaceEnlace copiado en el portapapeles!
In the Admin tab of the OpenStack Dashboard you can view usage and manage instances, volumes, flavors, images, projects, users, services, and quotas.
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:
| 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 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:
|
1.1.1. Viewing allocated floating IP addresses Copiar enlaceEnlace copiado en el portapapeles!
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 Copiar enlaceEnlace copiado en el portapapeles!
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:
| 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 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:
|
| 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. |
| Trunks |
Create and manage trunks. Requires the |
| 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 with templates, through both an OpenStack-native REST API and a CloudFormation-compatible Query API. |
1.3. The Identity tab Copiar enlaceEnlace copiado en el portapapeles!
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 Copiar enlaceEnlace copiado en el portapapeles!
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
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 Copiar enlaceEnlace copiado en el portapapeles!
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.1You can use this image as a basis for a modified image.
2.2. Obtaining the RCUE theme Copiar enlaceEnlace copiado en el portapapeles!
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
Create a directory for your theme:
$ mkdir ~/horizon-themes $ cd ~/horizon-themesStart 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 infinityCopy the RCUE theme from the container to your local directory:
$ sudo podman cp horizon-temp:/usr/share/openstack-dashboard/openstack_dashboard/themes/rcue .Terminate the container:
$ sudo podman kill horizon-tempResult: You now have a local copy of the RCUE theme.
2.3. Creating your own theme based on RCUE Copiar enlaceEnlace copiado en el portapapeles!
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 mythemeTo 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 ofrcueincluding paths, files, and directories to ensure that you change them to the newmythemename.
2.4. Creating a file to enable your theme and customize the dashboard Copiar enlaceEnlace copiado en el portapapeles!
To enable your theme in the dashboard container, you must create a file to override the AVAILABLE_THEMES parameter.
Procedure
Create a new file called
_12_mytheme_theme.pyin thehorizon-themesdirectory and add the following content:AVAILABLE_THEMES = [('mytheme', 'My Custom Theme', 'themes/mytheme')]The
12in the file name ensures this file is loaded after the default RCUE theme configuration file, which uses11, to override its settings.Optional: You can also set custom parameters in the
_12_mytheme_theme.pyfile. 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_homeby default.SITE_BRANDING_LINK = "http://example.com"
2.5. Generating a modified horizon image Copiar enlaceEnlace copiado en el portapapeles!
When your custom theme is ready, you can create a new container image that uses your theme.
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
Use a
Dockerfileto generate a new container image using the originalhorizonimage 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-
Save this file in your
horizon-themesdirectory asDockerfile. 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 debugThe
-toption 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
versionandreleaselabels as a basis for this tag. If you generate a new version of this image, increment therelease, for example,0-2.
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-5Verify 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 Copiar enlaceEnlace copiado en el portapapeles!
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
Edit the
DockerHorizonConfigImageandDockerHorizonImageparameters 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 ...-
Save this new version of the
overcloud-images.yamlfile.
2.7. Editing puppet parameters Copiar enlaceEnlace copiado en el portapapeles!
Director provides a set of dashboard parameters that you can modify with environment files.
Procedure
Use the
ExtraConfigparameter to set Puppet hieradata. For example, the default help URL points to https://access.redhat.com/documentation/en/red-hat-openstack-platform. To modify this URL, use the following environment file content and replace the URL:parameter_defaults: ExtraConfig: horizon::help_url: "http://openstack.example.com"
Additional resources
2.9. Deploying an overcloud with a customized dashboard Copiar enlaceEnlace copiado en el portapapeles!
You can deploy an overcloud with your dashboard customizations.
Procedure
Include the following environment files in the
openstack overcloud deploycommand:- 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]