Configure vCloud Director Integration

The vCloud Director integration is included by default into the OnApp installer. Perform the following steps to install vCloud Director:

As initial import of vCloud Director into OnApp might take a considerable amount of time, you may consider increasing the Idle session timeout parameter in the vCloud Director at Administration > General, to avoid the possible import failure.

You may also check Versions Compatibility to see which OnApp and vCloud versions are compatible. 

RabbitMQ And OnApp Control Panel Connection

OnApp vCD integration requires the use of RabbitMQ to keep vCD and OnApp synchronised. If you plan using the RabbitMQ server installed by OnApp by default, there is no need for additional configuration in OnApp Control Panel. Though, it is required that you edit the AMQP settings in vCD.

To specify RabbitMQ settings in vCD:

  1. Go to your OnApp Control Panel server.
  2. Open the /onapp/interface/config/on_app.yml file.
  3. Find the RabbitMQ parameters:
    • rabbitmq_login
    • rabbitmq_password
    • rabbitmq_vhost
    • rabbitmq_host - make sure it is reachable by vCloud Director
  4. Edit your AMQP settings in vCD with the RabbitMQ details found at step 3:
    1. Navigate to the Administration tab of your System Organization, expand System Settings and select Extensibility.
    2. Click Enable Notifications.
    3. Add the details from OnApp.
    4. Specify your vCloud Director AMQP Exchange name that you should later use in the corresponding AMQP Exchange Name box while creating compute resources in OnApp.
  • You can use the Shovel plugin to reliably and continually move messages from your own RabbitMQ instance to the OnApp's RabbitMQ instance. For more information refer to Using the Shovel plugin with RabbitMQ for vCloud Director.
  • Remember that rabbitmq_host must be reachable by vCloud Director.

If you are running your own RabbitMQ server, it is required that you add the RabbitMQ details through the OnApp Control Panel.

To specify RabbitMQ settings in OnApp Control Panel:

If you want to use a separate RabbitMQ instance for vCloud Director, specify the following vCloud Director RabbitMQ parameters in the /onapp/configuration/rabbit_mq/vcloud/credentials.yml file:

  • :host: - RabbitMQ server IP address
  • :port: - RabbitMQ port
  • :vhost: - the name of the "virtual host" (or vhost) that specifies the namespace for entities (exchanges and queues) referred to by the protocol. Note that this is not virtual hosting in the HTTP sense.
  • :user: - RabbitMQ login
  • :password: - RabbitMQ password

If you want to use the same Rabbit MQ instance both for vCloud Director and OnApp engine:

  1. Go to your Control Panel's Settings menu, and click the Configuration icon.
  2. Click the System tab to change the following application settings:

    • Host - RabbitMQ server IP address

    • Virtual Host - the name of the "virtual host" (or vhost) that specifies the namespace for entities (exchanges and queues) referred to by the protocol. Note that this is not virtual hosting in the HTTP sense.

    • Login - RabbitMQ login
    • Password - RabbitMQ password

You have to restart OnApp daemon after changing RabbitMQ credentials.

Import of vCloud Director resources into OnApp

Before you start

  • Your vCD should be v9.1 or later

  • vCD public addresses should be configured properly

  • All vCD users should have a valid email, or else they won’t be imported

  • Currently fast-provisioned virtual datacenters are not supported for vApp provisioning

  • vCD users should be assigned one of the default or custom vCloud Director roles.

  • vApps that have “system” owner will be imported under "System Owner" in OnApp.
  • VSs currently cannot be connected to network during provisioning

  • VS passwords are not imported into OnApp

  • vCloud Director system admins are not imported into OnApp and all management tasks are performed via the vCloud Director web interface.

  • vCloud Director compute resource passwords are encrypted by default.


To import your vCloud Director resources into OnApp:

  1. Log in to OnApp CP as an administrator.
  2. Set Rabbit MQ credentials for the OnApp CP and your vCloud Director.

  3. Create a compute zone in which the vCloud Director compute resource will reside.

    To create a compute zone:

    1. Go to your Control Panel's Settings menu and click the Compute Zones icon.
    2. Press "+" or click the Add New Compute Zone button.
    3. On the screen that follows:
      1. Label - give your compute zone a name
      2. Server type - select a type for your zone. For vCloud Director compute zones select the Virtual Private Cloud type.
      3. Location group - select the location group to which this Compute zone will be assigned
      4. Failover timeout - set the time period for which the iterations will run during the failover if the compute resource does not respond

    4.  Click the Save button.

  4. Create a compute resource of a vcloud type and specify vCloud Director global system admin credentials and API URL of your vCloud Director. 

    When importing vCD resources you can choose whether you wish your users to be associated with one or several vCloud Director instances. If you wish your users to have access to multiple vCloud Director instances, you can set up several organizations from different vCD instances to be associated in OnApp with a single user group and have access to resources across multiple vCD instances.

    • single vCloud Director mode - all resources are imported from the vCD instance. Each organization is imported as a separate user group which can be associated with one vCD instance.
    • multiple vCloud director mode - only system level entities are imported (provider VDCs, external networks, etc.). Organizations are imported but are empty, i.e. do not contain resources and users. After the initial import you can select which organization you wish to import and associate with a certain user group. Users imported in this mode can be configured to have access to multiple vCD instances.

    To create a compute resource:

    1. Go to your Control Panel Settings menu.
    2. Click the Compute Resources icon.
    3. Press + button or click the Add New Compute Resource button underneath the list of compute resources on the screen.
    4. On the screen that appears:
      • Label - enter a compute resource name.
      • Compute resource type - choose a compute resource type. Select vcloud.
      • Compute zone - select the compute zone you added on Step 3.
      • Operation mode - select whether you wish to import the zone in the single or multiple vCloud Director mode. If you select the multiple vCloud Director, you need to later import the resources of an organization and its users.
      • Login - specify the vCloud Director system admin login
      • Password - specify the vCloud Director system admin password

      • API URL - set the vCloud Director API URL - e.g.

      • AMQP Exchange Name - specify your vCloud Director AMQP exchange name (this can be taken in your vCloud Director instance Extensibility > Settings > Exchange )

    5. Click the Save button. The compute resource will be added to the system and the import will start automatically.

    You can later switch from single vCloud Director mode to the multiple vCloud Director mode if required. In this case, the new organizations will no longer be syncronized from vCD to OnApp. It will be required to import each new organization.

    You cannot switch from multiple to single vCloud Director mode.

  5. The import will start automatically. After the transaction is successfully completed, all your vCloud Director resources will be shown in OnApp. You can view log output of transaction Import vCloud to Control Panel for more import details.

  6. Import the users and resources of the required organization. This step is only applicable if you have selected the multiple vCloud Director mode for your compute resource in step 4.
    1. Go to Control Panel > Settings > Compute Resources > Label.
    2. The page that loads shows the details of your vCD compute resource. Click Tools and select Import Organization from vCloud.
    3. Move the Import slider to the right next to the organization(s) you wish to import.
    4. Select a user group to which you wish to assign the organization in the Assign to User Group field. If you do not select a user group but enable the Import slider, a new user group will be created for this organization. If you select a user group that is already associated with one or several organizations, the users from the new organization will be created in the already present organizations and the users from the already present organizations will be created in the new user group.
    5. Click Submit to import the organizations.

After adding/deleting vCloud compute resource you need to restart OnApp service on the Control Panel for the correct statistics gathering and resources synchronization.