Deploy the vSphere Integrated Containers Appliance
You install vSphere Integrated Containers by deploying a virtual appliance.
The following services run in the vSphere Integrated Containers appliance:
- vSphere Integrated Containers Registry service
- vSphere Integrated Containers Management Portal service
- The file server for vSphere Integrated Containers Engine downloads and installation of the vSphere Client plug-ins
vic-machine-serverservice, that powers the virtual container host deployment and management wizards in the HTML5 vSphere Client plug-in
You can deploy multiple vSphere Integrated Containers appliances to the same vCenter Server instance. Also, if a Platform Services Controller manages multiple vCenter Server instances, you can deploy multiple appliances to different vCenter Server instances that share that Platform Services Controller.
- You downloaded an official build or an open-source build of the OVA installer. For information about where to download the installer, see Download the vSphere Integrated Containers Installer.
- Verify that the environment in which you are deploying the appliance meets the prerequisites described in Deployment Prerequisites for vSphere Integrated Containers.
Use the Flex-based vSphere Web Client to deploy the appliance. You cannot deploy OVA files from the HTML5 vSphere Client or from the legacy Windows client.
IMPORTANT: In vSphere 6.7, the HTML5 client does not prevent you from deploying OVA files and deployment appears to succeed. However, the resulting appliance does not function correctly due to an issue with the vSphere 6.7 HTML5 client. Always use the Flex-based vSphere Web Client to deploy the appliance OVA, even if you are using vSphere 6.7.
- In the vSphere Web Client, right-click an object in the vCenter Server inventory, select Deploy OVF template, and navigate to the OVA file.
Follow the installer prompts to perform basic configuration of the appliance and to select the vSphere resources for it to use.
- Accept or modify the appliance name
- Select the destination datacenter or folder
- Select the destination host, cluster, or resource pool
- Accept the end user license agreements (EULA)
- Select the disk format and destination datastore
- Select the network that the appliance connects to
On the Customize template page, expand Appliance Configuration.
- Set the root password for the appliance VM. Setting the root password for the appliance is mandatory.
Optionally uncheck the Permit Root Login checkbox.
IMPORTANT: You require SSH access to the vSphere Integrated Containers appliance to perform upgrades. You can also use SSH access in exceptional cases that you cannot handle through standard remote management or CLI tools. Only use SSH to access the appliance when instructed to do so in the documentation, or under the guidance of VMware GSS.
- To use a custom certificate:
- Paste the contents of the appropriate certificate in the Appliance TLS Certificate text box.
- Paste the contents of the certificate key in the Appliance TLS Certificate Key text box. The appliance supports unencrypted PEM encoded PKCS#1 and unencrypted PEM encoded PKCS#8 formats for TLS private keys.
- Paste the contents of the Certificate Authority (CA) file in the Certificate Authority Certificate text box.
- To use a certificate that uses an intermediate CA, see Use a Certificate with an Intermediate CA for the vSphere Integrated Containers Appliance.
- To use auto-generated certificates, leave the Appliance TLS Certificate, Appliance TLS Certificate Key, and Certificate Authority Certificate text boxes blank.
- To use a custom certificate:
In the Appliance Configuration Port text box, optionally change the port on which to publish the vSphere Integrated Containers Getting Started page.
Expand Networking Properties and optionally configure a static IP address and fully qualified domain name (FQDN) for the appliance VM.
To use DHCP, leave the networking properties blank. If you specify an FQDN, the appliance uses this FQDN to register with the Platform Services Controller and runs the Registry, Management Portal, and file server services at that FQDN.
IMPORTANT: If you set a static IP address for the appliance, use spaces to separate DNS servers. Do not use comma separation for DNS servers.
Expand Registry Configuration to configure the deployment of vSphere Integrated Containers Registry.
- In the Registry Port text box, optionally change the port on which to publish the vSphere Integrated Containers Registry service.
- In the Notary Port text box, optionally change the port on which to publish the Docker Content Trust service for vSphere Integrated Containers Registry.
- Optionally check the Garbage Collection check box to enable garbage collection on the registry when the appliance reboots.
(Optional) Expand Management Portal Configuration and optionally change the port on which to publish the vSphere Integrated Containers Management Portal service.
Expand Configure Example Users to configure the ready-made example user accounts that vSphere Integrated Containers creates by default in the Platform Services Controller.
You can use these accounts to test the different user personas that can access vSphere Integrated Containers Management Portal and Registry.
- Uncheck the Create Example Users checkbox if you do not want vSphere Integrated Containers to create user accounts in the Platform Services Controller.
- In the Username Prefix for Example Users text box, optionally modify the prefix of the example user names from the default,
vic. If you unchecked the Create Example Users checkbox, this option is ignored.
In the Password for Example Users text boxes, modify the password for the example user account from the default,
VicPro!23. The new password must comply with the password policy for the Platform Services Controller, otherwise the creation of the example user accounts fails. If you unchecked the Create Example Users checkbox, this option is ignored.
IMPORTANT: If you did not uncheck the Create Example Users checkbox, it is strongly recommended that you change the default password for the example users.
- Click Next and Finish to deploy the vSphere Integrated Containers appliance.
When the deployment completes, power on the appliance VM.
If you deployed the appliance so that it obtains its address via DHCP, go to the Summary tab for the appliance VM and note the address.
(Optional) If you provided a static network configuration, view the network status of the appliance.
- In the Summary tab for the appliance VM, launch the VM console
- In the VM console, press the right arrow key.
The network status shows whether the network settings that you provided during the deployment match the settings with which the appliance is running. If there are mismatches, power off the appliance and select Edit Settings > vApp Options to correct the network settings.
In a browser, go to the vSphere Integrated Containers Getting Started page.
You can specify the address in one of the following formats:
The first two formats redirect automatically to https://vic_appliance_address:9443. If the vSphere Integrated Containers appliance was configured to expose the file server on a different port, the redirect uses the port specified during deployment. If you specify HTTPS, you must include the port number in the address.
Wait for a few minutes to allow the appliance services to start. During this time, you see the message
The VIC Appliance is initializing. When the initialization finishes, the Complete VIC appliance installation panel appears automatically. If you see a page not found error during initialization, refresh your browser.
Enter the connection details for the vCenter Server instance on which you deployed the appliance.
- The vCenter Server address and the Single Sign-on credentials for a vSphere administrator account.
- If vCenter Server is managed by an external Platform Services Controller, enter the FQDN and administrator domain for the Platform Services Controller. If vCenter Server is managed by an embedded Platform Services Controller, leave the External PSC text boxes empty.
IMPORTANT: The installation process requires administrator credentials to register vSphere Integrated Containers Management Portal and Registry with the Platform Services Controller and to tag the appliance VM for use in Docker content trust. Administrator credentials are not stored on the appliance VM after use in the installation process. The vSphere Integrated Containers Management Portal and Registry services cannot start if you do not complete this step.
Click Continue to initialize the appliance.
You see the vSphere Integrated Containers Getting Started page. The Getting Started page includes the following links:
- vSphere Integrated Containers Management Portal
- The download for the vSphere Integrated Containers Engine bundle
What to Do Next
- Download the vSphere Integrated Containers Engine Bundle.
- Install the vSphere Client Plug-ins.
- Log in to vSphere Integrated Containers Management Portal. For information about the management portal, see vSphere Integrated Containers Management Portal Administration.
- If you need to deploy multiple appliances, you can use the initialization API to initialize appliances without manual intervention. For information about the initialization API, see Initialize the Appliance by Using the Initialization API.
- For information about how to access the logs for the appliance, see Access and Configure Appliance Logs.
- If you do not see a green success banner at the top of the Getting Started page after initializing the appliance, the appliance has not initialized correctly. For more information, see Reinitialize the vSphere Integrated Containers Appliance.
- If deployment of the appliance fails, see Troubleshoot vSphere Integrated Containers Appliance Deployment.
- If you see errors when attempting to connect to the Getting Started page or to vSphere Integrated Containers Management Portal, or when downloading the vSphere Integrated Containers Engine bundle, see Troubleshoot Post-Deployment Operation.
- To remove security warnings when you connect to the Getting Started page or management portal, see Obtain the Thumbprints and CA Files of the vSphere Integrated Containers Appliance Certificates and Verify and Trust vSphere Integrated Containers Appliance Certificates.
- If necessary, you can reconfigure the appliance after deployment by editing the settings of the appliance VM. For information about reconfiguring the appliance and other post-installation management tasks, see Manage the vSphere Integrated Containers Appliance.