Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Doc updates for Create VCH Wizard #1259

Merged
merged 40 commits into from
Jan 17, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
6bdb48e
Reorg and updates for the VCH deployment wizard
stuclem Nov 29, 2017
5f8f744
Removed note about only VI admins seeing button
stuclem Dec 4, 2017
34e8df5
Overhauling for VCH creation wizard
stuclem Dec 4, 2017
f1eeba1
First wave of updates for storage
stuclem Dec 5, 2017
bc83cd2
More storage updates and layout adjustments
stuclem Dec 5, 2017
207d177
More storage updates
stuclem Dec 6, 2017
2c792ec
More updates about volume stores
stuclem Dec 7, 2017
7aa2f43
Networking updates
stuclem Dec 8, 2017
2a09304
More networking updates
stuclem Dec 8, 2017
944279c
Clarified storage req.
stuclem Dec 12, 2017
39d0f87
Beefed up note about using a DPG for public
stuclem Dec 12, 2017
d0ed58e
Beefed up recommendation about using DPG for public
stuclem Dec 12, 2017
8a3f19f
Making sure that all hosts can access networks.
stuclem Dec 12, 2017
a193a2e
More VCH create updates
stuclem Dec 12, 2017
67a21c6
Many more networking updates
stuclem Dec 13, 2017
20f11b6
More network settings....
stuclem Dec 13, 2017
66dc0a2
Updated summaries for PDF generation
stuclem Dec 13, 2017
3eda8fc
General edits, added firewall policy.
stuclem Dec 14, 2017
c36adfb
More security updates
stuclem Dec 22, 2017
40df7fc
Happy Christmas!
stuclem Dec 22, 2017
fde3a10
Clarified port group use for public network
stuclem Dec 28, 2017
ebda2e7
Further reorg and rewrites in security section.
stuclem Jan 3, 2018
ec5987d
More security updates
stuclem Jan 5, 2018
49d229e
More security and registry updates
stuclem Jan 5, 2018
8430281
Hopefully last wave of security updates.
stuclem Jan 7, 2018
8135723
Updated registry server doc
stuclem Jan 7, 2018
7b22248
Starting ops user
stuclem Jan 8, 2018
983456e
Updated photon example and ops user
stuclem Jan 8, 2018
e021737
Small fixes
stuclem Jan 8, 2018
7c1d6e2
Comment from Hasan
stuclem Jan 8, 2018
b568668
Comments from Hasan on networking
stuclem Jan 9, 2018
01b0940
Comments from Luca on ops-user
stuclem Jan 9, 2018
96227ff
Formatting fix
stuclem Jan 9, 2018
abb98a3
Fixed a bunch of broken links
stuclem Jan 9, 2018
0d7c45b
Fixing conflict
stuclem Jan 9, 2018
c6514f4
Comments from Zach and Angie
stuclem Jan 11, 2018
57cc742
Comments from Zach on compute resource
stuclem Jan 15, 2018
49e0449
Comments from Anchal and Zach
stuclem Jan 15, 2018
7c7ad86
Merge branch 'master' into vchui
stuclem Jan 17, 2018
dd34dfd
Merge branch 'master' into vchui
stuclem Jan 17, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user_doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This information is intended for the following audiences:

----------

Copyright © 2016, 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).
Copyright © 2016-2018 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.**<br>
3401 Hillview Ave.<br>
Expand Down
54 changes: 27 additions & 27 deletions docs/user_doc/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,35 +24,35 @@
* [vCenter Server for Windows](vic_vsphere_admin/plugins_vc_windows.md)
* [vCenter Server Appliance](vic_vsphere_admin/plugins_vcsa.md)
* [Deploy VCHs](vic_vsphere_admin/deploy_vch.md)
* [Open the Required Ports on ESXi Hosts](vic_vsphere_admin/open_ports_on_hosts.md)
* [Obtain Certificate Thumbprints](vic_vsphere_admin/obtain_thumbprint.md)
* [Deploy a Basic VCH](vic_vsphere_admin/deploy_basic_vch.md)
* [Using vic-machine](vic_vsphere_admin/using_vicmachine.md)
* [Running Commands](vic_vsphere_admin/running_vicmachine_cmds.md)
* [Obtain Certificate Thumbprints](vic_vsphere_admin/obtain_thumbprint.md)
* [Set Environment Variables](vic_vsphere_admin/vic_env_variables.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)
* [VCH Deployment Options](vic_vsphere_admin/vch_installer_options.md)
* [VCH Placement](vic_vsphere_admin/vch_placement.md)
* [Set Environment Variables](vic_vsphere_admin/vic_env_variables.md)
* [VCH Security](vic_vsphere_admin/vch_security.md)
* [Auto-Generated Certificates](vic_vsphere_admin/tls_auto_certs.md)
* [Custom Certificates](vic_vsphere_admin/tls_custom_certs.md)
* [Unrestricted Access](vic_vsphere_admin/tls_unrestricted.md)
* [Different User Accounts](vic_vsphere_admin/set_up_ops_user.md)
* [VCH Networking](vic_vsphere_admin/vch_networking.md)
* [Public Network](vic_vsphere_admin/public_network.md)
* [Bridge Networks](vic_vsphere_admin/bridge_network.md)
* [Client Network](vic_vsphere_admin/client_network.md)
* [Management Network](vic_vsphere_admin/mgmt_network.md)
* [Container Networks](vic_vsphere_admin/container_networks.md)
* [Static IP Address](vic_vsphere_admin/vch_static_ip.md)
* [Proxy Servers](vic_vsphere_admin/vch_proxy.md)
* [VCH Storage](vic_vsphere_admin/vch_storage.md)
* [Image Store](vic_vsphere_admin/image_store.md)
* [Volume Stores](vic_vsphere_admin/volume_stores.md)
* [Connect VCHs to Registries](vic_vsphere_admin/vch_registry.md)
* [VCH Appliance Configuration](vic_vsphere_admin/vch_config.md)
* [Container VM Configuration](vic_vsphere_admin/containervm_config.md)
* [Debugging VCH Deployment](vic_vsphere_admin/vch_debug_deployment.md)
* [VCH Boot Options](vic_vsphere_admin/vch_boot_options.md)
* [Deploy VCHs in vSphere Client](vic_vsphere_admin/deploy_vch_client.md)
* [General Settings](vic_vsphere_admin/vch_general_settings.md)
* [Compute Capacity](vic_vsphere_admin/vch_compute.md)
* [Storage Capacity](vic_vsphere_admin/vch_storage.md)
* [Image Datastore](vic_vsphere_admin/image_store.md)
* [Volume Datastores](vic_vsphere_admin/volume_stores.md)
* [Networks](vic_vsphere_admin/vch_networking.md)
* [Bridge Networks](vic_vsphere_admin/bridge_network.md)
* [Public Network](vic_vsphere_admin/public_network.md)
* [Client Network](vic_vsphere_admin/client_network.md)
* [Management Network](vic_vsphere_admin/mgmt_network.md)
* [Proxy Servers](vic_vsphere_admin/vch_proxy.md)
* [Container Networks](vic_vsphere_admin/container_networks.md)
* [Security](vic_vsphere_admin/vch_security.md)
* [VCH Certificate Options](vic_vsphere_admin/vch_cert_options.md)
* [Disable Client Verification](vic_vsphere_admin/tls_unrestricted.md)
* [Registry Access](vic_vsphere_admin/vch_registry.md)
* [Operations User](vic_vsphere_admin/set_up_ops_user.md)
* [Manually Create a User Account for the Operations User](vic_vsphere_admin/ops_user_manual.md)
* [Finish VCH Deployment](vic_vsphere_admin/complete_vch_deployment_client.md)
* [Deploy VCH for dch-photon](vic_vsphere_admin/deploy_vch_dchphoton.md)
* [VCH Administration](vic_vsphere_admin/vch_admin.md)
* [Interoperability](vic_vsphere_admin/interop.md)
Expand All @@ -66,10 +66,10 @@
* [Obtain General VCH Information and Connection Details](vic_vsphere_admin/inspect_vch.md)
* [Obtain VCH Configuration Information](vic_vsphere_admin/inspect_vch_config.md)
* [Configure Running VCHs](vic_vsphere_admin/configure_vch.md)
* [Delete VCHs](vic_vsphere_admin/remove_vch.md)
* [Debug Running VCHs](vic_vsphere_admin/debug_vch.md)
* [Enable Shell Access](vic_vsphere_admin/vch_shell_access.md)
* [Authorize SSH Access](vic_vsphere_admin/vch_ssh_access.md)
* [Delete VCHs](vic_vsphere_admin/remove_vch.md)
* [VCH Admin Portal](vic_vsphere_admin/access_vicadmin.md)
* [Browser-Based Certificate Login](vic_vsphere_admin/browser_login.md)
* [Command Line Certificate Login](vic_vsphere_admin/cmdline_login.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_app_dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This information is intended for DevOps administrators and container application

----------

Copyright &copy; 2016, 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).
Copyright &copy; 2016-2018 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.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_app_dev/configure_docker_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ DOCKER_HOST=<i>vch_address</i>:2376</pre>
- TLS authentication with server certificates without client authentication:<pre>DOCKER_HOST=<i>vch_address</i>:2376</pre>
- No `env` file is generated if the VCH does not implement TLS authentication.

For information about how to obtain the `env` file, see [Obtain a VCH](obtain_vch.md). For information about the `env` files in Docker, see [`docker-machine env`](docker-machine env) in the Docker documentation.
For information about how to obtain the `env` file, see [Obtain a VCH](obtain_vch.md). For information about the `env` files in Docker, see [`docker-machine env`](https://docs.docker.com/machine/reference/env/) in the Docker documentation.

## Install the vSphere Integrated Containers Registry Certificate <a id="registry"></a>

Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_app_dev/network_use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The following sections present examples of how to perform container networking o
To perform certain networking operations on containers, your Docker environment and your virtual container hosts (VCHs) must be configured in a specific way.

- For information about the default Docker networks, see https://docs.docker.com/engine/userguide/networking/.
- For information about the networking options with which vSphere administrators can deploy VCHs and examples, see [Virtual Container Host Networking](../vic_vsphere_admin/vch_networking.md) in *Install, Deploy, and Maintain the vSphere Integrated Containers Infrastructure*.
- For information about the networking options with which vSphere administrators can deploy VCHs and examples, see [Virtual Container Host Networks](../vic_vsphere_admin/vch_networking.md) in *Install, Deploy, and Maintain the vSphere Integrated Containers Infrastructure*.

**NOTE**: The default level of trust on VCH container networks is `published`. As a consequence, if the vSphere administrator did not configure `--container-network-firewall` on the VCH, you must specify `-p 80` in `docker run` and `docker create` commands to publish port 80 on a container. Alternatively, the vSphere administrator can configure the VCH to set [`--container-network-firewall`](../vic_vsphere_admin/container_networks.md#container-network-firewall) to a different level.

Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_app_dev/putting_apps_into_production.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The question of where a container stores its state is an important one. A contai

When a regular Linux container is deployed into a VM, there are typically two types of filesystem in the guest OS. An overlay filesystem manages the image data and stores ephemeral state. A volume will typically be another part of the guest filesystem mounted into the container. As such it is also possible for Linux containers to have shared read/write access to the same filesystem on the container host. This is useful in development, but potentially problematic in production as it forces containers to be tied to each other and to a specific container host. That may well be by design in the case where multiple containers form a single service and a single unit of scale. What's important however is to consider the scope, persistence and isolation of data when deploying containerized applications.

Take a database container as an example. Its data almost certainly needs to be backed up, live beyond the lifecycle of the container and not be mixed up with any other kind of data. The problem of peristing such state onto a container host filesystem is that it's mixed in with other state and cannot easily be backed up, unless the host itself has a disk mounted specifically for that purpose. There are volume drivers that can be used with Docker engine for this purpose. Eg. [VMware Docker Volume Service](https://vmware.github.io/docker-volume-vsphere)
Take a database container as an example. Its data almost certainly needs to be backed up, live beyond the lifecycle of the container and not be mixed up with any other kind of data. The problem of peristing such state onto a container host filesystem is that it's mixed in with other state and cannot easily be backed up, unless the host itself has a disk mounted specifically for that purpose. There are volume drivers that can be used with Docker engine for this purpose. Eg. [VMware Docker Volume Service](https://vmware.github.io/vsphere-storage-for-docker/)

When you deploy a container to a VCH, ephemeral state is written to a delta disk (an ephemeral layer on top of the image layers) and volumes are independently mounted disks which can only be mounted to one container at a time. When creating a volume, you can specify the size of the disk and the volume store it gets deployed to. If you select a volume store backed by a shared datastore, that volume will be available to any container anywhere in the vSphere cluster. This is particularly useful when it comes to the live migration of stateful containers. The vSphere administrator will be responsible for backup policy associated with the datastore.

Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_cloud_admin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This information is intended for Cloud administrators who want to use vSphere In

----------

Copyright &copy; 2016, 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).
Copyright &copy; 2016-2018 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.**<br>
3401 Hillview Ave.<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_cloud_admin/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* [Manage Repositories](manage_repository_registry.md)
* [Add Viewers, Developers, or DevOps Administrators to Projects](add_users.md)
* [Add VCHs](vchs_and_mgmt_portal.md)
* [Full Authentication](add_vch_fullTLS_in_portal.md)
* [Full TLS Authentication](add_vch_fullTLS_in_portal.md)
* [Server-Side Authentication](add_vch_serversideTLS_in_portal.md)
* [No Authentication](add_vch_noTLS_in_portal.md)
* [Add Registries](add_repos_in_portal.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This documentation applies to all 1.3.x releases.

----------

Copyright &copy; 2016, 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).
Copyright &copy; 2016-2018 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.**<br>
3401 Hillview Ave.<br>
Expand Down
5 changes: 3 additions & 2 deletions docs/user_doc/vic_overview/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
<!-- USE THIS SUMMARY FILE FOR PDF GENERATION ONLY -->

* [Introduction](README.md)
* [Overview of vSphere Integrated Containers](introduction.md)
* [Roles and Personas](roles_and_personas.md)
* [Quick Start Links](vic_quickstart.md)
* [Overview](introduction.md)
* [Roles and Personas](roles_and_personas.md)
4 changes: 2 additions & 2 deletions docs/user_doc/vic_overview/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,12 @@ A VCH is functionally distinct from a traditional container host in the followin
- There is no local image cache. This is kept on a datastore in the cluster that you specify when you deploy a VCH.
- There is no read-write shared storage

A VCH is a multi-functional appliance that you deploy as a vApp in a vCenter Server cluster or as a resource pool on an ESXi host. The vApp or resource pool provides a useful visual parent-child relationship in the vSphere Client so that you can easily identify the container VMs that are provisioned into a VCH. You can also specify resource limits on the vApp. You can provision multiple VCHs onto a single ESXi host, into a vSphere resource pool, or into a vCenter Server cluster.
A VCH is a multi-functional appliance that you deploy as a resource pool in a vCenter Server cluster or on an ESXi host. The resource pool provides a useful visual parent-child relationship in the vSphere Client so that you can easily identify the container VMs that are provisioned into a VCH. You can also specify resource limits on the resource pool. You can provision multiple VCHs onto a single ESXi host, into a vSphere resource pool, or into a vCenter Server cluster.


#### The VCH Endpoint VM <a id="endpoint"></a>

The VCH endoint VM is the VM that runs inside the VCH vApp or resource pool. There is a 1:1 relationship between a VCH and a VCH endpoint VM. The VCH endpoint VM provides the following functions:
The VCH endoint VM is the VM that runs inside the VCH resource pool. There is a 1:1 relationship between a VCH and a VCH endpoint VM. The VCH endpoint VM provides the following functions:

- Runs the services that a VCH requires.
- Provides a secure remote API to a client.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_vsphere_admin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This information is intended for VMware vSphere&reg; administrators who want to

----------

Copyright &copy; 2016, 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).
Copyright &copy; 2016-2018 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.**<br>
3401 Hillview Ave.<br>
Expand Down
Loading