Adding OVA/OVF Components to a Service

In Commander you can create service catalog entries that allow users to request VMs or vApps that are described by an OVF or OVA template. OVF and OVA templates are open-standard file formats for packaging and distributing VMs or vApps.

When a user requests a service that uses an OVA/OVF template, at deploy time, Commander will transfer the virtual machine image specified by the URL for the component to vCenter. Only OVF/OVA templates that describe a single VM are supported. However, a service may contain multiple OVA/OVF templates.

Access:

Configuration > Self-Service > Catalog tab

Available to:

Commander Role of Superuser, Enterprise Admin

To add an OVA/OVF component to a vCenter service:

  1. Do one of the following:
    • To add a new service, click Add Service.
    • To copy an existing service, select a listed service, and click the Copy link.

      This option saves time because much of the configuration is copied.

    • To add a template to an existing service, select a listed service, and click Edit Service.
  2. On the Service Description page, set the following display options for the vCenter service, then click Next:
    • Name — The service name to display in the Service Catalog.

      This name is used as the label for the Service section of the Request New Service form. Choose a distinctive service name to help requesters fill out the form.

    • Description — An optional description of the service to display in the Service Catalog.

      Along with the service name, the description is used in Service Catalog searches, so a good description can help users find service catalog entries.

    • Icon — An icon to identify the service.

      To add a custom icon, click Manage Icons. See Managing Icons for the Service Catalog for more details.

    • Categories — An identifying category that may help users find this service in a long list.

      To add a category, click Manage Categories. See Managing Categories for the Service Catalog for more details.

  3. On the Component Blueprints page, to add an OVA/OVF service, click Add > OVA/OVF Template.
  4. In the Add OVA/OVF Template dialog, enter one of the following in the URL field, then click OK:
    • A URL to a valid, publicly accessible OVA/OVF template. The URL can begin with "http://" or "https://".
    • A URL to an OVA/OVF template was downloaded to an accessible local network directory. The URL must begin with "file:///" and must be to the full network path. The URL can't use a mapped drive.

      For example:

      file:///droberts3d.companya.com/OVA-OVF/TinyCore.ova

      file:///resources/ovas/TinyCore.ova

      Not:

      file:///Z://ovas/TinyCore.ova

    The component is automatically named and added under the Component Blueprints. You can customize the name later through the componenent's Infrastructure subpage.

  5. If you want to add multiple OVA/OVF components to the service, repeat the step above for each additional component you want to add.

    You can also add custom components to the service.

  6. Click Next, then customize the component configuration parameters on each of the following tabs. You should review the configuration parameters for each OVA/OVF component that you added.

    When you have completed configuring the added components, click Next to continue editing the service catalog entry.

  7. On the Deployment page, specify deployment options for the entire service, then click Next.
    • Deploy Service As — Choose one of the following options:
      • Virtual Service — The service will be deployed as a vApp; you can manage the service as a whole after the service request has been completed, but Service Portal users will still be able to see and manage individual VMs within the vApp.
      • Individual Components — The service will be deployed as individual VMs.

        When creating a service that contains a single virtual service component, choose Individual Components. Otherwise, the service will be deployed as a virtual service within a virtual service.

    • Deployed Name — If you deploy the service as a virtual service, you can specify a customized name for deployed instances of the service. Select Use default naming format to use the default virtual service naming convention, or specify a customized deployed name.

      Click Configure global text replacement rules to shorten your service names. See also Set up text replacement rules for service names.

    • Deployment/Startup Order or Deployment Order — Applies only to VM and virtual service components. Some components in a multi-tier service may require other components to be started and running before they can start.
      • If you deploy the service as a virtual service, you specify both the order in which the components are deployed and the order in which the components are started.
      • If you deploy the service as individual components, you specify the order in which the components are deployed. The reverse order is used for shutdown.

      There is a 120 second delay between startup and shutdown of each component. There is no delay for deployment, but components are deployed serially, not in parallel.

      An administrator can override the deployment order by manually deploying components in a different order. It's also possible for Commander and Service Portal users with permissions can edit the start order for a deployed vApp.

    • Completion Workflow — If you have set up one or more service-level completion workflows, you can select one from the drop-down. Completion workflows allow you to specify actions to be carried out after deployment.
      • Click Add Workflow to create a new workflow.
      • Click Edit Workflow to edit a selected workflow selected. Note that when you edit the workflow using this link, you're editing the workflow for all of the components or services it's assigned to.
    • Start Deployed Components — By default, VMs are powered on during deployment. If you want to deploy VMs in this service in a powered-off state, clear this option.
  8. On the Placement page, you can configure placement attributes to define the Intelligent Placement requirements for the service.

    When you assign a placement attribute value to a published service, you're identifying the requirements of that published service to help ensure that services are deployed to the best destination. For more information, see Configure Placement Attributes

    To configure placement attributes:

    1. Click Edit Placement Attributes.
    2. In the Edit Placement Attributes dialog, in the Not Required section, select an attribute value that's provided by this destination and click Add to move it to the Required section.
    3. You can click Create Placement Attributes to create a new placement attribute. See Create placement attributes for more information.

    4. Click OK to close the Edit Placement Attributes dialog.

      The placement attribute values you've assigned to this service are displayed on the Placement page.

    5. For a placement attribute with selectable values, use the Up and Down arrow buttons to order the attribute values by preference if necessary. For example, if a service can be deployed on either private or public cloud, but private cloud is preferable, make sure the Private Cloud attribute value is first in the list.
  9. On the Visibility page, select one of the following options to set which users and groups can request this service, then click Next:
    • Do not publish — The service is in the catalog but isn't available for selection (temporarily disabled). See also Permanently Removing a Service from the Service Catalog.
    • Publish - Global — The service is available to all organizations, users and groups with the Request New Service permission. See Customize Service Portal Roles for Users.
    • Publish - Specific organizations, users and groups — The service is available to the specified organizations, users and groups with the Request New Service permission. If you select this option, you can assign a single service to both organizations and users/groups, therefore, do one or both of the following:
      • On the Organizations tab, select an organization from the drop-down menu. On the Users/Groups tab, enter the username or email address for one or more users or groups.

        When an organization member requests this service, the deployed service will automatically be assigned to the organization, with the requester as primary owner.

  10. On the Summary page, review the service's configuration details.

    If necessary, go back to the appropriate pages and make changes.

  11. Click Finish when you're done.
  • You can edit a listed service at any time by selecting it in the list and clicking Edit.
  • After a service is added to the Service Catalog, you can click Show Details to quickly view information about it.

Commander support for OVA/OVF parameters: Example

When you add an OVA/OVF template to the service catalog, any parameters and initial values that are defined by the template's descriptor file are encrypted and saved to the Commander database.

Commander allows you to add these parameters to the request form with a combination of custom attributes and variables.

Custom attributes allow:

  • requesters to select parameter values on the form
  • requesters to specify a regular expression value for a parameter on the form
  • administrators to select parameter values during manual deployment
  • administrators to specify a regular expression value for a parameter during manual deployment

Variables allow you to access information about the deployment destination and the request form.

When you create a custom attribute for a parameter, you can use a substitution variable to map specific values or an input type to a parameter. In this way, you can customize the input choices on the form that's provided to users making a request or a manual deployment.

To allow Service Portal users to request a deployment size when requesting the service, you will create a custom attribute named "DeploymentConfiguration" and set the possible values for it.

  1. Add an OVA or OVF template to the catalog as described in the section above.
  2. On the Attributes tab, click Add Attributes.
  3. In the Add Attributes dialog, click Create New Attribute.
  4. In the Configure Custom Attribute dialog, type "DeploymentConfiguration" for the Name, and optionally add a description.
  5. For Type, select List (to allow users to select from a list of key pairs).
  6. To allow users to specify a regular expression instead, select Text. See Work with Custom Attributes for more information.

  7. For Applies To, select All Types.
  8. Clear Edit in Service Portal and click Next.
  9. On the Configure Attribute page of the wizard, enter the allowed values for attribute.

    Note that the custom attribute's values must be must be exact, case-sensitive matches for the parameters provided in the template's descriptor file.

    1. Enter "small" and click Add.
    2. Enter "medium" and click Add.
    3. Enter "large" and click Add.
  10. Click Finish.
  11. The DeploymentConfiguration attribute is now selected in the Add Attributes dialog.

  12. Click OK.
  13. On the Attributes tab, the DeploymentConfiguration attribute appears. Select a default size if you want.
  14. On the Form tab, in the Attributes list, click DeploymentConfiguration to add it to the form.
  15. Click Edit and enable the Required option.
  16. Click OK to save the form element.
  17. Back on the Parameters tab, in the DeploymentConfiguration field, enter the following variable:
  18. #{form.customAttribute['DeploymentConfiguration']}

  19. Click Finish to save the service in the catalog.

Now, users must select a deployment configuration size when requesting this OVA template from the service catalog. Their selection will be passed to vCenter as a parameter through the Commander variable, unless an administrator overrides the requester's selection during manual deployment of the service request.