Skip Headers
Oracle® Exalogic Elastic Cloud Administrator's Guide
Release EL X2-2, X3-2, and X4-2

E25258-13
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

11 Deploying Assemblies in the Exalogic vDC Using OVAB Deployer

This chapter describes how to deploy assemblies, created by using Oracle Virtual Assembly Builder (OVAB) Studio, in an Exalogic virtualized data center (vDC).

This chapter contains the following sections:

Note:

For information about creating assemblies by using OVAB Studio, see "Operations Related to Creating an Assembly" in the Oracle Virtual Assembly Builder User's Guide.

11.1 Introduction to Oracle Virtual Assembly Builder (OVAB) Deployer

This section contains the following topics:

Oracle Virtual Assembly Builder (OVAB) is a tool that enables you to create a blueprint of a reference, multitier application topology, and then deploy that topology in Oracle VM and virtualized Exalogic environments. Using OVAB, you can examine a reference topology and capture the configuration of the individual Oracle software components in the topology, as appliances. You can then group the appliances into an assembly, which serves as a blueprint for the entire multitier application topology. You can deploy multiple instances of the OVAB-generated assemblies rapidly on virtualized systems, by using OVAB Deployer, which is an application running within an Oracle WebLogic Server container.

For information about creating assemblies by using OVAB Studio, see "Operations Related to Creating an Assembly" in the Oracle Virtual Assembly Builder User's Guide.

11.1.1 OVAB Deployer on Exalogic

When you upgrade the Exalogic Elastic Cloud Software (EECS) on an Exalogic machine to v2.0.6.0.0 or when you install EECS 2.0.6.0.0, OVAB Deployer 11.1.1.6.2 is installed in the Exalogic Control VM. You can use OVAB Deployer to deploy instances of OVAB-generated assemblies in the Exalogic vDC, as described in Section 11.2, "Deploying Assemblies in an Exalogic vDC Using the OVAB Deployer."

Note:

For the differences between the generally available OVAB release and OVAB Deployer 11.1.1.6.2, see Section 11.1.2, "Differences Between the Generally Available OVAB Release and OVAB Deployer 11.1.1.6.2."

11.1.2 Differences Between the Generally Available OVAB Release and OVAB Deployer 11.1.1.6.2

Table 11-1 describes the differences between release 11.1.1.6.2 of OVAB Deployer and the generally available release.

Table 11-1 Differences Between the Generally Available OVAB Release and OVAB Deployer 11.1.1.6.2

Feature Generally Available OVAB Release OVAB 11.1.1.6.2

Creating deployment targets

Multiple targets can be created.

A single pre-configured target, which is the same Exalogic system in which the OVAB Deployer is installed. The operation for adding targets is disabled.

Updating deployment targets

All the properties of targets can be updated

Only the operation time-out value (that is, the exalogic.vmOperationTimeout property) can be changed, by using the CLI.

Adding users to targets

Users belonging to the Cloud Admins group can grant permission to users in the Application Admins group, to use a target.

Users belonging to the Cloud Admins group can use a configured target; however, they must supply their own credential information to the virtualization system.

Guest base images that can be used for creating assemblies by using OVAB Studio

Any generic Oracle VM image

Only the Exalogic guest base image

Deployment interfaces

Command-line interface and API

Command-line interface, web console (for the tasks described in Section 11.2.4, "Using the OVAB Deployer Web Console"), and API

IP-address assignment for appliances

The IP addresses can be DHCP-assigned or static. So in the deployment plan, the network.eth<network>-usedhcp property can be set to true or false, depending on the requirement.

IP-address assignment is similar to DHCP, except that the addresses are from a set of addresses that are pre-allocated in Exalogic Control, as described in Section 10.2.8, "Allocating Virtual IPs for an Account." To use this feature, set the network.eth<network>-usedhcp property in the deployment plan to true.

If static IP addresses are required, set network.eth<network>-usedhcp to false, and specify IP addresses from the set of pre-allocated addresses.

Network creation/binding

The required networks must exist and must be preconfigured. The OVAB metadata defines bindings to the existing networks.

Based on the assembly metadata, private vNets are constructed dynamically on the InfiniBand fabric.

Anti-affinity behavior

See the Oracle Virtual Assembly Builder User's Guide.

If the anti-affinity-min-servers property is set to a value other than 0, anti-affinity is enabled for the appliance; otherwise, anti-affinity is disabled. When anti-affinity is enabled, the instances of the appliance are placed on separate nodes, up to the number of nodes available.

  • If the number of instances is equal to, or less than, the number of nodes, each instance is placed on a separate node.

  • When the number of instances exceeds the number of nodes, a placement failure occurs for the additional instances.


11.2 Deploying Assemblies in an Exalogic vDC Using the OVAB Deployer

This section contains the following topics:

11.2.1 Configuring a User and Connection for OVAB Deployer on Exalogic

When OVAB Deployer is installed in the Exalogic Controller vServer in an Exalogic vDC, a single target (named exalogic) is preconfigured. In addition, a default security realm is created in the Oracle WebLogic Server that hosts the OVAB Deployer application. The required OVAB-specific user groups—Application Admins and Cloud Admins—are preconfigured in the default security realm.

Before using OVAB Deployer on Exalogic, complete the following steps:

  1. In the Exalogic vDC, identify the following:

    • A Cloud User that you want to use to access the OVAB Deployer.

      Note:

      If you want more than one Cloud User to be able to access the OVAB Deployer, you must repeat the procedure described in this section separately for each such user.

    • The UUID of an account to which the selected user is assigned.

      This account that will be used for deploying assemblies, and the resulting vServers will be displayed in the Exalogic Control BUI under this account.

    To find out the UUID of an account in the Exalogic vDC, do the following:

    1. Log in to the Exalogic Control browser user interface (BUI) as a Cloud Admin user.

      The URL for the Exalogic Control BUI is:

      https://ec-vm/emoc
      

      In this URL, ec-vm is the IP address of the Exalogic Control VM on the EoIB-external-mgmt network on the Exalogic machine.

    2. In the navigation pane on the left, expand vDC Management, expand the name of the vDC (say, MyCloud), and select Accounts.

      The available accounts are listed in the main pane.

    3. Hover the mouse pointer over the name of the account for which you want to find the UUID.

      The resulting display box shows the details of the account, including its UUID (example: ACC-bbc4ea03-70c5-4fe8-8148-8e770e1b2ec2).

    If you want to use a new Cloud User and a new account, create the required user and account as described in Chapter 6, "Creating and Managing Users and Roles", and assign the user to the account, as described in Section 9.1.5, "Establishing Cloud Accounts."

  2. Create a user in the Oracle WebLogic Server that hosts the OVAB Deployer on Exalogic:

    1. Log in to the Oracle WebLogic Server Administration Console as the weblogic user with the administration password. If you do not know the password for the weblogic user, contact Oracle Support.

      The URL for the Oracle WebLogic Server Administration Console is:

      http://ec-vm:9001/console/login/LoginForm.jsp
      

      In this URL, ec-vm is the IP address of the Exalogic Control VM on the EoIB-external-mgmt network on the Exalogic machine.

    2. Create a user, as described in "Create users" in the Oracle WebLogic Server Administration Console Online Help.

    3. Assign the new user to the Application Admins group, as described in "Add users to groups" in the Oracle WebLogic Server Administration Console Online Help.

    The Oracle WebLogic Server Administration Console Online Help is available at:

    http://docs.oracle.com/cd/E23943_01/apirefs.1111/e13952/core/index.html

  3. Create a connection from an OVAB Studio installation to OVAB Deployer running on Exalogic:

    $ abctl createDeployerConnection -name connection_name -url http://ec-vm:9001 -username wls_user
    
    • wls_user is the user that you created in step 2.

    • connection_name is the name of the connection that you are creating.

    • ec-vm is the IP address of the Exalogic Control VM on the EoIB-external-mgmt network on the Exalogic machine.

    A prompt to enter the password is displayed. Enter the password that you defined while creating the user in step 2.

  4. From the OVAB Studio installation, add the user (that you created in step 2) to the preconfigured target named exalogic:

    $ abctl addTargetUser -connectionName connection_name -user wls_user
     -target exalogic -properties exalogic.user=cloud_user
     exalogic.pwd=cloud_user_password exalogic.tenancy=account_UUID
    
    • connection_name is the connection that you defined in step 3.

    • wls_user is the user that you created in step 2.

    • cloud_user is the user that you identified (or created) in step 1.

    • cloud_user_pasword is the password for the user you identified (or created) in step 1.

    • account_UUID is the UUID of the account to which the specified Cloud User is assigned, as identified in step 1.

  5. Verify the configuration by running the following command:

    $ abctl describeTargets -connectionName connection_name
    

    This command displays the name, type, and status of the exalogic target. It also displays information about the available networks, volumes, and memory.

11.2.2 Accessing the OVAB Deployer Interfaces

OVAB Deployer provides a web console and a command-line interface (CLI) for deploying assemblies on Exalogic.

Note:

You can also use OVAB Studio and OVAB web-service APIs for the deployer operations. For more information, see the following documentation:

11.2.2.1 Accessing the OVAB Deployer Web Console

To access the web console for OVAB Deployer on Exalogic, do the following:

  1. Ensure that a user and connection have been configured for OVAB Deployer as described in Section 11.2.1.

  2. Go to the following URL:

    http://ec-vm:9001/ovab/login.jsp
    

    In this URL, ec-vm is the IP address of the Exalogic Control VM on the EoIB-external-mgmt network on the Exalogic machine.

    The login page is displayed.

  3. Specify the user name and password that you defined earlier, as described in step 2 of Section 11.2.1, "Configuring a User and Connection for OVAB Deployer on Exalogic."

On the resulting page, you can perform the assembly deployment operations. For more information, see Section 11.2.4, "Using the OVAB Deployer Web Console."

11.2.2.2 Using OVAB Deployer-Related abctl CLI Commands

To run OVAB Deployer-related abctl CLI commands, you must use the OVAB Studio installation from which you defined a connection to OVAB Deployer on Exalogic as described in step 3 of Section 11.2.1, "Configuring a User and Connection for OVAB Deployer on Exalogic."

The abctl commands that are available for OVAB Deployer on Exalogic are the same as the commands that are available in a deployer-only installation of the generally available OVAB Deployer release, except for the differences noted in Section 11.1.2, "Differences Between the Generally Available OVAB Release and OVAB Deployer 11.1.1.6.2."

For more information about the OVAB Deployer-related abctl commands, see "Command Line Reference" in the Oracle Virtual Assembly Builder User's Guide.

You can also view help for individual commands directly at the console, by running the following command:

./abctl help -command command

11.2.3 Assembly Deployment Workflow

Table 11-2 provides an overview of the typical workflow for deploying an assembly in an Exalogic vDC by using the OVAB Deployer, and contains pointers to the sections describing the procedures for performing the tasks in the workflow by using the OVAB Deployer web console. The table also lists the abctl CLI commands that you can use to perform the deployment tasks. For more information about the CLI commands, see the Oracle Virtual Assembly Builder User's Guide.

Note that, before deploying an assembly, you must create a deployment plan. For more information, see "Operations Related to Deployment" in the Oracle Virtual Assembly Builder User's Guide.

Table 11-2 Assembly Deployment Workflow

Workflow Sequence Task Procedure Using the Web Console CLI Command/s

1

Upload the assembly archive to the OVAB Deployer on Exalogic.

Section 11.2.4.2, "Uploading an Assembly Archive"

uploadAssemblyArchive

2

Register the assembly with the Exalogic target.

Section 11.2.4.5, "Registering an Assembly Archive"

registerAssemblyArchive

3

Create an assembly instance.

Section 11.2.4.7, "Create an Assembly Instance"

createAssemblyInstance

4

Deploy the assembly instance.

Section 11.2.4.10, "Deploying an Assembly Instance"

deployAssemblyInstance

5

Start, stop, restart, or redeploy the assembly instance.

Section 11.2.4.12, "Starting, Stopping, Restarting, and Redeploying Assembly Instances"

startAssemblyInstance

stopAssemblyInstance

restartAssemblyInstance

redeployAssemblyInstance

6

Scale appliances.

Section 11.2.4.17, "Scaling an Appliance"

scale


11.2.4 Using the OVAB Deployer Web Console

This section describes the procedures to perform various assembly lifecycle-related tasks by using the OVAB Deployer web console.

This section contains the following subsections:

11.2.4.1 Viewing a List of Uploaded Assembly Archives

To view a list of assembly archives that are currently uploaded to the OVAB Deployer, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Archives tab.

11.2.4.2 Uploading an Assembly Archive

To upload an assembly archive to OVAB Deployer, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Archives tab.

  3. Click the Upload button on the toolbar.

  4. On the resulting page, specify a name and description for the archive, and the location, on the local host, of the archive file.

  5. Click Upload.

11.2.4.3 Downloading an Assembly Archive

To download an assembly archive from OVAB Deployer, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Archives tab.

  3. Select the assembly archive that you want to download.

  4. Click the Download button on the toolbar.

  5. In the resulting dialog box, specify the location, on the local host, to which the assembly archive should be downloaded.

11.2.4.4 Deleting an Assembly Archive

To delete an assembly archive from OVAB Deployer, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Archives tab.

  3. Select the assembly archive that you want to delete.

  4. Click the Delete button on the toolbar.

11.2.4.5 Registering an Assembly Archive

To register an assembly archive to the Exalogic target, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Registrations tab.

  3. Click the Register button on the toolbar.

  4. On the resulting page, do the following:

    1. In the Assembly field, select the assembly for which you want to register.

    2. In the Version field, select the assembly version number.

    3. In the Plan field, specify the location of the deployment plan.

    4. Click Register.

11.2.4.6 Unregistering an Assembly Archive

To unregister an assembly archive, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Registrations tab.

  3. Select the assembly archive that you want to unregister.

  4. Click the Unregister button on the toolbar.

11.2.4.7 Create an Assembly Instance

To create an assembly instance, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Deployments tab.

  3. Click the Create button on the toolbar.

  4. On the resulting page, do the following:

    1. In the Assembly field, select the assembly for which you want to create an instance.

    2. In the Version field, select the assembly version number.

    3. In the Plan field, specify the location of the deployment plan.

    4. Click Create.

11.2.4.8 Viewing a List of Assembly Instances

To view a list of assembly instances, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Deployments tab.

11.2.4.9 Deleting an Assembly Instance

To delete an assembly instance, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Deployments tab.

  3. Select the assembly instance that you want to delete.

  4. Click the Delete button on the toolbar.

11.2.4.10 Deploying an Assembly Instance

To deploy an instance of an assembly, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Deployments tab.

  3. Select the assembly for which you want to create an assembly instance.

  4. Click the Deploy button on the toolbar.

11.2.4.11 Undeploying an Assembly Instance

To undeploy an assembly instance, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Deployments tab.

  3. Select the assembly instance that you want to undeploy.

  4. Click the Undeploy button on the toolbar.

11.2.4.12 Starting, Stopping, Restarting, and Redeploying Assembly Instances

To start, stop, restart, or redeploy an assembly instance, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Deployments tab.

  3. Select the assembly instance that you want to start, stop, restart, or redeploy.

  4. Click the appropriate button on the toolbar.

11.2.4.13 Viewing the Status of Deployment Requests

To view the status of deployment requests, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Requests tab.

11.2.4.14 Deleting a Completed Deployment Request

To delete a deployment request that has been completed, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Requests tab.

  3. Select the request that you want to delete.

  4. Click the Delete button on the toolbar.

11.2.4.15 Viewing a List of Appliances

To view a list of appliances, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Appliances tab.

11.2.4.16 Deleting a Failed Appliance

To delete an appliance that is in the failed state, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Appliances tab.

  3. Select the appliance that you want to delete.

  4. Click the Delete button on the toolbar.

11.2.4.17 Scaling an Appliance

To scale an appliance, do the following:

  1. Log in to the OVAB Deployer web console, as described in Section 11.2.2, "Accessing the OVAB Deployer Interfaces."

  2. Click the Appliances tab.

  3. Select the appliance that you want to scale.

  4. Click the Scale button on the toolbar.

  5. On the resulting page, specify the scaling parameters.