As a cloud administrative user, the OpenStack dashboard lets you create and manage projects, users, images, and flavors. You can also set quotas, and create and manage services. For information about using the dashboard to perform end user tasks, see the OpenStack End User Guide (http://docs.openstack.org/user-guide/).
The dashboard is generally installed on the controller node.
Ask the cloud operator for the host name or public IP address from which you can access the dashboard, and for your user name and password.
Open a web browser that has JavaScript and cookies enabled.
To use the Virtual Network Computing (VNC) client for the dashboard, your browser must support HTML5 Canvas and HTML5 WebSockets. The VNC client is based on noVNC. For details, see noVNC: HTML5 VNC Client (https://github.com/kanaka/noVNC/blob/master/README.md). For a list of supported browsers, see Browser support (https://github.com/kanaka/noVNC/wiki/Browser-support).
In the address bar, enter the host name or IP address for the
dashboard, for example https://ipAddressOrHostName/.
If a certificate warning appears when you try to access the URL for the first time, a self-signed certificate is in use, which is not considered trustworthy by default. Verify the certificate or add an exception in the browser to bypass the warning.
On the Log In page, enter your user name and password, and click .
The top of the window displays your user name. You can also access the tab (Section 3.1.4, “OpenStack dashboard — tab”) or sign out of the dashboard.
The visible tabs and functions in the dashboard depend on the access permissions, or roles, of the user you are logged in as.
If you are logged in as an end user, the tab (Section 3.1.1, “OpenStack dashboard — tab”) and tab (Section 3.1.3, “OpenStack dashboard — tab”) are displayed.
If you are logged in as an administrator, the tab (Section 3.1.1, “OpenStack dashboard — tab”) and tab (Section 3.1.2, “OpenStack dashboard — tab”) and tab (Section 3.1.3, “OpenStack dashboard — tab”) are displayed.
Projects are organizational units in the cloud, and are also known as tenants or accounts. Each user is a member of one or more projects. Within a project, a user creates and manages instances.
From the tab, you can view and manage the resources in a selected project, including instances and images. You can select the project from the drop down menu at the top left.
From the tab, you can access the following categories:
: View reports for the project.
: View, launch, create a snapshot from, stop, pause, or reboot instances, or connect to them through VNC.
: Use the following tabs to complete these tasks:
: View, create, edit, and delete volumes.
: View, create, edit, and delete volume snapshots.
: View images and instance snapshots created by project users, plus any images that are publicly available. Create, edit, and delete images, and launch instances from images and snapshots.
: Use the following tabs to complete these tasks:
: View, create, edit, and delete security groups and security group rules.
: View, create, edit, import, and delete key pairs.
: Allocate an IP address to or release it from a project.
: View API endpoints.
: View the network topology.
: Create and manage public and private networks.
: Create and manage routers.
: Use the REST API to orchestrate multiple composite cloud applications.
: Show a list of all the supported resource types for HOT templates.
: Create and manage containers and objects.
Administrative users can use the tab to view usage and to manage instances, volumes, flavors, images, networks and so on.
From the tab, you can access the following category to complete these tasks:
: View basic reports.
: Use the following tabs to view the following usages:
: View the usage report.
: View the statistics of all resources.
: View the hypervisor summary.
: View, create, and edit host aggregates. View the list of availability zones.
: 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 through VNC.
: Use the following tabs to complete these tasks:
: View, create, manage, and delete volumes.
: View, create, manage, and delete volume types.
: View, manage, and delete volume snapshots.
: View, create, edit, view extra specifications for, and delete flavors. A flavor is size of an instance.
: View, create, edit properties for, and delete custom images.
: View, create, edit properties for, and delete networks.
: View, create, edit properties for, and delete routers.
: View default quota values. Quotas are hard-coded in OpenStack Compute and define the maximum allowable size and number of resources.
: Import namespace and view the metadata information.
: Use the following tabs to view the service information:
: View a list of the services.
: View a list of all Compute services.
: View a list of all Block Storage services.
: View the network agents.
: View a list of all Orchestration services.
As an administrative user, you can create and manage images for the projects to which you belong. You can also create and manage images for users in all projects to which you have access.
To create and manage images in specified projects as an end user, see the OpenStack End User Guide (http://docs.openstack.org/user-guide/).
To create and manage images as an administrator for other users, use the following procedures.
For details about image creation, see the Virtual Machine Image Guide (http://docs.openstack.org/image-guide/).
Log in to the dashboard.
Choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category. The images that you can administer for cloud users appear on this page.
Click , which opens the window.
In the window, enter or select the following values:
|
|
Enter a name for the image. |
|
|
Enter a brief description of the image. |
|
|
Choose the image source from the dropdown list. Your choices are and . |
|
or |
Based on your selection, there is an or field. You can include the location URL or browse for the image file on your file system and add it. |
|
|
Select the kernel to boot an AMI-style image. |
|
|
Select the ramdisk to boot an AMI-style image. |
|
|
Select the image format. |
|
|
Specify the architecture. For
example, |
|
|
Leave this field empty. |
|
|
Leave this field empty. |
|
|
Specify this option to copy image data to the Image service. |
|
|
Select this option to make the image public to all users. |
|
|
Select this option to ensure that only users with permissions can delete it. |
Click .
The image is queued to be uploaded. It might take several minutes
before the status changes from Queued to Active.
Log in to the Dashboard. Choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select the images that you want to edit. Click .
In the window, you can change the image name.
Select the check box to make the image public. Clear this check box to make the image private. You cannot change the , , or attributes for an image.
Click .
Log in to the Dashboard. Choose the project from the drop-down list at the top of the page.
On the , open the tab and click the category.
Select the images that you want to delete.
Click .
In the window, click to confirm the deletion.
You cannot undo this action.
A role is a personality that a user assumes to perform a specific set of operations. A role includes a set of rights and privileges. A user assumes that role inherits those rights and privileges.
OpenStack Identity service defines a user's role on a
project, but it is completely up to the individual service
to define what that role means. This is referred to as the
service's policy. To get details about what the privileges
for each role are, refer to the policy.json file
available for each service in the
/etc/SERVICE/policy.json file. For example, the
policy defined for OpenStack Identity service is defined
in the /etc/keystone/policy.json file.
Log in to the dashboard and choose the project from the drop-down list.
On the tab, click the category.
Click the button.
In the window, enter a name for the role.
Click the button to confirm your changes.
Log in to the dashboard and choose the project from the drop-down list.
On the tab, click the category.
Click the button.
In the window, enter a new name for the role.
Click the button to confirm your changes.
Using the dashboard, you can edit only the name assigned to a role.
Log in to the dashboard and choose the project from the drop-down list.
On the tab, click the category.
Select the role you want to delete and click the button.
In the window, click to confirm the deletion.
You cannot undo this action.
As an administrative user, you can manage instances for users in various projects. You can view, terminate, edit, perform a soft or hard reboot, create a snapshot from, and migrate instances. You can also view the logs for instances or launch a VNC console for an instance.
For information about using the Dashboard to launch instances as an end user, see the OpenStack End User Guide (http://docs.openstack.org/user-guide/dashboard_launch_instances.html).
Log in to the Dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select an instance to create a snapshot from it. From the drop-down list, select .
In the window, enter a name for the snapshot.
Click . The Dashboard shows the instance snapshot in the category.
To launch an instance from the snapshot, select the snapshot and click . For information about launching instances, see the OpenStack End User Guide (http://docs.openstack.org/user-guide/dashboard_launch_instances.html).
Log in to the Dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select the instance for which you want to change the state.
From the drop-down list in the column, select the state.
Depending on the current state of the instance, you can perform various actions on the instance. For example, pause, un-pause, suspend, resume, soft or hard reboot, or terminate (actions in red are dangerous).
Use the category to track usage of instances for each project.
You can track costs per month by showing meters like number of VCPUs, disks, RAM, and uptime of all your instances.
Log in to the Dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select a month and click to query the instance usage for that month.
Click to download a CSV summary.
In OpenStack, a flavor defines the compute, memory, and storage capacity of a virtual server, also known as an instance. As an administrative user, you can create, edit, and delete flavors.
The following table lists the default flavors.
|
Flavor |
VCPUs |
Disk (in GB) |
RAM (in MB) |
|---|---|---|---|
|
m1.tiny |
1 |
1 |
512 |
|
m1.small |
1 |
20 |
2048 |
|
m1.medium |
2 |
40 |
4096 |
|
m1.large |
4 |
80 |
8192 |
|
m1.xlarge |
8 |
160 |
16384 |
Log in to the dashboard.
Choose the project from the drop-down list at the top of the page.
In the tab, open the tab and click the category.
Click .
In the window, enter or select the parameters for the flavor in the tab.
|
Name |
Enter the flavor name. |
|
ID |
Unique ID (integer or UUID) for the new flavor. If specifying 'auto', a UUID will be automatically generated. |
|
VCPUs |
Enter the number of virtual CPUs to use. |
|
RAM (MB) |
Enter the amount of RAM to use, in megabytes. |
|
Root Disk (GB) |
Enter the amount of disk space in gigabytes to use for the root (/) partition. |
|
Ephemeral Disk (GB) |
Enter the amount of disk space in gigabytes to use for the ephemeral partition. If unspecified, the value is 0 by default. Ephemeral disks offer machine local disk storage linked to the lifecycle of a VM instance. When a VM is terminated, all data on the ephemeral disk is lost. Ephemeral disks are not included in any snapshots. |
|
Swap Disk (MB) |
Enter the amount of swap space (in megabytes) to use. If unspecified, the default is 0. |
In the tab, you can control access to the flavor by moving projects from the column to the column.
Only projects in the column can use the flavor. If there are no projects in the right column, all projects can use the flavor.
Click .
Log in to the dashboard.
Choose the project from the drop-down list at the top of the page.
In the tab, open the tab and click the category.
Select the flavor that you want to edit. Click .
In the window, you can change the flavor name, VCPUs, RAM, root disk, ephemeral disk, and swap disk values.
Click .
Log in to the dashboard.
Choose the project from the drop-down list at the top of the page.
In the tab, open the tab and click the category.
Select the flavor that you want to update. In the drop-down list, click or click or in the column.
In the window, you can customize some metadata keys, then add it to this flavor and set them values.
Click .
Optional metadata keys
|
CPU limits |
quota:cpu_shares |
|
quota:cpu_period | |
|
quota:cpu_limit | |
|
quota:cpu_reservation | |
|
quota:cpu_quota | |
|
Disk tuning |
quota:disk_read_bytes_sec |
|
quota:disk_read_iops_sec | |
|
quota:disk_write_bytes_sec | |
|
quota:disk_write_iops_sec | |
|
quota:disk_total_bytes_sec | |
|
quota:disk_total_iops_sec | |
|
Bandwidth I/O |
quota:vif_inbound_average |
|
quota:vif_inbound_burst | |
|
quota:vif_inbound_peak | |
|
quota:vif_outbound_average | |
|
quota:vif_outbound_burst | |
|
quota:vif_outbound_peak | |
|
Watchdog behavior |
hw:watchdog_action |
|
Random-number generator |
hw_rng:allowed |
|
hw_rng:rate_bytes | |
|
hw_rng:rate_period |
For information about supporting metadata keys, see the OpenStack Cloud Administrator Guide (http://docs.openstack.org/admin-guide-cloud/compute-flavors.html).
Log in to the dashboard.
Choose the project from the drop-down list at the top of the page.
In the tab, open the tab and click the category.
Select the flavors that you want to delete.
Click .
In the window, click to confirm the deletion. You cannot undo this action.
Volumes are the Block Storage devices that you attach to instances to enable persistent storage. Users can attach a volume to a running instance or detach a volume and attach it to another instance at any time. For information about using the dashboard to create and manage volumes as an end user, see the OpenStack End User Guide (http://docs.openstack.org/user-guide/dashboard_manage_volumes.html).
As an administrative user, you can manage volumes and volume types for users in various projects. You can create and delete volume types, and you can view and delete volumes. Note that a volume can be encrypted by using the steps outlined below.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Click the tab, and click button. In the window, enter a name for the volume type.
Click button to confirm your changes.
A message indicates whether the action succeeded.
Create a volume type using the steps above for Section 3.6.1, “Create a volume type”.
Click in the Actions column of the newly created volume type.
Configure the encrypted volume by setting the parameters below from available options (see table):
Specifies the class responsible for configuring the encryption.
Specifies whether the encryption is from the front end (nova) or the back end (cinder).
Specifies the encryption algorithm.
Specifies the encryption key size.
Click .
Encryption Options
The table below provides a few alternatives available for creating encrypted volumes.
|
Encryption parameters |
Parameter options |
Comments |
|---|---|---|
|
Provider |
nova.volume.encryptors. luks.LuksEncryptor (Recommended) |
Allows easier import and migration of imported encrypted volumes, and allows access key to be changed without re-encrypting the volume |
|
nova.volume.encryptors. cryptsetup. CryptsetupEncryptor |
Less disk overhead than LUKS | |
|
Control Location |
front-end (Recommended) |
The encryption occurs within nova so that the data transmitted over the network is encrypted |
|
back-end |
This could be selected if a cinder plug-in supporting an encrypted back-end block storage device becomes available in the future. TLS or other network encryption would also be needed to protect data as it traverses the network | |
|
Cipher |
aes-xts-plain64 (Recommended) |
See NIST reference below to see advantages* |
|
aes-cbc-essiv |
Note: On the command line, type 'cryptsetup benchmark' for additional options | |
|
Key Size (bits) |
512 (Recommended for aes-xts-plain64. 256 should be used for aes-cbc-essiv) |
Using this selection for aes-xts, the underlying key size would only be 256-bits* |
|
256 |
Using this selection for aes-xts, the underlying key size would only be 128-bits* |
* Source NIST SP 800-38E (http://csrc.nist.gov/publications/nistpubs/800-38E/nist-sp-800-38E.pdf)
When you delete a volume type, volumes of that type are not deleted.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Click the tab, select the volume type or types that you want to delete.
Click button.
In the window, click the button to confirm the action.
A message indicates whether the action succeeded.
When you delete an instance, the data of its attached volumes is not destroyed.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select the volume or volumes that you want to delete.
Click button.
In the window, click the button to confirm the action.
A message indicates whether the action succeeded.
Shares are file storage that instances can have access to. Users can allow or deny a running instance to have access to a share at any time. For information about using the dashboard to create and manage shares as an end user, see the OpenStack End User Guide (http://docs.openstack.org/user-guide/dashboard_manage_shares.html).
As an administrative user, you can manage shares and share types for users in various projects. You can create and delete share types, and you can view and delete shares.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Click the tab, and click button. In the window, enter or select the following values.
: Enter a name for the share type.
: Choose True or False
: To add extra specs, use key=value.
Click button to confirm your changes.
A message indicates whether the action succeeded.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Click the tab, select the share type that you want to update.
Select from Actions.
In the window, update extra specs.
: To add extra specs, use key=value. To unset extra specs, use key.
Click button to confirm your changes.
A message indicates whether the action succeeded.
When you delete a share type, shares of that type are not deleted.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Click the tab, select the share type or types that you want to delete.
Click button.
In the window, click the button to confirm the action.
A message indicates whether the action succeeded.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select the share or shares that you want to delete.
Click button.
In the window, click the button to confirm the action.
A message indicates whether the action succeeded.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select the share that you want to delete.
Click button.
In the window, click the button to confirm the action.
A message indicates whether the action succeeded.
Log in to the dashboard and choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Select the share network or share networks that you want to delete.
Click button.
In the window, click the button to confirm the action.
A message indicates whether the action succeeded.
To prevent system capacities from being exhausted without notification, you can set up quotas. Quotas are operational limits. For example, the number of gigabytes allowed for each tenant can be controlled so that cloud resources are optimized. Quotas can be enforced at both the tenant (or project) and the tenant-user level.
Typically, you change quotas when a project needs more than ten volumes or 1 TB on a compute node.
Using the Dashboard, you can view default Compute and Block Storage quotas for new tenants, as well as update quotas for existing tenants.
Using the command-line interface, you can manage quotas for the OpenStack Compute service, the OpenStack Block Storage service, and the OpenStack Networking service (see ). Additionally, you can update Compute service quotas for tenant users.
The following table describes the Compute and Block Storage service quotas:
Quota Descriptions
|
Quota Name |
Defines the number of |
Service |
|---|---|---|
|
Gigabytes |
Volume gigabytes allowed for each project. |
Block Storage |
|
Instances |
Instances allowed for each project. |
Compute |
|
Injected Files |
Injected files allowed for each project. |
Compute |
|
Injected File Content Bytes |
Content bytes allowed for each injected file. |
Compute |
|
Keypairs |
Number of keypairs. |
Compute |
|
Metadata Items |
Metadata items allowed for each instance. |
Compute |
|
RAM (MB) |
RAM megabytes allowed for each instance. |
Compute |
|
Security Groups |
Security groups allowed for each project. |
Compute |
|
Security Group Rules |
Rules allowed for each security group. |
Compute |
|
Snapshots |
Volume snapshots allowed for each project. |
Block Storage |
|
VCPUs |
Instance cores allowed for each project. |
Compute |
|
Volumes |
Volumes allowed for each project. |
Block Storage |
Log in to the OpenStack dashboard.
On the tab, open the tab and click the category.
The default quota values are displayed.
You can sort the table by clicking on either the or column headers.
Log in to the OpenStack dashboard.
On the tab, open the tab and click the category.
Click the button.
In the window, you can edit the default quota values.
Click the button.
The dashboard does not show all possible project quotas. To view and update the quotas for a service, use its command-line client. See .
As an administrative user, you can view information for OpenStack services.
Log in to the OpenStack dashboard and choose the project from the drop-down list at the top of the page.
On the tab, click the category.
View the following information on these tabs:
: Displays the internal name and the public OpenStack name for each service, the host on which the service runs, and whether or not the service is enabled.
: Displays information specific to the Compute service. Both host and zone are listed for each service, as well as its activation status.
: Displays information specific to the Block Storage service. Both host and zone are listed for each service, as well as its activation status.
: Displays the network agents active within the cluster, such as L3 and DHCP agents, and the status of each agent.
: Displays information specific to the Orchestration service. Name, engine id, host and topic are listed for each service, as well as its activation status.
The Telemetry service provides user-level usage data for OpenStack-based clouds, which can be used for customer billing, system monitoring, or alerts. Data can be collected by notifications sent by existing OpenStack components (for example, usage events emitted from Compute) or by polling the infrastructure (for example, libvirt).
You can only view metering statistics on the dashboard (available
only to administrators).
The Telemetry service must be set up and administered through the
ceilometer command-line interface (CLI).
For basic administration information, refer to the "Measure Cloud Resources" chapter in the OpenStack End User Guide (http://docs.openstack.org/user-guide/).
Log in to the OpenStack dashboard as a user with Admin privileges.
On the tab, click the category.
Click the:
tab to view a usage report per tenant (project) by specifying the time period (or even use a calendar to define a date range).
tab to view a multi-series line chart with user-defined meters. You group by project, define the value type (min, max, avg, or sum), and specify the time period (or even use a calendar to define a date range).
Host aggregates enable administrative users to assign key-value pairs to groups of machines.
Each node can have multiple aggregates and each aggregate can have multiple key-value pairs. You can assign the same key-value pair to multiple aggregates.
The scheduler uses this information to make scheduling decisions. For information, see Scheduling (http://docs.openstack.org/liberty/config-reference/content/section_compute-scheduler.html).
Log in to the dashboard.
Choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
Click .
In the dialog box, enter or select the following values on the tab:
: The host aggregate name.
: The cloud provider defines the default
availability zone, such as us-west, apac-south, or
nova. You can target the host aggregate, as follows:
When the host aggregate is exposed as an availability zone, select the availability zone when you launch an instance.
When the host aggregate is not exposed as an availability zone, select a flavor and its extra specs to target the host aggregate.
Assign hosts to the aggregate using the tab in the same dialog box.
To assign a host to the aggregate, click + for the host. The host moves from the list to the list.
You can add one host to one or more aggregates. To add a host to an existing aggregate, edit the aggregate.
Choose the project from the drop-down list at the top of the page.
On the tab, open the tab and click the category.
To edit host aggregates, select the host aggregate that you want to edit. Click .
In the dialog box, you can change the name and availability zone for the aggregate.
To manage hosts, locate the host aggregate that you want to edit in the table. Click and select .
In the dialog box, click + to assign a host to an aggregate. Click - to remove a host that is assigned to an aggregate.
To delete host aggregates, locate the host aggregate that you want to edit in the table. Click and select .
The Orchestration service provides a template-based orchestration engine for the OpenStack cloud. Orchestration services create and manage cloud infrastructure resources such as storage, networking, instances, and applications as a repeatable running environment.
Administrators use templates to create stacks, which are collections of resources. For example, a stack might include instances, floating IPs, volumes, security groups, or users. The Orchestration service offers access to all OpenStack core services via a single modular template, with additional orchestration capabilities such as auto-scaling and basic high availability.
For information about:
administrative tasks on the command-line, see .
There are no administration-specific tasks that can be done through the Dashboard.
the basic creation and deletion of Orchestration stacks, refer to the OpenStack End User Guide (http://docs.openstack.org/user-guide/dashboard_stacks.html).