Install API Portal

You can install CA API Developer Portal (API Portal) with or without internet access:
apip42
You can install CA API Developer Portal (API Portal) with or without internet access:
  • When installing with internet access (online), the images are downloaded from 
    Bintray
  • When installing without internet access (offline), the images are packed and require a minimum of 5 GB of disk space to download. 
This article contains the following information:
 
 
2
 
2
 
 
Before You Begin
Before installing, ensure that you have met the following prerequisites:
 
Info:
 If you are performing online installation and using a proxy to download the API Portal image, ensure that you follow the steps that are listed in Docker HTTP/HTTPS proxy documentation.
Prepare for Offline Installation 
This section describes the preparations that you need to install API Portal when there is no internet connection. To facilitate the install, a built-in 
portal
 user account is already set up if you are using the CA hardened OVA.
 
To prepare for offline installation:
 
  1.  Hardware and Software Requirements for compatible versions.
  2. Access your
    /etc/hosts
    file and add 
    jarvis.packages.ca.com
     and 
    apim-portal.packages.ca.com 
    to the end of your local hosts line:
    127.0.0.1 localhost localhost.localdomain localhost4 localhost4.localdomain4 jarvis.packages.ca.com apim-portal.packages.ca.com
    Adding these URLs to your hosts file avoids long timeouts during the Docker import process.
Install and Configure API Portal
Use the following procedure to install in either an online or offline environment.
In this example, the install package is called 
package.gz
, the license file is 
license.xml
, and the user account on the system is named 
portal
.
 
To install and configure CA API Developer Portal:
 
  1. From your workstation, copy the installation package and the license file to the host for your CA API Developer Portal installation:
    scp package.gz [email protected]:/tmp/ scp license.xml [email protected]:/tmp/
  2. The remaining commands are performed on the Portal host.
    Extract the installation package:
    sudo tar zxvf /tmp/package.gz -C /opt/
  3. Move the license file to the portal installation directory:
    mv /tmp/license.xml /opt/package
  4. Change the working directory to the portal installation directory:
    cd /opt/package
  5. Run the 
    config.sh
     script:
    sudo ./config.sh
  6. At the prompts, provide your configuration details for the following parameters:
      4251.png  
    Parameter
    Notes
    PORTAL_DOMAIN
    The domain that is serving the traffic. The PORTAL_TENANT_ID and PORTAL_DOMAIN are combined to form the URL that is used to access the API Developer Portal.
    If the PORTAL_TENANT_ID is apim and the PORTAL_DOMAIN is example.com, the API Developer Portal URL will be https://apim.example.com/ 
     The PORTAL_TENANT_ID default value of 'apim' is hard-coded in the installation script for release 4.2.5.1 and higher, unless it has been specified in portal.conf, in which case the value is preserved with no prompts for the user.
    PORTAL_LICENSE_FILENAME
    The absolute path to the license file.
    For example: /opt/package/license.xml 
    PORTAL_ENROLL_NOTIFICATION_EMAIL 
    The email address that is used when sending notification emails.
    PORTAL_ENABLE_ANALYTICS 
    Option to enable or disable CA Jarvis as part of the installation. Type
    Y
    for yes or
    N
    for no. 
    The following code uses example values.
    APIM Portal configuration . . PORTAL_DOMAIN: example.com PORTAL_LICENSE_FILENAME: /opt/package/license.xml PORTAL_ENROLL_NOTIFICATION_EMAIL: [email protected] PORTAL_ENABLE_ANALYTICS: y Do you want to keep these settings? [Y/n]: y Done.
      42423.png  
     Parameter
    Notes
    PORTAL_TENANT_ID
    The default value of 'apim' is strongly recommended.
    The PORTAL_TENANT_ID and PORTAL_SUBDOMAIN are combined to form the URL that is used to access the API Developer Portal.
    If the PORTAL_TENANT_ID is apim and the PORTAL_SUBDOMAIN is example.com, the API Developer Portal URL will be https://apim.example.com/ 
    PORTAL_SUBDOMAIN
    The domain that is serving the traffic. See PORTAL_TENANT_ID.
    PORTAL_LICENSE_FILENAME
    The absolute path to the license file.
    For example: /opt/package/license.xml 
    PORTAL_ENROLL_NOTIFICATION_EMAIL 
    The email address that is used when sending notification emails.
    PORTAL_ENABLE_ANALYTICS 
    Option to enable or disable CA Jarvis as part of the installation. Type
    Y
    for yes or
    N
    for no. 
    The following code uses example values.
    APIM Portal configuration . . PORTAL_TENANT_ID: apim PORTAL_SUBDOMAIN: example.com PORTAL_LICENSE_FILENAME: /opt/package/license.xml PORTAL_ENROLL_NOTIFICATION_EMAIL: [email protected] PORTAL_ENABLE_ANALYTICS: y Do you want to keep these settings? [Y/n]: y Done.
  7. Confirm. Type
    Y
    to save your configuration.