A Simplified Installation Guide for Cloud Pak for Watson AIOps

Note: This is not an IBM project and is provided AS-IS. Support is provided by community collaboration style at best effort only.

Overview

This project is designed to provide an automated, simplified way to install a set of desired components of the Cloud Pak for Watson AIOps, for POC / demo purposes only, on ROKS with classic infra.

Note: The master is meant for version 3.1.1+; for installation of IBM Watson AIOps v2.1.x, please refer to tag 2.1.x

Currently there is a typical set of components included in this installation experience, which takes less than 1.5 hour:

Dependent Common Services (~3mins)
OpenLDAP as the LDAP server, if required (~3mins)
Dependent OpenShift Serverless (~5mins)
AIOps, with aiopsFoundation, aiManager and applicationManager components (~60mins)
Log Management System: Humio (~~5mins), and/or OpenShift Logging (10~~mins)
Turbonomic (10~mins)

Please note that:

By design, the scripts are fully modularized so you can cherry-pick and install the components you want;
Along the way, there might be more components to be added here.

Get Started

0. Prerequisites

CLI tools: oc, helm v3, and jq
You must be authenticated to your OpenShift cluster with admin permissions
IBM Entitled Registry Key

1. Clone the repo and cd to the project folder

$ git clone https://github.com/brightzheng100/cp4waiops-installer.git
$ cd cp4waiops-installer

2. Export configurable variables

There are quite some configurable variables to further customize the installation.

Please check out 00-setup.sh for details.

It's recommended to compile a local bash file so that we can export all customized variables without the need to change any existing files -- a file starting with _ will be ignored by this repository so it's safe to keep it local and private only.

$ cat > _customization.sh <<EOF
#
# IBM Entitled Registry Credential
#
export ENTITLEMENT_KEY="<YOUR KEY GOES HERE>"
export ENTITLEMENT_EMAIL="<YOUR EMAIL GOES HERE>"
EOF

Important Notes:

To simplify things, all of the components are mandatory except below optional yet configurable ones:

Humio: disabled by default, but you can enable it by export HUMIO_ENABLED=true;
Turbonomic: disabled by default, but you can enable it by export TURBONOMIC_ENABLED=true;
OpenShift Logging: disabled by default, but you can enable it by export OPENSHIFT_LOGGING_ENABLED=true;

Meanwhile, to facilitate the retry UX, there is a way to skip some components by exporting a list of SKIP_STEPS.

For example, export SKIP_STEPS="CS LDAP SERVERLESS EXTENSIONS INFRA HUMIO OPENSHIFT_LOGGING" is to instruct the installation process to skip installing anything except AIOPS.

The available named steps are:

CS: Common Services
LDAP: OpenLDAP as the potential dependency when Humio is installed, together with flag HUMIO_WITH_LDAP_INTEGRATED=true
SERVERLESS: OpenShift Serverless
AIOPS: AIOps with aiopsFoundation, aiManager and applicationManager components
EXTENSIONS: AIOps Extensions, if any
INFRA: Infrastructure Automation
HUMIO: Humio log management system
OPENSHIFT_LOGGING: OpenShift Logging (the EFK stack)
TURBONOMIC: Turbonomic application resource management system

Humio requires a dedicated license to be created as a secret for installation, we can explicitly put it as ./_humio_license.txt, or otherwise you will be prompted for it if you've enabled it.

# Copy your Humio license file as _humio_license.txt
$ cat ./_humio_license.txt

# Tune some more parameters and add them into _customization.sh
$ cat >> _customization.sh <<EOF
#
# Enable Humio explicitly, as it's disabled by default
#
export HUMIO_ENABLED=true

#
# Optionally, to further spin up LDAP and integrate it with Humio
#
export HUMIO_WITH_LDAP_INTEGRATED=true
EOF

3. Kick off the installation

# Source the customization we've compiled
$ source _customization.sh

# Make sure we've logged into OCP, then kick it off
$ ./install.sh

A install-<YYYY-mm-dd>.log file will be generated to log the installation activities within the _logs folder under current folder, but you can change the folder by export LOGDIR=<somewhere else>;

4. How to access?

At the end of the installation, the scripts will print out the access info, like URL, username/password, for major components.

But printing out the access info is also doable anytime after installation:

# Source the necessary
source _customization.sh && source 00-setup.sh

# Display how to access IBM Cloud Pak for Watson AIOps console
source 20-aiops.sh
how-to-access-aiops-console

# Display how to access Humio
source 50-humio.sh
how-to-access-humio

What's Next?

There are two major things we shall carry on:

To make our components fully integrated;
To build/use an app to run through an end-to-end demo.

So there will be two guides to be developed along the way:

Integration Guide

TODO

End-to-end Demo Guide

A simple demo guide will be provided to cover some typical use cases.

For example:

A demo app -> logs to Humio -> AI Manager for log integration;
Same demo app -> Event Manager -> AI Manager for event grouping, topology integration.

TODO

Uninstall

To uninstall, run this:

source _customization.sh && source 00-setup.sh

# To uninstall ALL except Common Services and LDAP
./uninstall.sh

# Or to uninstall ALL including Common Services and LDAP
./uninstall.sh all

Note: while hosting multiple Cloud Paks into one cluster, think before you delete the Common Services.

If you want to uninstall specific component(s), you can do this:

source _customization.sh && source 00-setup.sh  && source 99-uninstall.sh

# Uninstall only AIOps components
uninstall-aiops
uninstall-aiops-post-actions

Note: you may have to run ./uninstall.sh multiple times to uninstall all completely.

khongks/cp4waiops-installer