Procedure

  1. Configure the vCloud Availability for vCloud Director Portal host by running the following command.

    In the following example the vCloud Availability for vCloud Director Portal is configured to operate with a new generated self-signed SSL certificate. You can set up the vCloud Availability for vCloud Director Portal to use an externally signed SSL certificate, by replacing the --keep-self-signed-certificate argument with --https-certificate=/file-path-to-certificate-file and --https-key=/file-path-to-certificate-public-key. The vCloud Availability for vCloud Director Portal appliance provides the certificate and key files to an nginx process.

    Standard Command

    Command Using Registry

    # vcav vcd-ui configure \
    --ui-address=$UI01_ADDRESS \
    --keep-self-signed-certificate \
    --truststore-password-file=~/.ssh/.truststore \
    --vcd-address=$VCD_ADDRESS \
    --vcd-user=$VCD_USER \
    --vcd-password-file=~/.ssh/.vcd \
    --sso-user=administrator@vsphere.local \
    --sso-password-file=~/.ssh/.sso
    # vcav vcd-ui configure \
    --ui-address=$UI01_ADDRESS \
    --keep-self-signed-certificate \
    --truststore-password-file=~/.ssh/.truststore \
    --vcd=vcd-01-name

    The system returns an OK message, after the process finishes.

  2. You allocate small, medium, and large sizes of Java Virtual Memory (JVM) to the vCloud Availability for vCloud Director Portal service process during the deployment of the vCloud Availability for vCloud Director Portal host. You can change the allocated JVM by following the procedure bellow. You must complete steps d. and g. for medium and large deployments. For more information about the vCloud Availability for vCloud Director Portal deployment types and related JVM configuration, see Create vCloud Availability for vCloud Director Portal Host. You can optionally update the allocated JVM by editing the nginx.conf file by completing the following steps.
    1. Use SSH to connect to the vCloud Availability for vCloud Director Portal host.
    2. Use a text editor to open the /opt/vmware/conf/vcav-ui/nginx/nginx.conf file.
    3. The initial size of the memory allocation pool is defined in the following line. Change the numeric value to designate more JVM to the vCloud Availability for vCloud Director Portal host.
      jvm_options "-Xms1024m";
    4. The following line defines the maximum size of memory allocation pool for the nginx process. The numeric value must be equal to or greater than the numeric value you defined in the previous step.
      Important:

      This step required for medium and large vCloud Availability for vCloud Director Portal deployments.

      jvm_options "-Xmx1024m";
    5. You can optionally uncomment the following lines to enable JVM heap dump and define the heap dump file path.
      jvm_options "-XX:+HeapDumpOnOutOfMemoryError";
      jvm_options "-XX:HeapDumpPath=/opt/vmware/logs/vcav-ui/jvm.hprof";
      
    6. By default, the maximum number of concurrent client sessions is set to 1024. To increase this number, use a text editor to open the /usr/lib/systemd/system/vcav-ui.service and add the following line after the [Service] line.
      LimitNOFILE=8192
    7. Restart the vCloud Availability for vCloud Director Portal service to complete this configuration, by running the following command.
      Important:

      This step required for medium and large vCloud Availability for vCloud Director Portal deployments.

      systemctl restart vcav-ui
  3. Configure the nginx process to run for a non-root user.

    The vCloud Availability for vCloud Director Portal host nginx process runs under the system root user by default. You can change the user that the nginx process uses by modifying the vCloud Availability for vCloud Director Portal service script. You can skip this step, if you do not want to edit the nginx process user.

    1. Use SSH to connect to the vCloud Availability for vCloud Director Portal host as root.
    2. Stop the vCloud Availability for vCloud Director Portal service by running the following command.
      # systemctl stop vcav-ui
    3. Use a text editor to modify the /usr/lib/systemd/system/vcav-ui.service file, by adding User=new-user-name line after the [Service] line.
    4. Change the line that provides the PID file location to read PIDFile=/opt/vmware/logs/vcav-ui/vcav-ui.pid.
    5. Using a text editor open the /opt/vmware/conf/vcav-ui/nginx/nginx.conf and change the line that provides the PID file location to read pid /opt/vmware/logs/vcav-ui/vcav-ui.pid.
    6. Change the ownership of the log files that the service uses by running the following commands.
      # chown -R new-user-name /opt/vmware/logs/vcav-ui
      
      # chown -R new-user-name /opt/vmware/vcav-ui/logs
    7. Start the vCloud Availability for vCloud Director Portal service by running the following command.
      # systemctl start vcav-ui
  4. Assign a domain name to your vCloud Availability for vCloud Director Portal host.

    It is a best practice to assign a domain name to your vCloud Availability for vCloud Director Portal VM for production deployments.

  5. Verify that the vCloud Availability for vCloud Director Portal is configured correctly, by running the following command.
    'curl -k https://$UI01_ADDREESS:8443/