Skip Headers
Oracle® Communications Network Integrity Developer's Guide
Release 7.1

E23701-03
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

21 Deploying and Undeploying Cartridges

Network Integrity cartridges can be directly deployed or undeployed from Design Studio. The deployment or undeployment of Network Integrity cartridges directly from Design Studio should be carried out by Network Integrity cartridge developers only.

Use the Oracle Cartridge Deployer to deploy or undeploy any productized Network Integrity cartridge into a production system.

Note:

Before deploying or undeploying cartridges, ensure that:
  • You are logged out of the WebLogic Server Administration Console.

  • No one else is deploying or undeploying cartridges on the same server.

  • Network Integrity is not running a scan that makes use of the cartridge.

This chapter consists of the following topics:

Creating a Design Studio Environment Project

Design Studio projects are collections of folders and files that represent the content you are working on. They are used for builds, version management, sharing, and resource organization. Projects map to directories in the file system. When you create a project, you specify a location for it in the file system. Studio uses the files and folders in a project to build a cartridge that you can import into Network Integrity. Each project is a cartridge. See "Building and Packaging Cartridges" for more information. To deploy or undeploy a cartridge from Design Studio, you must first create a Studio Environment Project. When you create a project, you specify its name and location for its corresponding file structure.

To create a Design Studio environment project:

  1. Ensure that the Build Automatically setting is enabled. See "Building Cartridges Automatically".

  2. Open the Studio Design perspective.

    Note:

    The procedures for creating projects assume that you are working in the Studio Design perspective. For more information about using perspectives, see Design Studio Help.
  3. Within the Cartridge view, right-click and select New, then select Environment Project.

    The New Studio Environment Project wizard appears.

    Figure 21-1 shows an example of a project, named my_integrity_studio_project.

    Figure 21-1 Creating a New Studio Project

    Displays studio project info UI
  4. In the Project name field, enter the name of your project.

    The project name cannot contain spaces, slashes, or backslashes.

  5. Create a location to contain your Network Integrity cartridge project, or verify that the Use default location check box is selected.

    The default location is the workspace directory that contains your Network Integrity cartridge project.

  6. Click Finish.

    Design Studio creates the project and its file structure. The perspective you are using determines how it is displayed. In the Studio Design perspective, the project appears in the Cartridge view, with the Integrity Cartridge editor displaying its properties.

Creating a Studio Environment

Having created a Studio Environment Project, you then create the environment. An environment represents a connection to a particular server.

To create a Studio environment:

  1. Right-click the my_integrity_studio_project project, select New, select Environment, and then select Studio Environment.

    The Studio Environment Wizard appears. Figure 21-2 shows an example of an environment, named my_server.

    Figure 21-2 Creating a New Studio Environment

    Displays Studio environment wizard UI
  2. In the Name field, enter the name of your environment. The name should incorporate the server name.

    The environment name cannot contain spaces, slashes, or backslashes.

  3. Create a location to contain your environment.

  4. Click Finish.

    Design Studio creates the environment and its file structure. The perspective you are using determines how it is displayed. In the Studio Design perspective, the environment appears in the Cartridge view, with the Integrity Cartridge editor displaying its properties.

    Figure 21-3 shows the connection details for the environment.

    Figure 21-3 Configuring the Studio Environment Connection information

    Displays Studio environment connection UI
  5. In the Cartridge view for the environment, click the Connection tab.

    1. (Optional) In the Description field, provide a description of your environment.

    2. In the Address field, specify the Cartridge Management Web Service (CMWS) URL.

      Note:

      If SSL is used, ensure that https is specified in this field.
  6. (Optional) In the Cartridge view for the environment, click the SSL tab. This step is required only if Hypertext Transfer Protocol Secure (HTTPS) is used.

    1. (Optional) In the Description field, provide a description of your environment.

    2. In the Keystore field, browse to the location of the keystore file on the local hard drive.

      The keystore file must be transferred from the WebLogic server to the location where Design Studio is running. If you select the WebLogic demo keystore, you must add the host name instead of the IP address in the Address field under the Connection tab.

      This is because the WebLogic demo keystore was generated against the host name, not the IP address, during Network Integrity installation.

  7. In the Cartridge view for the environment, click the Properties tab.

    Specify the properties for cartridge management so that Design Studio can successfully deploy and undeploy Network Integrity cartridges:

    1. Expand the Network Integrity Cartridge folder, and then expand the Cartridge Management folder.

    2. Configure the following properties:

      wladmin.host.name: The host name or IP address where the Oracle WebLogic Admin Server is running

      wladmin.host.port: The port number on which the Oracle WebLogic Admin Server is running

      wladmin.server.name: The Oracle WebLogic Admin Server name.

  8. Click Save to save the Studio environment project. Design Studio automatically builds the environment project. When the build is completed, there should be no warnings or errors from this environment project. You can now deploy and undeploy Network Integrity cartridges.

Switching to the Studio Environment Perspective

Before deploying or undeploying cartridges from Design Studio, you must open the Studio Environment perspective.

To open the Studio Environment perspective, do one of the following:

  • From the Window menu, select Open Perspective, then select Studio Environment

  • From the Studio menu, select Other

    The Open Perspective dialog appears

    Select Studio Environment

    Click OK

  • From the Studio menu, select Show Environment Perspective.

The Studio Environment perspective displays two views:

  • Environment

  • Cartridge Management

If they do not open, you can manually open these two views.

To open the Studio Environment views, do one of the following:

  • From the Window menu, select Show View, then select Environment and Cartridge Management

  • From the Window menu, select Other

    The Show View dialog appears

    Expand the Oracle Design Studio folder

    Select Environment and Cartridge Management

Connecting to the Studio Environment

Having opened the Environment and Cartridge Management views in the Studio Environment perspective, you can connect to the environment that has been created.

  1. Within the Environment view, right-click my_server, then select Test Connection.

    The Test Environment Connection dialog appears.

    Figure 21-4 shows an example of a test connection.

    Figure 21-4 Creating a Test Connection

    Displays environment connection properties UI
  2. In the User Name field, enter the Cartridge Management Web Service (CMWS) username.

  3. In the Password field, enter the password associated with the CMWS username.

  4. Click OK to test the connection.

    Design Studio connects to the CMWS environment and is ready to deploy or undeploy cartridges.

Deploying a Cartridge

Before deploying a Network Integrity cartridge in Design Studio, you must first build the cartridge and ensure that there is no error marker associated with it. See "Building Cartridges Automatically".

To deploy a cartridge:

  1. Open the Studio Environment perspective. See "Switching to the Studio Environment Perspective".

  2. If Design Studio is not connected to the target environment, make the connection by following the steps outlined in "Connecting to the Studio Environment".

  3. From the Cartridge Management view, select the cartridge that you want to deploy, and click Deploy to deploy this cartridge to the target environment.

    Note:

    The Cartridge Management view displays a list of cartridges available in the current workspace. However, a cartridge that contains only abstract actions does not appear in this list.
    1. (Optional) Click Run in Background to run the deployment in the background.

    2. (Optional) Check the Always run in background box to run all future cartridge deployments in the background.

    3. (Optional) Click Details to view the environment connection properties. See "Connecting to the Studio Environment".

    When deployment is completed without error, a Deploy Completed confirmation dialog appears.

  4. Click OK.

    Design Studio deploys the cartridge, and lists the newly deployed cartridge with version and timestamp in the Deployed Versions table. The Console view opens to provide extra information regarding the deployment. Error messages are displayed if any exist.

    Figure 21-5 shows a deployed cartridge called Address_Handlers.

    Figure 21-5 Viewing a Deployed Cartridge

    Displays deployed cartridges UI

Redeploying a Cartridge

You can redeploy a Network Integrity cartridge using Design Studio, only if the version of the redeployed cartridge (build number) is equal to, or greater than, the version of the deployed cartridge. For example, my_cartridge is already deployed with a build number of 28 (b28). If my_cartridge is up-versioned to b30, you can deploy it without undeploying my_cartridge (b28) and deploying it again.

Redeployment removes the deployed cartridge and deploys the new cartridge instead. Network Integrity does not allow more than one version of the same cartridge to be deployed at the same time.

Undeploying a Cartridge

When a cartridge is undeployed, Network Integrity removes all the scan configurations and scan results associated with the cartridge and all the specifications associated with the cartridge (except those specifications still in use by other cartridges).If a cartridge has a dependency on other deployed cartridges, the cartridge cannot be undeployed. For example, you cannot undeploy the Address_Handlers cartridge if the cartridges using Address_Handlers are still deployed in Network Integrity. You must undeploy all dependent cartridges from Network Integrity before Address_Handlers can be undeployed.

The Network Integrity Cartridge Management Web Service (CMWS) Adapter automatically carries out dependency checks at deployment or undeployment time and returns error messages if deployment or undeployment cannot be carried out.

To undeploy a cartridge:

  1. Open the Studio Environment perspective. See "Switching to the Studio Environment Perspective".

  2. If Design Studio is not connected to the target environment, make the connection by following the steps outlined in "Connecting to the Studio Environment".

  3. From the Deployed Versions table in the Cartridge Management view, select the cartridge that you want to undeploy, and click Undeploy to undeploy this cartridge from the target environment.

    A Confirm to Undeploy dialog appears.

  4. Click OK to confirm the undeployment.

    Design Studio undeploys the cartridge, and removes the cartridge from the Deployed Versions table. The Console view opens to provide extra information regarding the undeployment. Error messages are displayed if any exist.

  5. (Optional) You can click Cancel to attempt to cancel this undeployment. If the undeployment request has already been sent to CMWS, this undeployment cannot be cancelled.

When a cartridge is undeployed, Network Integrity removes all of the scan configurations and scan results associated with this cartridge and all of the specifications (except those still in use by other cartridges) associated with this cartridge.

If a cartridge has a dependency with other deployed cartridges, this cartridge cannot be undeployed. For example, you cannot undeploy Address_Handlers if the cartridges that are using the Address Handler are still deployed on Network Integrity.

You must undeploy all dependent cartridges from Network Integrity before the Address_Handlers can be undeployed. The Network Integrity CMWS Adapter automatically carries out the dependency check at deployment or undeployment time.