Removes --image-version flag from docs

The --image-version flag is for internal use only. The `ucp help` command doesn't output that flag anymore, so I'm removing it from the docs also. Fixes #795 Signed-off-by: Joao Fernandes <joao.fernandes@docker.com>
docker · Nov 6, 2016 · 6b2ee8d · 6b2ee8d
1 parent cdff9b0
commit 6b2ee8d
Show file tree

Hide file tree

Showing 5 changed files with 115 additions and 101 deletions.
diff --git a/reference/images.md b/reference/images.md
@@ -29,11 +29,10 @@ behavior.
 
 ## Options
 
-| Option | Description |
-|---------------------------|----------------------------------------------------------------------------------|
-| `--debug`, `-D` | Enable debug. |
-| `--jsonlog` | Produce json formatted output for easier parsing. |
-| `--interactive`, `-i` | Enable interactive mode. You are prompted to enter all required information. |
-| `--image-version "0.7.0"` | Select a specific UCP version. |
-| `--pull "missing"` | Specify image pull behavior (`always`, when `missing`, or `never`). |
-| `--list` | Don`t do anything, just list the images used by UCP |
+| Option | Description |
+|:----------------------|:-----------------------------------------------------------------------------|
+| `--debug`, `-D` | Enable debug. |
+| `--jsonlog` | Produce json formatted output for easier parsing. |
+| `--interactive`, `-i` | Enable interactive mode. You are prompted to enter all required information. |
+| `--pull "missing"` | Specify image pull behavior (`always`, when `missing`, or `never`). |
+| `--list` | Don`t do anything, just list the images used by UCP |
diff --git a/reference/install.md b/reference/install.md
@@ -9,9 +9,9 @@ parent = "ucp_ref"
 
 # install
 
-Verify the UCP images on this engine
+Install UCP on this engine.
 
-```
+```bash
 docker run --rm -it \
  --name ucp \
  -v /var/run/docker.sock:/var/run/docker.sock \
@@ -23,38 +23,45 @@ docker run --rm -it \
 
 Install the UCP controller on a machine. You can only install on machines where
 Docker Engine is already installed. If you intend to install a multi-node
-cluster, you must open firewall ports between the engines for the following
+cluster, you must open firewall ports between the Engines for the following
 ports:
 
-* 443 (system default `--controller-port`)
+* 443 (customizable using the `--controller-port` option)
 * 12376
 * 12379 through 12382
-* 2376 (system default '--swarm-port')
+* 2376 (customizable using the `--swarm-port` option)
 
 You can optionally use an externally generated and signed certificate for the
-UCP controller by specifying '--external-ucp-ca'.  Create a storage volume named
-'ucp-server-certs' with ca.pem, cert.pem, and key.pem in the root directory
+UCP controller by using the `--external-ucp-ca`. Create a storage volume named
+`ucp-server-certs` with ca.pem, cert.pem, and key.pem in the root directory
 before running the install.
 
+A license file can optionally be added during install by volume
+mounting the file at `/docker_subscription.lic` in the tool.
+
+```bash
+-v /path/to/my/docker_subscription.lic:/docker_subscription.lic
+```
+
 ## Options
 
-| Option | Description |
-|------------------------------------------------------------|------------------------------------------------------------------------------------------------|
-| `--debug`, `-D` | Enable debug. |
-| `--jsonlog` | Produce json formatted output for easier parsing. |
-| `--interactive`, `-i` | Enable interactive mode.,You will be prompted to enter all required information. |
-| `--fresh-install` | Destroy any existing state and start fresh. |
-| `--san` [`--san option` `--san option`] | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`). |
-| `--host-address` | Specify the visible IP/hostname for this node. |
-| `--swarm-port "2376"` | Select what port to run the local Swarm manager on. |
-| `--controller-port "443" | Select what port to run the local Controller on. |
-| `--dns` [`--dns option` `--dns option`] | Set custom DNS servers for the UCP infrastructure containers. |
-| `--dns-opt` [`--dns-opt option --dns-opt option`] | Set DNS options for the UCP infrastructure containers. |
-| `--dns-search` [`--dns-search option --dns-search option`] | Set custom DNS search domains for the UCP infrastructure containers. |
-| `--disable-tracking` | Disable anonymous tracking and analytics. |
-| `--disable-usage` | Disable anonymous usage reporting. |
-| `--external-ucp-ca` | Set up UCP with an external CA. |
-| `--preserve-certs` | Don't (re)generate certs on the host if existing ones are found. |
-| `--binpack` | Set Swarm scheduler to binpack mode (default spread). |
-| `--random` | Set Swarm scheduler to random mode (default spread). |
-| `--pull "missing"` | Specify image pull behavior (`always`, when `missing`, or `never`). |
+| Option  | Description  |
+|:-----------------------------------------------------------|:-----------------------------------------------------------------------------------------------|
+| `--debug`, `-D`  | Enable debug.  |
+| `--jsonlog`  | Produce json formatted output for easier parsing.  |
+| `--interactive`, `-i`  | Enable interactive mode.,You will be prompted to enter all required information.  |
+| `--fresh-install`  | Destroy any existing state and start fresh.  |
+| `--san` `[--san option --san option]`  | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`). |
+| `--host-address`  | Specify the visible IP/hostname for this node.  |
+| `--swarm-port "2376"`  | Select what port to run the local Swarm manager on.  |
+| `--controller-port "443"` | Select what port to run the local Controller on.  |
+| `--dns` `[--dns option --dns option]` | Set custom DNS servers for the UCP infrastructure containers.  |
+| `--dns-opt` `[--dns-opt option --dns-opt option]` | Set DNS options for the UCP infrastructure containers.  |
+| `--dns-search` `[--dns-search option --dns-search option]` | Set custom DNS search domains for the UCP infrastructure containers.  |
+| `--disable-tracking`  | Disable anonymous tracking and analytics.  |
+| `--disable-usage`  | Disable anonymous usage reporting.  |
+| `--external-ucp-ca`  | Set up UCP with an external CA.  |
+| `--preserve-certs`  | Don't (re)generate certs on the host if existing ones are found.  |
+| `--binpack`  | Set Swarm scheduler to binpack mode (default spread).  |
+| `--random`  | Set Swarm scheduler to random mode (default spread).  |
+| `--pull "missing"`  | Specify image pull behavior (`always`, when `missing`, or `never`).  |
diff --git a/reference/join.md b/reference/join.md
@@ -30,31 +30,32 @@ visibility to eachother and have the required ports open on their firewall
 settings. If your system has multiple IP addresses, you may need to
 specify the `--host-address` option to ensure the correct address is used.
 
-Ports: 443 (`--controller-port` from `install`), 12376, 12379, 12380, 12381, 12382 and 2376 (`--swarm-port` from `install`)
+Ports: 443 (customizable using `install --controller-port`),
+12376, 12379, 12380, 12381, 12382 and 2376
+(customizable using `install --swarm-port`).
 
 To enable high-availability, you must join at least one node with the
-`replica` flag.
-
+`--replica` flag.
 
 ## Options
 
-| Option | Description |
-|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
-| `--debug`, `-D` | Enable debug. |
-| `--jsonlog` | Produce json formatted output for easier parsing. |
-| `--interactive`, `-i` | Enable interactive mode. You will be prompted to enter all required information. |
-| `--fresh-install` | Destroy any existing state and start fresh. |
-| `--san` [`--san option` `--san option`] | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`). |
-| `--host-address` | Specify the visible IP/hostname for this node. (override automatic detection) [`$UCP_HOST_ADDRESS`] |
-| `--swarm-port "2376"` | Select what port to run the local Swarm manager on. |
-| `--controller-port "443"` | Select what port to run the local Controller on. |
-| `--dns` [`--dns option --dns option`] | Set custom DNS servers for the UCP infrastructure containers. |
-| `--dns-opt `[`--dns-opt option --dns-opt option`] | Set DNS options for the UCP infrastructure containers. |
-| `--dns-search` [`--dns-search option --dns-search option`] | Set custom DNS search domains for the UCP infrastructure containers. |
-| `--disable-tracking` | Disable anonymous tracking and analytics. |
-| `--disable-usage` | Disable anonymous usage reporting. |
-| `--url` | The connection URL for the remote UCP controller [`$UCP_URL`] |
-| `--fingerprint ` | The fingerprint of the UCP controller you trust [`$UCP_FINGERPRINT`] |
-| `--replica` | Configure this node as a full Orca controller replica. |
-| `--external-ucp-ca` | (Replica only) Use externally signed certificates for the controller. |
-| `--pull "missing"` | Specify image pull behavior (`always`, when `missing`, or `never`). |
+| Option  | Description  |
+|:-----------------------------------------------------------|:----------------------------------------------------------------------------------------------------|
+| `--debug`, `-D`  | Enable debug.  |
+| `--jsonlog`  | Produce json formatted output for easier parsing.  |
+| `--interactive`, `-i`  | Enable interactive mode. You will be prompted to enter all required information.  |
+| `--fresh-install`  | Destroy any existing state and start fresh.  |
+| `--san` [`--san option` `--san option`]  | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`).  |
+| `--host-address`  | Specify the visible IP/hostname for this node. (override automatic detection) [`$UCP_HOST_ADDRESS`] |
+| `--swarm-port "2376"`  | Select what port to run the local Swarm manager on.  |
+| `--controller-port "443"`  | Select what port to run the local Controller on.  |
+| `--dns` [`--dns option --dns option`]  | Set custom DNS servers for the UCP infrastructure containers.  |
+| `--dns-opt `[`--dns-opt option --dns-opt option`]  | Set DNS options for the UCP infrastructure containers.  |
+| `--dns-search` [`--dns-search option --dns-search option`] | Set custom DNS search domains for the UCP infrastructure containers.  |
+| `--disable-tracking`  | Disable anonymous tracking and analytics.  |
+| `--disable-usage`  | Disable anonymous usage reporting.  |
+| `--url`  | The connection URL for the remote UCP controller [`$UCP_URL`]  |
+| `--fingerprint `  | The fingerprint of the UCP controller you trust [`$UCP_FINGERPRINT`]  |
+| `--replica`  | Configure this node as a full Orca controller replica.  |
+| `--external-ucp-ca`  | (Replica only) Use externally signed certificates for the controller.  |
+| `--pull "missing"`  | Specify image pull behavior (`always`, when `missing`, or `never`).  |
diff --git a/reference/uninstall.md b/reference/uninstall.md
@@ -19,50 +19,58 @@ parent = "ucp_ref"
 
 ## Description
 
-Removes UCP from a node. The `uninstall` | does not remove any other containers that are running, except those recognized to be part of UCP.
-
-After you uninstall UCP from a node, the node continues to appear in the Dashboard because the node still has the `ucp` image; the image couldn't be removed while a container was running. Remove the `ucp` tool's image to completely delete the node from the UCP application dashboard.
+Removes UCP from a node. The `uninstall` command doesn't remove any other
+containers that are running, except those recognized to be part of UCP.
 
 ## Options
 
-| Option | Description |
-|-----------------------|------------------------------------------------------------------------------|
-| `--debug`, `-D` | Enable debug. |
-| `--jsonlog` | Produce json formatted output for easier parsing. |
+| Option  | Description  |
+|:----------------------|:-----------------------------------------------------------------------------|
+| `--debug`, `-D`  | Enable debug.  |
+| `--jsonlog`  | Produce json formatted output for easier parsing.  |
 | `--interactive`, `-i` | Enable interactive mode.,You are prompted to enter all required information. |
-| `--id` | The ID of the UCP instance to uninstall. |
-| `--preserve-certs` | Don't delete the certs on the host. |
-| `--preserve-images` | Don't delete images on the host. |
+| `--id`  | The ID of the UCP instance to uninstall.  |
+| `--preserve-certs`  | Don't delete the certs on the host.  |
+| `--preserve-images`  | Don't delete images on the host.  |
 
 ## Example
 
 The following example illustrates an interactive uninstall.
 
 1. Run the uninstall command.
 
-  $ docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock --name ucp docker/ucp uninstall -i
-  INFO[0000] We're about to uninstall the local components for UCP ID: FEY4:M46O:7OUS:QQA4:HLR3:4HRD:IUTH:LC2W:QPRE:BLYH:UWEM:3TYV
-  Do you want proceed with the uninstall? (y/n): y
-  INFO[0000] Removing UCP Containers 
-  INFO[0000] Removing UCP images 
-  INFO[0005] Removing UCP volumes 
+ ```
+ $ docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock --name ucp docker/ucp uninstall -i
+
+ INFO[0000] We're about to uninstall the local components for UCP ID: FEY4:M46O:7OUS:QQA4:HLR3:4HRD:IUTH:LC2W:QPRE:BLYH:UWEM:3TYV
+ Do you want proceed with the uninstall? (y/n): y
+
+ INFO[0000] Removing UCP Containers
+ INFO[0000] Removing UCP images
+ INFO[0005] Removing UCP volumes
+ ```
 
 2. List the images remaining on the node.
 
- Because the `ucp` tool is running during the installation, it can't remove
- its own image. Until you remove that image, the node continues to appear in
- the UCP dashboard.
+ ```
+ $ docker images
 
-  $ docker images
-  REPOSITORY TAG IMAGE ID  CREATED SIZE
-   docker/ucp latest 788bdcfde423 8 days ago 8.239 MB
+ REPOSITORY  TAG IMAGE ID CREATED SIZE
+ docker/ucp latest 788bdcfde423  8 days ago 8.239 MB
+ ```
 
 3. Remove the `ucp` image from the node.
 
-  $ docker rmi 788bdcfde423
-  Untagged: docker/ucp:latest
-  Deleted: sha256:788bdcfde423b6226b90ac98e6f233b15c0c527779177d7017a4e17db31404c9
-  Deleted: sha256:dee84053b25f9b3edffb734c842a70313021063cc78d9158c63de109e1b3cb72
-  Deleted: sha256:93743d5df2362466e2fe116a677ec6a4b0091bd09e889abfc9109047fcfcdebf
+ Because the `ucp` tool is running during the installation, it can't remove
+ its own image. If you want to free up that space, delete the ucp image.
+
+ ```
+ $ docker rmi docker/ucp:latest
+
+ Untagged: docker/ucp:latest
+ Deleted: sha256:788bdcfde423b6226b90ac98e6f233b15c0c527779177d7017a4e17db31404c9
+ Deleted: sha256:dee84053b25f9b3edffb734c842a70313021063cc78d9158c63de109e1b3cb72
+ Deleted: sha256:93743d5df2362466e2fe116a677ec6a4b0091bd09e889abfc9109047fcfcdebf
+ ```
 
-4. Return to the UCP application, confirm the node is removed.
+4. Return to the UCP web application to confirm the node is removed.