Skip to content

Commit

Permalink
Documented how to deploy a demo VCH (#397)
Browse files Browse the repository at this point in the history
* structural changes for demo VCH.

* Adding topic about demo VCHs.
  • Loading branch information
stuclem authored Jun 28, 2017
1 parent 0fd7754 commit 0b82f38
Show file tree
Hide file tree
Showing 6 changed files with 90 additions and 15 deletions.
3 changes: 2 additions & 1 deletion docs/user_doc/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
* [Installation](vic_vsphere_admin/installing_vic.md)
* [Download](vic_vsphere_admin/download_vic.md)
* [Deploy the Appliance](vic_vsphere_admin/deploy_vic_appliance.md)
* [Open the Required Ports on ESXi Hosts](vic_vsphere_admin/open_ports_on_hosts.md)
* [Deploy a Demo VCH](vic_vsphere_admin/deploy_demo_vch.md)
* [Installing the Plug-ins](vic_vsphere_admin/install_vic_plugin.md)
* [vCenter Server for Windows](vic_vsphere_admin/plugins_vc_windows.md)
* [vCenter Server Appliance](vic_vsphere_admin/plugins_vcsa.md)
Expand All @@ -28,7 +30,6 @@
* [Deploy VCHs](vic_vsphere_admin/deploy_vch.md)
* [Contents of the vSphere Integrated Containers Engine Binaries](vic_vsphere_admin/contents_of_vic_binaries.md)
* [Environment Prerequisites for VCH Deployment](vic_vsphere_admin/vic_installation_prereqs.md)
* [Open the Required Ports on ESXi Hosts](vic_vsphere_admin/open_ports_on_hosts.md)
* [Deploy a VCH to an ESXi Host with No vCenter Server](vic_vsphere_admin/deploy_vch_esxi.md)
* [Deploy a VCH to a Basic vCenter Server Cluster](vic_vsphere_admin/deploy_vch_vcenter.md)
* [Verify the Deployment of a VCH](vic_vsphere_admin/verify_vch_deployment.md)
Expand Down
4 changes: 1 addition & 3 deletions docs/user_doc/vic_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
If you want to start experimenting with vSphere Integrated Containers straight away, see the following topics:

- [Deploy the vSphere Integrated Containers Appliance](vic_vsphere_admin/deploy_vic_appliance.html)
- [Environment Prerequisites for VCH Deployment](vic_vsphere_admin/vic_installation_prereqs.html)
- [Deploy a VCH to an ESXi Host with No vCenter Server](vic_vsphere_admin/deploy_vch_esxi.html)
- [Deploy a VCH to a Basic vCenter Server Cluster](vic_vsphere_admin/deploy_vch_vcenter.html)
- [Deploy a Demo VCH](vic_vsphere_admin/deploy_demo_vch.md)
- [Deploy a VCH for Use with vSphere Integrated Containers Registry](vic_vsphere_admin/deploy_vch_registry.md)
- [Using vSphere Integrated Containers Registry to Create Projects and Manage Users](vic_dev_ops/using_registry.md)
- [View and Manage VCHs, Add Registries, and Provision Containers Through the Management Portal](vic_dev_ops/vchs_and_mgmt_portal.md)
Expand Down
63 changes: 63 additions & 0 deletions docs/user_doc/vic_vsphere_admin/deploy_demo_vch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Deploy a Demo Virtual Container Host

The vSphere Integrated Containers appliance provides an interactive web installer from which you can deploy a basic virtual container host (VCH). This VCH has limited cabilities and is for demonstration purposes only, to allow you to start experimenting with vSphere Integrated Containers.

The demo VCH has the minimum configuration that deployment to vCenter Server requires. Only the bridge network, public network, image store, and compute resource options are currently supported.

**IMPORTANT**: The demo VCH does not implement any TLS authentication options, and as such is completely unsecured. Do not use the demo VCH in production environments. To deploy VCHs for use in production environments, use the `vic-machine` command line utility.

**Prerequisites**

- You deployed the vSphere Integrated Containers appliance. For information about deploying the appliance, see [Deploy the vSphere Integrated Containers Appliance](deploy_vic_appliance.html).
- You opened port 2377 for outgoing connections on all ESXi hosts in your vCenter Server environment. For information about opening port 2377, see [Open the Required Ports on ESXi Hosts](open_ports_on_hosts.html).
- You must create two distributed port groups, one each for the bridge and public networks, on the vCenter Server instance on which to deploy the VCH. For information about how to create a distributed virtual switch and a port group, see [Create a vSphere Distributed Switch](https://pubs.vmware.com/vsphere-65/topic/com.vmware.vsphere.networking.doc/GUID-D21B3241-0AC9-437C-80B1-0C8043CC1D7D.html) and [Add Hosts to a vSphere Distributed Switch](https://pubs.vmware.com/vsphere-65/topic/com.vmware.vsphere.networking.doc/GUID-E90C1B0D-82CB-4A3D-BE1B-0FDCD6575725.html) in the vSphere documentation.

**NOTE**: When using `vic-machine` to deploy VCHs, if you do not specify a network or port group for the public network, the VCH uses the VM Network by default. However, because the VM Network might not be present, the demo VCH requires that you create a port group for the public network.


**Procedure**

1. Go to https://<i>vic_appliance_address</i>:1337 in your browser and trust the certificate.
2. Enter the IP address and administrator credentials of the vCenter Server instance on which the vSphere Integrated Containers appliance is running and click **Logon**.
4. Use the drop-down menus to select the appropriate resources for each of the required resources.

<table border="1">
<tr>
<th scope="col">Option</th>
<th scope="col">Description</th>
</tr>
<tr>
<td>Bridge Network</td>
<td>Select an existing distributed port group for container VMs use to communicate with each other.</td>
</tr>
<tr>
<td>Public Network</td>
<td>Select a different distributed port group for container VMs use to connect to the internet.</td>
</tr>
<tr>
<td>Image Store</td>
<td>Select a datastore in which to store container images that you pull into the VCH.</td>
</tr>
<tr>
<td>Compute Resource</td>
<td>Select the host, cluster, or resource pool in which to deploy the VCH.</td>
</tr>
</table>
5. (Optional) Modify the name of the VCH to create.
6. Leave **Thumbprint** empty and click **Execute**.

The deployment of the VCH fails, but the certificate thumbprint of the target vCenter Server appears under **Execution Output**.
7. Copy and paste the certificate thumbprint into **Thumbprint** and click **Execute** again.

You can monitor the progress of the VCH deployment under **Execution Output**. Stay on the Installer page until the command finishes. Logs might stop streaming if you switch to other tabs or windows.

**Result**

At the end of a successful deployment, **Execution Output** displays information about the new VCH.


**What to Do Next**

- Connect a Docker client to the VCH and run Docker commands against it. For information about running Docker commands against a VCH, see [Verify the Deployment of a VCH](verify_vch_deployment.md).
- Copy the generated command output under **Create Command** and use it as a template for use with `vic-machine` to create production VCHs. For information about how to deploy production VCHs, see [Using `vic-machine` to Deploy Virtual Container Hosts](deploy_vch.html).
- Go to the at vSphere Integrated Containers Management Portal at https://<i>vic_appliance_address</i>:8282. After creating a VCH, the web installer adds the VCH to the management portal instance that is running in the appliance.
10 changes: 6 additions & 4 deletions docs/user_doc/vic_vsphere_admin/installing_vic.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ You install vSphere Integrated Containers by deploying an OVA appliance. The OVA

The installation process involves several steps.

- Download the OVA from http://www.vmware.com/go/download-vic.
- Deploy the OVA, providing configuration information for vSphere Integrated Containers Registry and vSphere Integrated Containers Management Portal. The OVA deploys an appliance VM that provides the following services:
- [Download the OVA installer](download_vic.md).
- [Deploy the OVA](deploy_vic_appliance.md), providing configuration information for vSphere Integrated Containers Registry and vSphere Integrated Containers Management Portal. The OVA deploys an appliance VM that provides the following services:
- Runs vSphere Integrated Containers Registry
- Runs vSphere Integrated Containers Management Portal
- Makes the vSphere Integrated Containers Engine binaries available for download
- Hosts the vSphere Client plug-in packages for vCenter Server
- Run the scripts to install the vSphere Client plug-ins on vCenter Server.
- Run the command line utility, `vic-machine`, to deploy and manage virtual container hosts.
- Hosts the Web Installer for demo virtual container hosts (VCHs)
- Run the Web Installer to [deploy a demo VCH](deploy_demo_vch.md).
- Run the scripts to [install the vSphere Client plug-ins on vCenter Server](install_vic_plugin.md).
- Run the command line utility, `vic-machine`, to [deploy and manage VCHs in production](deploy_vch.md).
21 changes: 16 additions & 5 deletions docs/user_doc/vic_vsphere_admin/verify_vch_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ After you have deployed a virtual container host (VCH), you can verify the deplo

**Prerequisites**

- You followed the instructions in [Deploy a VCH to an ESXi Host with No vCenter Server](deploy_vch_esxi.md) or [Deploy a VCH to a Basic vCenter Server Cluster](deploy_vch_vcenter.md) to deploy a VCH to either an ESXi host or to a vCenter Server instance.
- You ran `vic-machine create` with the `--no-tlsverify` option.
- You deployed a VCH in one of the following ways:

- You followed the instructions in [Deploy a Demo VCH](deploy_demo_vch.md) to deploy a basic VCH with no security.
- You followed the instructions in [Deploy a VCH to an ESXi Host with No vCenter Server](deploy_vch_esxi.md) or [Deploy a VCH to a Basic vCenter Server Cluster](deploy_vch_vcenter.md), specifying the `--no-tlsverify` option.
- You have installed a Docker client.
- If you deployed the VCH to vCenter Server, connect a vSphere Web Client to that vCenter Server instance.
- If you deployed the VCH to an ESXi host, connect a vSphere Client to that host.
Expand All @@ -22,11 +24,17 @@ After you have deployed a virtual container host (VCH), you can verify the deplo

The vApp or resource pool contains the VCH endpoint VM.

3. Run the `docker info` command to confirm that you can connect to the VCH.<pre>docker -H <i>vch_address</i>:2376 --tls info</pre>
3. Run the `docker info` command to confirm that you can connect to the VCH.

- Demo VCH: <pre>docker -H <i>vch_address</i>:2376 info</pre>
- Deployment with `vic-machine create`: <pre>docker -H <i>vch_address</i>:2376 --tls info</pre>

You should see confirmation that the Storage Driver is ``` vSphere Integrated Containers Backend Engine```.

1. Pull a Docker container image into the VCH, for example, the `BusyBox` container.<pre>docker -H <i>vch_address</i>:2376 --tls pull busybox</pre>
1. Pull a Docker container image into the VCH, for example, the `BusyBox` container.

- Demo VCH: <pre>docker -H <i>vch_address</i>:2376 pull busybox</pre>
- Deployment with `vic-machine create`: <pre>docker -H <i>vch_address</i>:2376 --tls pull busybox</pre>
1. View the container image files in the vSphere Web Client or vSphere Client.

- vCenter Server: Go to **Storage**, right-click the datastore that you designated as the image store, and select **Browse Files**.
Expand All @@ -36,7 +44,10 @@ After you have deployed a virtual container host (VCH), you can verify the deplo

1. Expand the `VIC` folder to navigate to the `images` folder. The `images` folder contains a folder for every container image that you pull into the VCH. The folders contain the container image files.

1. In your Docker client, run the Docker container that you pulled into the VCH.<pre>docker -H <i>vch_address</i>:2376 --tls run --name test busybox</pre>
1. In your Docker client, run the Docker container that you pulled into the VCH.

- Demo VCH: <pre>docker -H <i>vch_address</i>:2376 run --name test busybox</pre>
- Deployment with `vic-machine create`: <pre>docker -H <i>vch_address</i>:2376 --tls run --name test busybox</pre>

1. View the container VMs in the vSphere Web Client or vSphere Client.

Expand Down
4 changes: 2 additions & 2 deletions docs/user_doc/vic_vsphere_admin/vic_installation_prereqs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Environment Prerequisites for VCH Deployment #

Before you deploy vSphere Integrated Containers Engine, you must ensure that your vSphere infrastructure meets the requirements.
Before you deploy virtual container hosts (VCHs), you must ensure that your vSphere infrastructure meets the requirements.

- [Supported Platforms for `vic-machine`](#platforms)
- [Supported vSphere Configurations](#configs)
Expand Down Expand Up @@ -80,7 +80,7 @@ The following network requirements apply to deployment of VCHs to standalone ESX
The following network requirements apply to the deployment of VCHs to vCenter Server:

- Create a distributed virtual switch with a port group for each VCH, for use as the bridge network. You can create multiple port groups on the same distributed virtual switch, but each VCH requires its own port group for the bridge network.
- Optionally create port groups for use as mapped container networks.
- Optionally create port groups for use as mapped container networks, or for the public, management, and client networks.
- All hosts in a cluster must be attached to the port groups that you will use for the VCH bridge network and for any mapped container networks.
- Isolate the bridge network and any mapped container networks. You can isolate networks by using a separate VLAN for each network.

Expand Down

0 comments on commit 0b82f38

Please sign in to comment.