Skip to content

Commit

Permalink
Removing repetitive instruction to wrap options in quotes. (#611)
Browse files Browse the repository at this point in the history
* Removing repetitive instruction to wrap options in quotes.

* Reversed order of note and para on env variables.

* Removed link to options topic as no longer relevant

* Added ops-user to list that might need quotes.
  • Loading branch information
stuclem authored Aug 23, 2017
1 parent 845fd91 commit e1e13ec
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 132 deletions.
26 changes: 10 additions & 16 deletions docs/user_doc/vic_vsphere_admin/common_vic_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

This section describes the options that are common to all `vic-machine` commands. The common options that `vic-machine` requires relate to the vSphere environment in which you deployed the virtual container host (VCH), and to the VCH itself.

**NOTE**: Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.

Option arguments that might require quotation marks include the following:

- User names and passwords in `--target`, or in `--user` and `--password`.
- Datacenter names in `--target`.
- VCH names in `--name`.
- Datastore names and paths in `--image-store`.
- Cluster and resource pool names in `--compute-resource`.

You can set environment variables for the `--target`, `--user`, `--password`, and `--thumbprint` options. For information about setting environment variables, see [Set Environment Variables for Key `vic-machine` Options](vic_env_variables.md).

### `--target` ###
Expand All @@ -13,8 +23,6 @@ The IPv4 address, fully qualified domain name (FQDN), or URL of the ESXi host or
- If the target ESXi host is not managed by vCenter Server, provide the address of the host.<pre>--target <i>esxi_host_address</i></pre>
- If the target ESXi host is managed by vCenter Server, or if you deployed the VCH to a cluster, provide the address of vCenter Server.<pre>--target <i>vcenter_server_address</i></pre>
- You can include the user name and password in the target URL. The user account that you specify must have vSphere administrator privileges.<pre>--target <i>vcenter_or_esxi_username</i>:<i>password</i>@<i>vcenter_or_esxi_address</i></pre>

Wrap the user name or password in single quotes (Linux or Mac OS) or double quotes (Windows) if they include special characters.<pre>'<i>vcenter_or_esxi_usern@me</i>':'<i>p@ssword</i>'@<i>vcenter_or_esxi_address</i></pre>

If you do not include the user name in the target URL, you must specify the `user` option. If you do not specify the `password` option or include the password in the target URL, `vic-machine` prompts you to enter the password.
- If you deployed the VCH on a vCenter Server instance that includes more than one datacenter, include the datacenter name in the target URL. If you include an invalid datacenter name, `vic-machine` fails and suggests the available datacenters that you can specify.<pre>--target <i>vcenter_server_address</i>/<i>datacenter_name</i></pre>
Expand All @@ -28,11 +36,6 @@ The ESXi host or vCenter Server user account with which to run the `vic-machine`

<pre>--user <i>esxi_or_vcenter_server_username</i></pre>

Wrap the user name in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes special characters.

<pre>--user '<i>esxi_or_vcenter_server_usern@me</i>'</pre>


### `--password` ###

Short name: `-p`
Expand All @@ -41,10 +44,6 @@ The password for the user account on the vCenter Server on which you deployed t

<pre>--password <i>esxi_host_or_vcenter_server_password</i></pre>

Wrap the password in single quotation marks (') on Mac OS and Linux and in double quotation (") marks on Windows if it includes special characters.

<pre>--password '<i>esxi_host_or_vcenter_server_p@ssword</i>'</pre>

### `--thumbprint` ###

Short name: None
Expand Down Expand Up @@ -75,7 +74,6 @@ If you do not specify the `compute-resource` or `id` options and multiple possib
* If the VCH is on a vCenter Server with more than one cluster, specify the name of the target cluster: <pre>--compute-resource <i>cluster_name</i></pre>
* If the VCH is in a specific resource pool on a standalone host that is managed by vCenter Server, specify the IPv4 address or FQDN of the target host and name of the resource pool:<pre>--compute-resource <i>host_name</i>/<i>resource_pool_name</i></pre>
* If the VCH is in a specific resource pool in a cluster, specify the names of the target cluster and the resource pool:<pre>--compute-resource <i>cluster_name</i>/<i>resource_pool_name</i></pre>
* Wrap the resource names in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces:<pre>--compute-resource '<i>cluster name</i>'/'<i>resource pool name</i>'</pre>

### `--name` ###

Expand All @@ -85,10 +83,6 @@ The name of the VCH. This option is mandatory if the VCH has a name other than t

<pre>--name <i>vch_appliance_name</i></pre>

Wrap the appliance name in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes spaces.

<pre>--name '<i>vch appliance name</i>'</pre>

### `--id` ###

Short name: None
Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_vsphere_admin/deploy_vch_esxi.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This topic provides instructions for deploying a virtual container host (VCH) to
2. Navigate to the directory that contains the `vic-machine` utility:
3. Run the `vic-machine create` command.

Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. In these examples, the password is wrapped in quotes because it contains `@`.
In these examples, the password is wrapped in quotes because it contains `@`.

- Linux OS:
<pre>$ vic-machine-linux create
Expand Down
2 changes: 1 addition & 1 deletion docs/user_doc/vic_vsphere_admin/deploy_vch_vcenter.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The vCenter Server instance to which you deploy the VCH must match the specifica
2. Navigate to the directory that contains the `vic-machine` utility:
3. Run the `vic-machine create` command.

Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. In these examples, the user name is wrapped in quotes because it contains `@`.
In these examples, the user name is wrapped in quotes because it contains `@`.

- Linux OS:
<pre>$ vic-machine-linux create
Expand Down
12 changes: 5 additions & 7 deletions docs/user_doc/vic_vsphere_admin/ts_cli_argument_error.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,9 @@ Wrap any arguments that contain spaces or special characters in single quotation
Option arguments that might require quotation marks include the following:

- User names and passwords in `--target`, or in `--user` and `--password`
- Datacenter names in `--target`
- VCH names in `--name`
- Datastore names and paths in `--image-store` and `--volume-store`
- Datacenter names in `--target`.
- VCH names in `--name`.
- Datastore names and paths in `--image-store` and `--volume-store`.
- Network and port group names in all networking options.
- Cluster and resource pool names in `--compute-resource`
- Folder names in the paths for `--tls-cert-path`, --tls-server-cert, --tls-server-key, `--appliance-iso`, and `--bootstrap-iso`

For information about when to use quotation marks for different options, see the descriptions of those options in [VCH Deployment Options](vch_installer_options.md).
- Cluster and resource pool names in `--compute-resource`.
- Folder names in the paths for `--tls-cert-path`, `--tls-server-cert`, `--tls-server-key`, `--appliance-iso`, and `--bootstrap-iso`.
10 changes: 2 additions & 8 deletions docs/user_doc/vic_vsphere_admin/upgrade_vch_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The command line utility for vSphere Integrated Containers Engine, `vic-machine`

The `vic-machine upgrade` command includes the following options in addition to the common options described in [Common `vic-machine` Options](common_vic_options.md).

**NOTE**: Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.

### `--appliance-iso` ###

Short name: `--ai`
Expand All @@ -14,10 +16,6 @@ The path to the new version of the ISO image from which to upgrade the VCH appli

<pre>--appliance-iso <i>path_to_ISO_file</i>/<i>ISO_file_name</i>.iso</pre>

Wrap the folder names in the path in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces.

<pre>--appliance-iso '<i>path to ISO file</i>'/appliance.iso</pre>

### `--bootstrap-iso` ###

Short name: `--bi`
Expand All @@ -28,10 +26,6 @@ The path to the new version of the ISO image from which to upgrade the container

<pre>--bootstrap-iso <i>path_to_ISO_file</i>/bootstrap.iso</pre>

Wrap the folder names in the path in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces.

<pre>--bootstrap-iso '<i>path to ISO file</i>'/<i>ISO_file_name</i>.iso</pre>

### `--force` ###

Short name: `-f`
Expand Down
23 changes: 16 additions & 7 deletions docs/user_doc/vic_vsphere_admin/vch_installer_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,18 @@ For simplicity, these examples use the `--force` option to disable the verificat

For detailed descriptions of all of the `vic-machine create` options, see [VCH Deployment Options](vch_installer_options.md).

**NOTE**: Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.

Option arguments that might require quotation marks include the following:

- User names and passwords in `--target`, `--user`, `--password`, `--ops-user`, and `--ops-password`.
- Datacenter names in `--target`.
- VCH names in `--name`.
- Datastore names and paths in `--image-store` and `--volume-store`.
- Network and port group names in all networking options.
- Cluster and resource pool names in `--compute-resource`.
- Folder names in the paths for `--tls-cert-path`, `--tls-server-cert`, `--tls-server-key`, `--appliance-iso`, and `--bootstrap-iso`.


## General Deployment Examples <a id="general"></a>

Expand All @@ -43,7 +55,7 @@ When deploying a VCH to vCenter Server, you must use the `--bridge-network` opti

This example deploys a VCH with the following configuration:

- Provides the vCenter Single Sign-On user and password in the `--target` option. Note that the user name is wrapped in quotes, because it contains the `@` character. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.
- Provides the vCenter Single Sign-On user and password in the `--target` option. The user name is wrapped in quotes, because it contains the `@` character.
- Deploys a VCH named `vch1` to the cluster `cluster1` in datacenter `dc1`.
- Uses a port group named `vic-bridge` for the bridge network.
- Designates `datastore1` as the datastore in which to store container images, the files for the VCH appliance, and container VMs.
Expand Down Expand Up @@ -86,7 +98,7 @@ To deploy a VCH in a specific resource pool on an ESXi host that is not managed
This example deploys a VCH with the following configuration:

- Specifies the user name and password, image store, and a name for the VCH.
- Designates `rp 1` as the resource pool in which to place the VCH. Note that the resource pool name is wrapped in quotes, because it contains a space. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.
- Designates `rp 1` as the resource pool in which to place the VCH. The resource pool name is wrapped in quotes, because it contains a space.

<pre>vic-machine-<i>operating_system</i> create
--target root:<i>password</i>@<i>esxi_host_address</i>
Expand Down Expand Up @@ -129,8 +141,6 @@ If the name of the resource pool is not unique across all clusters, for example
--no-tls
</pre>

Note that the resource pool and cluster names in these examples are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.

### Set Limits on Resource Use <a id="customized"></a>

To limit the amount of system resources that the container VMs in a VCH can use, you can set resource limits on the VCH vApp.
Expand Down Expand Up @@ -177,7 +187,7 @@ In addition to the mandatory bridge network, if your vCenter Server environment
This example deploys a VCH with the following configuration:

- Specifies the user name, password, datacenter, cluster, image store, bridge network, and name for the VCH.
- Directs public and management traffic to network 1 and Docker API traffic to network 2. Note that the network names are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.
- Directs public and management traffic to network 1 and Docker API traffic to network 2.

<pre>vic-machine-<i>operating_system</i> create
--target '[email protected]':<i>password</i>@<i>vcenter_server_address</i>/dc1
Expand All @@ -202,7 +212,7 @@ If you specify networks for any or all of the public, management, and client net
This example deploys a VCH with the following configuration:

- Specifies the user name, password, datacenter, cluster, image store, bridge network, and name for the VCH.
- Directs public and management traffic to network 1 and Docker API traffic to network 2. Note that the network names are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.
- Directs public and management traffic to network 1 and Docker API traffic to network 2.
- Sets a DNS server for use by the public, management, and client networks.
- Sets a static IP address and subnet mask for the VCH endpoint VM on the public and client networks. Because the management network shares a network with the public network, you only need to specify the public network IP address. You cannot specify a management IP address because you are sharing a port group between the management and public network.
- Specifies the gateway for the public network. If you set a static IP address on the public network, you must also specify the gateway address.
Expand Down Expand Up @@ -295,7 +305,6 @@ This example deploys a VCH with the following configuration:
- Specifies the user name, password, datacenter, cluster, bridge network, and name for the VCH.
- Specifies the `volumes` folder on `datastore 1` as the default volume store. Creating a volume store named `default` allows container application developers to create anonymous or named volumes by using `docker create -v`.
- Specifies a second volume store named `volume_store_2` in the `volumes` folder on `datastore 2`.
- Note that the datastore names are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.

<pre>vic-machine-<i>operating_system</i> create
--target '[email protected]':<i>password</i>@<i>vcenter_server_address</i>/dc1
Expand Down
Loading

0 comments on commit e1e13ec

Please sign in to comment.