Before you set up VMware Cloud Director Extension for Data Solutions and publish solutions to tenant organizations, you must install the plug-in to VMware Cloud Director.
VMware Cloud Director Extension for Data Solutions is distributed as an ISO package with a name in the format vmware-vcd-ds-v.v.v-nnnnnnnnnn.iso where v.v.v is the product version and nnnnnnnnnn is the build number. For example, vmware-vcd-ds-1.0.0-1234567890.iso.
Prerequisites
- Verify that you have the credentials of a VMware Cloud Director System Administrator account.
- Verify that you have downloaded the installation ISO package for VMware Cloud Director Extension for Data Solutions.
- Verify that you have copied the VMware Cloud Director API endpoint SSL certificate file in the local directory. If you do not have the certificate file, see the Installation command parameters table.
Procedure
- Copy the ISO file to the client machine and upload it to the local file system.
- Mount the ISO package to a new folder.
- For Windows: Right click the ISO file and click Mount.
- For MacOS: Run the following command:
hdiutil mount <FILENAME>.iso -mountroot <FILE_DIRECTORY>
- For Linux: Run the following command:
mount -o loop <FILENAME>.iso <FILE_DIRECTORY>
- To install VMware Cloud Director Extension for Data Solutions, navigate to the folder, which contains the extracted ISO package and run the following command:
- For Windows:
./windows_run.exe create instance --name <EXTENSION_NAME> --encryptionkey <ENCRYPTION_KEY> --host <HOST_NAME> --username <USER_NAME> --password <PASSWORD> --certificate-file <CERTIFICATE_FILE_NAME> --accept
- For MacOS:
./darwin.run create instance --name <EXTENSION_NAME> --encryption-key <ENCRYPTION_KEY> --host <HOST_NAME> --username <USER_NAME> --password <PASSWORD> --certificate-file <CERTIFICATE_FILE_NAME> --accept
or
./darwin-arm64.run create instance --name <EXTENSION_NAME> --encryption-key <ENCRYPTION_KEY> --host <HOST_NAME> --username <USER_NAME> --password <PASSWORD> --certificate-file <CERTIFICATE_FILE_NAME> --accept
- For Linux:
./linux.run create instance --name <EXTENSION_NAME> --encryption-key <ENCRYPTION_KEY> --host <HOST_NAME> --username <USER_NAME> --password <PASSWORD> --certificate-file <CERTIFICATE_FILE_NAME> --accept
The following table describes the parameters values that you must enter.
Note: To see the full list of command parametres, run the following command:
<run> create instance -h
.
Table 1.
Installation command parameters
Parameter |
Description |
EXTENSION_NAME |
The name of the VMware Cloud Director Extension for Data Solutions. |
ENCRYPTION_KEY |
The encryption key to be used for encrypting data. The encryption key can be any string of numbers. |
HOST_NAME |
The name of the VMware Cloud Director host. |
USER_NAME |
The user name of the VMware Cloud Director system administrator. |
PASSWORD |
The password of the VMware Cloud Director system administrator. |
CERTIFICATE_FILE_NAME |
The VMware Cloud Director API endpoint SSL certificate filename. If you do not have the certificate file, run the following command: $ run get certificates --accept --host <HOST_NAME> -o ~/vcd_cert.pem . If you do not trust the VMware Cloud Director certificate, use the following command to trust it: $ run trust --accept --host <HOST_NAME> --username USER_NAME --password PASSWORD --certificate-file ~/vcd_cert.pem |
Example:
windows.run.exe get certificates --accept --host atl1-vcd-static-130-52.eng.vmware.com -o C:\Users\Administrator\Downloads\vcd_cert.pem
windows.run.exe trust --accept --host atl1-vcd-static-130-52.eng.vmware.com --username admin --password vmware --certificate-file C:\Users\Administrator\Downloads\vcd_cert.pem
windows.run.exe create instance --name tds1 --encryption-key 123 --host atl1-vcd-static-130-52.eng.vmware.com --username admin --password vmware --certificate-file C:\Users\Administrator\Downloads\vcd_cert.pem --accept
Results
Once the installation is complete, the following line appears in the console:
Successfully created instance <EXTENSION_NAME>
You are now able to open VMware Cloud Director Extension for Data Solutions from VMware Cloud Director.