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 the installation of the vSphere Client plug-in
The vic-machine-server service, that powers the vSphere Integrated Containers plug-in for the HTML5 vSphere Client.

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. For information about deploying multiple appliances, see Deployment Topologies for the vSphere Integrated Containers Appliance.

By default, the vSphere Integrated Containers plug-in for the vSphere Client is installed automatically. The installer installs the following plug-ins:

A plug-in for the HTML5 vSphere Client on vCenter Server 6.5 and 6.7. The HTML5 plug-in allows you to to deploy and interact with virtual container hosts (VCHs) directly in the vSphere Client.
A basic informational plug-in for the Flex-based vSphere Web Client on vCenter Server 6.0.
NOTE: vSphere Integrated Containers 1.5.2 and later versions do not include the Flex-based vSphere Web Client.

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.

You can also deploy the vSphere Integrated Containers Appliance using the ovftool command line utility. For more information, see Deploy the vSphere Integrated Containers Appliance Using VMware OVF Tool.

Prerequisites

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.
Obtain the vCenter Server certificate thumbprint. For information about how to obtain the certificate thumbprint, see Obtain vSphere Certificate Thumbprints.
If you intend to use a custom certificate for the vSphere Integrated Containers appliance, verify that the certificate meets the criteria described in vSphere Integrated Containers Appliance Certificate Requirements.
If you use vCenter Server 6.7 update 1 or later, you can use the HTML5 vSphere Client to deploy the appliance. If you use an older version of vCenter Server, you must use the Flex-based vSphere Web Client to deploy the appliance. You cannot deploy OVA files from versions of the HTML5 vSphere Client that pre-date vCenter Server 6.7 update 1.
NOTE: Versions of the HTML5 client that pre-date 6.7 update 1 do 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 HTML5 client. This issue is fixed in version 6.7 update 1 of the vSphere Client.

Procedure 1: Deploy the OVA

In the vSphere 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. In vSphere Integrated Containers 1.5.3 and later versions, the root password cannot exceed 128 characters. In earlier versions, the root password cannot exceed 30 characters.
- 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.

Configure the appliance certificate, that is used by all of the services that run in the appliance to authenticate connections.

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:

Paste the contents of the server certificate PEM file in the Appliance TLS Certificate text box.

-----BEGIN CERTIFICATE-----
VIC_appliance_server_certificate_contents
-----END CERTIFICATE-----</pre>

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.
```
-----BEGIN PRIVATE KEY-----
VIC_appliance_private_key_contents
-----END PRIVATE KEY-----</pre>
```

Paste the contents of the Certificate Authority (CA) file in the Certificate Authority Certificate text box.

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 the networking for the appliance VM.
- To set a static IP address on the appliance, set the Network IP Address, Network Netmask, and Default Gateway settings. To use DHCP, leave these properties blank.
- To configure DNS servers, set the Domain Name Servers, and Domain Search Path settings. To use DHCP, leave these properties blank.
  IMPORTANT: Use spaces to separate DNS servers. Do not use comma separation for DNS servers.
- To specify a fully qualified domain name (FQDN) for the appliance, set the FQDN setting. The appliance uses the FQDN to register with the Platform Services Controller and runs the Registry, Management Portal, and file server services at that FQDN. To use DHCP, leave this property blank.
- To specify one or more network time protocol (NTP) servers, set the NTP Servers setting. To use an NTP server provided by DHCP, leave this property blank.
- To configure the appliance to use proxies, and to identify hosts or domains that do not use proxies, set the HTTP Proxy URL, HTTPS Proxy URL, and No Proxy List settings.
  NOTE: If you intend to implement image scanning with Clair in vSphere Integrated Containers Registry, and if your environment uses proxies, you must set both of the HTTP and HTTPS proxy URL settings. This is because the Clair updater requires HTTPS.

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.

Expand the Syslog Configuration to optionally configure the Syslog server to forward the appliance logs.
- In the Remote Syslog Server text box, specify the IP address or host name of the Syslog server that you want to forward the appliance logs to. Leave this property blank if you do not want to forward the logs.
- In the Syslog server protocol property, specify the protocol used by the Syslog server to upload logs. The default protocol is UDP. You can also specify TCP as the protocol. If you specify TCP, the Syslog server must support the TCP protocol.
- In the Syslog Server Port textbox, specify the remote Syslog server port. Default port is 514.
Click Next and Finish to deploy the vSphere Integrated Containers appliance.

Procedure 2: Register the Appliance with vCenter Server

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.
1. In the Summary tab for the appliance VM, launch the VM console
2. 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 appliance welcome page.
You can specify the address in one of the following formats:
- vic_appliance_address
- http://vic_appliance_address
- https://vic_appliance_address:9443
  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.

Enter the root password for the vSphere Integrated Containers appliance, that you set when you deployed the OVA.
To automatically install the vSphere Integrated Containers plug-in for vSphere Client, leave the Install UI Plugin check box selected, and click Continue.
NOTE: By default, in an environment in which multiple vSphere Integrated Containers are deployed to the same vCenter Server instance, the vSphere Integrated Containers plug-in connects to one appliance only. This appliance instance might not be the one that registered most recently with vCenter Server. Consequently, if there are older instances of the appliance registered with vCenter Server and you do not want the plug-in to automatically upgrade to the latest version, deselect the Install UI Plugin check box. You can see version information about the plug-in and the appliance in the Summary tab of the vSphere Integrated Containers plug-in. If you deselect the Install UI Plugin check box, you can install or upgrade the plug-in later.
Verify that the certificate thumbprint for vCenter Server is valid, and click Continue to complete the installation of the appliance.

Result

You see the vSphere Integrated Containers appliance welcome page. The appliance welcome page includes the following links:

vSphere Integrated Containers Management Portal
The download for the vSphere Integrated Containers Engine bundle
Documentation

What to Do Next

If you selected Install UI Plugin, access the vSphere Integrated Containers plug-in for vSphere Client: 1. Log out of the HTML5 vSphere Client and log back in again. You should see a banner that states There are plug-ins that were installed or updated. 2. Log out of the HTML5 vSphere Client a second time and log back in again. 3. Click the vSphere Client logo in the top left corner. 4. Under Inventories, click vSphere Integrated Containers to access the vSphere Integrated Containers plug-in.
If you selected Install UI Plugin, you can Deploy Virtual Container Hosts in the vSphere Client.
If you deselected the Install UI Plugin check box and want to install the plug-in later, see Reinitialize the vSphere Integrated Containers Appliance.
Download the vSphere Integrated Containers Engine bundle and start using vic_machine to deploy virtual container hosts.
Log in to vSphere Integrated Containers Management Portal. For information about the management portal, see vSphere Integrated Containers Management Portal Administration.

Troubleshooting

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 appliance welcome 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 appliance welcome 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 appliance welcome page or management portal, see Obtain the Thumbprint and CA File of the vSphere Integrated Containers Appliance Certificate and Verify and Trust vSphere Integrated Containers Appliance Certificate.
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.

Deploy the Appliance