From 04798ea6e0bb737cc74fa832cb801e12790a521b Mon Sep 17 00:00:00 2001 From: Anne Henmi Date: Wed, 7 Nov 2018 10:26:12 -0800 Subject: [PATCH 1/6] Fixed table in UCP 3.1 CLI reference. --- reference/ucp/3.1/cli/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/ucp/3.1/cli/install.md b/reference/ucp/3.1/cli/install.md index 4c7a3dabd5..9a9731e266 100644 --- a/reference/ucp/3.1/cli/install.md +++ b/reference/ucp/3.1/cli/install.md @@ -47,8 +47,8 @@ command. | `--interactive, i` | Run in interactive mode and prompt for configuration values | | `--admin-username` | The UCP administrator username | | `--admin-password` | The UCP administrator password | -| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | -| `--unmanaged-cni` | This determines who manages the CNI plugin, using `true` or `false`. The default is `false`. The `true` value installs UCP without a managed CNI plugin. UCP and the Kubernetes components will be running but pod to pod networking will not function until a CNI plugin is manually installed. This will impact some functionality of UCP until a CNI plugin is running. | +| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) +| `--unmanaged-cni` | This determines who manages the CNI plugin, using `true` or `false`. The default is `false`. The `true` value installs UCP without a managed CNI plugin. UCP and the Kubernetes components will be running but pod to pod networking will not function until a CNI plugin is manually installed. This will impact some functionality of UCP until a CNI plugin is running. | `--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. Format: IP address or network interface name | | `--controller-port` | Port for the web UI and API | From a277b0d20cd82bef951eb412c610974476ce40c2 Mon Sep 17 00:00:00 2001 From: Anne Henmi Date: Wed, 7 Nov 2018 10:29:07 -0800 Subject: [PATCH 2/6] Fixed the rest of the table. --- reference/ucp/3.1/cli/install.md | 54 ++++++++++++++++---------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/reference/ucp/3.1/cli/install.md b/reference/ucp/3.1/cli/install.md index 9a9731e266..ef993a7a04 100644 --- a/reference/ucp/3.1/cli/install.md +++ b/reference/ucp/3.1/cli/install.md @@ -54,32 +54,32 @@ command. | `--controller-port` | Port for the web UI and API | | `--kube-apiserver-port` | Port for the Kubernetes API server (default: 6443) | | `--swarm-port` | Port for the Docker Swarm manager. Used for backwards compatibility | -| `--swarm-grpc-port` | Port for communication between nodes | +| `--swarm-grpc-port` | Port for communication between nodes | `--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. -| + | `--unmanaged-cni` | flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider). The default value is "true" when using the default Calico CNI. -| -| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: 192.168.0.0/16) | -| `--cloud-provider` | The cloud provider for the cluster | -| `--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 | -| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | -| `--existing-config` | Use the latest existing UCP config during this installation. The install fails if a config is not found. | -| `--force-minimums` | Force the install/upgrade even if the system doesn't meet the minimum requirements. | -| `--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 | -| `--kv-timeout` | Timeout in milliseconds for the key-value store | -| `--kv-snapshot-count` | Number of changes between key-value store snapshots | -| `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility | -| `--disable-tracking` | Disable anonymous tracking and analytics | -| `--disable-usage` | Disable anonymous usage reporting | -| `--external-server-cert` | Use the certificates in the `ucp-controller-server-certs` volume instead of generating self-signed certs during installation | -| `--preserve-certs` | Don't generate certificates if they already exist | -| `--binpack` | Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility | -| `--random` | Set the Docker Swarm scheduler to random mode. Used for backwards compatibility | -| `--external-service-lb` | Set the external service load balancer reported in the UI | -| `--enable-profiling` | Enable performance profiling | -| `--license` | Add a license: e.g. --license "$(cat license.lic)" | -| `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports | + +| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: 192.168.0.0/16) +| `--cloud-provider` | The cloud provider for the cluster +| `--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 +| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. +| `--existing-config` | Use the latest existing UCP config during this installation. The install fails if a config is not found. +| `--force-minimums` | Force the install/upgrade even if the system doesn't meet the minimum requirements. +| `--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 +| `--kv-timeout` | Timeout in milliseconds for the key-value store +| `--kv-snapshot-count` | Number of changes between key-value store snapshots +| `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility +| `--disable-tracking` | Disable anonymous tracking and analytics +| `--disable-usage` | Disable anonymous usage reporting +| `--external-server-cert` | Use the certificates in the `ucp-controller-server-certs` volume instead of generating self-signed certs during installation +| `--preserve-certs` | Don't generate certificates if they already exist +| `--binpack` | Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility +| `--random` | Set the Docker Swarm scheduler to random mode. Used for backwards compatibility +| `--external-service-lb` | Set the external service load balancer reported in the UI +| `--enable-profiling` | Enable performance profiling +| `--license` | Add a license: e.g. --license "$(cat license.lic)" +| `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports From e639c5d80a579c4f1fe7a96755e96f3ab749b1f1 Mon Sep 17 00:00:00 2001 From: Anne Henmi Date: Wed, 7 Nov 2018 10:32:03 -0800 Subject: [PATCH 3/6] Still arguing with markdown.. --- reference/ucp/3.1/cli/install.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/reference/ucp/3.1/cli/install.md b/reference/ucp/3.1/cli/install.md index ef993a7a04..fb43b9910c 100644 --- a/reference/ucp/3.1/cli/install.md +++ b/reference/ucp/3.1/cli/install.md @@ -42,22 +42,21 @@ command. | 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 | -| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) -| `--unmanaged-cni` | This determines who manages the CNI plugin, using `true` or `false`. The default is `false`. The `true` value installs UCP without a managed CNI plugin. UCP and the Kubernetes components will be running but pod to pod networking will not function until a CNI plugin is manually installed. This will impact some functionality of UCP until a CNI plugin is running. +| `--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 | +| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | | `--unmanaged-cni` | This determines who manages the CNI plugin, using `true` or `false`. The default is `false`. The `true` value installs UCP without a managed CNI plugin. UCP and the Kubernetes components will be running but pod to pod networking will not function until a CNI plugin is manually installed. This will impact some functionality of UCP until a CNI plugin is running.| | `--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. Format: IP address or network interface name | | `--controller-port` | Port for the web UI and API | | `--kube-apiserver-port` | Port for the Kubernetes API server (default: 6443) | -| `--swarm-port` | Port for the Docker Swarm manager. Used for backwards compatibility | -| `--swarm-grpc-port` | Port for communication between nodes -| `--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. +| `--swarm-port` | Port for the Docker Swarm manager. Used for backwards compatibility | +| `--swarm-grpc-port` | Port for communication between nodes | +| `--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. | -| `--unmanaged-cni` | flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider). The default value is "true" when using the default Calico CNI. +| `--unmanaged-cni` | flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider). The default value is "true" when using the default Calico CNI. | | `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: 192.168.0.0/16) | `--cloud-provider` | The cloud provider for the cluster From 7a4592bd6829897d909968861300400e0e510e36 Mon Sep 17 00:00:00 2001 From: Anne Henmi Date: Wed, 7 Nov 2018 10:35:35 -0800 Subject: [PATCH 4/6] Hopefulling fixing.. --- reference/ucp/3.1/cli/install.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/reference/ucp/3.1/cli/install.md b/reference/ucp/3.1/cli/install.md index fb43b9910c..0f0bbb1106 100644 --- a/reference/ucp/3.1/cli/install.md +++ b/reference/ucp/3.1/cli/install.md @@ -58,12 +58,12 @@ command. | `--unmanaged-cni` | flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider). The default value is "true" when using the default Calico CNI. | -| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: 192.168.0.0/16) -| `--cloud-provider` | The cloud provider for the cluster -| `--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 -| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. +| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: `192.168.0.0/16`) | +| `--cloud-provider` | The cloud provider for the cluster | +| `--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 | +| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | | `--existing-config` | Use the latest existing UCP config during this installation. The install fails if a config is not found. | `--force-minimums` | Force the install/upgrade even if the system doesn't meet the minimum requirements. | `--pull` | Pull UCP images: `always`, when `missing`, or `never` From e1cdcd5322750ad1e15e20d168b6318fdde9fcbc Mon Sep 17 00:00:00 2001 From: Anne Henmi Date: Wed, 7 Nov 2018 11:10:08 -0800 Subject: [PATCH 5/6] Completed HTML table fix. --- reference/ucp/3.1/cli/install.md | 203 ++++++++++++++++++++++++------- 1 file changed, 161 insertions(+), 42 deletions(-) diff --git a/reference/ucp/3.1/cli/install.md b/reference/ucp/3.1/cli/install.md index 0f0bbb1106..409b993e56 100644 --- a/reference/ucp/3.1/cli/install.md +++ b/reference/ucp/3.1/cli/install.md @@ -40,45 +40,164 @@ command. ## 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 | -| `--san` | Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) | | `--unmanaged-cni` | This determines who manages the CNI plugin, using `true` or `false`. The default is `false`. The `true` value installs UCP without a managed CNI plugin. UCP and the Kubernetes components will be running but pod to pod networking will not function until a CNI plugin is manually installed. This will impact some functionality of UCP until a CNI plugin is running.| -| `--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. Format: IP address or network interface name | -| `--controller-port` | Port for the web UI and API | -| `--kube-apiserver-port` | Port for the Kubernetes API server (default: 6443) | -| `--swarm-port` | Port for the Docker Swarm manager. Used for backwards compatibility | -| `--swarm-grpc-port` | Port for communication between nodes | -| `--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. | - -| `--unmanaged-cni` | flag to indicate if cni provider is calico and managed by UCP (calico is the default CNI provider). The default value is "true" when using the default Calico CNI. | - -| `--pod-cidr` | Kubernetes cluster IP pool for the pods to allocated IPs from (Default: `192.168.0.0/16`) | -| `--cloud-provider` | The cloud provider for the cluster | -| `--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 | -| `--unlock-key` | The unlock key for this swarm-mode cluster, if one exists. | -| `--existing-config` | Use the latest existing UCP config during this installation. The install fails if a config is not found. -| `--force-minimums` | Force the install/upgrade even if the system doesn't meet the minimum requirements. -| `--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 -| `--kv-timeout` | Timeout in milliseconds for the key-value store -| `--kv-snapshot-count` | Number of changes between key-value store snapshots -| `--swarm-experimental` | Enable Docker Swarm experimental features. Used for backwards compatibility -| `--disable-tracking` | Disable anonymous tracking and analytics -| `--disable-usage` | Disable anonymous usage reporting -| `--external-server-cert` | Use the certificates in the `ucp-controller-server-certs` volume instead of generating self-signed certs during installation -| `--preserve-certs` | Don't generate certificates if they already exist -| `--binpack` | Set the Docker Swarm scheduler to binpack mode. Used for backwards compatibility -| `--random` | Set the Docker Swarm scheduler to random mode. Used for backwards compatibility -| `--external-service-lb` | Set the external service load balancer reported in the UI -| `--enable-profiling` | Enable performance profiling -| `--license` | Add a license: e.g. --license "$(cat license.lic)" -| `--force-insecure-tcp` | Force install to continue even with unauthenticated Docker Engine ports + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
--debug, DEnable debug mode
--jsonlogProduce json formatted output for easier parsing
--jsonlogProduce json formatted output for easier parsing
--interactive, i Run in interactive mode and prompt for configuration values
--admin-username The UCP administrator username
--admin-passwordThe UCP administrator password
--sanAdd subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com)--unmanaged-cniThis determines who manages the CNI plugin, using true or false. The default is false The true value installs UCP without a managed CNI plugin. UCP and the Kubernetes components will be running but pod to pod networking will not function until a CNI plugin is manually installed. This will impact some functionality of UCP until a CNI plugin is running.
--host-addressThe network address to advertise to other nodes. Format: IP address or network interface name
--data-path-addrAddress or interface to use for data path traffic. Format: IP address or network interface name
--controller-portPort for the web UI and API
--kube-apiserver-portPort for the Kubernetes API server (default: 6443)
--swarm-portPort for the Docker Swarm manager. Used for backwards compatibility
--swarm-grpc-portPort for communication between nodes
--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.
--pod-cidrKubernetes cluster IP pool for the pods to allocated IPs from (Default: `192.168.0.0/16`)
--cloud-providerThe cloud provider for the cluster
--dnsSet custom DNS servers for the UCP containers
--dns-optSet DNS options for the UCP containers
--dns-searchSet custom DNS search domains for the UCP containers
--unlock-keyThe unlock key for this swarm-mode cluster, if one exists.
--existing-configUse the latest existing UCP config during this installation. The install fails if a configuration is not found.
--force-minimumsForce the install/upgrade even if the system doesn't meet the minimum requirements.
--pullPull UCP images: always when missing or never.
--registry-usernameUsername to use when pulling images
--registry-passwordPassword to use when pulling images
--kv-timeoutTimeout in milliseconds for the key-value store
--kv-snapshot-countNumber of changes between key-value store snapshots
--swarm-experimentalEnable Docker Swarm experimental features. Used for backwards compatibility.
--disable-trackingDisable anonymous tracking and analytics
--disable-usageDisable anonymous usage reporting
--external-server-certUse the certificates in the ucp-controller-server-certs volume instead of generating self-signed certs during installation.
--preserve-certsDo not generate certificates if they already exist.
--binpackSet the Docker Swarm scheduler to binpack mode. Used for backwards compatibility.
--randomSet the Docker Swarm scheduler to random mode. Used for backwards compatibility.
--external-service-lbSet the external service load balancer reported in the UI
--enable-profilingEnable performance profiling
--licenseAdd a license: e.g. --license "$(cat license.lic)" +
--force-insecure-tcpForce install to continue even with unauthenticated Docker Engine ports
From 897a4ba3b1d09f1d62479bd79142b33e55065b94 Mon Sep 17 00:00:00 2001 From: Anne Henmi Date: Wed, 7 Nov 2018 11:11:13 -0800 Subject: [PATCH 6/6] Fixed td tag. --- reference/ucp/3.1/cli/install.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/reference/ucp/3.1/cli/install.md b/reference/ucp/3.1/cli/install.md index 409b993e56..511415f13b 100644 --- a/reference/ucp/3.1/cli/install.md +++ b/reference/ucp/3.1/cli/install.md @@ -72,7 +72,8 @@ command. --san Add subject alternative names to certificates (e.g. --san www1.acme.com --san www2.acme.com) - + + --unmanaged-cni This determines who manages the CNI plugin, using true or false. The default is false The true value installs UCP without a managed CNI plugin. UCP and the Kubernetes components will be running but pod to pod networking will not function until a CNI plugin is manually installed. This will impact some functionality of UCP until a CNI plugin is running.