You can install cAPI on supported Linux Platform. Console mode provides a text-based method for invoking the installation program. This mode is intended for Linux platforms with non-graphics consoles.

Prerequisites

Fulfill the following prerequisites before starting the installation:
  1. Ensure Event store is installed already.
  2. Ensure that minimum 3 node elastic search cluster is already installed.
  3. Ensure java version 1.8+ is already installed.
  4. Ensure bash and curl utility are already installed and installation server is compatible with "sed" command.
  5. Create Client Id and Shared Secret in VIDM for cAPI.

    Refer the cAPI-vIDM Configuration and Authentication.

  6. Copy the "cAPI-install.bin " installer to any directory on the server where cAPI will be installed.

  7. Ensure that you have a login with root privileges to run the installer.
  8. Download the installation file from support.vmware.com and place it in a temporary location on the server.

Procedure

  1. Login to the server as root.
    Logged in with root privileges.
  2. Type bash cAPI-install.bin –i console to run the installer in the console-based installer mode, press Enter.
    Installer introduction appears.
  3. Press Enter to continue.
    Installer Prompts to choose an install folder.
  4. Press Enter to continue.
    This is the location where cAPI will be installed. Default is /opt/cAPI.
  5. If install folder already contains cAPI folder, choose from the following options
    • Enter 1 to override the already installed folder.

      or

    • Enter 2 to choose a new installation directory.

      or

    • Enter 3 to cancel the installation.
  6. Installer prompts for cAPI configuration.
    1. Enter cAPI ADMIN port. Default port 9901.
    2. Enter cAPI Listener port. Default port 10000.
    3. Press Enter to continue.
    Note: The port number must be between 1 to 65535. Otherwise, installer throws validation error and redirects to this step to re-enter the port details.
  7. Installer prompts to enter the cAPI configuration.
    1. Enter VIDM HOST NAME. Default is identitymanager.eng.vmware.com.
    2. Enter the VIDM IP ADDRESS. Default is 127.0.0.1
    3. Enter the VIDM PORT. Default port is 443.
    4. Press Enter to continue.
    Note: If the IP address is wrong or the Port is invalid, installer throws validation error and redirects to the beginning of this step to enter the configurations.
  8. Choose the Elastic Search https Configuration when installer prompts. Default is http.
    • Choose 1 for https and Press Enter to continue.

      or

    • Choose 2 for http and Press Enter to continue.
    Note: 1. For https communication in Elastic search ensure that "esdb.crt" file is available in "/opt/ssl". For configuring https refer Enabling HTTPS In Elastic Search.
    Note: 2. The certificate file esdb.crt should contain certificates from all elastic search instances in a cluster.
  9. Installer prompts for Elastic Search configurations.
    1. Enter the Elastic search IP/fqdn/hostname in the format <IP-ADDRESS/FQDN/HOSTNAME>:<PORT>. In case of cluster, enter the comma separated IP/fqdn/hostname address.
    2. Enter Elastic Search User name and press Enter to continue.

      To enable ES authentication, refer Elasticsearch Authentication.

    Note: Installer throws validation error and redirects to the beginning of this step to enter the configurations if any input fields are left blank.
  10. Enter the Elastic Search Password when installer prompts, press Enter to continue.
    Installer prompts for password confirmation.
  11. Press Enter to continue.
    If the passwords are mismatched, installer throws a validation error and redirects to re-enter the password at step 10.
  12. Enter EventStore configuration when installer prompts.
    1. Enter Event Store IP Address. Default is 127.0.0.1.
    2. Enter Event Store Port. Default is 8080.
    3. Press Enter to continue.
    Note: If the IP address is wrong or the Port is invalid, installer throws validation error and redirects to the beginning of this step to enter the configurations.
  13. Installer prompts to enter the Client Registration configuration.
    1. Provide Client ID. Default is capi_client.
    2. Provide Secret and press Enter to continue.
    Note:

    Client ID and Secret is a one-time configuration of an Oauth2 client that supports password grant on VIDM.

    Refer cAPI-vIDM Configuration and Authentication for configuration details.

    Installer throws an error and redirects to the beginning of this step to enter the configurations if any input filed left blank.

  14. Press Enter to continue the installation when installer shows the pre-install summary.
    Installation continues.
  15. Press Enter to exit the installer when installer shows the installation is completed.
    cAPI is installed.