Self Service User Interface Guide

Red Hat CloudForms 4.6

An overview of the Red Hat CloudForms Self Service user interface

Red Hat CloudForms Documentation Team

Abstract

This document provides an outline of the options available in the Red Hat CloudForms Self Service user interface.
If you have a suggestion for improving this guide or have found an error, please submit a Bugzilla report at http://bugzilla.redhat.com against Red Hat CloudForms Management Engine for the Documentation component. Please provide specific details, such as the section number, guide name, and CloudForms version so we can easily locate the content.

Chapter 1. Red Hat CloudForms Self Service

Red Hat CloudForms Self Service is a web-based graphical user interface for ordering and managing IT service requests. You can enable self-service tenant end users, who can easily access their services, track requests, and manage their accounts using the Self Service user interface (SSUI), which has widgets, dashboard controls and feedback. The Self Service user interface supports role-based access control (RBAC) of menus and features, similar to in the full administrative user interface.

Note

All catalog items, dialogs, buttons, icons among other items must be configured in the full administrative user interface before they are available to users in the Self Service user interface.

Chapter 2. Accessing the Self Service User Interface

The Self Service user interface is running by default and does not need to be started or configured. To access the Self Service user interface, you must know the host name (or IP address) of the appliance, and the login credentials.

Self Service URL:

https://HOSTNAME/self_service/

Self Service Login Screen

You can choose your preferred language for the Self Service user interface from the options in the Language list available on the login screen. The following languages are supported:

  • English
  • Español (Spanish)
  • Français (French)
  • 日本語 (Japanese)
  • 한국어 (Korean)
  • Nederlands (Dutch)
  • Português (Portuguese)
  • Português do Brasil (Brazilian Portuguese)
  • 简体中文 (Simplified Chinese)
  • Traditional Chinese

Additionally, the User Default and Browser Default options default to the language already set by the user or browser respectively.

Chapter 4. Dashboard Tab

Once you log in to the Self Service user interface, you will see the dashboard screen by default. The Dashboard tab provides a quick summary of the services available, requests made, and their statuses as below:

  • Total Services
  • Current Services
  • Services Retiring Soon
  • Retired Services
  • Total Requests
  • Pending Requests
  • Approved Requests
  • Denied Requests

Dashboard Tab

Monthly Charges - This Month To Date
The Self Service user interface has added basic support for displaying monthly chargeback data of the computing and storage cost for the use of resources, in the currencies supported by the full administrative user interface. This provides a quick summary of where you are from cost standpoint to that point in the month. For more information about configuring chargeback rates in the full administrative user interface and how Red Hat CloudForms calculates chargeback costs, see Chargeback in the Monitoring, Alerts, and Reporting guide.
Note

If you are on the first day of the month, there can be no data yet therefore resulting in zero dollar amount. Also, if you have a lot of data, it might not have rolled into the new month yet, resulting in no data and dollar amount for month to date.

Chapter 5. My Services Tab

The My Services tab lists all service requests individually with a summary of information associated with each service, including the Service Name, its current Power State represented by an icon, Number of VMs, Owner, date Created, and Retires date. Additionally, you can see the chargeback cost per service for a virtual machine’s month-to-date usage. You can filter or sort services by those entities, and by Relative Cost.

On the same screen, you have the option to edit the service name and description, edit tags, set ownership, retire the service now or at a later date, or remove the service by clicking more options (represented by three dots) next to the service. You also have options to perform power operations, that is start, stop, or suspend, at the service level. You can choose to click on a service where you can perform all of these actions at the service level using the designated buttons located at the top of the screen, as well as access the virtual machine dashboard, manage snapshots, and open the virtual machine and web console from under the Resources section. You can also control power operations and life cycle of virtual machine resources via more options (represented by three dots).

ssui my services

ssui my service details

Virtual Machine Dashboard:

From the My Services screen, click on a service and then on the virtual machine name or View Details under more options (represented by three dots) to access the virtual machine dashboard. The dashboard displays the following information about the virtual machine resource:

  • Compliance
  • Retirement
  • Snapshots
  • Timeline of power events
  • Utilization of CPU, Memory, and Storage
  • Smart State analysis
  • Tags
  • Custom attributes
  • Disk usage

Additionally, you can also control the virtual machine power operations, and manage snapshots from the dashboard. A snapshot is a copy of the virtual machine’s disk file (VMDK) that captures the entire state of the virtual machine at a point in time.

5.1. Setting a Retirement Date for a Service

Follow this procedure to schedule retirement for a service at a later date. For retiring a service immediately, see Section 5.2, “Retiring a Service”.

  1. From the Services screen, click on the required service you want to schedule retirement for.
  2. Click the Service Retire Button button located on the upper-right corner of the screen, then select Set Retirement Dates. The Schedule Service Retirement window will appear. ssui schedule service retirement
  3. Set the Retirement Date.
  4. Select the Retirement Warning from the list.
  5. Click Save.

5.2. Retiring a Service

Follow this procedure to retire a service immediately. For retiring a service at a later date, see Section 5.1, “Setting a Retirement Date for a Service”.

  1. From the Services screen, click on the service you want to retire now.
  2. Click the Service Retire Button button located on the upper right corner of the screen, then select Retire. The Retire Service Now window will appear to confirm your action. ssui retire service now
  3. Click Yes, Retire Service Now.

5.3. Setting Ownership of a Service

Follow this procedure to set ownership of a service.

  1. From the Services screen, click on the more options button next to the service you want set ownership for, then click Set Ownership. Alternatively, click on the service. Click the ssui service settings button button located on the upper-right corner of the screen, then select Set Ownership. ssui set service ownership
  2. Select an owner from the list.
  3. Select a group from the list.
  4. Click Save.

5.4. Adding and Editing Tags

Follow this procedure to add or edit tags for a service.

  1. From the Services screen, click on more options next to the service you want add or edit tags for, then click Edit Tags. Alternatively, click on the service. Click the ssui edit tags button button located on the upper-right corner of the screen, then select Edit Tags. ssui add edit tags
  2. To add a tag, select the tag category and value from the lists, then click the blue plus (+) sign as shown in the screen capture.
  3. To edit tags, simply change the value assigned to a category, or click on the cross sign in the tag to delete an existing tag.
  4. Click Save.

5.5. Removing a Service

Follow this procedure to remove a service.

  1. From the Services screen, click on more options next to the service you want to remove, then click Remove. Alternatively, click on the service. Click the ssui service settings button button located on the upper-right corner of the screen, then select Remove. A confirmation window appears.
  2. Click Yes, Remove Service.

5.6. Editing a Service

Follow this procedure to edit the name and description of a service.

  1. From the My Services screen, click on more options next to the service you want to edit, then click Edit. Alternatively, click on the service. Click the ssui service settings button button located on the upper-right corner of the screen, then select Edit. An Edit Service screen appears.
  2. Edit the name and description of the service as required. ssui edit service
  3. Click Save.

5.7. Controlling Virtual Machine Power States

Follow this procedure to perform power operations on virtual machines, such as start, stop, or suspend, depending on the current state of the virtual machine.

  1. From the My Services screen, click on the required service.
  2. Under Resources, click more options (represented by three dots) where you have the option to start, stop, or suspend the virtual machine. Alternatively, click on the virtual machine name to see more details about the resource, including the Power Operations button.

5.8. Creating Virtual Machine Snapshots

To create a snapshot from the Services screen:

  1. From the My Services screen, click on the service associated with the virtual machine you want to create a snapshot for.
  2. In Resources, click Snapshots next to the virtual machine you want to create a snapshot for, then select Create to create a snapshot. The Create Snapshot window appears.
  3. Enter a name for the snapshot.
  4. Optional: Select Memory if you want to capture the state of the virtual machine’s memory.
  5. Optional: Enter a Description.
  6. Click Create.

To create a snapshot from the Resources screen:

  1. From the My Services screen, click on the service associated with the virtual machine you want to create a snapshot for.
  2. In Resources, click on the virtual machine you want to create a snapshot for.
  3. On the virtual machine dashboard, click the Snapshots button, then select Create. The Create Snapshot window appears.
  4. Enter a name for the snapshot.
  5. Optional: Select Memory if you want to capture the state of the virtual machine’s memory.
  6. Optional: Enter a Description.
  7. Click Create.

5.9. Viewing Virtual Machine Snapshots

  1. From the My Services screen, click on the service associated with the virtual machine you want to view snapshots for.
  2. In Resources, click Snapshots next to the virtual machine and select View to view available snapshots. Alternatively, click on the virtual machine, then click Snapshots to view available snapshots.
Note

You can revert or delete a snapshot only from the snapshot summary screen. To do so, navigate to Snapshots > View, click more options (represented by three dots) next to the snapshot you want to revert or delete, and then click Revert or Delete as required. Revert returns a virtual machine to a previous state when you took the snapshot.

5.10. Accessing the Virtual Machine Console

Follow this procedure to open a console window to the virtual machine. The console is the remote control system that enables you to interact directly with your virtual machines.

  1. From the Services screen, click on the required service.
  2. In Resources, click the Access Button button next to the virtual machine and select VM Console.

The virtual machine console will open in a new window of your web browser. Note that you may have to enable the pop-up settings in your browser to access the console.

5.11. Web Console (Cockpit) Integration

The Web console (Cockpit) is an interactive Linux server administrative interface. You can perform simple administration tasks such as starting containers, storage administration, network configuration, and inspecting logs. While Cockpit allows you to monitor and administer several servers at the same time, your browser connects to a primary server that runs the Cockpit web service through which connections to additional servers can be established.

The Red Hat CloudForms full administrative user interface and the Self Service user interface have enabled for users to access the Web console (Cockpit interface) for a given virtual machine.

5.11.1. Accessing the Web Console

Note

Launching of Cockpit requires as IP address for the virtual machine. It must be pre-configured and running on the virtual machine.

You can open the Web console (Cockpit) for a virtual machine from the Access Button button.

  1. From the My Services screen, click on the service associated with the virtual machine you want to open the Web console for.
  2. In Resources, click Access next to the virtual machine and select Web Console. A notification will appear to show the Cockpit interface is loading.
  3. The Cockpit interface for the virtual machine will open in a new browser window. If you get a security warning by the browser, you will need to add this connection to the security exceptions. Click Advanced → Add Exception → Confirm Security Exception. After that, you will see the login screen. Cockpit Login
  4. Once you have logged in, you will see the tabs for the dashboard and the individual machines added to Cockpit. Cockpit UI

Chapter 6. My Orders Tab

The My Orders tab lists all shopping cart orders which contain service requests added from the Service Catalog.

Click on the tab to see a summary of each order, including the order number, requester, order date, and the number of items. Click the arrow next to an order number to see more details such as the requests associated with the order, request ID, whether it is approved or denied, and the current state of the request. You can reorder a request by clicking the Reorder button, then enter the options associated with the order, and add to shopping cart. You can click on more options (represented by three dots) next to an order to Remove the order.

Orders Tab

Chapter 7. Service Catalog Tab

The Service Catalog tab lists all service catalog items, displayed as tiles. These items must be configured on the administrative user interface before they will be accessible to the user here. You can filter or sort the service catalog items by Name, Description and Catalog Name.

Service Catalog

Click on a service to go to the page where you can enter the requested information in the dialog fields under Service and VM Name and VM Characteristics associated with the service. Note that there is now an ability to add dynamic dialog elements within the Self Service user interface, meaning you can include a particular dialog field where Red Hat CloudForms will communicate to the instance and method, obtain the required information, and enter the value in the field dynamically. After you have entered all information in the dialog fields, click Add to Shopping Cart.

Shopping Cart:

The Self Service user interface has adopted a shopping cart model for ordering services, instead of ordering them individually. Click on the shopping cart icon at the top to view all services added to the shopping cart that are available to order. You can delete a particular service from the cart if required, and order the services in the cart all at one time. Or, you can even choose to clear all the services in the cart and exit.

Shopping Cart

If you click Add to Shopping Cart for the same item, you will see a pop up window alerting you that there is an identical item in the cart but if you want to add it anyway.

Duplicate Item in the Shopping Cart