Quick reference Q&A for offline deployments

You can create an air gapped installation of Cloud Pak for Business Automation by preparing a host, mirroring the image registry, and by using the ibm-pak CLI.

Read each question in the order that they appear, and go to the next question only after you complete all the relevant steps.

Before you begin

Review what you need to know before you begin a production installation. You must plan your production deployment even more so than a starter deployment. You must consider properly what you want to install, what software you need, and what type of storage to use. Use the following links to read up on the things that you need to know beforehand.

When you are ready to move to the next step, answer the following questions to help you complete the necessary tasks.

Tip: Many of the links in the tables leave the page and send you forward in the table of contents. If you want to continue to use the quick reference, it is important that you come back to the next question after you complete the relevant steps. You can right-click a link to open the page in a new tab or window, but remember to close them when you are done to prevent having too many pages open.

Question 1: Does your cluster already have storage classes that you can use?

Check that you have storage that works with the Capabilities for production deployments that you plan to install.

Options What to do
You have the supported storage

Go to Question 2: Do you have your IBM entitlement key?
You do not have any supported storage

a) Decide which storage classes you want to use.

b) Make sure that you have dynamic storage provisioning for the cluster, see Storage considerations.

c) Go to Question 2: Do you have your IBM entitlement key?

Question 2: Do you have your IBM entitlement key?

The Cloud Pak for Business Automation container images are hosted on the IBM Entitled Registry. To access the images, you must have your IBM entitlement key.

Options What to do
You have your IBM entitlement key

Go to Question 3: Do you need to prepare a host to mirror images?.
You do not have your IBM entitlement key

a) Log in to MyIBM Container Software Library with the IBMid and password that is associated with the entitled software. In the Container software library tile, verify your entitlement on the View library page, and then go to Get entitlement key to retrieve the key. Remember to take a note of the key so that you can enter it when you create the deployment.

b) Go to Question 3: Do you need to prepare a host to mirror images?

Question 3: Do you need to prepare a host to mirror images?

You can store everything that you need to install Cloud Pak for Business Automation on a host and use it, or use it to transfer the images, in an air gap environment.

Options What to do
Setting up a host

a) Follow the steps in Setting up a host to mirror images to a private registry.

b) Go to Question 4: How do you mirror the image registry?

Question 4: How do you mirror the image registry?

If this is the first time the Cloud Pak is installed in an air gap environment, then you do need to mirror the image registry.

Options What to do
Setting up a mirror image registry

a) Follow the steps to complete the setup by using Downloading the CASE files.

b) Follow the steps to complete the setup by using Option 1: Mirroring catalogs to a private registry by using oc mirror.

c) Go to Question 5: How do you install the Cloud Pak operator?

Question 5: How do you install the Cloud Pak operator?

If this is the first time the Cloud Pak is installed in an air gap environment, then you do need to install the Cloud Pak catalog and operator.

Options What to do
Installing the Cloud Pak catalog and an operator instance

a) Follow the steps to complete the setup by using Installing the Cloud Pak catalog and operator instances.

b) Go to Question 6: How do you prepare for the capabilities that you want to install?

Question 6: How do you prepare for the capabilities that you want to install?

Each capability that you want to install must be prepared for before you apply your custom resource.

Options What to do
Prepare your data sources, secrets, and PVCs for each capability in your deployment

a) Follow the steps to prepare your data sources, secrets, and PVCs by using Preparing your chosen capabilities.

b) Go to Question 7: How can you create a production deployment?

Question 7: How can you create a production deployment?

You can install the capabilities that you want by using the Operator Form view of the Cloud Pak operator in the OCP console or by running the deployment script.

Options What to do
Create a production deployment in the OCP console

a) Follow the steps to create a custom resource by using Option 1: Installing a production deployment in the OpenShift console.

b) Follow the steps to configure your custom resource in the YAML View by using Checking and completing your custom resource.

c) Create the deployment instance.

d) Follow the steps in Completing post-installation tasks.

e) Go to Question 8: How do you troubleshoot your production deployment?
Create a production deployment by using the deployment script

a) Follow the steps to complete the installation of the production deployment by using Option 2a: Generating the custom resource with the deployment script.

b) Follow the steps to configure your custom resource in the YAML View by using Checking and completing your custom resource.

c) Follow the steps in Option 2b: Deploying the custom resource you created with the deployment script.

d) Follow the steps in Completing post-installation tasks.

e) Go to Question 8: How do you troubleshoot your production deployment?

Question 8: How do you troubleshoot your production deployment?

See Troubleshooting if you encounter problems with the production deployment.