Skip to content

Commit

Permalink
Migrate bug fixes from 0.8, Docker version, and cosmetic changes (#4126)
Browse files Browse the repository at this point in the history
* Revert "Revert "Migrating bug fixes from 0.8, Docker version, and cosmetic changes""

* Fix typo in set_up_ops_user.md
  • Loading branch information
Anchal Agrawal authored Mar 2, 2017
1 parent 793ec14 commit d08e396
Show file tree
Hide file tree
Showing 23 changed files with 245 additions and 31 deletions.
Binary file added doc/user_doc/Covers/vic_admin_cover.pub
Binary file not shown.
Binary file added doc/user_doc/Covers/vic_app_dev_cover.pub
Binary file not shown.
Binary file added doc/user_doc/Covers/vic_install_cover.pub
Binary file not shown.
Binary file added doc/user_doc/Covers/vic_security_cover.pub
Binary file not shown.
5 changes: 4 additions & 1 deletion doc/user_doc/vic_admin/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@
* [List VCHs and Obtain Their IDs](list_vch.md)
* [Obtain VCH Information](inspect_vch.md)
* [Delete a VCH](remove_vch.md)
* [VCH Delete Options](delete_vch_options.md)
* [VCH Delete Options](delete_vch_options.md)
* [Upgrade a Virtual Container Host](upgrade_vch.md)
* [Virtual Container Host Upgrade Options](upgrade_vch_options.md)
* [Find VCH Information in the vSphere Web Client](vch_portlet_ui.md)
* [Find Container Information in the vSphere Web Client](container_portlet_ui.md)
* [Upgrade the vSphere Integrated Containers Engine Plug-In](upgrade_ui_plugin.md)
* [Access the VCH Admin Portal](access_vicadmin.md)
* [Browser-Based Certificate Login](browser_login.md)
* [Command Line Certificate Login](cmdline_login.md)
Expand Down
2 changes: 1 addition & 1 deletion doc/user_doc/vic_admin/book.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{

"title": "VMware vSphere Integrated Containers Engine 0.8 for vSphere Administrators",

"gitbook": "2.x.x",
"pdf": {
"headerTemplate": "_TITLE_",
"footerTemplate": "_PAGENUM_"
Expand Down
2 changes: 1 addition & 1 deletion doc/user_doc/vic_admin/interop.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can deploy VCHs in vCenter Linked Mode environments.
## vSphere Features Not Supported in This Release
vSphere Integrated Containers Engine does not currently support the following vSphere features:

- vSphere Storage DRS™: You cannot configure VCHs to use datastores that are in Storage DRS clusters.
- vSphere Storage DRS™: You cannot configure VCHs to use Storage DRS datastore clusters. However, you can specify the path to a specific datastore within a Storage DRS datastore cluster by specifying the full inventory path to the datastore in the `vic-machine create --image-store` option. For example, `--image-store /dc1/datastore/my-storage-pod/datastore1`. You can also specify the relative path from a datastore folder in a datacenter, for example `--image-store my-storage-pod/datastore1`.
- vSphere High Availability: You can deploy VCHs to systems that are configured with High Availability, but you cannot use High Availability to fail over the VCHs themselves.
- vSphere Fault Tolerance: You cannot configure Fault Tolerance on VCHs.
- vSphere Virtual Volumes™: You cannot use Virtual Volumes as the target datastores for image stores or volume stores.
Expand Down
2 changes: 1 addition & 1 deletion doc/user_doc/vic_app_dev/book.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Developing Container Applications with VMware vSphere Integrated Containers 0.8",

"gitbook": "2.x.x",
"pdf": {
"headerTemplate": "_TITLE_",
"footerTemplate": "_PAGENUM_"
Expand Down
44 changes: 40 additions & 4 deletions doc/user_doc/vic_app_dev/container_operations.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Supported Docker Commands

vSphere Integrated Containers Engine supports Docker 1.11.2. The supported version of the Docker API is 1.23. If you are using a more recent version of the Docker client, see [Docker Commands Fail with a Docker API Version Error](ts_docker_version_error.md).
vSphere Integrated Containers Engine 0.9 supports Docker 1.13. The supported version of the Docker API is 1.25. If you are using a more recent version of the Docker client, see [Docker Commands Fail with a Docker API Version Error](ts_docker_version_error.md).

- [Docker Management Commands](#mgmt)
- [Image Commands](#image)
- [Container Commands](#container)
- [Hub and Registry Commands](#registry)
- [Network and Connectivity Commands](#network)
- [Shared Data Volume Commands](#volume)
- [Docker Compose Commands](#compose)
- [Swarm Commands](#swarm)

<a name="mgmt"></a>
Expand Down Expand Up @@ -48,12 +49,12 @@
|`diff`|[Inspect changes on a container's filesystem](https://docs.docker.com/engine/reference/commandline/diff/)|No|
|`events`|[Get real time events from the server](https://docs.docker.com/engine/reference/commandline/events/)|No|
|`exec`|[Run a command in a running container](https://docs.docker.com/engine/reference/commandline/exec/)|No|
|export|[Export a container](https://docs.docker.com/engine/reference/commandline/export/)|No|
|`export`|[Export a container](https://docs.docker.com/engine/reference/commandline/export/)|No|
|`kill`|[Kill a running container](https://docs.docker.com/engine/reference/commandline/kill/)|Yes. Docker must wait for the container to shut down.|
|`logs`|[Get container logs](https://docs.docker.com/engine/reference/commandline/logs/)|Yes, vSphere Integrated Container Engine does not yet support `docker logs --timestamps` (`-t`) and `--since` options.|
|`pause`|[Pause processes in a container](https://docs.docker.com/engine/reference/commandline/pause/)|No|
|`port`|[Obtain port data](https://docs.docker.com/engine/reference/commandline/port/)|Yes. Displays port mapping data. <br> vSphere Integrated Container Engine supports mapping a random host port to the container when the host port is not specified.|
|`ps`|[Show running containers](https://docs.docker.com/engine/reference/commandline/ps/)|Yes, vSphere Integrated Containers Engine supports only `-a/--all`, `--no-trunc`, and `-q/--quiet` options.|
|`ps`|[Show running containers](https://docs.docker.com/engine/reference/commandline/ps/)|Yes. Only supports the `-a/--all`, `--no-trunc`, and `-q/--quiet` options.|
|`rename`|[Rename a container](https://docs.docker.com/engine/reference/commandline/rename/)|No|
|`restart`|[Restart a container](https://docs.docker.com/engine/reference/commandline/restart/)|Yes|
|`rm`|[Remove a container](https://docs.docker.com/engine/reference/commandline/rm/)|Yes, vSphere Integrated Containers Engine also removes associated anonymous and regular volumes, supports `-f/--force` option and the <code>name</code> parameter. `docker rm -v` and `docker rm -f` are not supported. To view volumes attached to a container that is removed, use `docker volume ls` and `docker volume inspect <id>`. If you continually invoke `docker create` to make more anonymous volumes, those volumes are left behind after each subsequent removal of that container.|
Expand Down Expand Up @@ -85,7 +86,7 @@ For more information about network operations with vSphere Integrated Containers
| **Command** | **Docker Reference** | **Supported** |
| --- | --- | --- |
|`network connect`|[Connect to a network](https://docs.docker.com/engine/reference/commandline/network_connect/)|Yes, However, this is not supported for running containers.|
|`network create`|[Create a network](https://docs.docker.com/engine/reference/commandline/network_create/)|Yes. See the use case to connect to an external network in [Container Networking with vSphere Integrated Containers Engine](network_use_cases.md). Bridge is also supported.|
|`network create`|[Create a network](https://docs.docker.com/engine/reference/commandline/network_create/)|Yes. See the use case to connect to an external network in [Container Networking with vSphere Integrated Containers Engine](network_use_cases.md). Bridge is also supported.<br><br>The `--label`, `--internal`, and `--ipam` options are currently not supported.|
|`network disconnect`|[Disconnect a network](https://docs.docker.com/engine/reference/commandline/network_disconnect/)|No|
|`network inspect`|[Inspect a network](https://docs.docker.com/engine/reference/commandline/network_inspect/)|Yes|
|`network ls`|[List networks/](https://docs.docker.com/engine/reference/commandline/network_ls/)|Yes|
Expand All @@ -103,6 +104,41 @@ For more information about volume operations with vSphere Integrated Containers
|`volume ls`|[List volumes](https://docs.docker.com/engine/reference/commandline/volume_ls/)|Yes. `--filter` is not supported.|
|`volume rm`|[Remove or delete a volume](https://docs.docker.com/engine/reference/commandline/volume_rm/)|Yes|

<a name="compose"></a>
## Docker Compose Commands ##

vSphere Integrated Containers Engine 0.8 supports Docker Compose version 1.10.

For more information about using Docker Compose with vSphere Integrated Containers Engine, see [Creating a Containerized Application with vSphere Integrated Containers Engine](creating_containerized_app_with_vic.md).

| **Command** | **Docker Reference** | **Supported** |
| --- | --- | --- |
| `build` | [Build or rebuild service](https://docs.docker.com/compose/reference/build/) | No. Depends on `docker build`.|
| `bundle` | [Generate a Distributed Application Bundle (DAB) from the Compose file](https://docs.docker.com/compose/reference/bundle/)| No|
| `config` | [Validate and view the compose file](https://docs.docker.com/compose/reference/config/) | Yes |
| `create` | [Create services](https://docs.docker.com/compose/reference/create/) | Yes |
| `down` | [Stop and remove containers, networks, images, and volumes](https://docs.docker.com/compose/reference/down/) | Yes |
| `events` |[Receive real time events from containers](https://docs.docker.com/compose/reference/events/) | No. Depends on `docker events`.|
| `exec` | [Run commands in services](https://docs.docker.com/compose/reference/exec/) | No. Depends on `docker exec`. |
| `help` | [Get help on a command](https://docs.docker.com/compose/reference/help/) | yes |
| `kill` | [Kill containers](https://docs.docker.com/compose/reference/kill/) | No, but `docker kill` works. |
| `logs` | [View output from containers](https://docs.docker.com/compose/reference/logs/) | Yes |
| `pause` | [Pause services](https://docs.docker.com/compose/reference/pause/) | No. Depends on `docker pause`. |
| `port` | [Print the public port for a port binding](https://docs.docker.com/compose/reference/port/) | Yes |
| `ps` | [List containers](https://docs.docker.com/compose/reference/ps/) | No. Depends on `docker ps --filter`. |
| `pull` | [Pulls service images](https://docs.docker.com/compose/reference/pull/) | Yes |
| `push` | [Pushes images for service](https://docs.docker.com/compose/reference/push/) | No. Depends on `docker push` |
| `restart` | [Restart services](https://docs.docker.com/compose/reference/restart/) | Yes |
| `rm` | [Remove stopped containers](https://docs.docker.com/compose/reference/rm/) | Yes |
| `run` | [Run a one-off command](https://docs.docker.com/compose/reference/run/) | Yes |
| `scale` | [Set number of containers for a service](https://docs.docker.com/compose/reference/scale/) | No. Depends on `docker ps --filter`. |
| `start` | [Start services](https://docs.docker.com/compose/reference/start/) | Yes |
| `stop` | [Stop services](https://docs.docker.com/compose/reference/stop/) | Yes |
| `unpause` | [Unpause services](https://docs.docker.com/compose/reference/unpause/) | No. Depends on `docker unpause`. |
| `up` | [Create and start containers]() | Conditionally supported. Does not work if there are orphaned containers. Depends on `docker rename` and `docker ps --filter`. |
| `version` | Show the Docker-Compose version information | Yes |


<a name="swarm"></a>
## Swarm Commands ##

Expand Down
2 changes: 1 addition & 1 deletion doc/user_doc/vic_app_dev/ts_bridge_pool_mask_error.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ The error in the log states:

You specified a `--bridge-network-range` that cannot accommodate a /16 network. By default, the range is 172.16.0.0/12, which can accept 16 /16 networks.

##Solution
## Solution
Use a bridge network of at least /16 or larger. See [Other Advanced Options](../vic_installation/vch_installer_options.html#adv-other) in the VCH Deployment Options section of *vSphere Integrated Containers Installation*.
6 changes: 3 additions & 3 deletions doc/user_doc/vic_app_dev/ts_docker_version_error.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ After a successful deployment of a vSphere Integrated Containers Engine virtual
## Problem ##
When you attempt to run a Docker command from a Docker client that is connecting to a VCH, the command fails with the following error:
<pre>Error response from daemon: client is newer than server
(client API version: <i>x.xx</i>, server API version: 1.23)</pre>
(client API version: <i>x.xx</i>, server API version: <i>y.yy</i>)</pre>

## Cause ##

This version of vSphere Integrated Containers Engine supports Docker 1.11, that includes version 1.23 of the Docker API. You are using a more recent version of the Docker client, that includes a version of the Docker API that is incompatible.
This version of vSphere Integrated Containers Engine supports Docker 1.13, that includes version 1.25 of the Docker API. You are using a more recent version of the Docker client, that includes a version of the Docker API that is incompatible.

## Solution ##
1. Open a terminal on the system on which you run the Docker client.
2. Set the Docker client API to the same version as the one that is used by vSphere Integrated Containers Engine.

<pre>export DOCKER_API_VERSION=1.23</pre>
<pre>export DOCKER_API_VERSION=1.25</pre>

4. Check that your Docker client can now connect to the VCH by running a Docker command.

Expand Down
4 changes: 2 additions & 2 deletions doc/user_doc/vic_installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Help us to improve the vSphere Integrated Containers documentation.

Copyright &copy; 2017 VMware, Inc. All rights reserved. [Copyright and trademark information](http://pubs.vmware.com/copyright-trademark.html). Any feedback you provide to VMware is subject to the terms at [www.vmware.com/community_terms.html](http://www.vmware.com/community_terms.html).

**VMware, Inc.**
3401 Hillview Ave.
**VMware, Inc.**<br>
3401 Hillview Ave.<br>
Palo Alto, CA 94304

[www.vmware.com](http://www.vmware.com)
2 changes: 2 additions & 0 deletions doc/user_doc/vic_installation/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* [Verify the Deployment of a VCH](verify_vch_deployment.md)
* [VCH Deployment Options](vch_installer_options.md)
* [Advanced Examples of Deploying a VCH](vch_installer_examples.md)
* [Use Different User Accounts for VCH Deployment and Operation](set_up_ops_user.md)
* [Deploy a VCH with vSphere Integrated Containers Registry (Harbor)](deploy_vch_harbor.md)
* [Installing the vSphere Web Client Plug-in](install_vic_plugin.md)
* [vCenter Server For Windows with a Web Server](plugin_vc_web.md)
Expand All @@ -20,6 +21,7 @@
* [vCenter Server Appliance without a Web Server](plugin_vcsa_no_web.md)
* [Verify the Deployment of the Plug-In](plugin_verify_deployment.md)
* [Troubleshooting vSphere Integrated Containers Engine Installation](troubleshoot_vic_install.md)
* [VCH Deployment Times Out](ts_vch_deployment_timeout.md)
* [Certificate Verification Error](ts_thumbprint_error.md)
* [Missing Common Name Error When TLS Options Are Specified](ts_cli_argument_error.md)
* [Firewall Validation Error](ts_firewall_error.md)
Expand Down
2 changes: 1 addition & 1 deletion doc/user_doc/vic_installation/book.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{

"title": "VMware vSphere Integrated Containers Engine 0.8 Installation",

"gitbook": "2.x.x",
"pdf": {
"headerTemplate": "_TITLE_",
"footerTemplate": "_PAGENUM_"
Expand Down
1 change: 1 addition & 0 deletions doc/user_doc/vic_installation/deploy_vch.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ You use the vSphere Integrated Containers Engine `vic-machine` utility to deploy
* [Verify the Deployment of a VCH](verify_vch_deployment.md)
* [VCH Deployment Options](vch_installer_options.md)
* [Advanced Examples of Deploying a VCH](vch_installer_examples.md)
* [Use Different User Accounts for VCH Deployment and Operation](set_up_ops_user.md)
* [Deploy a VCH with vSphere Integrated Containers Registry (Harbor)](deploy_vch_harbor.md)
Loading

0 comments on commit d08e396

Please sign in to comment.