SSGT7J_16.2.0 - Documentation Index
Table of Contents
Welcome
Overview
What's new in IBM Cloud Pak for Integration 16.2.0
Planning
System requirements
Operating environment
Compute resources for development environments
Considerations for high availability
Storage considerations
Deploying multiple IBM Cloud Paks on the same OpenShift cluster
Licensing
Structuring your deployment
Workload placement
Installing on a single node OpenShift (SNO) cluster
Logging
Cluster monitoring
Deploying custom images
Disaster recovery
Additional Services
Installing
Express installation
Adding catalog sources and mirroring images
Mirroring images for an air-gapped OpenShift cluster
Mirroring images with a bastion host
Mirroring images with a portable compute or storage device (file system)
Troubleshooting issues when mirroring images for an air-gapped OpenShift cluster
Adding catalog sources to an OpenShift cluster
Installing the operators
Installing the operators by using the Red Hat OpenShift console
Installing the operators by using the CLI
Finding and applying your entitlement key (online installation)
Finding and applying your entitlement key by using the UI (online installation)
Finding and applying your entitlement key by using the CLI (online installation)
Deploying the Platform UI
Deploying the Platform UI by using the OpenShift console
Deploying the Platform UI by using the CLI
Automated installation
Installing on IBM Cloud
Deploying instances
Deploying an instance by using the Platform UI
Deploying an instance by using the CLI
Deploying a Messaging server by using the CLI
Deploying an assembly canvas by using the CLI
Deploying Automation assets by using the CLI
Deploying end-to-end monitoring by using the CLI
Deploying an API Connect cluster by using the CLI
Deploying the API Manager subsystem by using the CLI
Deploying the API Analytics subsystem by using the CLI
Deploying the API CMS Portal subsystem by using the CLI
Deploying the API Developer Portal subsystem by using the CLI
Deploying the API Gateway subsystem by using the CLI
Using templates to create instances
Installing on Azure Kubernetes Service ( AKS )
Installing operators on AKS
Deploying the Platform UI on AKS
Uninstalling
Uninstalling instances
Uninstalling the Platform UI
Uninstalling the operators and catalog sources
Upgrading
Upgrading from version 16.1.0 or 16.1.3
Managing versions and upgrades by using the Platform UI
Upgrading IBM Cloud Pak foundational services
Upgrading Red Hat OpenShift
Upgrading operators
Upgrading operators by using the OpenShift web console
Upgrading operators using the CLI
Upgrading the Platform UI
Moving to specific catalog sources for each operator
Upgrading instances
Upgrading an API Connect cluster
Upgrading all API Connect cluster subsystems on amd64
Upgrading an API Connect cluster on s390x
Upgrading the instance of API Connect on IBM Z
Upgrading the Gateway subsystem on Linux x86_64
Upgrading the Analytics subsystem on Linux x86_64
Using the Cloud Pak
Using the Platform UI
Configuring the Platform UI
Using the assembly canvas
Managing instances across multiple locations
Configuring instance locations
Configuration for the location agent
Configuring App Connect Enterprise private networks
Saving drafts of instances
Using the Cloud Pak for Integration Agent
Configuring the Cloud Pak for Integration Agent
Legal and operational considerations for the Cloud Pak for Integration Agent
Known limitations of the Cloud Pak for Integration Agent
Applying policies
Connecting different instance types
Using bindings
Using the API and API Product Kubernetes resources
Using the API Kubernetes resource
Using the API Product Kubernetes resource
Managing your APIs
What's new in API Connect
Determining the endpoint URL for the toolkit
Tracking API volume for auditing and compliance
Using AutoTest Assist
Using Federated API management
Using end-to-end monitoring
Creating a service account for authentication
Configuring notification settings for end-to-end monitoring
Getting the OTel endpoint for end-to-end monitoring
Configuring Integration runtime tracing for end-to-end monitoring
Configuring Queue manager tracing for end-to-end monitoring
Configuring API Gateway tracing for end-to-end monitoring
Configuring Event Gateway tracing for end-to-end monitoring
Monitoring end-to-end transactions
External observability platform integration
Configuring external observability platforms
External observability platform configuration reference
Monitoring transactions for failures
Getting quick access to transactions with deep links
Using client certificate authentication with the REST API and IBM MQ Console
The IBM MQ Console and REST API
Creating integration flows
Using Automation assets
Configuring Automation assets
Instantiating Enterprise gateway functionality
Managing Kafka event streams
Using a Messaging server
Using a Queue manager
Socializing your Kafka event sources
Tutorials
Tutorial: Connecting Keycloak to a SAML identity provider
Tutorial: Using the assembly canvas to create messaging workflows with Kubernetes resources
Tutorial: Connect an API Product with an Integration runtime
Tutorial: Setting up end-to-end transaction tracing across instances
Migrating to the Cloud Pak
API Connect transformation guide
Migrating from API Connect v10
Preparing to migrate from API Connect v10
Migrate your v10 data to the new OpenShift cluster
Modernize your API usage
IBM App Connect Enterprise transformation guide
Assess your readiness
Deploy IBM App Connect Enterprise Toolkit integrations to a containerized environment
Prerequisites for deploying a Toolkit integration
Scenario 1: Deploy a Toolkit integration from the Red Hat OpenShift CLI
Scenario 2: Deploy a Toolkit integration from the App Connect Dashboard
Migrate IBM App Connect Enterprise configuration to containers
server.conf.yaml configuration
Policy project configuration
setdbparms.txt configuration
ODBC configuration
AgentX configuration
Truststore configuration
Keystore configuration
IBM DataPower Gateway transformation guide
IBM MQ transformation guide
Troubleshooting
Common issues and solutions
Administering
Developer reference
OpenShift roles and permissions
Identity and access management
Getting the initial administrator password
Managing users and groups
Managing users in Keycloak
Importing LDAP users
Connecting to an OpenID Connect provider
Connecting to a SAML identity provider
Connecting to OpenShift identity
Cloud Pak roles and permissions
Keycloak configuration
Managing users on AKS
Configuring hostnames and certificates
Backing up and restoring IBM Cloud Pak for Integration
Enabling and using logging
Enabling OpenShift Container Platform monitoring
Enabling IBM Instana monitoring
Configuring Keycloak and IBM PostgreSQL
Deploying License Service
Node licensing
Applying fix packs between major releases
Usage metrics
Reference
Operator reference
Container images
Location of images
Downloading container images
Verifying image signatures
Operator and instance versions for this release
Version information for the IBM Cloud Pak for Integration operator
Version information for automation assets
Version information for IBM Cloud Pak for Integration end-to-end monitoring
Cluster-scoped permissions for operators
Cluster-scoped permissions required by the IBM Cloud Pak for Integration operator
Cluster-scoped permissions required by the Automation assets operator
Required cluster-scoped permissions for API Connect
Compliance with U.S. federal government regulations
FIPS compliance
Configuring FIPS support on OpenShift
API Connect cluster FIPS compliance
Automation Assets FIPS compliance
API and API Product FIPS compliance
Platform UI FIPS compliance
Accessibility features
Workload placement for instances
Community resources
Glossary
Regulatory compliance
Legal information
Notices
Terms and conditions for information centers