package_deployment
Package deployment workflow
The following graphic displays the workflow of the package deployment process:
Package deployment process
A user with AR System administrator permission or a Package Deployer role can deploy packages by using the AR System Deployment Management Console.
Task | Action | Additional information |
---|---|---|
1 | Before you start deploying a package, download the relevant deployment package from the Electronic Product Distribution (EPD) site. | |
2 | Import the package | A deployment package is a ZIP file. Import the package without extracting the ZIP file. If you need to extract the file for troubleshooting, you must use the 7-Zip utility to extract the contents of the ZIP file. |
3 | Deploy the package | Deploy the relevant package to upgrade Remedy applications. In a large server group implementation, you can speed up the upgrade process by deploying a package simultaneously across a server group. If a package deployment fails, BMC recommends that you rollback the package, fix the cause of the failure, and then import and deploy the package. Do not fix the errors manually. See Troubleshooting package deployment issues. |
4 | (Optional) Rollback the package | If an issue occurs during the validation of the package, or if an error occurs while deploying the package, you can restore the applications on your server to the pre-deployment state. |
Importing a package
- Log in to Mid Tier as an administrator or a package deployer user by using the following URL:
http://<midTierServerName>:<port number>/arsys - From the IT Home page, select Applications > AR System Administration > AR System Deployment Management Console.
- In the Deployment Management Console, perform the following actions:
- Select Transfer Package > Import.
- In the Add Attachment dialog box, click Choose File to navigate to the folder that has the downloaded EPD package (ITSM, SRM, or SLM).
Select the package that you want to import, and then click OK.
The Status column shows the status as Importing until the package contents are completely imported. If the status shows Importing for more than 10 seconds, click Refresh to view the updated status.When the package has been successfully imported, the entry of the package is listed in the AR System Deployment Management Console and the package status changes to Ready to Deploy.
- Select Transfer Package > Import.
Deploying a package
The AR System administrator or a Package Deployer performs the following steps to deploy the package in an environment:
- Log in to Mid Tier as an administrator or a package deployer user by using the following URL:
http://<midTierServerName>:<port number>/arsys/ - From the IT Home page, select Applications > AR System Administration > AR System Deployment Management Console.
- In the Deployment Management Console, perform the following actions:
- Click the package row that you have imported, and then select Operations > Deploy.
The following message is displayed if the package contains binaries:
This package includes files to be deployed/rollback. You can monitor the status of the file deployment/rollback by opening the package, selecting the item for file deployment and clicking on the "View Payload Status" button. (ARNOTE 10000)
- Click the package row that you have imported, and then select Operations > Deploy.
- In the message window, click OK.
- To view the package status, click Refresh.
When the package is successfully deployed, the status of the package changes to Deployed.
Running the payload deployment utility
When you deploy a package in a server group, the ARX and DEF content types are processed on all the servers of the server group. However, if the package contains a Deployment Payload content type, you need to run the payload utility, which is processed according to the component ranking order. The higher the ranking, the higher is the preference given for processing the package on that server. For more information, see Setting the component ranking order before deploying a binary payload in BMC Remedy AR System online documentation.
A binary payload is deployed on all the servers automatically if the filedeployer.localDeploymentRequired parameter is set to false in the deployConfig.properties file. If the filedeployer.localDeploymentRequired parameter is set to true (default), you need to manually run the payload utility on all the servers in the server group.
The deployConfig.properties file is located in the following folder:
- (Windows): /ARinstallDirectory
- (UNIX): /ARSystem/bin
Only an administrator user with permissions to access the file system can change the setting.
The arpayloaddeploymentutil.bat (Windows) or arpayloaddeploymentutil.sh (UNIX) utility stops all the related components services for which the package is provided. After the package is successfully applied, the services are up automatically.
To run the payload deployment utility
- View the payload deployment status. Perform the following:
- Select the deployed package entry, and then select Manage Package > View.
The AR System Deployment Management form opens. - Select Deployment Payload from the table next to the Deployment Package Contents panel.
- Click View Payload Status.
- The AR System Single Point Deployment Status window opens displaying the list of server names in the Host Name column and the package deployment status in the Host Status column.
- If a server's package deployment status shows the Waiting for Utility Run status, connect to the server and run the payload deployment utility. This utility needs to be run on all the servers that has Waiting for Utility Run status.
- Select the deployed package entry, and then select Manage Package > View.
- Run the payload deployment utility, perform the following:
- On the server, set JAVA_HOME to point to the JRE top level folder.
- (UNIX) Ensure that the file deployer service is running.
- To start the service, from the /opt/bmc/ARSystem/midtier/filedeployer/ location, run the ./filedeployer.sh start command.
- To stop the service, from the /opt/bmc/ARSystem/midtier/filedeployer/ location, run the ./filedeployer.sh stop command.
- Run the arpayloaddeploymentutil.bat (Windows) or arpayloaddeploymentutil.sh (UNIX) utility from the following location:
- (Windows): <installDirectory>\Program Files\BMC Software\ARSystem
- (UNIX): <installDirectory>/ARSystem/bin
- If the deployment status is Waiting for Utility Run on servers, repeat steps 2 and 3.
After you run the utility, the package for BMC Remedy IT Service Management is successfully applied to your environment.
Depending on your operating system, the package content types compatible with your operating system are processed. Package entries that are not compatible with your operating system, are skipped from processing and are shown with a Skipped status. For example, if your operating system is Unix and if you deploy a package which has content type for Windows, the package processing is skipped for that server.
Parallel deployment
In a large server group implementation, you can speed up the upgrade process by deploying a package simultaneously across a logical subset of servers.
- When the servers are in the Waiting for utility run state, run the arpayloadutil.bat or arpayloadutil.sh utility simultaneously on all the servers in the logical subset. You need not wait for the status on each server to change to Deployment Success.
- Set the same ranking for a logical subset of servers on the AR System Monitor form. Make sure that the admin server is not a part of this logical subset. For more information about setting monitor ranking see,
- Deploy the package.
Refer to the following screen for information about the AR System Monitor form displaying monitor registration for a cluster of servers:
Parallel rollback
You can also perform a simultaneous rollback for all the packages in a logical sub group. Peform the below steps to start a parallel package rollback:
- Set the same ranking for a logical subset of servers on the AR System Monitor form
- In the AR System Deployment Management console, select a package.
- Click Rollback.
- At the command prompt, run the arpayloadutil.bat or arpayloadutil.sh utility.
All servers in a cluster are rolled back to the previous state.
Rolling back a package
The AR System administrator or a Package Deployer performs the following steps to roll back a package:
- Log in to Mid Tier by using the following URL:
http://<midTierServer>:<port number>/arsys/ - From the IT Home page, select Applications > AR System Administration > AR System Deployment Management Console.
- In the Deployment Management Console, perform the following actions:
- Select the package that has Deployed with Error status.
- Select Operations > Rollback.
- In the confirmation dialog box that is displayed, click Yes.
- (Optional) Click Refresh.
The State of the package changes from Rolling back to Rolled back.
If a package contains binary files, the state of the package is shown as Pending Rollback. - To view the payload deployment status for a package containing binary files, perform the following steps:
- Select the deployed package entry and click Manage Package > View.
The AR System Deployment Management form opens. - Select Deployment Payload from the table next to the Deployment Package Contents panel.
- The Deployment Payload status is shown as Rollback Pending.
- Click the View Payload Status button.
A table that shows the status of the package on all the servers in a server group is displayed.
- Select the deployed package entry and click Manage Package > View.
- Connect to the server that has the Wait for Utility Run status and run the payload utility.
- Repeat steps from i to v on all the servers of a server group from where you want to roll back the package.
After the payload utility is run, the package starts rolling back. You can view the package status on the main AR System Deployment Management Console. If the state changes to Rolled Back, it means that the package rollback is successful.
- Repeat steps from i to v on all the servers of a server group from where you want to roll back the package.