Manual Chapter : Integrating with a vCMP Host

Applies To:

Show Versions Show Versions

F5 iWorkflow

  • 2.3.0
Manual Chapter

About vCMP integration

You can integrate vCMP® hosts with the F5 iWorkflow™ Networking connector. iWorkflow compatibility with BIG-IP® system releases is limited to explicit releases.

Note: For the most current list of compatible versions, refer to the F5 iWorkflow compatibility matrix (K11198324) at suport.askf5.com.

Network requirements for communication with vCMP hosts

For proper communication, F5® iWorkflow™ must have network access to the vCMP® host. Before you can manage cloud resources, you must define a network route between the iWorkflow device and the vCMP host network. This route can use either management or internal networks.

Creating a vCMP connector

To enable integration between the vCMP® host and F5 iWorkflow™, you must configure a cloud connector. A cloud connector is a resource that identifies the local or virtual environment in which a tenant deploys applications and, when necessary, adds parameters that are required by third-party cloud providers.

  1. Log in to iWorkflow™ with the administrator user name and password.
  2. At the top of the screen, click Clouds and Services and then, on the Clouds header, click the + icon.
    The New Cloud screen opens.
  3. In the Name and Description fields, type a name and description for this connector.
    You can use the name and description to help you organize network resources into logical groups based on certain criteria, such as the location or application.
  4. From the Connector Type list, select vCMP.
    The screen displays additional settings specific to vCMP.
  5. In the VCMP Host field, type the IP address of the vCMP host.
  6. In the UserName and Password fields, type the credentials that the iWorkflow device will use to authenticate to the vCMP host.
  7. For the vCMP Host Certificate SHA-512 Hash field, to avoid security threats, verify the SSL certificate hash of the host.
    Note: Either manually enter or automatically retrieve the certificate hash. Run the command openssl x509 -noout -fingerprint -sha512 -in <path to certificate file> | tr -d ':' to verify with OpenSSL. If the iWorkflow certificate unexpectedly changes in the future, a warning displays and interactions with the host are prevented.
  8. Click Save.

As part of the connection creation process, the iWorkflow system takes these actions:

  • Verifies connectivity to the vCMP host.
  • Displays any vCMP guests present on the vCMP host.
Important: Although existing guests are visible after you add the connector, you must discover them before you can use them.

Creating a vCMP guest

The following tasks must be complete before you can perform this task.
  • Create a vCMP® connector.
  • Install BIG-IP® software images on the vCMP host on which you plan to create guests.
You can specify a number of optional parameters when you create a guest. For the following optional parameters, you must know the capabilities of the vCMP host on which you plan to create the new guest:
  • Hotfix level needed
  • Number of cores per slot supported
  • Names of existing VLANs
Creating a vCMP guest using the iWorkflow™ interface provides a straightforward method for managing your vCMP resources.
  1. Log in to iWorkflow™ with the administrator user name and password.
  2. At the top of the screen, click Clouds and Services and then, on the Devices header, click the + icon, and then select Create Virtual Device.
    The Create Virtual Device screen opens.
  3. In the Cloud field, select the name of the vCMP connector you created previously.
  4. In the Device Image field, select the version of BIG-IP software that you want the guest to use.
    The software images that display (*.iso) are those that have been imported to the /shared/images folder on the vCMP host.
    Tip: If you are going to specify a hot fix, this is not the place to do so. This field is only for the name of the base level installation file.
  5. If you want the system to generate a password for you when it creates the guest, for User Credentials, you can select Use "admin" and a random strong password.
    Important: Choose this setting to enable management authority of the guest by the iWorkflow device. Once this authority is established, you can only modify the guest from the iWorkflow.
  6. For Name, type a unique name for the new guest.
    Make a note of the name you choose for this guest. You will need this in the future.
  7. If you want to specify a particular hotfix for the software version to install for this guest, type the name of the hotfix installation file in the Device Hotfix field.
    Currently, the hotfix versions available for installation on the vCMP host are not suggested for you. Therefore, you must know which hotfixes are available for installation before you enter the name here.
  8. If you want to specify a host name for this guest, type the name in the Hostname field.
  9. If you want to specify the number of cores per slot that this guest occupies, type the number in the Cores per Slot field.
    Currently, the number of cores per slot supported by the vCMP host is not suggested for you. Therefore, you must know the capabilities of the device on which the host is installed before you enter the number here.
    Note: If you do not specify the number of cores, the system configures the minimum number of cores per slot that are supported by the platform on which your vCMP host resides.
  10. If you want to specify the number of slots that this guest uses, type the number in the Number of Slots field.
  11. For the IP Address, type the management IP address and mask that you want to assign to the new guest.
  12. For the Management Route, type the subnet IP address for the gateway that you want to assign to access the guest.
  13. Under VLAN List, specify the Name and Local Address for each VLAN that you want the guest to use.
    You can check the BIG-IP device to determine which VLANs are available.
  14. To start creating the guest that you just specified, click Deploy.
    The Create Virtual Device screen closes.

The new guest name appears as a new entry in the Servers panel. As the creation and provisioning process progresses, the guest status displays on the properties panel for the new guest.

Additionally, when iWorkflow creates a new guest, it adds an entry to the Activities panel.

Monitoring a vCMP guest

A guest must have been discovered, or you must have added a vCMP® guest before you can monitor it.
You can monitor the health of the vCMP guests that exist on the vCMP host. Monitoring the health for vCMP guests provides you with the information you need to make resource management decisions.
  1. Log in to iWorkflow™ with the administrator user name and password.
  2. At the top of the screen, click Clouds and Services and then, on the Devices panel, click the gear icon next to the name of the guest that you want to monitor, and select Properties.
    The panel expands to display the guest's properties.
  3. To view the health statistics for the guest, click Statistics.
    The current health status for the guest and host display as a decimal number between 0 and 1. (Where 1 indicates that the status is completely healthy.)

Creating a customized services template

Before you can customize a services template for a tenant, you must add a vCMP® connector.

An iApp is an application template located on F5 devices. An administrator can import iApps® templates to the iWorkflow™ system.

With a services template, you can:
  • Create custom catalog templates, based on iApps templates, that provide the network settings, levels of services, and so forth, that you expect to see in your vCMP environment.
  • Modify the base template, choosing default values for selected parameters, and specifying which parameters the tenant can edit.
The values specified in the service templates you create are automatically exported to the vCMP guests.
Note: Until a tenant deploys an application that uses this service template, you can modify the options that define the settings for this template, but not the Name, Application Type, or Application Tier Information. Once an application deploys that uses this template, you can no longer modify settings for that template. For options that you set to Tenant Editable, the values you specify just determine the default values.
Important: If you make modifications to an iApps template, you need to import it with a new version number in its name.
  1. In the iWorkflow system, hover over the Service Templates header and click the + icon when it appears.
    The New Template screen opens.
  2. In the Name field, type a name for this new template.
  3. For the Input Parameters, select the option that displays the parameters you want to work with.
    The setting you choose here determines which parameters from the base template that you select display in subsequent fields and areas on the screen.
    • Select All Options to cofigure the Application Tier Information section. You can view all of the parameters for the template you select and then expand individual template sections, or click Expand All to view every parameter in every section.
    • Select Common Options if you only want to edit a subset of the template parameters. This option displays parameters that are:
      • Marked as tenant-editable.
      • Specified in the Application Tier Information section.
      Important: If you are creating an L4-L7 service template based directly off on an iApps template, select All Options, and in the Application Tier Information section, set the required fields. The Application Tier Information section provides iWorkflow with information about the contents of the template for a given server tier, including the Virtual Server IP, Virtual Server Port, Pool Member IP, Pool Member Port, SSL/TLS Public Key, and SSL/TLS Private Key. If you are creating an L4-L7 service template based off of an existing service template, to accept the existing application tier information values and other defaults without having to view the complete set of options, select Accept Defaults or Common Options.
  4. For the Cloud Connector select the vCMP connector you created earlier.
  5. From the Application Type list, select the base template that contains the parameters that provide the network settings and levels of services that you want to have available in your vCMP environment.
    The screen displays sections specific to the template you selected.
  6. Expand sections as necessary, and then specify parameter values as needed. (You can provide default values in that column, and select which parameters the user can revise.)
    Tip: The template options that you can view depend on which option you chose in step 3.
    Important: There are two parameters for which you must select the Tenant Editable check box: the parameter that identifies the pool address and the parameter that defines the pool member table. You can specify default values and allow user revision for as many parameters as you want. The names of these two parameters vary from one template to the next.
  7. Click the Save button.
You can now use this connector with your vCMP integration.

Deleting a vCMP guest

If you no longer need one of the guests on the vCMP® host, you can delete it.
  1. Log in to iWorkflow™ with the administrator user name and password.
  2. At the top of the screen, click Clouds and Services and then, on the Devices panel, click the gear icon next to the name of the guest that you want to delete, and click Properties.
    The panel expands to display the guest's properties.
  3. At the top of the properties panel, click Delete.
    A Delete device confirmation popup screen opens.
    Important: Make sure you no longer need this guest before confirming; you cannot recover a deleted guest.
  4. Click Delete to permanently remove the guest from the vCMP host.
The guest is deleted from the vCMP host.