Prerequisites

Before you install IBM® Planning Analytics Workspace, you must install IBM Planning Analytics Local version 2.0.0 or later.

Planning Analytics Workspace is included as part of IBM Planning Analytics Local. For more information, see the IBM Planning Analytics Local download document for instructions.

If you are using IBM Cognos® Analytics as your authentication provider, then you must have IBM Cognos Analytics 11.2.0 or later installed.

Planning Analytics Workspace communicates with TM1® servers by using the TM1 REST API. In the Tm1s.cfg file for all TM1 Servers, set the HTTPPortNumber property to a free port on the server.

The following list contains information about requirements and the installation kit name for different operating systems that are supported by Planning Analytics Workspace.

Microsoft Windows Server 2022

• The installation kit is ipa_workspace_win_2022_<version>.zip.
• Install Mirantis Container Runtime (https://www.mirantis.com/blog/getting-started-with-mirantis-container-runtime-on-windows-server/).
• You must have at least 100 GB of free space on the C:\ drive for Microsoft Windows Server 2022.
• When you run the start.ps1 script, validation checks run automatically and the host server is repaired if possible. The script checks your Windows Server version, prerequisite software, network configuration, and free ports. It also checks for unsupported anti-virus software that conflicts with Planning Analytics Workspace Local. You can jump directly to Install Planning Analytics Workspace Local on Windows Server 2019 or 2022.

Microsoft Windows Server 2019

• The installation kit is ipa_workspace_win_2019_<version>.zip.
• Install Mirantis Container Runtime (https://www.mirantis.com/blog/getting-started-with-mirantis-container-runtime-on-windows-server/).
• You must have at least 100 GB of free space on the C:\ drive for Microsoft Windows Server 2019.
• When you run the start.ps1 script, validation checks run automatically and the host server is repaired if possible. The script checks your Windows Server version, prerequisite software, network configuration, and free ports. It also checks for unsupported anti-virus software that conflicts with Planning Analytics Workspace Local. You can jump directly to Install Planning Analytics Workspace Local on Windows Server 2019 or 2022.

Red Hat Enterprise Linux® 8 and 9

• The installation kit is ipa_workspace_local_<version>.zip.
• Podman 4.6 or later is required. Any version of Podman provided with a supported version of RHEL is supported.
• Planning Analytics Workspace on Red Hat Enterprise Linux supports non-distributed installation on RHEL 8 or 9 using the Podman container engine and can be installed by either root or a non-root user.

  Rootless Podman containers are supported in Planning Analytics Workspace Local 2.0.103 and later versions.

  Rootless configuration

  Here is an example on how to configure a system service user with no login access that will be used to run Planning Analytics Workspace and enable rootless Podman:

  Note: The following is one example of a configuration. For more information, see Basic setup and Use of Podman in a Rootless Environment.
  1. Create an unprivileged system service user named paw with home in /opt/ibm/paw:

     sudo useradd -r -m -d /opt/ibm/paw -s /sbin/nologin paw

  2. Enable user lingering systemd to allow for user containers to remain after the user exits:

     sudo loginctl enable-linger paw

  3. Rootless Podman requires the run user to have a range of sub-UIDs and sub-GIDs assigned. These are configured in /etc/subuid and /etc/subgid. Review existing range assignments to ensure a unique range is assigned to Planning Analytics Workspace. Here is how to set up paw with range 100000-165535:

     sudo usermod paw --add-subuids 100000-165535 --add-subgids 100000-165535

  4. Enable podman.socket for docker-compose communication with podman (required by Planning Analytics Workspace deployment) and enable the podman-restarts ervice to automatically start Planning Analytics Workspace on system startups:

     sudo -u paw XDG_RUNTIME_DIR=/run/user/$(id -u paw) systemctl enable --user --now podman.socket
     sudo -u paw XDG_RUNTIME_DIR=/run/user/$(id -u paw) systemctl enable --user --now podman-restart.service

  Important: If a user is configured to access both the root and rootless (user-mode) Podman socket, the rootless socket takes priority over the root socket.

  Once installation and startup are complete, Planning Analytics Workspace is available on ports 8000 and 8443.

  To run any management scripts, or upgrade and restore scripts found in the Planning Analytics Workspace installation, it's best to run in a paw system user shell. Switch to a paw user shell by running the following:

  sudo -H -u paw bash

• When you run the start.sh script, validation checks run automatically. You can jump directly to Install Planning Analytics Workspace Local on Red Hat Enterprise Linux.
• For all currently supported Linux distributions, overlay2 is the preferred storage driver and requires no extra configuration. For more information, see Docker storage drivers at https://docs.docker.com/storage/storagedriver/select-storage-driver/.
• Storage requirements can vary, you need at least 100 GB for the /var/lib/docker directory and sufficient space for at least two Planning Analytics Workspace installation packages wherever you choose to install them.