Summary
Overview of the process you follow
- Create resources. For the deployment of a server deployment package to a commerce server, you must populate resources manually. You can view the resources you create in the Resources view. Each resource corresponds to the Commerce server.
- Define components, applications, and environments to automate deployment.
- Deploy.
Refer to plugin documentation for system requirements and a complete list of steps available.
Compatibility
It was tested to work with Windows Server 2008 R2 Datacenter Edition.
The DevOps Deploy plug-in for WSRR works with WebSphere Service Registry and Repository versions 8.0.0.x through 8.5.0.0.
The steps in this plug-in run on any agents that the HCL DevOps Deploy server supports.
Installation
See Installing plug-ins in HCL Deploy for installing and removing plug-ins.
History
Version |
Description |
9 |
Fixes PI75774: Add missing AirPluginTool import to Register Service step. Exit with failure if the Register Service step completes unsuccessfully. |
8 |
Support property file encryption. |
1 |
First version - test |
Usage
This section elaborates on the procedure to be followed to use this plug-in.
Before you begin, you must have
- Installed and started your WSRR server, you can refer to http://pic.dhe.ibm.com/infocenter/sr/v8r0/index.jsp.
- Installed and started your DevOps Deploy Server, you can refer to Installing DevOps Deploy.
- Installed DevOps Deploy Agent on the machine which the WSRR server locates.
- Started the DevOps Deploy Agent which connects to the DevOps Deploy Server.
- Load the WSRR plug-in into the DevOps Deploy Server.
Register Web Services to a WebSphere Service Registry and Repository server
- Prepare CSV and WSDL files that describe the web services.
- The CSV file must contain the following exact headers:
- Name
- Description
- Version
- Status
- Date in Production
- Owner
- Endpoint URL
- Documentation Filename
- WSDL Filename
- Namespace
- Service ID
- Create a resource that represents the WebSphere Service Registry and Repository server.
- Add the agent that is installed on the system hosting the WebSphere Service Registry and Repository server to the resource group.
- Hover over the row for the resource group, click Actions, and then select Add agent.
- Create components for the resources. The components must include the CSV files and WSDL folders. Create one component for each resource to deploy.
- Create component processes of type Deployment. In the corresponding component deployment process, add a Register Service step, and enter parameters such as csvFile, wsdlPath, hostname, port, username, password, and so on.
- -csvFile is the complete file name of the CSV file to import.
- -wsdlPath is the complete path to a directory containing the WSDL and XSD documents. By default, the wsdlPath parameter is the current directory.
- -hostname is the host name or IP address of the WebSphere Service Registry and Repository server. By default, the hostname parameter is localhost.
- -port is the Service Registry WC_defaulthost port, which is the port on which the Service Registry Web UI is hosted. Typically, in standalone environments this port number is 9080 for secure communication and 9443 for non-secure communication. By default, the port parameter is 9433.
- Add the components to the resources.
- Navigate to the resource.
- Click Actions > Add Component.
- Select the component to add.
- Create the application.
- Navigate to Applications.
- If an application does not exist, click Create New Application. You can also use an existing application that is attached to the cell to manage.
- Enter an application name, then click Save.
- Click the Components tab, then add the components to the application.
- Create an application environment.
- On the Resources page, click Create New Environment.
- Enter an environment name, then click Save.
- Navigate to the environment editing page.
- Click on the environment name, then click Add Base Resource. Select the group for the Process Center environment.
- Create an application process of type Deployment.
- Click the Processes tab.
- Add a deployment step.
- Drag and drop the Install Component step into the process editor.
- Select the component to install from the list of components that you created for the resource. For example, you created a component to contain the process application to deploy.
- Choose the process for the component.
- Click Save.
- Save the process.
- Run the deployment process and check the corresponding status and log information.
Load, activate or delete Configuration Profile
Load, activate or delete Configuration Profile on a WebSphere Service Registry and Repository server
- For loading, activating or deleting a Configuration Profile on a WebSphere Service Registry and Repository server, create a resource that represents the WebSphere Service Registry and Repository server.
- Add the agent that is installed on the system hosting the WebSphere Service Registry and Repository server to the resource group.
- Hover over the row for the resource group, click Actions, and then select Add agent.
- Create components for the resources. Create one component for each resource to deploy.
- Create the component process of type Deployment. Drag and drop steps such as Load Configuration Profile, Activate Configuration Profile, and Delete Configuration Profile into the deployment process. Configure any input parameters that are required by the steps.
- Add the components to the resource.
- Navigate to the resource.
- Click Actions > Add Component
- Select the component to add.
- Navigate to Applications.
- If an application does not exist, click Create New Application. You can also use an existing application that is attached to the cell to manage.
- Enter an application name, then click Save.
- Click the Components tab, then add the components.
- Create an application environment.
- On the Resources page, click Create New Environment.
- Enter an environment name, then click Save.
- Navigate to the environment editing page.
- Click the environment name, then click Add Base Resource. Choose the group for the Process Center environment.
- Create an application process of type Deployment
- Click the Processes tab.
- Add a deployment step.
- Drag and drop the Install Component step onto the process editor.
- Select the component to use. You created this component for the resource. For example, you created a component to contain the process application to be deployed.
- Choose the process for the component.
- Click Save.
- Save the process. You can then run the deployment process and check the status and logs for each step.
- Check the new Configuration Profile status on the WebSphere Service Registry and Repository server.
IBM WebSphere Service Registry and Repository - Process Steps
Activate Configuration Profile
This step archives the currently active profile and then makes the specified configuration profile active. The configuration profile that was previously active is saved in WSRR.
Name |
Type |
Description |
Required |
Cell Name |
String |
In a stand-alone or federated node configuration, the name of the cell in which WSRR is deployed. |
No |
Cluster Name |
String |
In a cluster configuration, the name of the cluster on which WSRR is deployed in a cluster configuration. |
No |
Node Name |
String |
In a stand-alone or federated node configuration, the name of the node on which WSRR is deployed. |
No |
Password |
Password |
The password of the account that will interact with WSRR system. |
Yes |
Profile Name |
String |
The name given to the configuration profile created in WSRR. |
Yes |
Server Name |
String |
In a stand-alone or federated node configuration, the name of the server on which WSRR is deployed. |
No |
WSRR Home |
String |
The WSRR_INSTALL_ROOT directory. This parameter is optional and, if omitted, defaults to the current directory. You must provide a value for this parameter if you are not running the script from the WAS_INSTALL_ROOT\WSRR\admin\scripts_cell directory. |
Yes |
WSRR User |
String |
The user name of the account that will interact with WSRR system. |
Yes |
Delete Configuration Profile
This script removes a configuration profile from WSRR.
Name |
Type |
Description |
Required |
Cell Name |
String |
In a stand-alone or federated node configuration, the name of the cell in which WSRR is deployed. |
No |
Cluster Name |
String |
In a cluster configuration, the name of the cluster on which WSRR is deployed. |
No |
Node Name |
String |
In a stand-alone or federated node configuration, the name of the node on which WSRR is deployed. |
No |
Password |
Password |
The password of the account that will interact with WSRR system. |
Yes |
Profile Name |
String |
The name given to the configuration profile created in WSRR. |
Yes |
Server Name |
String |
In a stand-alone or federated node configuration, the name of the server on which WSRR is deployed. |
No |
WSRR Home |
String |
The WSRR_INSTALL_ROOT directory. This parameter is optional and, if omitted, defaults to the current directory. You must provide a value for this parameter if you are not running the script from the WAS_INSTALL_ROOT\WSRR\admin\scripts_cell directory. |
Yes |
WSRR User |
String |
The user name of the account that will interact with WSRR system. |
Yes |
Load Configuration Profile
This step loads a configuration profile, from a configuration profile compressed file, into WSRR.
Name |
Type |
Description |
Required |
Cell Name |
String |
In a stand-alone or federated node configuration, the name of the cell in which WSRR is deployed. |
No |
Cluster Name |
String |
In a cluster configuration, the name of the cluster on which WSRR is deployed. |
No |
File Name |
String |
The name of the configuration profile file. |
Yes |
File Path |
String |
The file path to the configuration profile file. |
No |
Node Name |
String |
In a stand-alone or federated node configuration, the name of the node on which WSRR is deployed. |
No |
Password |
Password |
The password of the account that will interact with WSRR system. |
Yes |
Profile Name |
String |
The name given to the configuration profile created in WSRR. |
Yes |
Server Name |
String |
In a stand-alone or federated node configuration, the name of the server on which WSRR is deployed. |
No |
WSRR Home |
String |
The WSRR_INSTALL_ROOT directory. This parameter is optional and, if omitted, defaults to the current directory. You must provide a value for this parameter if you are not running the script from the WAS_INSTALL_ROOT\WSRR\admin\scripts_cell directory. |
Yes |
WSRR User |
String |
The user name of the account that will interact with WSRR system. |
Yes |
Register Service
This script registers service using WSDL document onto WSRR.
Name |
Type |
Description |
Required |
CSV File |
String |
The name of the CSV file which describes your services metadata. |
Yes |
Host Name |
String |
The host name of the server on which you want to register your service. |
Yes |
Password |
Password |
The password of the account that will interact with WSRR system. |
Yes |
Port Number |
String |
The port number of the server on which you want to register your service. |
Yes |
WSDL Path |
String |
The path which includes your WSDL files. |
Yes |
WSRR User |
String |
The user name of the account that will interact with WSRR system. |
Yes |