First steps for deploying in a VMware environment
The first steps in deploying in a VMware environment are to obtain the API Connect distribution files and to create a project directory.
Before you begin
About this task
In these First Steps, you will use the apicup
command to create a project
directory that contains the configuration file apiconnect-up-v10.yml
. When you
configure the first subsystem, such as the Management Service, the subsystem configuration settings
are placed in the file.
When you want to configure a second subsystem, it is important that you reuse the same project
directory. This means that you only need to download apicup
once, and create a
project directory once. The configuration settings for the second subsystem are added to the
existing apiconnect-up-v10.yml
. In this way, the second subsystem, such as
Developer Portal, can access the configuration information needed to interact with the first
subsystem.
After completing these First Steps, follow the links to instructions for configuring your subsystem. You will specify configuration settings, create an ISO of the subsystem configuration, and then use VMware to deploy the distribution file (.ova file) for the subsystem with your ISO. Note that you create a separate ISO for each subsystem.
Installation and configuration of DataPower® Gateway on an appliance (physical or virtual) is completed after you install the API Connect subsystems. For the gateway service in a VMware environment, use the instructions in Deploying DataPower Gateway virtual appliance.
- For upgrades, do not use the procedures on this page. See Upgrading API Connect.
- Some
apicup
commands have changed from previous versions of API Connect. See What's new for v10 installation. - When maintaining API Connect, do not use
kubectl exec
commands to access API Connect pods unless advised by IBM.Do not make any changes on the deployed VMs unless documented here or otherwise advised by IBM. Attempting to manually update packages, adding new users, or installing new software will likely cause problems. Operating system updates are handled by API Connect fix packs.