Sunstone

Overview

Sunstone is the new generation OpenNebula web interface, fully featured for VM and VM Template management and with other sections ready covering most functionality for end users.

This interface is delivered by the FireEdge server, and is its main interface, meaning that it will redirect to Sunstone when contacted in the http://<OPENNEBULA-FRONTEND>:2616/ address.

Configuration

To configure Sunstone, there are several options to consider and they are described in the FireEdge Configuration guide.

Usage

This completely fresh user experience is available by accessing http://<OPENNEBULA-FRONTEND>:2616. On the left menu, users can find the available tabs to manage resources, as described in the Sections part of this guide.

Sunstone users can change their current view from the top-right dropdown menu:

They can also configure several options from the settings tab.

Sections

The available Sunstone sections and their tabs are described in the following subsections. All the tabs described below can be deactivated in the Sunstone views

Instances

• VMs Tab: Users can see all their Virtual Machines and perform managing actions such as changing permissions, attaching disks, attaching networks, taking snapshots, adding scheduled actions, remote console connections, and more. From this tab, users can also instantiate a new Virtual Machine. Some VM actions can be through multiple VMs, such as: suspend, stop, power-off, reboot, resume, undeploy, and more.
• Virtual Routers Tab: Admins can see all their virtual routers and perform different kinds of managing actions. From this tab, admins can also instantiate new virtual routers.
• Services Tab: Admins can see all their services and perform different kinds of managing actions. From this tab, admins can also instantiate new services.

Templates

• VM Template Tab: Users can see all their Templates and perform updates and clones. From this tab, users can also instantiate a Virtual Machine. Also, users can perform some managing operations over the templates, such as: change permissions, share and unshare, lock and unlock, and more.
• Service Template Tab: Admins can see all their Service Templates, create new ones, and update existing templates. From this tab, admins can also instantiate services directly and perform different kinds of managing operations.
• Virtual Routers Template Tab: Admins can see all their Virtual Routers Templates, create new ones, and update existing templates. From this tab, admins can also instantiate virtual routers directly and perform different kinds of managing operations.
• VM Groups Tab: Admins can access all the VM groups defined in the OpenNebula instance and perform managing operations such as updating, enabling/disabling, and more. Also, admins can create new VM groups from this tab.

Storage

• Datastores Tab: Users can see all their FILE, IMAGE, and SYSTEM datastores. Also, users can perform some managing actions, such as changing permissions, enabling and disabling, and more. From this tab, users can create a new Datastore of one of the types described before.
• Images Tab: Users can see all their OS, CDROM, and DATABLOCK images. Also, users can perform some managing actions, such as changing permissions, locking and unlocking, and more. From this tab, users can instantiate a new Image of one of the types described before.
• Files Tab: Users can see all their KERNEL, RAMDISK, and CONTEXT images. Also, users can perform some managing actions, such as changing permissions, enabling and disabling, and more. From this tab, users can instantiate a new Image of one of the types described before.
• Backups Tab: Users can see all their BACKUP images. Also, users can perform some managing actions, such as changing permissions and restoring.
• Marketplace Tab: Users can see all their Marketplaces. Also, users can perform some managing actions, such as create and update a Marketplace, changing permissions and restoring, and more.
• Marketplace Apps Tab: Users can see all the apps from their active Marketplaces, download and create templates from them, or download them locally on their computers.
• BackupJobs Tab: Users can see all their backup jobs. Also, users can perform some managing actions, such as create, start, and cancel a backup job, changing permissions and restoring, and more.

Networks

• Virtual Networks Tab: Users can see all their Virtual Networks and perform managing operations such as updating, reserving, changing permissions, and more. Also, users can create a new Virtual Network from this tab.
• Virtual Networks Template Tab: Users can see all their Virtual Networks Templates and perform updates. From this tab, users can also instantiate a Virtual Network from a template. Also, users can perform some managing operations over the templates, such as: change permissions, lock and unlock, and more.
• Security Groups Tab: Users can see all their Security Groups and perform managing operations such as updating, cloning, committing, changing permissions, and more. Also, users can create a new Security Group from this tab.

Infrastructure

• Providers Tab: Users can see all their Providers and can create and edit them.
• Provisions Tab: Users can see all their Provisions and can create and edit them.
• Clusters Tab: Users can see all their Clusters and perform managing operations such as updating and deleting.
• Hosts Tab: Users can see all their Hosts and perform managing operations such as enabling, disabling, and more. Also, users can create a new Host from this tab.
• Zone Tab: Users can see all their Zones and see all the information about a Zone.

System

• VDCs Tab: Users can see all their VDCs and can update, rename, and view the resources associated with them, and more. Also, users can create a new VDC from this tab.
• Users Tab: Admins can access all the users defined in the OpenNebula instance and perform managing operations such as updating, enabling/disabling, setting quotas, and more. Also, admins can create new Users from this tab.
• Groups Tab: Admins can access all the groups defined in the OpenNebula instance and perform managing operations such as updating, setting quotas, and more. Also, admins can create new Groups from this tab.
• ACL Tab: Admins can access all the ACL rules defined in the OpenNebula instance and perform create and delete operations.

Settings

From this section, users can define multiple configuration options for themselves that will be saved inside the user template, such as:

• Schema (default = System): change the Sunstone Theme to dark, light, or matching with the system.
• Language (default = English US): select the language that they want to use for the UI.
• View: allows users to change the user view.
• Default endpoint: allows users to change the Sunstone endpoint when using federation.
• SSH Public key: allows users to specify a public SSH key that they can use on the VMs.
• Disable the dashboard animations. By default they are enabled.
• Disable the information on full screen. By default they are disabled.
• Change password: allows users to change their password.
• Labels: allows users to manage their labels.
• SSH Public key: allows users to specify a public SSH key that they can use on the VMs.
• SSH Private key: allows users to specify a private SSH key that they can use when establishing connections with their VMs.
• SSH Private key passphrase: if the private SSH key is encrypted, the user must specify the password.
• Login token: allows the creation of a new token for the user.
• Two Factor Authentication: allows users to register an app to perform Two Factor Authentication.

Views

Using the Sunstone views, you can provide a simplified UI aimed at end users of an OpenNebula cloud. Sunstone Views are fully customizable, so you can easily enable or disable specific information tabs or action buttons. You can define multiple views for different user groups. Each view defines a set of UI components, so each user accesses and views the relevant parts of the cloud for their role. Default views:

• Admin View.
• User View.
• Groupadmin View.
• Cloud View.

Each view is in an individual directory, admin, user, groupadmin, and cloud that OpenNebula proposes by default, as described in the next section.

Default Views

Admin View

This view provides complete control of the Virtual Machines, Templates, and Marketplace apps. Details can be configured in the /etc/one/fireedge/sunstone/views/admin/ directory.

User View

Based on the Admin View. It is an advanced user view intended for users with fewer privileges than an admin user, allowing them to manage Virtual Machines and Templates. Users will not be able to manage or retrieve the Hosts and clusters of the cloud. Details can be configured in the /etc/one/fireedge/sunstone/views/user/ directory.

Groupadmin View

This view is like a limited version of the cloud administrator view to be used by the administrators of a group. Details can be configured in the /etc/one/fireedge/sunstone/views/groupadmin/ directory. More details on Group admin view

Cloud View

This is a simplified view intended for cloud consumers that just require a portal where they can provision new VMs easily. Details can be configured in the /etc/one/fireedge/sunstone/views/cloud/ directory. More details on Cloud view

Defining a New View

The views definitions are placed in the /etc/one/fireedge/sunstone/views directory. Each view is defined by a folder (named as the view) with the necessary configuration files inside.

/etc/one/fireedge/sunstone/views
...
|-- admin/
|   |-- backup-tab.yaml           <--- the Backup tab configuration file
|   |-- cluster-tab.yaml          <--- the Cluster tab configuration file (not installed by default)
|   |-- datastore-tab.yaml        <--- the Datastore tab configuration file
|   |-- file-tab.yaml             <--- the File tab configuration file
|   |-- group-tab.yaml            <--- the Group tab configuration file
|   |-- host-tab.yaml             <--- the Host tab configuration file
|   |-- image-tab.yaml            <--- the Image tab configuration file
|   |-- marketplace-app-tab.yaml  <--- the Marketplace App tab configuration file
|   |-- sec-group-tab.yaml        <--- the Security Group tab configuration file
|   |-- user-tab.yaml             <--- the User tab configuration file
|   |-- vdc-tab.yaml              <--- the VDC tab configuration file
|   |-- vm-tab.yaml               <--- the VM tab configuration file
|   |-- vm-template-tab.yaml      <--- the VM Template tab configuration file
|   |-- vm-group-tab.yaml         <--- the VM Group tab configuration file
|   |-- vnet-tab.yaml             <--- the Virtual Network tab configuration file
|-- sunstone-server.conf
|-- sunstone-views.yaml           <--- the FireEdge Sunstone views main configuration
`-- user/
    ...
    |-- vm-tab.yaml               <--- the VM tab configuration file
    `-- vm-template-tab.yaml      <--- the VM Template tab configuration file
...

The easiest way to create a custom view is to copy the admin or user folder and modify its content as needed. After that, add the new view into /etc/one/fireedge/sunstone/views/sunstone-views.yaml.

View Customization

On Sunstone each view is defined by a folder that has the YAML files for the configured tabs. The content for those files is divided into sections that are described in the following sections.

In the following tables, the description field contains the expected behavior when it is set to true.

Actions

The attributes described here indicate which buttons are visible to operate over the resources. The following attributes must be nested in an actions tag.

Filters

The attributes described here indicate which filters are visible to select resources. The following attributes must be nested in a filters tag.

Info Tabs

The attributes described here indicate the available actions on each info tab on the resource. The following attributes must be nested in an info-tabs and the corresponding tab.

The available actions in the info tabs are described in the following table.

Features

The attributes described here indicate which features are used for the resources. The following attributes must be nested in a features tag.

Dialogs

The attributes described here indicate the available actions on each dialog on the resource.

Remote connections

OpenNebula VNC remote connection.

Sunstone allows direct connections to VMs using VNC. It admits parameters such as configuring the Host and port for remote connections, configuring the keyboard layout (needed for qemu KVM Hosts), and setting a connection password.

To set these VNC connection configurations we must:

1. Go to the VM template configuration and click on create or update an existing one.
2. Go to the “Advanced options” step and click on Input/Output.
3. Under the “Graphics” section there are all the VNC configurations.

Note

In case the VNC client is blurry or has any kind of visual tearing, try switching to the virtio video device type instead. This can be done by selecting the VM and going to the Configuration tab.

Actions in VNC console

At the top of the console you can find the buttons for the following actions:

• Full Screen: Set the console to full screen mode.
• Screenshot: Take a screenshot from the VNC console.
• Reconnect: Reconnect the VNC console.
• Lock/Unlock: Lock/Unlock the use of the keyboard and mouse.

OpenNebula RDP remote connection.

Sunstone also admits direct connections using RDP. This kind of connection is bound to a network interface, meaning that to enable it you must follow the following steps:

1. Go to the VM template tab and click on create or update an existing one.
2. Go to the “Advanced options” step.
3. Click on “Network”.
4. Click on attach nic or update an existing one.
5. Go to the “Advanced options” step and enable the RDP connection and all the desired configuration parameters for the connection.

Actions in RDP console

At the top of the console you can find the buttons for the following actions:

• Full Screen: Set the console to full screen mode.
• Screenshot: Take a screenshot from the VNC console.
• Reconnect: Reconnect the VNC console.
• Download connection file: Download the connection file for use with Microsoft Remote Desktop.

  Note

  In order to be able to connect from an external application, you must have access to the IP address that appears in the file.

OpenNebula SSH remote connection.

Sunstone also allows direct connections using SSH. This kind of connection is bound to a network interface, meaning that to enable it you must follow the following steps:

1. Go to the VM template tab and click on create or update an existing one.
2. Go to the “Advanced options” step.
3. Click on “Network”.
4. Click on attach nic or update an existing one.
5. Go to the “Advanced options” step and enable the SSH connection.

Actions in SSH console

At the top of the console you can find the buttons for the following actions:

• Full Screen: Set the console to full screen mode.

• Screenshot: Take a screenshot from the VNC console.

• Reconnect: Reconnect the VNC console.

• Configurations:

  • SSH Command: Reconnect the console by executing the command placed

  • Schema: Changes the color scheme to be used for the terminal session. It consists of a series of name-value pairs separated by semicolons. Each name-value pair is separated by a colon and assigns a value to a color in the terminal emulator palette. For example:

    foreground: rgb:00/00/ff;
    background: rgb:ff/ff/ff;
    color9: rgb:80/00/80
    

    Possible color names are:

    • foreground: Set the default foreground color.
    • background: Set the default background color.

    • colorN: Set the color at index N on the Xterm 256-color palette. For example, color9 refers to the red color.

      • rgb:RR/GG/BB: Use the specified color in RGB format, with each component in hexadecimal. For example: rgb:ff/00/00 - colorN: Use the color currently assigned to index N on the Xterm 256-color palette.
        For backward compatibility, it will also accept four special values as the color scheme parameter:

    • black-white: Black text over a white background.
    • gray-black: Gray text over a black background. This is the default color scheme.
    • green-black: Green text over a black background.
    • white-black: White text over a black background.

  • Font Name: The name of the font to use. This parameter is optional. If not specified, the default of “mono-space” will be used instead.

  • Font Size: The size of the font to use, in points. This parameter is optional. If not specified, the default of 12 will be used instead.

• Download connection file: Download the connection file for use with TigerVNC Viewer.

  Note

  In order to be able to connect from an external application, you must have access to the IP address that appears in the file.

< Previous page