Installing with the Cloud Pak for Applications command-line interface (CLI)
You can use the Cloud Pak installer CLI
install command to install the Accelerators for Teams, Transformation Advisor, and Application Navigator software.
- Before you begin
- Installation steps
- After installation, access the consoles and use the Cloud Pak software.
Before you begin
Ensure that you have a connection to a Red Hat® OpenShift® Container Platform (OCP) cluster, and have cluster-admin permissions. You also need Docker installed to run the Cloud Pak installer. See Preparing for installation.
Upgrading from Cloud Pak 3.x to Cloud Pak 4.x:
- You cannot upgrade a Cloud Pak version 3.x installation directly to version 4.x. Cloud Pak version 4.1.0 requires an OCP version 4.3 cluster and Cloud Pak version 4.1.1 requires an OCP version 4.4 or 4.3 cluster, while Cloud Pak version 3.x requires an OCP version 3.11 cluster.
Upgrading from a previous Cloud Pak 4.x version:
If you are upgrading from version 4.0.x of IBM Cloud Pak for Applications, see Upgrading with the Cloud Pak CLI.
If you are upgrading from version 4.1.0 to 4.1.1, complete the same steps as for installation. To upgrade Accelerators for Teams, Transformation Advisor, and Application Navigator, complete the steps in this topic and run the installer
Important: If you changed settings in the 4.1.0
.yamlinstaller configuration files and will extract the 4.1.1 installation configuration to the same location, back up the changed 4.1.0 files. Add 4.1.0 settings to the 4.1.1 configuration files as needed.
Step 1: Get a key to the entitled registry.
After you order IBM Cloud Pak for Applications, an entitlement key for the Cloud Pak software is associated with your MyIBM account. Use the key to access the Entitled Container Fulfillment Registry.
Get the entitlement key that is assigned to your ID.
- Log in to MyIBM Container Software Library with the IBMid and password that are associated with the entitled software.
- In the Entitlement keys section, select Copy key to copy the entitlement key to the clipboard.
Step 2: Extract the installation configuration from the installer image on the entitled registry.
At a command line, run the following commands. The command examples apply for Linux® and macOS operating systems. For Windows® operating systems, see Running the Cloud Pak CLI on Windows.
Set the entitled registry information. Run
exportcommands that set
cp, and set
ENTITLED_REGISTRY_KEYto the entitlement key that you got from the previous step.
export ENTITLED_REGISTRY=cp.icr.io export ENTITLED_REGISTRY_USER=cp export ENTITLED_REGISTRY_KEY=<apikey>
Log in to the entitled registry with the following
docker login "$ENTITLED_REGISTRY" -u "$ENTITLED_REGISTRY_USER" -p "$ENTITLED_REGISTRY_KEY"
Run the following command to pull down the installer container image and view the license.
docker run -e LICENSE=view \ "$ENTITLED_REGISTRY/cp/icpa/icpa-installer:4.1.1"
You must accept the license before running any installer command. To accept the license pass
-e LICENSE=acceptoption with each command.
Extract the installation configuration. Run the following commands to create the
datadirectory and extract the configuration files to it.
mkdir data docker run -v $PWD/data:/data:z -u 0 \ -e LICENSE=accept \ "$ENTITLED_REGISTRY/cp/icpa/icpa-installer:4.1.1" cp -r "data/*" /data
Step 3: Review the installation configuration files.
Review settings in the
transadv.yaml configuration files, which are in the
data directory. The Cloud Pak installer calculates default values when you run a command.
The default values likely are suitable for your environment. But, if you encounter problems after you run a command in Step 4, you might need to change the configuration values for your environment and then run the command
For example, you might need to specify your OpenShift cluster router subdomain in the
subdomain setting of the
config.yaml configuration file if the installer cannot find your subdomain when a
install command is run. To see what values the installer used for a command, you might need to run the command first and then view the log for the command in the
Note: Default installation does not install Mobile Foundation or Common Services. To install Mobile Foundation, review settings in
mobilefoundation.yaml and run
To install Common Services, review settings in
commonservices.yaml and run
For information about configuration file settings, see Installer configuration files.
Step 4: Run the installer.
The Cloud Pak for Applications installer requires a connection to your OCP cluster. There are two ways to provide the login information to the installer:
If you have the
occlient installed, use the client to log in to your cluster as usual.
oc login https://<your_api_cluster_url> -u <username> -p <password>
Note: To generate a login command with the correct URL and port number, log in to the OpenShift console, click your username, then click Copy Login Command. Paste the copied
oc logincommand into your terminal.
If you do not have the
occlient installed, you can use environment variables to pass in login information.
- If you have a username and password, pass
-e OPENSHIFT_URL=https://<your_api_cluster_url> -e OPENSHIFT_USERNAME=<username> -e OPENSHIFT_PASSWORD=<password>
- If you have a token, pass
-e OPENSHIFT_URL=https://<your_api_cluster_url> -e OPENSHIFT_TOKEN=<token>
- If you have a username and password, pass
(Optional) Run the Cloud Pak for Applications installer
checkcommand to check prerequisites.
docker run -v ~/.kube:/root/.kube:z -u 0 -t \ -v $PWD/data:/installer/data:z \ -e LICENSE=accept \ -e ENTITLED_REGISTRY -e ENTITLED_REGISTRY_USER -e ENTITLED_REGISTRY_KEY \ "$ENTITLED_REGISTRY/cp/icpa/icpa-installer:4.1.1" check
To see details on the check results, view the
check.log.<timestamp>file in the
Run the installer
installcommand to install Accelerators for Teams, Transformation Advisor, and Application Navigator.
docker run -v ~/.kube:/root/.kube:z -u 0 -t \ -v $PWD/data:/installer/data:z \ -e LICENSE=accept \ -e ENTITLED_REGISTRY -e ENTITLED_REGISTRY_USER -e ENTITLED_REGISTRY_KEY \ "$ENTITLED_REGISTRY/cp/icpa/icpa-installer:4.1.1" install
The installer displays progress messages and adds the messages to the
install.log.<timestamp>file in the
logsdirectory. If you encounter problems during installation, see Troubleshooting.
If the installation is successful, the last progress messages have URLs to the Cloud Pak console, the pipelines dashboard, Transformation Advisor, and Application Navigator.
Verify that you can access the Cloud Pak Console:
Click the displayed Cloud Pak Console URL.
On the Cloud Pak Console, click Instance. The Accelerators for Teams instance page provides information about your application stacks and, under Tools, has links to the pipelines dashboard and other tools such as Transformation Advisor and Application Navigator.
Tip: You can also access the Cloud Pak Console from an OpenShift Web Console. Go to the OpenShift Container Platform application console and click Cloud Pak Console from the navigation menu.
Before you start developing applications, set up your environment:
To customize the Accelerators for Teams application stacks and share them with your team, see Setting up application stacks. Code changes are shared only with members of your GitHub Enterprise organization, and are not public. By default, your Kabanero instance is configured with a public set of Kabanero stacks. If needed, you can configure Appsody to get the Accelerators for Teams stack images from the internal Docker registry of your cluster.
From the Cloud Pak Console, click Set up dev tools and configure development tools.
Note: There is a compatibility issue with some versions of Appsody CLI. For more information, see Troubleshooting.
For information about how to use Accelerators for Teams, click Docs and Guides on the Cloud Pak Console or see the Kabanero resources .
For information about how to use Transformation Advisor, see the Transformation Advisor documentation, videos, and web page.
For information about how to use Application Navigator, see Managing the environment or the IBM Application Navigator web page.
The following figure displays the IBM Cloud Pak for Applications Cloud Pak Console.