diff --git a/reference/ucp/3.1/cli/backup.md b/reference/ucp/3.1/cli/backup.md index 97250d35a8..b67365047a 100644 --- a/reference/ucp/3.1/cli/backup.md +++ b/reference/ucp/3.1/cli/backup.md @@ -37,10 +37,11 @@ Note: ## Options -| Option | Description | -|:--------------------------|:---------------------------| -|`--debug, D`|Enable debug mode| -|`--jsonlog`|Produce json formatted output for easier parsing| -|`--interactive, i`|Run in interactive mode and prompt for configuration values| -|`--id`|The ID of the UCP instance to back up| -|`--passphrase`|Encrypt the tar file with a passphrase| +| Option | Description | +|:-----------------------|:--------------------------------------------------------------------| +| `--debug, -D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--interactive, -i` | Run in interactive mode and prompt for configuration values | +| `--id` *value* | The ID of the UCP instance to back up | +| `--no-passphrase` | Opt out to encrypt the tar file with a passphrase (not recommended) | +| `--passphrase` *value* | Encrypt the tar file with a passphrase | diff --git a/reference/ucp/3.1/cli/dump-certs.md b/reference/ucp/3.1/cli/dump-certs.md index 928bbbba1c..008e6cb912 100644 --- a/reference/ucp/3.1/cli/dump-certs.md +++ b/reference/ucp/3.1/cli/dump-certs.md @@ -27,9 +27,9 @@ to configure DTR. ## Options -| Option | Description | -|:--------------------------|:---------------------------| -|`--debug, D`|Enable debug mode| -|`--jsonlog`|Produce json formatted output for easier parsing| -|`--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| +| Option | Description | +|:-------------|:--------------------------------------------------------------------------------| +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--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 | diff --git a/reference/ucp/3.1/cli/id.md b/reference/ucp/3.1/cli/id.md index 0721e0e1c6..14387cd983 100644 --- a/reference/ucp/3.1/cli/id.md +++ b/reference/ucp/3.1/cli/id.md @@ -23,3 +23,9 @@ a client bundle. 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 | diff --git a/reference/ucp/3.1/cli/images.md b/reference/ucp/3.1/cli/images.md index 2980128ae0..9a0fb8145e 100644 --- a/reference/ucp/3.1/cli/images.md +++ b/reference/ucp/3.1/cli/images.md @@ -24,11 +24,11 @@ the ones that are missing. ## Options -| Option | Description | -|:--------------------------|:---------------------------| -|`--debug, D`|Enable debug mode| -|`--jsonlog`|Produce json formatted output for easier parsing| -|`--pull`|Pull UCP images: `always`, when `missing`, or `never`| -|`--registry-username`|Username to use when pulling images| -|`--registry-password`|Password to use when pulling images| -|`--list`|List all images used by UCP but don't pull them| +| Option | Description | +|:------------------------------|:-----------------------------------------------------| +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--list` | List all images used by UCP but don't pull them | +| `--pull` *value* | Pull UCP images: `always`, when `missing`, or `never`| +| `--registry-password` *value* | Password to use when pulling images | +| `--registry-username` *value* | Username to use when pulling images | diff --git a/reference/ucp/3.1/cli/index.md b/reference/ucp/3.1/cli/index.md index 12e71bdcc2..f41b7283c9 100644 --- a/reference/ucp/3.1/cli/index.md +++ b/reference/ucp/3.1/cli/index.md @@ -31,15 +31,16 @@ docker container run -it --rm \ | 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 | | `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 | -| `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 | diff --git a/reference/ucp/3.1/cli/install.md b/reference/ucp/3.1/cli/install.md index 4c0d06528c..f0df1ba991 100644 --- a/reference/ucp/3.1/cli/install.md +++ b/reference/ucp/3.1/cli/install.md @@ -42,44 +42,45 @@ If you are installing on Azure, see [Install UCP on Azure](/ee/ucp/admin/install ## Options -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--admin-password` | The UCP administrator password. Must be at least 8 characters. | -| `--admin-username` | The UCP administrator username | -| `--binpack` | Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility | -| `--cloud-provider` | The cloud provider for the cluster -| `--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. | -| `--controller-port` | Port for the web UI and API -| `--data-path-addr` | Address or interface to use for data path traffic. Format: IP address or network interface name -| `--debug, D` | Enable debug mode | -| `--disable-tracking` | Disable anonymous tracking and analytics | -| `--disable-usage` | Disable anonymous usage reporting | -| `--dns` | Set custom DNS servers for the UCP containers | -| `--dns-opt` | Set DNS options for the UCP containers | -| `--dns-search` | Set custom DNS search domains for the UCP containers | -| `--enable-profiling` | Enable performance profiling | -| `--existing-config` | Use the latest existing UCP config during this installation. The install fails if a config is not found. | -| `--external-server-cert` | Use the certificates in the `ucp-controller-server-certs` volume instead of generating self-signed certs during installation | -| `--external-service-lb` | Set the external service load balancer reported in the UI | -| `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports | -| `--force-minimums` | Force the install/upgrade even if the system doesn't meet the minimum requirements. | -| `--host-address` | The network address to advertise to other nodes. Format: IP address or network interface name | -| `--interactive, i` | Run in interactive mode and prompt for configuration values | -| `--jsonlog` | Produce json formatted output for easier parsing | -| `--kube-apiserver-port` | Port for the Kubernetes API server (default: 6443) | -| `--kv-snapshot-count` | Number of changes between key-value store snapshots | -| `--kv-timeout` | Timeout in milliseconds for the key-value store | -| `--license` | Add a license: e.g.` --license "$(cat license.lic)" ` | -| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: `192.168.0.0/16`) | -| `--preserve-certs` | Don't generate certificates if they already exist | -| `--pull` | Pull UCP images: `always`, when `missing`, or `never` | -| `--random` | Set the Docker Swarm scheduler to random mode. Used for backwards compatibility | -| `--registry-username` | Username to use when pulling images | -| `--registry-password` | Password to use when pulling images | -| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | -| `--skip-cloud-provider` | Disables checks that rely on detecting the cloud provider (if any) on which the cluster is currently running. | -| `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility | -| `--swarm-port` | Port for the Docker Swarm manager. Used for backwards compatibility | -| `--swarm-grpc-port` | Port for communication between nodes | -| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | -| `--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. | +| Option | Description | +|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--debug, -D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--interactive, -i` | Run in interactive mode and prompt for configuration values | +| `--admin-password` *value* | The UCP administrator password [$UCP_ADMIN_PASSWORD] | +| `--admin-username` *value* | The UCP administrator username [$UCP_ADMIN_USER] | +| `--binpack` | Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility | +| `--cloud-provider` *value* | The cloud provider for the cluster | +| `--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 | +| `--controller-port` *value* | Port for the web UI and API (default: 443) | +| `--data-path-addr` *value* | Address or interface to use for data path traffic. Format: IP address or network interface name [$UCP_DATA_PATH_ADDR] | +| `--disable-tracking` | Disable anonymous tracking and analytics | +| `--disable-usage` | Disable anonymous usage reporting | +| `--dns-opt` *value* | Set DNS options for the UCP containers [$DNS_OPT] | +| `--dns-search` *value* | Set custom DNS search domains for the UCP containers [$DNS_SEARCH] | +| `--dns` *value* | Set custom DNS servers for the UCP containers [$DNS] | +| `--enable-profiling` | Enable performance profiling | +| `--existing-config` | Use the latest existing UCP config during this installation. The install will fail if a config is not found | +| `--external-server-cert` | Customize the certificates used by the UCP web server | +| `--external-service-lb` *value* | Set the IP address of the load balancer that published services are expected to be reachable on | +| `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports. | +| `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements | +| `--host-address` *value* | The network address to advertise to other nodes. Format: IP address or network interface name [$UCP_HOST_ADDRESS] | +| `--kube-apiserver-port` *value* | Port for the Kubernetes API server (default: 6443) | +| `--kv-snapshot-count` *value* | Number of changes between key-value store snapshots (default: 20000) [$KV_SNAPSHOT_COUNT] | +| `--kv-timeout` *value* | Timeout in milliseconds for the key-value store (default: 5000) [$KV_TIMEOUT] | +| `--license` *value* | Add a license: e.g. --license "$(cat license.lic)" [$UCP_LICENSE] | +| `--nodeport-range` *value* | Allowed port range for Kubernetes services of type NodePort (Default: 32768-35535) (default: "32768-35535") | +| `--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") | +| `--preserve-certs` | Don't generate certificates if they already exist | +| `--pull` *value* | Pull UCP images: 'always', when 'missing', or 'never' (default: "missing") | +| `--random` | Set the Docker Swarm scheduler to random mode. Used for backwards compatibility | +| `--registry-password` *value* | Password to use when pulling images [$REGISTRY_PASSWORD] | +| `--registry-username` *value* | Username to use when pulling images [$REGISTRY_USERNAME] | +| `--san` *value* | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) [$UCP_HOSTNAMES] | +| `--skip-cloud-provider-check` | Disables checks which rely on detecting which (if any) cloud provider the cluster is currently running on | +| `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility | +| `--swarm-grpc-port` *value* | Port for communication between nodes (default: 2377) | +| `--swarm-port` *value* | Port for the Docker Swarm manager. Used for backwards compatibility (default: 2376) | +| `--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) | diff --git a/reference/ucp/3.1/cli/restart.md b/reference/ucp/3.1/cli/restart.md index f1824f28ed..d8e50fc9cf 100644 --- a/reference/ucp/3.1/cli/restart.md +++ b/reference/ucp/3.1/cli/restart.md @@ -18,7 +18,7 @@ docker container run --rm -it \ ## Options -| Option | Description | -|:--------------------------|:---------------------------| -|`--debug, D`|Enable debug mode| -|`--jsonlog`|Produce json formatted output for easier parsing| +| Option | Description | +|:-------------|:-------------------------------------------------| +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | diff --git a/reference/ucp/3.1/cli/restore.md b/reference/ucp/3.1/cli/restore.md index 6552c6b4f9..dc528345e3 100644 --- a/reference/ucp/3.1/cli/restore.md +++ b/reference/ucp/3.1/cli/restore.md @@ -58,13 +58,13 @@ Notes: ## Options -| Option | Description | -|:-------------------|:----------------------------------------------------------------------------------------------| -| `--debug, D` | Enable debug mode | -| `--jsonlog` | Produce json formatted output for easier parsing | -| `--interactive, i` | Run in interactive mode and prompt for configuration values | -| `--passphrase` | Decrypt the backup tar file with the provided passphrase | -| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | -| `--host-address` | The network address to advertise to other nodes. Format: IP address or network interface name | -| `--data-path-addr` | Address or interface to use for data path traffic | -| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | +| Option | Description | +|:---------------------------|:----------------------------------------------------------------------------------------------| +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--interactive, i` | Run in interactive mode and prompt for configuration values | +| `--data-path-addr` *value* | Address or interface to use for data path traffic | +| `--host-address` *value* | 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 | +| `--san` *value* | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | +| `--unlock-key` *value* | The unlock key for this swarm-mode cluster, if one exists. | diff --git a/reference/ucp/3.1/cli/stop.md b/reference/ucp/3.1/cli/stop.md index a246cb9fdf..3e9fbe58ba 100644 --- a/reference/ucp/3.1/cli/stop.md +++ b/reference/ucp/3.1/cli/stop.md @@ -18,7 +18,7 @@ docker container run --rm -it \ ## Options -| Option | Description | -|:--------------------------|:---------------------------| -|`--debug, D`|Enable debug mode| -|`--jsonlog`|Produce json formatted output for easier parsing| +| Option | Description | +|:-------------|:-------------------------------------------------| +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | diff --git a/reference/ucp/3.1/cli/support.md b/reference/ucp/3.1/cli/support.md index 7649e26824..32ef42d55d 100644 --- a/reference/ucp/3.1/cli/support.md +++ b/reference/ucp/3.1/cli/support.md @@ -22,8 +22,7 @@ This command creates a support dump file for the specified node(s), and prints i ## Options -| Option | Description | -|:--------------------------|:---------------------------| -|`--loglines`|Specify number of lines to grab from `journalctl`. The default is 10,000 lines.| -|`--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.| -|`--nodes`|Select specific nodes on which to produce a support dump. Comma-separated node IDs are allowed. The default selects all nodes.| +| Option | Description | +|:-------------|:-------------------------------------------------| +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | diff --git a/reference/ucp/3.1/cli/uninstall-ucp.md b/reference/ucp/3.1/cli/uninstall-ucp.md index a1277e692c..6e6e6d10f7 100644 --- a/reference/ucp/3.1/cli/uninstall-ucp.md +++ b/reference/ucp/3.1/cli/uninstall-ucp.md @@ -30,13 +30,13 @@ UCP is installed again. ## Options -| Option | Description | -| :-------------------- | :---------------------------------------------------------- | -| `--debug, D` | Enable debug mode | -| `--jsonlog` | Produce json formatted output for easier parsing | -| `--interactive, i` | Run in interactive mode and prompt for configuration values | -| `--pull` | Pull UCP images: `always`, when `missing`, or `never` | -| `--registry-username` | Username to use when pulling images | -| `--registry-password` | Password to use when pulling images | -| `--id` | The ID of the UCP instance to uninstall | -| `--purge-config` | Remove UCP configs during uninstallation | +| Option | Description | +|:------------------------------|:----------------------------------------------------------- | +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--interactive, i` | Run in interactive mode and prompt for configuration values | +| `--id` *value* | The ID of the UCP instance to uninstall | +| `--pull` *value* | Pull UCP images: `always`, when `missing`, or `never` | +| `--purge-config` | Remove UCP configs during uninstallation | +| `--registry-password` *value* | Password to use when pulling images | +| `--registry-username` *value* | Username to use when pulling images | diff --git a/reference/ucp/3.1/cli/upgrade.md b/reference/ucp/3.1/cli/upgrade.md index de7d72ae24..23206666c5 100644 --- a/reference/ucp/3.1/cli/upgrade.md +++ b/reference/ucp/3.1/cli/upgrade.md @@ -29,19 +29,16 @@ healthy and that all nodes have been upgraded successfully. ## Options -| Option | Description | -|:----------------------|:------------------------------------------------------------------------------------------------------| -| `--debug, D` | Enable debug mode | -| `--jsonlog` | Produce json formatted output for easier parsing | -| `--interactive, i` | Run in interactive mode and prompt for configuration values | -| `--admin-username` | The UCP administrator username | -| `--admin-password` | The UCP administrator password | -| `--pull` | Pull UCP images: `always`, when `missing`, or `never` | -| `--registry-username` | Username to use when pulling images | -| `--registry-password` | Password to use when pulling images | -| `--id` | The ID of the UCP instance to upgrade | -| `--host-address` | Override the previously configured host address with this IP or network interface | -| `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements | -| `--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 | +| Option | Description | +|:------------------------------|:------------------------------------------------------------------------------------| +| `--debug, D` | Enable debug mode | +| `--jsonlog` | Produce json formatted output for easier parsing | +| `--interactive, i` | Run in interactive mode and prompt for configuration values | +| `--admin-password` *value* | The UCP administrator password | +| `--admin-username` *value* | The UCP administrator username | +| `--force-minimums` | Force the install/upgrade even if the system does not meet the minimum requirements | +| `--host-address` *value* | Override the previously configured host address with this IP or network interface | +| `--id` | The ID of the UCP instance to upgrade | +| `--pull` | Pull UCP images: `always`, when `missing`, or `never` | +| `--registry-password` *value* | Password to use when pulling images | +| `--registry-username` *value* | Username to use when pulling images |