This installation procedure describes the steps of cAPI installation in the Graphical Interface.

Prerequisites

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

Procedure

  1. Log in to the server as root.
    Logged in with root privileges.
  2. Type bash cAPI-install.bin –i gui to run the installer in the graphical mode, press Enter.
    Introduction to the installer appears.
  3. Click Next to continue.
    Installer prompts to choose an install folder.
  4. Click Choose.
    This is the location where cAPI will be installed. Default is /opt/cAPI.
  5. Click Next to continue.
    Installer checks if any cAPI folder existing inside install folder.
  6. If install folder already contains cAPI folder, choose from the following options:
    • Click Yes to override the already installed folder.
    • Click No to choose a new Installation directory.
    • Click Cancel to cancel the Installation.
  7. Installer prompts for cAPI configuration.
    1. Enter cAPI ADMIN port. Default port 9901.
    2. Enter cAPI Listener port. Default port 10000.
    3. Click Next 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.
  8. 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 number is 443.
    4. Click Next 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.
  9. Choose the Elastic Search https Configuration when installer prompts. Default is http.
    • Click https radio button for https communication and Click Next to continue.

      or

    • Click http radio button for http communication and Click Next 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.
  10. 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 click Next to continue.
    To enable ES authentication refer the #GUID-53F1D415-D5CE-4795-8F6E-CBA4577DE9FA.
    Note: Installer throws validation error and redirects to the beginning of this step to enter the configurations if any input filed left blank.
  11. Enter the Elastic Search Password when installer prompts, click Next to continue.
    Installer prompts for password confirmation.
  12. Confirm Elastic Search Password when installer prompts for confirmation, click Next to continue.
    If the passwords are mismatched, installer throws a validation error and redirects to re-enter the password at step 11.
  13. 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. Click Next to continue.
    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.
  14. Installer prompts to enter the Client Registration configuration.
    1. Provide Client ID. Default is capi_client.
    2. Provide Secret and click Next to continue.
    Note: Client ID and Secret is a one-time configuration of an Oauth2 client that supports password grant on VIDM. Refer #GUID-AD4F880C-51FC-4155-876A-2BCE2D6EE775 for configuration details.

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

  15. Click Install to continue the installation when displays pre-install summary.
    Installation continues.
  16. Click Done to exit the installer.
    Installer displays installation is completed.