Installing the API Connect subsystems

Deploy the API Connect subsystem custom resources.

Before you begin

Attention: API Connect is not supported on a FIPS-enabled environment.

Before you install the subsystems, verify that you completed the following prerequisite tasks:

About this task

Use the CR (custom resource) files to install the Management, Gateway, Analytics, and Portal subsystems for your API Connect cloud. CRs are extensions of the Kubernetes API. API Connect installs its subsystems using individual CRs. One CR is deployed per one managed subsystem. The API Connect operator manages the lifecycle of the subsystem CRs and deploys and manages the microservice for each one.

CR templates are provided in the helper_files archive to install each API Connect subsystem. You uncompressed these files into an installation folder of your choosing in Obtaining product files.

The API Connect operators and operands must be at compatible versions of API Connect.
You can deploy multiple instances of API Connect into the same cluster by using different namespaces.
Deploying multiple similar subsystems in a single namespace is not supported. For example, deploying two management subsystems, mgmt1, mgmt2 in a single namespace where API Connect operator is installed.
For more information on Custom Resources in Kubernetes see https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/.
For details on how the API Connect operator manages the CRs using the Kubernetes operator pattern, see https://kubernetes.io/docs/concepts/extend-kubernetes/operator/.
For guidance on choosing object names and IDs in Kubernetes, see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names.

Procedure

Complete each of the following instructions:

Installing the management subsystem.
Installing the gateway subsystem.
Installing the developer portal subsystem.
Installing the analytics subsystem.
When all subsystems are running, verify you can access the API Connect Cloud Manager. Enter the Cloud Manager endpoint URL in your browser.
Tip:
You can find your Cloud Manager endpoint URL as follows:

The property cloudManagerEndpoint is specified in the management CR (management_cr.yaml). When you edited the template, you specified a value for $STACK_HOST:
```
cloudManagerEndpoint:
    annotations:
      cert-manager.io/issuer: ingress-issuer
    hosts: 
    - name: admin.$STACK_HOST
      secret: cm-endpoint
```
The template URL is https://admin.<STACK_HOST>/admin. The /admin suffix at the end is the name of the Cloud Manager administrator.

For example, if $STACK_HOST is myhost.subnet.example.com, the Cloud Manager endpoint URL is:
```
https://admin.myhost.subnet.example.com/admin
```
The first time that you access the Cloud Manager user interface, you enter admin for the user name and 7iron-hide for the password. You will be prompted to change the Cloud Administrator password and email address. See Accessing the Cloud Manager user interface.

What to do next

When you have completed the installation of all required API Connect subsystems, you can proceed to defining your API Connect configuration by using the API Connect Cloud Manager; refer to the Cloud Manager configuration checklist.