Compute Resources

The compute resources page can be accessed via The Infrastructure Menu:

Infrastructure > Compute resources

The term compute resource refers to any server that offers a virtualization solution as a service. Here, the term virtualization solution can refer both to a service providing virtual machines, or one providing (for example) Docker containers.

Most modern IT infrastructures make extensive use of virtualization. In most use cases hosts managed by orcharhino will run on virtual machines. As a result orcharhino needs to be able to interact with the underlying compute resource providing the virtualization service. The compute resources page exists to manage this interaction.

Note

Orcharhino supports a wide range of different virtualization solutions from different providers. For now, this document focuses primarily on VMware’s virtual machine environment. It may be expanded with detailed documentation for other providers at a later time. See also: Compute Resources Guide

Hosts managed by orcharhino that run on virtual machines, are said to be associated with the virtual machine they run on. It is possible to disassociate (and reassociate) a host from the virtual machine it runs on. This will keep the hosts entry in orcharhino, but sever it’s connection to the underlying compute resource. The host entry can then be deleted or retained within orcharhino independently of the virtual machine on the underlying compute resource.


The compute resources page includes a Create Compute Resource button, and a list of compute resources known to orcharhino:

List of configured compute resources
  • Clicking on the name of a compute resource in the Name column (3) of the list (2), will take you to the compute resource overview page for that compute resource. (See Viewing a Compute Resource below).
  • Clicking on the Create Compute Resource button (1) will take you to the create compute resource page. (See Creating a Compute Resource below).
  • Selecting Edit from the Actions column (4) will take you to the edit compute resource page for that compute resource. (See Editing a Compute Resource below).
  • Selecting Delete from the Actions column (4) will delete the compute resource entry from the list of compute resources.

Creating a Compute Resource

The create compute resource page can be accessed via the Create Compute Resource button:

Infrastructure > Compute resources >> Create Compute Resource

Note

Clicking the Create Compute Resource button, does not actually “create” a compute resource, rather it serves to add a preexisting compute resource to the list of compute resources known to orcharhino. (See also: Compute Resources Guide).

When adding a compute resource to orcharhino you must provide a name, select the relevant provider, and enter any provider specific connection information:

Configure a new compute resource
  • The Name (1) should be something meaningful (e.g.: <hostname>.<domain> of the host that the compute resource is running on).
  • To add a VMware compute resource choose VMware from the drop down menu for the Provider field (2).
  • Once a Provider has been selected from the drop down menu (2), additional provider specific fields will appear. (See also the Compute Resources Guide for more information on how to fill in the various provider specific connection information).
  • You should assign a context to your smart proxy via the Locations and Organizations tabs (3). (See also: The Context Menu).
  • You may also add an arbitrary Description to your compute resource.
  • Remember to click Submit (4) to save your changes.

Editing a Compute Resource

The edit compute resource page (for a given compute resource) can be accessed via the list of compute resources:

Infrastructure > Compute resources >> list of compute resources > Actions column > Edit

This page is essentially the same as the create compute resource page, with the difference that fields will be prefilled with the settings of the compute resource being edited:

Edit a existing compute resource
  • The above example is a VMware (1) type compute resource and many of the fields are VMware specific (2). (See also the Compute Resources Guide for more information on how to fill in provider specific information).
  • Fields that cannot be changed for an existing compute resource are greyed out.
  • Remember to click Submit (3) to save your changes.
  • See also Creating a Compute Resource above.

Important

The above example uses the administrator account to connect to VMware. This is not considered best practice! (See also the Compute Resources Guide).

Viewing a Compute Resource

The compute resource overview page (for a given compute resource) can be accessed via the list of compute resources:

Infrastructure > Compute resources >> list of compute resources > name of a compute resource

A compute resource overview page displays a wealth of information and a number of actions relating to the compute resource in question. The precise look of the overview page may vary depending on the type/provider of the compute resource.

The overview page for a VMware type compute resource will provide access to certain ESXi server features through orcharhino. (The ESXi server is the hypervisor running virtual machines within VMware’s vSphere software suite). In particular, all virtual machines present in the VMware compute resource can be viewed (irrespective of whether they correspond to some orcharhino host), as well as powered on or off, deleted, and accessed via ssh.


The overview page for a VMware type compute resource will look as follows:

Details of VMware compute resource
  • The Associate VMs button (1) will reassociate any hosts that exist in a disassociated state. (This generally only happens when hosts are disassociated via the All Hosts page).
  • The Refresh Cache button (2) will update the list of virtual machines (in the Virtual Machines tab) in case any new virtual machines where created or deleted directly within VMware since the cache was last refreshed.
  • The Edit button (3) will take you to the edit compute resource page for the compute resource being viewed. (See Editing a Compute Resource above).
  • The Create Image button (4) will take you to the create compute resource image page. (See Creating a Compute Resource Image below).
  • Note that there are additional tabs (5) on the compute resource overview page.
  • The Compute Resource tab shows some basic information (6) about the compute resource in question.
  • The Compute profiles tab (5) will list any compute profiles defined for the compute resource being viewed. (See also: Compute Profiles).
  • The other tabs are explained further below.

The Virtual Machines tab of the compute resource overview page for a VMware compute resource looks as follows:

List of available virtual machines available for a VMware compute resource
  • This list includes all virtual machines on the VMware compute resource, irrespective of whether they are associated with an orcharhino host.
  • Virtual machines can be filtered using the search bar (1).
  • Clicking on the name of a virtual machine in the Name column (2) of the list, will take you to the virtual machine overview page for that virtual machine. (See Viewing a Virtual Machine below).
  • Selecting Power On or Power Off from the Actions column (3) will change the power state of the virtual machine in question.
  • Selecting Console (4) (only available if the virtual machine is currently turned on) from the Actions column (3) will open a ssh connection to the virtual machine in question.
  • Selecting Import (4) (only available if the virtual machine is not associated with any orcharhino host) from the Actions column (3) will take you to the import virtual machine page. (See Importing a Virtual Machine below).
  • Selecting Delete (4) from the Actions column (3) will delete the virtual machine from the VMware compute resource while retaining any associated orcharhino hosts. (A so orphaned host may complain about the missing virtual machine and will need to be deleted separately via the All Hosts page).

Note

ssh connections via the orcharhino web interface require the use of a https connection. This may in turn require importing the orcharhino servers ssl certificate into your browser. This certificate can be obtained at http://<orcharhino_host>.<domain>/pub/katello-server-ca.crt.


The Images tab of the compute resource overview page for a VMware compute resource looks as follows:

Images tab of the compute resource overview page
  • The Create Image button (4) will take you to the create compute resource image page. (See Creating a Compute Resource Image below).
  • Images can be filtered using the search bar (1).
  • Selecting Edit (3) from the Actions column (2) will take you to the edit compute resource image page. (See Editing a Compute Resource Image below).
  • Selecting Destroy (3) from the Actions column (2) will delete the Image from orcharhino, but not from the underlying hypervisor.

Viewing a Virtual Machine

The virtual machine overview page (for a given virtual machine) can be accessed via the Virtual Machines tab on the compute resource overview page running the virtual machine:

Infrastructure > Compute resources >> list of compute resources > name of a compute resource > Virtual Machines tab > name of a virtual machine

A virtual machine overview page displays information about the relevant virtual machine, and includes a number of buttons to perform actions relating to it:

Virtual machine overview page
  • The Power On or Power Off button (1) will change the power state of the virtual machine in question.
  • The Delete button (2) will delete the virtual machine from the VMware compute resource while retaining any associated orcharhino hosts. (If desired, a so orphaned host will have to be separately deleted via the All Hosts page).
  • The Console button (3) (only available if the virtual machine is currently turned on) will open a ssh connection to the virtual machine in question.
  • The Associate VM button (4) will reassociate the virtual machine with an orcharhino hosts that was previously disassociated from it. The action will fail (do nothing) if there is no such host.
  • The Back button (5) will take you back to the compute resource overview page (Compute Resources tab). (See also Viewing a Compute Resource above).

Importing a Virtual Machine

The import virtual machine page (for a given virtual machine) can be accessed via the Virtual Machines tab on the compute resource overview page running the virtual machine:

Infrastructure > Compute resources >> list of compute resources > name of a compute resource > Virtual Machines tab > Actions column > Import

The import virtual machine feature exists to create an associated orcharhino host for a virtual machine that exists on the relevant compute resource, but is not yet being managed through orcharhino. When importing a virtual machine the orcharhino user must provide orcharhino with all the information (like operating system and installation media) normally needed when creating a host. (See also: Create Host). This information (for example the operating system) need not necessarily be the os actually present on the virtual machine, but in such a scenario the virtual machine will have to be reprovisioned by orcharhino before it is properly usable. (This is equivalent to a complete reinstall of the system present on the virtual machine).


An import virtual machine page looks as follows:

Import a virtual machine
  • Note that there are several additional tabs (1) to the one displayed above.
  • Remember to click Submit (2) to save your changes. This will create an orcharhino host using the settings provided, and take you to the host overview page for that host. If the settings provided do not match those actually present on the virtual machine being imported you may want to click the Build button to enable a rebuild of the host on the next boot.
  • An import virtual machine page is essentially identical to the create host page. (See also the Create Host page for more information on the various fields and tabs on the above screen shot).

Creating a Compute Resource Image

The create compute resource image page can be accessed via the compute resource overview page:

Infrastructure > Compute resources >> list of compute resources > name of a compute resource > Create Image button

Note

What is referred to as a “compute resource image” within orcharhino is referred to as a “template” within VMware (for example). This difference in terminology is necessary since the term “template” is already widely used (with a definite meaning) within orcharhino. Within this section of the orcharhino documentation the two terms may be used interchangeably.

Note

Clicking the Create Image button, does not actually “create” an image (template), rather it serves to import a preexisting image (template) from a compute resource into orcharhino.

Compute resource images exist as a more efficient alternative to orcharhino’s normal provisioning process when provisioning hosts running as a virtual machine. (See also: Provisioning Setup). The basic idea is to use a compute resources inbuilt template system to provision hosts directly within a compute resource, rather than using some boot disk or network based installation media. (Which generally necessitates that the installation media data is transferred to the compute resource via the network, generating a lot of avoidable network traffic).


The create compute resource image page looks as follows:

Create a virtual machine image
  • The Name (1) should be something meaningful that describes the kind of host that is to be provisioned from the image. E.g.: “Cent OS 7 template” (the term “template” makes clear that this “image” references some “template” within the compute resource).
  • The image needs to be associated with an orcharhino Operatingsystem and Architecture (2). These fields should of course match the operating system and architecture actually found on the template being imported. (See also: Provisioning Setup).
  • If the template has inbuilt user accounts/passwords (3), those may be required for orcharhino provisioning.
  • The Image path field tells orcharhino where the template is physically located on the compute resource’s hypervisor. (For a VMware type compute resource, this path can be found within VMware’s vSphere client).
  • Remember to click Submit (5) to save your changes.

Editing a Compute Resource Image

The edit compute resource image page (for a given compute resource image) can be accessed via the Images tab on the compute resource overview page:

Infrastructure > Compute resources >> list of compute resources > name of a compute resource > Images tab > Actions column > Edit

The edit compute resource image page (for a given compute resource image) is essentially the same as the create compute resource image page, with the difference that fields will be prefilled with the settings of the compute resource image being edited:

Edit a virtual machine image