Deploying IBM Rational License Key Server Pattern

To set up a license key server, deploy this pattern. To provide automated license management, deploy the shared service. If you already have an IBM® Rational® License Key Server, you can use the license files on that server and skip deploying this pattern. However, you must deploy the shared service.
The shared service provides automated license management between these deployments and IBM Rational License Key Server.

Before you begin

You must have a supported installation of the appliance that is being used to manage resources in a cloud-computing environment.

To deploy IBM Rational License Key Server Pattern on the appliance, you must install its pattern type. For more information, see Installing the pattern type. You must also be assigned the Create new catalog content role or the Workload resources administration role with full permissions. For more information about user roles, see Managing system users.

Request the following details about the environment to deploy into from your appliance system administrator:
  • The environment profile
  • The cloud group
  • The IP group
For more information, see Administering cloud resources.

About this task

Deploy the IBM Rational License Key Server Pattern. If you already have an existing Rational License Key Server, skip this task and go to Deploying the shared service.

Procedure

  1. Go to the virtual system patterns by clicking Patterns > Virtual System Patterns.
  2. From the list of patterns on the Virtual System Patterns page, select the IBM Rational License Key Server Pattern.
  3. Click the Deploy icon.
  4. Complete the required fields to deploy the pattern.
    1. On the Deploy Pattern page, leave the default name for the virtual system. If you change the name, make note of this information for future use.
      Restriction: The name can have no more than 64 characters.
    2. Enter any other required information:
      1. Select the environment profile to use for the deployment. Internally or externally managed environment profiles can be used for single-system deployments.
      2. Specify, or accept the default cloud group and IP group to deploy into. These fields are displayed only for internally managed environment profiles.
      3. Set a priority for the deployment.
      4. Optional: Set up Secure Shell (SSH) access to the deployment either by generating an SSH public/private key pair, or by specifying an externally generated SSH public key. The generated or specified public key is uploaded to the virtual machines during deployment. If you generated a key pair, be sure to download the private key file to a secure location. You can distribute this file later to users who are allowed to access the deployed virtual machines in the cloud group for troubleshooting and maintenance purposes.
      5. Set the schedule for the deployment to be at the current time or a later time that you specify.
      6. Click the component names to set the parameters for the individual software components. Fields that have a red asterisk next to the name are required parameters that you must set before the pattern is deployed.

        You can accept all or most of the default values, although you might prefer to override some of them. For example, you might want to override the cell name or node name to conform to your site naming conventions. In most cases, only passwords need to be additionally specified.

        For more information about the parameters in the predefined pattern, see IBM Rational License Key Server pattern parameters.

  5. Click Quick Deploy to start the deployment process. The length of time that is required for the deployment to complete depends on the complexity of the pattern that is being deployed.

Results

The license key server is set up.

What to do next

Obtain the host name of the deployed pattern instance, if you deployed the IBM Rational License Key Server Pattern and are not using an existing IBM Rational License Key Server.

Obtaining the host name of the deployed instance

Obtain the host name of the deployed pattern instance. The host name is a required parameter that you must enter when you deploy the license key server shared service.

Before you begin

Deploy the IBM Rational License Key Server Pattern.

Procedure

  1. Go to the Virtual System Instances page by clicking Patterns > Pattern Instances > Virtual System Instances.
  2. From the list of instances on the Virtual System Instances page, select the IBM Rational License Key Server Pattern that was deployed. The details of the deployed instance are displayed.
  3. Expand the Virtual machine perspective section in the details view, and then expand the software component VM section that you deployed.
  4. In the Hardware and network section of the virtual system instance, look for the entry next to Network interface 1. Make a note of this information for future use.

    Finding the network interface

What to do next

Add a license file, if you deployed the IBM Rational License Key Server Pattern and are not using an existing IBM Rational License Key Server.

Adding a license file

Before you can use the patterns, you must add a license file.

Before you begin

  • Deploy the license key server pattern.
  • Log in to the workload console.
  • Obtain a license file from your IBM sales representative and put the licensing file on the local host.
    Warning: The license file name must consist of letters and numbers only. Special characters in the file name might cause failure when you add or activate the license. Rename the file if it has any special characters in the name.

About this task

To add the license file into the license key server, use the instance console. After the license file is added, users of the deployed instance are issued license tokens automatically. When a user ends a session, the license tokens are returned to the pool automatically.

If you plan to use an existing Rational License Key Server, you already have license files, and can skip this topic.

Procedure

  1. Go to the Virtual System Instances page by clicking Patterns > Pattern Instances > Virtual System Instances.
  2. From the list of instances on the Virtual System Instances page, select the IBM Rational License Key Server Pattern that was deployed. The details of the deployed instance are displayed.
  3. Click Manage then Operations.
  4. Click RLKS.

    Selecting RLKS

  5. Click Add License in the list of operations. Click Browse, to find the license file on your local host. Select it and click OK. There can be more than one license file that is loaded and available. Click Submit. The result is displayed in the Operations Execution Results pane.
  6. Click Start RLKS. Click Submit. The result is displayed in the Operations Execution Results pane.

Results

The license key server has a license file. is now available for applications to use. Whenever a user runs an application, the application requests licenses from the license key server. When the user logs out from the application, the licenses are returned to the pool.

What to do next

Deploy the shared service.

Deploying the shared service

To provide automated license management between pattern deployments and the license key server, deploy the shared service.

Before you begin

To deploy the license key server shared service on the appliance, you must install the IBM Rational License Key Server Pattern Type. For more information, see Installing the pattern type. You must also be assigned the Create new catalog content role or the Workload resources administration role with full permissions. For more information about user roles, see Managing system users.

About this task

You must deploy the shared service. The shared service provides automated license management between these deployments and IBM Rational License Key Server.
  • Rational Integration Tester
  • Rational Test Virtualization Server with Agent mode licensing
  • Rational Performance Test Server with Agent mode licensing

Procedure

  1. Go to the shared services by clicking Patterns > Shared Services
  2. From the list of shared services on the Shared Services page, select the shared service IBM Shared Service for Rational License Key Server (External) 1.0.0.0 to deploy.
  3. Click the Deploy icon.

    Deploying the shared service

  4. Complete the required fields to deploy the pattern.
    1. On the Deploy Pattern page, leave the default name for the virtual system. If you change the name, make note of this information for future use.
      Restriction: The name can have no more than 64 characters.
    2. Enter any other required information:
      1. Select the environment profile to use for the deployment. Internally or externally managed environment profiles can be used for single-system deployments.
      2. Specify, or accept the default cloud group and IP group to deploy into. These fields are displayed only for internally managed environment profiles.
      3. Accept the default operation system family and base image.
      4. Optional: Set up Secure Shell (SSH) access to the deployment either by generating an SSH public/private key pair, or by specifying an externally generated SSH public key. The generated or specified public key is uploaded to the virtual machines during deployment. If you generated a key pair, be sure to download the private key file to a secure location. You can distribute this file later to users who are allowed to access the deployed virtual machines in the cloud group for troubleshooting and maintenance purposes.
      5. Click the shared service component name to set its parameters. Fields that have a red asterisk next to the name are required parameters that you must set before the pattern is deployed. Use the host name that you made note of earlier by entering it into the RLKS Public IP Address parameter. You can also use the host name of an existing IBM Rational License Key Server, if you have one.

        Entering the public IP address

        You can accept all or most of the default values, although you might prefer to override some of them. For example, you might want to override the cell name or node name to conform to your site naming conventions.

        For more information about the parameters in the shared service, see the applicable section about shared service parameters.

  5. Click Quick Deploy to start the deployment process. The length of time that is required for the deployment to complete depends on the complexity of the pattern that is being deployed.

Results

The deployment process creates a shared service instance. The shared service provides automated license management between deployments and IBM Rational License Key Server.

What to do next

View the status of the deployed instance, and administer it from the Virtual System Instances page, which you can access by clicking Patterns > Pattern Instances > Virtual System Instances. For more information, see Working with deployed instances.
Feedback