Installing the platform hub

Before you begin

Step 1: Obtain your entitlement key

Your entitlement key is available from your IBM account. The installer uses this key to pull container images from the IBM Container Registry automatically during installation.

1. Log in to the container software library on My IBM by using the IBMid and password that are associated with your Concert platform purchase.
2. Go to the Entitlement keys tab.
3. Click Copy to copy the entitlement key to your clipboard.
4. Save the API key in a text file or in a secure location.

You provide this entitlement key as the value for the --registry_password flag when you run the setup command.

Step 2: Download, extract, and export the platform hub software package

1. Download the platform assembly .tar file from the following location:

   https://github.com/IBM/Concert-Platform/releases/download/v3.0.0/ibm-itom-assembly-x86.tar.gz

2. Extract the .tar file and change to the ibm-itom-assembly directory:

   tar -xvf ibm-itom-assembly-x86.tar.gz
   cd ibm-itom-assembly

3. Export the installation directory as an environment variable.

   export INSTALL_DIR={your_installation_directory}/ibm-itom-assembly

   Replace {your_installation_directory} with the name of the directory where you extracted the ibm-itom-assembly directory.

4. Go to the installation directory.

   cd $INSTALL_DIR

Step 3: Configure the params.ini file

The params.ini file defines the environment-specific settings that the installation script uses to configure your Concert platform instance. It follows a standard .ini format with key-value pairs. You can configure this file for your environment by modifying the all-params.ini sample file.

1. Copy the all-params.ini sample parameter file to params.ini.

   cp $INSTALL_DIR/etc/sample-params/all-params.ini $INSTALL_DIR/etc/params.ini

   The all-params.ini sample file provides the default settings that are required for platform deployment. Review the parameters detailed in the next step to determine whether you need to modify them.

2. Edit $INSTALL_DIR/etc/params.ini for your chosen deployment configuration.

   Review the following fields:

   Parameter	Description
   ENABLE_CROSS_PRODUCT_INTEGRATION	Set this parameter to true to install the platform hub with ITOM (the first component of the data access layer) in one step. ITOM is optional for the platform, but required to enable the shared data access layer that supports cross-capability queries and AI features. If your deployment includes multiple capabilities, set this parameter to true. For single-capability deployments that do not require the shared data layer, keep this parameter set to false (default). For more information, see installation components. Note: Concert Protect, Concert Resilience, Data apps, and Workflows run on the core Concert product. These capabilities operate as a single unit and do not require the data access layer to work together. However, if you want to access Concert home and use the platform-level Concert assistant to build custom views, you must install the data access layer.
   PLATFORM_STORAGE_CLASS	Specify the Kubernetes storage class for your platform deployment. For k3s deployments, the system automatically provisions and uses a default storage class and this parameter is not required.
   NAMESPACE	The default namespace for the platform hub is ibm-platform-hub. Optionally, if you need to specify a custom namespace, set this parameter.

   Note: If you need to add the data access layer to an existing platform hub installation, you can install ITOM separately. This approach fits when you expand a single-capability deployment to support multiple capabilities that share data.

   To install ITOM without the platform, copy itom-params.ini instead of the all-params.ini file and save the copy as params.ini:

   cp $INSTALL_DIR/etc/sample-params/itom-params.ini $INSTALL_DIR/etc/params.ini

   This file contains default settings to dopey only the ITOM component when ht platform hub is already deployed. After you copy and rename the file, run the setup script as described in the next step.

Step 4: Run the setup script

1. Run the setup command:

   ./setup --license_acceptance=YES --username={YOUR_USERNAME} --registry_password={ENTITLEMENT_KEY} --password={YOUR_PASSWORD}

   Replace the following values:

   • {ENTITLEMENT_KEY}: The IBM entitlement key from your IBM account. The installer uses this credential to pull container images from the IBM Container Registry.
   • {YOUR_USERNAME}: The default username for the installation. Specify an initial admin username for your platform login.
   • {YOUR_PASSWORD}: The password for the default user. If you omit this parameter, the installer prompts you to enter it.
   • license_acceptance is set to YES by default. Retain this setting to accept the license and enable the platform. For more information, see Platform hub license.
2. Export the platform namespace as an environment variable for later use.

   export HUB_NS=ibm-platform-hub

   If you set a custom namespace, replace ibm-platform-hub with that value when you export this environment variable.

Step 5: Expose the ingress or route

- host: ${HOST_NAME}
  http:
    paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: ibm-solis-hub-gw-svc
            port:
              number: 11443

For Red Hat OpenShift, run the provided ocp-route.sh script to establish the route.

1. Run the script.

   cd $INSTALL_DIR/ibm-platform-hub/bin/ocp-route.sh --namespace=$HUB_NS

2. Retrieve the route created in the previous step.

   oc get routes solis-hub -n $HUB_NS

Step 6: Verify the deployment

After you complete the installation, verify that the deployments in the namespace are available:

kubectl get install -n $HUB_NS

Check that all pods are running:

kubectl get pods -n $HUB_NS

Check for any failing pods:

kubectl get pods -n $HUB_NS | grep -Ev 'Running|Completed'

If you encounter errors during installation, check the installation logs:

$INSTALL_DIR/ibm-itom-assembly/localstorage/logs/product_install_logs_{timestamp}.log

Next steps

After you install the platform hub, install TurboLite to complete the data access layer. See Installing the data access layer.