IBM Streams 4.3.0

Creating and deploying a resource installation package for an IBM Streams enterprise domain

If you are using IBM® Spectrum Symphony® or a user-defined resource manager to manage resources in your enterprise domain, you can use this procedure to create a resource installation package and deploy that package on all of the externally managed resources that you want to add to the domain.

If you are using Apache Hadoop YARN or the default IBM Streams resource manager to manage resources, use the following procedures:

To use YARN, see Setting up Apache Hadoop YARN for IBM Streams.
To use the default IBM Streams resource manager, see Creating a domain host installation package for an IBM Streams enterprise domain.

Both IBM Streams resources and externally managed resources can be used together in a domain.

Before you begin

Install the main installation package for IBM Streams on at least one resource. The main installation package includes all of the product files. To reduce the product size requirement on resources, the resource installation package contains a subset of the IBM Streams product files. For example, this package does not contain Streams Studio, Streams for Excel, and the toolkits.
Note: If you installed the main installation package on a shared file system that is accessible by all resources in the domain, you do not need to create and deploy a resource installation package. To add resources to the domain, see Adding externally managed resources to an IBM Streams enterprise domain.
Set up the external resource manager for IBM Streams.
Requirements for installing the resource installation package:
- The installation script does not check that the hardware, software, and other preinstallation requirements for installing IBM Streams are satisfied. Ensure that you have satisfied these requirements before installing IBM Streams on the externally managed resources. Otherwise, the installation might not be successful or the product might not run. For example, the installation will fail if there is not enough storage. If there are missing software dependencies, the product might not run.
- If you run the installation script with root authority, the user ID and group that own the installation must exist before running the script. Otherwise, the script will fail and indicate that the user ID and group are missing. The root user cannot own the installed files.
- The installation script creates the specified root installation directory and any parent directories that do not exist. You must have write permission for the last existing parent directory. For example, if you install the product in the /opt/ibm/InfoSphere_Streams directory and the ibm directory does not exist, you must have write permission for the opt directory. If the product version is already installed in the specified installation directory, the default behavior is that the script fails with exit code 1. For any other error, the script exits with exit code 2.
- If you are installing the package in the same root directory as a previous product version, you must be the installation owner of the previous version. If you are installing the package with root authority, you must specify the same installation owner as the previous version.

Procedure

Create the resource installation package by entering the following command:
```
  streamtool mkresourcepkg
```
The default location of the generated package is the current directory. For a different directory, specify the --pkg-dir pathname command option.
For more information about this command, enter streamtool man mkresourcepkg.
The resource installation package contains the following files:
- deployment.xml: This file is used by Spectrum Symphony only. It helps to simplify the installation process when you use the Spectrum Symphony rsdeploy command.
- Installation script files:
  - streamsresourceinstall.sh: This script file is used to install the IBM Streams product on the externally managed resources with the same options that you specified on the streamtool mkresourcepkg command.
  - streamsresourcesetup.sh: This script file is used to install the IBM Streams product on the externally managed resources if you want to change any options that you specified on the streamtool mkresourcepkg command.
- streamsresourceuninstall.sh: This script file is used to uninstall the IBM Streams product on the externally managed resources.
Deploy the resource installation package on the externally managed resources. The method for deploying the package depends on the external resource manager that you use.
- IBM Spectrum Symphony: A consumer that has the execution user set to root deploys and installs the package by using the Spectrum Symphony rsdeploy command.
  1. Enter the following command to access the Spectrum Symphony commands:
```
source /opt/ibm/platformsymphony/profile.platform
```
  2. On the Spectrum Symphony cluster master resource, enter the following command to add the resource installation package to the Spectrum Symphony rsdeploy repository.
```
rsdeploy add package-name -p path-to-package -u user -x password
```
  3. Enter the following command to download and install the resource installation package to all resources in a resource group. You can specify multiple resource groups on the same command.
    Note: If you add resources to a resource group, you must run the rsdeploy install command again to install the package on these resources.
```
rsdeploy install package-name -c path-to-root-consumer -r resource-group -u user -x password
```
  4. To check the status of the installation, enter the following command:
```
rsdeploy status package-name -u user -x password
```
  The following rsdeploy commands are available if you need to uninstall the package or remove it from the rsdeploy repository.
  - To uninstall the IBM Streams product on all the resources in a resource group, enter the following command.
    Important:
    Before uninstalling the product, stop all domains. If the product is uninstalled while a domain is running, the services on the resources might fail and be unavailable.
    
    Do not remove the resource installation package from the rsdeploy repository until after you uninstall the product.
```
rsdeploy uninstall package-name -c path-to-root-consumer -r resource-group -u user -x password
```
  - To check the status of the uninstallation, enter the following command:
```
rsdeploy status package-name -u user -x password
```
  - To remove the package from the rsdeploy repository, enter the following command:
```
rsdeploy remove package-name -u user -x password
```
- User-defined resource manager: Deploy and install the package manually.
  1. Copy the package to the externally managed resources.
  2. Extract the contents of the package by entering tar -xvf resource-installation-package-name.tar.
  3. Install the IBM Streams product.
    - To install the product with the same options that you specified on the streamtool mkresourcepkg command, run the streamsresourceinstall.sh script file.
    - If you want to change any options that you specified on the streamtool mkresourcepkg command, run the streamsresourcesetup.sh script file.

What to do next

Add the externally managed resources to the domain.