Online installation of IBM Cloud Pak for AIOps on Linux
Learn about installing IBM Cloud Pak for AIOps on Linux.
Overview
You can install a production deployment of IBM Cloud Pak® for AIOps on a Linux® platform, without installing Red Hat® OpenShift® Container Platform.
The deployment is a base deployment that does not have the log anomaly detection and ticket analysis capabilities enabled. You cannot change to an extended deployment post-install. Extended deployments of IBM Cloud Pak for AIOps on Linux are not supported.
The deployment is configured to collect usage data. If you want to disable usage data collection, then you can do this post-install. For more information, see Updating usage data collection preferences.
Limitations
- Starter-size deployments are not supported.
- You cannot upgrade from a deployment on Red Hat OpenShift to a deployment on Linux.
- You cannot upgrade from IBM Cloud Pak for AIOps 4.6.0 or 4.6.1 to 4.7.0. If IBM Cloud Pak for AIOps 4.6.0 or 4.6.1 is already installed, then you must uninstall it before installing 4.7.0.
- The following features and capabilities are only available for deployments of IBM Cloud Pak for AIOps on Red Hat OpenShift, and are not available for deployments of IBM Cloud Pak for AIOps on Linux:
Before you begin
Ensure that you meet the following prerequisites:
- Your cluster meets the hardware and storage requirements that are detailed in Planning an installation of IBM Cloud Pak for AIOps on Linux. The Linux cluster must be reserved for the sole use of IBM Cloud Pak for AIOps, and you must have a minimum of three control planes nodes.
- Local storage is configured in accordance with the instructions in Configuring local volumes.
- You have the credentials for the root user. Root user must be used to install IBM Cloud Pak for AIOps.
- The worker nodes and the client machine that you are running the installation from have network connectivity to the control plane nodes.
- You have a load balancer configured in accordance with the details in Load balancing.
Installation Procedure
The installation procedure requires you to download the aiopsctl
tool, which installs IBM Cloud Pak for AIOps and its prerequisites on your cluster.
1. Retrieve your entitlement key
Obtain the IBM entitlement key that is assigned to your IBMid
. The key is needed to pull the IBM Cloud Pak for AIOps images from the IBM® Entitled Registry.
-
Log in to MyIBM Container Software Library with the IBMid and password details that are associated with the entitled software.
-
In the Entitlement key section, select Copy to copy the entitlement key to the clipboard.
2. Optionally configure a custom certificate
If you want to use your own custom certificate for IBM Cloud Pak for AIOps instead of the default cluster certificate, then use the following steps to create a certificate and key that you can supply as parameters at installation time.
-
Ensure that you have the following three PEM-encoded X.509 certificate files:
caintermediate.pem
: The intermediate certificate that issued your server certificate.aiops.pem
: An IBM Cloud Pak for AIOps certificate, which includes the two fully qualified domain names (FQDNs) foraiops-cpd
andcp-console-aiops
in the Subject Alternative Name (SAN) list.aiops.key.pem
: A key file for the signed certificate in aiops.pem
Tip: You can create the FQDN strings to use for
aiops-cpd
andcp-console-aiops
by prependingcp-console-aiops
andaiops-cpd
to your load balancer's host name. For example, if your load balancer host name isloadbalancerhost.acme.com
, then the FQDN strings arecp-console-aiops.loadbalancerhost.acme.com
andaiops-cpd.loadbalancerhost.acme.com
. -
Concatenate the server and intermediate certificates into one file called
aiops-certificate-chain.pem
.cat aiops.pem caintermediate.pem > aiops-certificate-chain.pem
Note: If you do not install IBM Cloud Pak for AIOps with a custom certificate, you can switch to using a custom certificate after installation. For more information, see Using a custom certificate (IBM Cloud Pak for AIOps on Linux).
3. Create environment variables
Create and then source a shell script that is named aiops_var.sh, which defines the environment variables that are used to provide installation parameters for your deployment. Use the following codeblock as a template, replacing the
brackets < ... >
with values for your environment. It is important that you keep this file.
Important: If you used an alternative path for APP_STORAGE_PATH or PLATFORM_STORAGE_PATH when you set up your local storage in Configuring local volumes, then you must change the values of these environment variables accordingly.
#================================================================================================================================
# IBM Cloud Pak for AIOps installation variables (Linux)
#================================================================================================================================
export TARGET_USER="root"
export ACCEPT_LICENSE=<license_acceptance> # Set to --accept-license to agree to the license terms.
# --------------------------------------------------------------------------------------------------------------------------------
# IBM Entitled Registry
# --------------------------------------------------------------------------------------------------------------------------------
export IBM_ENTITLEMENT_KEY=<ibm-entitlement-key> # Set to the entitlement key retrieved in previous step.
# --------------------------------------------------------------------------------------------------------------------------------
# Hostnames
# `<load_balancer_hostname>` - the hostname of your load balancer
# `<control_plane_node_n>` - the FQDN or IP address of each control plane node. For example, "control_plane_node_1.example.com"
# `<worker_n>` - the FQDN or IP address of each worker node. For example, "worker_1.example.com"
# --------------------------------------------------------------------------------------------------------------------------------
export LOAD_BALANCER_HOST="<load_balancer_hostname>"
export CONTROL_PLANE_NODE="<control_plane_node_1>"
export ADDITIONAL_CONTROL_PLANE_NODES=(
"<control_plane_node_2>"
"<control_plane_node_3>"
)
export WORKER_NODES=(
"<worker_1>"
"<worker_2>"
"<worker_3>"
"<worker_4>"
"<worker_5>"
"<worker_6>"
"<worker_7>"
)
# -------------------------------------------------------------------------------------------------------------------------------
# Storage
# -------------------------------------------------------------------------------------------------------------------------------
export APP_STORAGE_PATH="/var/lib/aiops/storage"
export PLATFORM_STORAGE_PATH="/var/lib/aiops/platform"
Run the following command to source your script and set the environment variables:
. ./aiops_var.sh
4. Install the aiopsctl
tool and register cluster nodes
-
Run the following commands to install
aiopsctl
on your cluster, and then register the control plane nodes and worker nodes.AIOPSCTL_TAR="aiopsctl-linux_amd64.tar.gz" AIOPSCTL_INSTALL_URL="https://github.com/IBM/aiopsctl/releases/download/v4.7.0/${AIOPSCTL_TAR}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} curl -LO "${AIOPSCTL_INSTALL_URL}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} tar xf "${AIOPSCTL_TAR}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} mv aiopsctl /usr/local/bin/aiopsctl echo "Installing main control plane node ${CONTROL_PLANE_NODE}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} aiopsctl cluster node up ${ACCEPT_LICENSE} --role=control-plane --registry-token="${IBM_ENTITLEMENT_KEY}" --app-storage "${APP_STORAGE_PATH}" --platform-storage "${PLATFORM_STORAGE_PATH}" --load-balancer-host="${LOAD_BALANCER_HOST}" K3S_TOKEN=$(ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} aiopsctl cluster node info --token-only) K3S_HOST=$(ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} aiopsctl cluster node info --server-url-only) echo "Installing additional control plane nodes" for CP_NODE in "${ADDITIONAL_CONTROL_PLANE_NODES[@]}"; do ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${CP_NODE} curl -LO "${AIOPSCTL_INSTALL_URL}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${CP_NODE} tar xvf "${AIOPSCTL_TAR}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${CP_NODE} mv aiopsctl /usr/local/bin/aiopsctl ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${CP_NODE} aiopsctl cluster node up ${ACCEPT_LICENSE} --role=control-plane --server-url="${K3S_HOST}" --token="${K3S_TOKEN}" --registry-token="${IBM_ENTITLEMENT_KEY}" --app-storage "${APP_STORAGE_PATH}" --platform-storage "${PLATFORM_STORAGE_PATH}" --load-balancer-host="${LOAD_BALANCER_HOST}" done echo "Installing worker nodes" K3S_LB_HOST="https://${LOAD_BALANCER_HOST}:6443" for WORKER_NODE in "${WORKER_NODES[@]}"; do ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${WORKER_NODE} curl -LO "${AIOPSCTL_INSTALL_URL}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${WORKER_NODE} tar xvf "${AIOPSCTL_TAR}" ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${WORKER_NODE} mv aiopsctl /usr/local/bin/aiopsctl ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} ssh ${TARGET_USER}@${WORKER_NODE} aiopsctl cluster node up ${ACCEPT_LICENSE} --role=worker --server-url="${K3S_LB_HOST}" --token="${K3S_TOKEN}" --registry-token="${IBM_ENTITLEMENT_KEY}" done
Note: The preceding commands install the Red Hat OpenShift CLI (oc) if it is not already installed. If it is already installed, then you must ensure that it is at version 4.14 or higher.
-
Run the following command to see information about your cluster:
aiopsctl cluster node info
Example output:
# aiopsctl cluster node info Node Details Role: Control plane Server URL: https://test-server.acme.com:6443 Token: ***** (Use --show-secrets to reveal token)
-
Check for network connectivity issues.
VMWare vSphere virtual machines (VMs) with Red Hat® Enterprise Linux® can have connectivity issues. If you are not using vSphere VMs for your IBM Cloud Pak for AIOps deployment, then skip this step. Otherwise, run the following lookup command:
nslookup kubernetes.default.svc.cluster.local 10.43.0.10
If the lookup is successful, then proceed to the next step. If the lookup fails, then run the following command on each of your VMs to rectify connectivity problems:
ethtool -K flannel.1 tx-checksum-ip-generic off
For more information, see Installation on Linux fails with network connectivity errors when using
aiopsctl
to install on vSphere VMs.
5. Install IBM Cloud Pak for AIOps
Run the aiopsctl
tool to install IBM Cloud Pak for AIOps.
If you did not configure a custom certificate in step 2 then run the following command:
ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} aiopsctl server up --load-balancer-host="${LOAD_BALANCER_HOST}"
If you configured a custom certificate in step 2 then run the following command:
ssh ${TARGET_USER}@${CONTROL_PLANE_NODE} aiopsctl server up --load-balancer-host="${LOAD_BALANCER_HOST}" --certificate-file aiops-certificate-chain.pem --key-file aiops.key.pem
6. Verify your installation
The installation takes one to two hours to complete. If the installation is unsuccessful, an error message is displayed and a nonzero exit code is returned.
Run the following command to check the status of the components of your IBM Cloud Pak for AIOps installation:
aiopsctl server status
Example output for a healthy installation:
$ aiopsctl status
o- [12 Aug 24 08:40 PDT] Getting cluster status
Control Plane Node(s):
test-server-1.acme.com Ready
test-server-2.acme.com Ready
test-server-3.acme.com Ready
Worker Node(s):
test-agent-1.acme.com Ready
test-agent-2.acme.com Ready
test-agent-3.acme.com Ready
test-agent-4.acme.com Ready
test-agent-5.acme.com Ready
test-agent-6.acme.com Ready
test-agent-7.acme.com Ready
o- [12 Aug 24 08:40 PDT] Checking AIOps installation status
15 Ready Components
cluster
aimanager
lifecycletrigger
aiopsanalyticsorchestrator
baseui
elasticsearchcluster
aiopsedge
rediscp
asm
zenservice
aiopsui
commonservice
kafka
issueresolutioncore
lifecycleservice
AIOps installation healthy
If the installation fails, or is not complete and is not progressing, then see Troubleshooting installation and upgrade and Known Issues to help you identify any installation problems.
7. Access the Cloud Pak for AIOps console
Run the following command on a control plane node to see the URL, username, and password for your IBM Cloud Pak for AIOps deployment.
aiopsctl server info --show-secrets
Example output:
aiopsctl server info --show-secrets
Cluster Access Details
URL: aiops-cpd.test-server.acme.com
Username: cpadmin
Password: abcdefghijklmno
Note: If your cluster is running on a private network, configure your DNS to resolve the hosts for accessing the Cloud Pak for AIOps console. Add the following records to your DNS settings:
<your server node IP> aiops-cpd.<your fully-qualified server domain name>
<your server node IP> cp-console-aiops.<your fully-qualified server domain name>
What to do next
Important: Any commands that use oc
must be run from a control plane node.
- Define integrations and applications with Defining.
- If you have an existing on-premises IBM Tivoli Netcool/OMNIbus deployment, then you can connect it to IBM Cloud Pak for AIOps through an integration. For more information, see Creating IBM Tivoli Netcool/OMNIbus integrations.
- If you have an existing on-premises IBM Tivoli Netcool/Impact deployment, then you can connect it to IBM Cloud Pak for AIOps through an integration. For more information, see Creating IBM Tivoli Netcool/Impact integrations.
To uninstall your IBM Cloud Pak for AIOps on Linux deployment, follow the instructions in Uninstalling a deployment of IBM Cloud Pak for AIOps on Linux.