docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated UCP CLI Reference to 3.1.7 (#8805) 

-Updated all of the UCP 3.1.7 references.
-Alphabeticalised each reference
-Added very a value is expected or not after each variable.

Signed-off-by: Olly Pomeroy <olly@docker.com>
This commit is contained in:
Olly P 2019-05-17 16:28:29 +01:00 committed by Maria Bermudez
parent 02b8e67e54
commit eb86438912
12 changed files with 125 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
reference/ucp/3.1/cli/backup.md
View File

@ -37,10 +37,11 @@ Note:
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:-----------------------|:--------------------------------------------------------------------|
|`--debug, D`|Enable debug mode| | `--debug, -D` | Enable debug mode |
|`--jsonlog`|Produce json formatted output for easier parsing| | `--jsonlog` | Produce json formatted output for easier parsing |
|`--interactive, i`|Run in interactive mode and prompt for configuration values| | `--interactive, -i` | Run in interactive mode and prompt for configuration values |
|`--id`|The ID of the UCP instance to back up| | `--id` *value* | The ID of the UCP instance to back up |
|`--passphrase`|Encrypt the tar file with a passphrase| | `--no-passphrase` | Opt out to encrypt the tar file with a passphrase (not recommended) |
| `--passphrase` *value* | Encrypt the tar file with a passphrase |

12
reference/ucp/3.1/cli/dump-certs.md
View File

@ -27,9 +27,9 @@ to configure DTR.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:-------------|:--------------------------------------------------------------------------------|
|`--debug, D`|Enable debug mode| | `--debug, D` | Enable debug mode |
|`--jsonlog`|Produce json formatted output for easier parsing| | `--jsonlog` | Produce json formatted output for easier parsing |
|`--ca`|Only print the contents of the ca.pem file| | `--ca` | Only print the contents of the ca.pem file |
|`--cluster`|Print the internal UCP swarm root CA and cert instead of the public server cert| | `--cluster` | Print the internal UCP swarm root CA and cert instead of the public server cert |

6
reference/ucp/3.1/cli/id.md
View File

@ -23,3 +23,9 @@ a client bundle.
This ID is used by other commands as confirmation. This ID is used by other commands as confirmation.
## Options
| Option | Description |
|:-------------|:-------------------------------------------------|
| `--debug, D` | Enable debug mode |
| `--jsonlog` | Produce json formatted output for easier parsing |

16
reference/ucp/3.1/cli/images.md
View File

@ -24,11 +24,11 @@ the ones that are missing.
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:------------------------------|:-----------------------------------------------------|
|`--debug, D`|Enable debug mode| | `--debug, D` | Enable debug mode |
|`--jsonlog`|Produce json formatted output for easier parsing| | `--jsonlog` | Produce json formatted output for easier parsing |
|`--pull`|Pull UCP images: `always`, when `missing`, or `never`| | `--list` | List all images used by UCP but don't pull them |
|`--registry-username`|Username to use when pulling images| | `--pull` *value* | Pull UCP images: `always`, when `missing`, or `never`|
|`--registry-password`|Password to use when pulling images| | `--registry-password` *value* | Password to use when pulling images |
|`--list`|List all images used by UCP but don't pull them| | `--registry-username` *value* | Username to use when pulling images |

19
reference/ucp/3.1/cli/index.md
View File

@ -31,15 +31,16 @@ docker container run -it --rm \
| Option | Description | | Option | Description |
|:-----------------|:----------------------------------------------------------| |:-----------------|:----------------------------------------------------------|
| `backup` | Create a backup of a UCP manager node |
| `dump-certs` | Print the public certificates used by this UCP web server |
| `example-config` | Display an example configuration file for UCP |
| `help` | Shows a list of commands or help for one command |
| `id` | Print the ID of UCP running on this node |
| `images` | Verify the UCP images on this node |
| `install` | Install UCP on this node | | `install` | Install UCP on this node |
| `restart` | Start or restart UCP components running on this node | | `restart` | Start or restart UCP components running on this node |
| `stop` | Stop UCP components running on this node |
| `upgrade` | Upgrade the UCP cluster |
| `images` | Verify the UCP images on this node |
| `uninstall-ucp` | Uninstall UCP from this swarm |
| `dump-certs` | Print the public certificates used by this UCP web server |
| `support` | Create a support dump for this UCP node |
| `id` | Print the ID of UCP running on this node |
| `backup` | Create a backup of a UCP manager node |
| `restore` | Restore a UCP cluster from a backup | | `restore` | Restore a UCP cluster from a backup |
| `example-config` | Display an example configuration file for UCP | | `stop` | Stop UCP components running on this node |
| `support` | Create a support dump for this UCP node |
| `uninstall-ucp` | Uninstall UCP from this swarm |
| `upgrade` | Upgrade the UCP cluster |

83
reference/ucp/3.1/cli/install.md
View File

@ -42,44 +42,45 @@ If you are installing on Azure, see [Install UCP on Azure](/ee/ucp/admin/install
## Options ## Options
| Option | Description | | Option | Description |
|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--admin-password` | The UCP administrator password. Must be at least 8 characters. | | `--debug, -D` | Enable debug mode |
| `--admin-username` | The UCP administrator username | | `--jsonlog` | Produce json formatted output for easier parsing |
| `--binpack` | Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility | | `--interactive, -i` | Run in interactive mode and prompt for configuration values |
| `--cloud-provider` | The cloud provider for the cluster | `--admin-password` *value* | The UCP administrator password [$UCP_ADMIN_PASSWORD] |
| `--cni-installer-url` | Deprecated feature. A URL pointing to a Kubernetes YAML file to be used as an installer for the CNI plugin of the cluster. If specified, the default CNI plugin is not installed. If the URL uses the HTTPS scheme, no certificate verification is performed. | | `--admin-username` *value* | The UCP administrator username [$UCP_ADMIN_USER] |
| `--controller-port` | Port for the web UI and API | `--binpack` | Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility |
| `--data-path-addr` | Address or interface to use for data path traffic. Format: IP address or network interface name | `--cloud-provider` *value* | The cloud provider for the cluster |
| `--debug, D` | Enable debug mode | | `--cni-installer-url` *value* | A URL pointing to a kubernetes YAML file to be used as an installer for the CNI plugin of the cluster. If specified, the default CNI plugin will not be installed. If the URL is using the HTTPS scheme, no certificate verification will be performed |
| `--disable-tracking` | Disable anonymous tracking and analytics | | `--controller-port` *value* | Port for the web UI and API (default: 443) |
| `--disable-usage` | Disable anonymous usage reporting | | `--data-path-addr` *value* | Address or interface to use for data path traffic. Format: IP address or network interface name [$UCP_DATA_PATH_ADDR] |
| `--dns` | Set custom DNS servers for the UCP containers | | `--disable-tracking` | Disable anonymous tracking and analytics |
| `--dns-opt` | Set DNS options for the UCP containers | | `--disable-usage` | Disable anonymous usage reporting |
| `--dns-search` | Set custom DNS search domains for the UCP containers | | `--dns-opt` *value* | Set DNS options for the UCP containers [$DNS_OPT] |
| `--enable-profiling` | Enable performance profiling | | `--dns-search` *value* | Set custom DNS search domains for the UCP containers [$DNS_SEARCH] |
| `--existing-config` | Use the latest existing UCP config during this installation. The install fails if a config is not found. | | `--dns` *value* | Set custom DNS servers for the UCP containers [$DNS] |
| `--external-server-cert` | Use the certificates in the `ucp-controller-server-certs` volume instead of generating self-signed certs during installation | | `--enable-profiling` | Enable performance profiling |
| `--external-service-lb` | Set the external service load balancer reported in the UI | | `--existing-config` | Use the latest existing UCP config during this installation. The install will fail if a config is not found |
| `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports | | `--external-server-cert` | Customize the certificates used by the UCP web server |
| `--force-minimums` | Force the install/upgrade even if the system doesn't meet the minimum requirements. | | `--external-service-lb` *value* | Set the IP address of the load balancer that published services are expected to be reachable on |
| `--host-address` | The network address to advertise to other nodes. Format: IP address or network interface name | | `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports. |
| `--interactive, i` | Run in interactive mode and prompt for configuration values | | `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements |
| `--jsonlog` | Produce json formatted output for easier parsing | | `--host-address` *value* | The network address to advertise to other nodes. Format: IP address or network interface name [$UCP_HOST_ADDRESS] |
| `--kube-apiserver-port` | Port for the Kubernetes API server (default: 6443) | | `--kube-apiserver-port` *value* | Port for the Kubernetes API server (default: 6443) |
| `--kv-snapshot-count` | Number of changes between key-value store snapshots | | `--kv-snapshot-count` *value* | Number of changes between key-value store snapshots (default: 20000) [$KV_SNAPSHOT_COUNT] |
| `--kv-timeout` | Timeout in milliseconds for the key-value store | | `--kv-timeout` *value* | Timeout in milliseconds for the key-value store (default: 5000) [$KV_TIMEOUT] |
| `--license` | Add a license: e.g.` --license "$(cat license.lic)" ` | | `--license` *value* | Add a license: e.g. --license "$(cat license.lic)" [$UCP_LICENSE] |
| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: `192.168.0.0/16`) | | `--nodeport-range` *value* | Allowed port range for Kubernetes services of type NodePort (Default: 32768-35535) (default: "32768-35535") |
| `--preserve-certs` | Don't generate certificates if they already exist | | `--pod-cidr` *value* | Kubernetes cluster IP pool for the pods to allocated IP from (Default: 192.168.0.0/16) (default: "192.168.0.0/16") |
| `--pull` | Pull UCP images: `always`, when `missing`, or `never` | | `--preserve-certs` | Don't generate certificates if they already exist |
| `--random` | Set the Docker Swarm scheduler to random mode. Used for backwards compatibility | | `--pull` *value* | Pull UCP images: 'always', when 'missing', or 'never' (default: "missing") |
| `--registry-username` | Username to use when pulling images | | `--random` | Set the Docker Swarm scheduler to random mode. Used for backwards compatibility |
| `--registry-password` | Password to use when pulling images | | `--registry-password` *value* | Password to use when pulling images [$REGISTRY_PASSWORD] |
| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | | `--registry-username` *value* | Username to use when pulling images [$REGISTRY_USERNAME] |
| `--skip-cloud-provider` | Disables checks that rely on detecting the cloud provider (if any) on which the cluster is currently running. | | `--san` *value* | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) [$UCP_HOSTNAMES] |
| `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility | | `--skip-cloud-provider-check` | Disables checks which rely on detecting which (if any) cloud provider the cluster is currently running on |
| `--swarm-port` | Port for the Docker Swarm manager. Used for backwards compatibility | | `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility |
| `--swarm-grpc-port` | Port for communication between nodes | | `--swarm-grpc-port` *value* | Port for communication between nodes (default: 2377) |
| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | | `--swarm-port` *value* | Port for the Docker Swarm manager. Used for backwards compatibility (default: 2376) |
| `--unmanaged-cni` |The default value of `false` indicates that Kubernetes networking is managed by UCP with its default managed CNI plugin, Calico. When set to `true`, UCP does not deploy or manage the lifecycle of the default CNI plugin - the CNI plugin is deployed and managed independently of UCP. Note that when `unmanaged-cni=true`, networking in the cluster will not function for Kubernetes until a CNI plugin is deployed. | | `--unlock-key` *value* | The unlock key for this swarm-mode cluster, if one exists. [$UNLOCK_KEY] |
| `--unmanaged-cni` | Flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider) |

8
reference/ucp/3.1/cli/restart.md
View File

@ -18,7 +18,7 @@ docker container run --rm -it \
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:-------------|:-------------------------------------------------|
|`--debug, D`|Enable debug mode| | `--debug, D` | Enable debug mode |
|`--jsonlog`|Produce json formatted output for easier parsing| | `--jsonlog` | Produce json formatted output for easier parsing |

20
reference/ucp/3.1/cli/restore.md
View File

@ -58,13 +58,13 @@ Notes:
## Options ## Options
| Option | Description | | Option | Description |
|:-------------------|:----------------------------------------------------------------------------------------------| |:---------------------------|:----------------------------------------------------------------------------------------------|
| `--debug, D` | Enable debug mode | | `--debug, D` | Enable debug mode |
| `--jsonlog` | Produce json formatted output for easier parsing | | `--jsonlog` | Produce json formatted output for easier parsing |
| `--interactive, i` | Run in interactive mode and prompt for configuration values | | `--interactive, i` | Run in interactive mode and prompt for configuration values |
| `--passphrase` | Decrypt the backup tar file with the provided passphrase | | `--data-path-addr` *value* | Address or interface to use for data path traffic |
| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | | `--host-address` *value* | The network address to advertise to other nodes. Format: IP address or network interface name |
| `--host-address` | The network address to advertise to other nodes. Format: IP address or network interface name | | `--passphrase` *value* | Decrypt the backup tar file with the provided passphrase |
| `--data-path-addr` | Address or interface to use for data path traffic | | `--san` *value* | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) |
| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | | `--unlock-key` *value* | The unlock key for this swarm-mode cluster, if one exists. |

8
reference/ucp/3.1/cli/stop.md
View File

@ -18,7 +18,7 @@ docker container run --rm -it \
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:-------------|:-------------------------------------------------|
|`--debug, D`|Enable debug mode| | `--debug, D` | Enable debug mode |
|`--jsonlog`|Produce json formatted output for easier parsing| | `--jsonlog` | Produce json formatted output for easier parsing |

9
reference/ucp/3.1/cli/support.md
View File

@ -22,8 +22,7 @@ This command creates a support dump file for the specified node(s), and prints i
## Options ## Options
| Option | Description | | Option | Description |
|:--------------------------|:---------------------------| |:-------------|:-------------------------------------------------|
|`--loglines`|Specify number of lines to grab from `journalctl`. The default is 10,000 lines.| | `--debug, D` | Enable debug mode |
|`--servicedriller`|Run the swarm service driller (ssd) tool. For more information on this tool, see [Docker Swarm Service Driller (ssd)](https://github.com/docker/libnetwork/tree/master/cmd/ssd) Not run by default.| | `--jsonlog` | Produce json formatted output for easier parsing |
|`--nodes`|Select specific nodes on which to produce a support dump. Comma-separated node IDs are allowed. The default selects all nodes.|

20
reference/ucp/3.1/cli/uninstall-ucp.md
View File

@ -30,13 +30,13 @@ UCP is installed again.
## Options ## Options
| Option | Description | | Option | Description |
| :-------------------- | :---------------------------------------------------------- | |:------------------------------|:----------------------------------------------------------- |
| `--debug, D` | Enable debug mode | | `--debug, D` | Enable debug mode |
| `--jsonlog` | Produce json formatted output for easier parsing | | `--jsonlog` | Produce json formatted output for easier parsing |
| `--interactive, i` | Run in interactive mode and prompt for configuration values | | `--interactive, i` | Run in interactive mode and prompt for configuration values |
| `--pull` | Pull UCP images: `always`, when `missing`, or `never` | | `--id` *value* | The ID of the UCP instance to uninstall |
| `--registry-username` | Username to use when pulling images | | `--pull` *value* | Pull UCP images: `always`, when `missing`, or `never` |
| `--registry-password` | Password to use when pulling images | | `--purge-config` | Remove UCP configs during uninstallation |
| `--id` | The ID of the UCP instance to uninstall | | `--registry-password` *value* | Password to use when pulling images |
| `--purge-config` | Remove UCP configs during uninstallation | | `--registry-username` *value* | Username to use when pulling images |

29
reference/ucp/3.1/cli/upgrade.md
View File

@ -29,19 +29,16 @@ healthy and that all nodes have been upgraded successfully.
## Options ## Options
| Option | Description | | Option | Description |
|:----------------------|:------------------------------------------------------------------------------------------------------| |:------------------------------|:------------------------------------------------------------------------------------|
| `--debug, D` | Enable debug mode | | `--debug, D` | Enable debug mode |
| `--jsonlog` | Produce json formatted output for easier parsing | | `--jsonlog` | Produce json formatted output for easier parsing |
| `--interactive, i` | Run in interactive mode and prompt for configuration values | | `--interactive, i` | Run in interactive mode and prompt for configuration values |
| `--admin-username` | The UCP administrator username | | `--admin-password` *value* | The UCP administrator password |
| `--admin-password` | The UCP administrator password | | `--admin-username` *value* | The UCP administrator username |
| `--pull` | Pull UCP images: `always`, when `missing`, or `never` | | `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements |
| `--registry-username` | Username to use when pulling images | | `--host-address` *value* | Override the previously configured host address with this IP or network interface |
| `--registry-password` | Password to use when pulling images | | `--id` | The ID of the UCP instance to upgrade |
| `--id` | The ID of the UCP instance to upgrade | | `--pull` | Pull UCP images: `always`, when `missing`, or `never` |
| `--host-address` | Override the previously configured host address with this IP or network interface | | `--registry-password` *value* | Password to use when pulling images |
| `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements | | `--registry-username` *value* | Username to use when pulling images |
| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IP. The default IP pool is `192.168.0.0/16`. |
| `--nodeport-range` | Allowed port range for Kubernetes services of type `NodePort`. The default port range is `32768-35535`. |
| `--cloud-provider` | The cloud provider for the cluster |