Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 19131c0

Browse files
author
Joao Fernandes
committed
Adds reference docs for docker/ucp
1 parent 98699e9 commit 19131c0

File tree

8 files changed

+115
-86
lines changed

8 files changed

+115
-86
lines changed

‎reference/images.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ to change behavior.
3030

3131
## Options
3232

33-
| Option | Description |
34-
|:----------------------|:-----------------------------------------------------------------------|
35-
| `--debug, -D` | Enable debug |
36-
| `--jsonlog` | Produce json formatted output for easier parsing |
37-
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
38-
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
39-
| `--pull "missing"` | Specify image pull behavior ('always', when 'missing', or 'never') |
40-
| `--list` | Don`t do anything, just list the images used by UCP |
33+
| Option | Description |
34+
|:----------------------|:----------------------------------------------------------------------------------------|
35+
| `--debug, -D` | Enable debug |
36+
| `--jsonlog` | Produce json formatted output for easier parsing |
37+
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
38+
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
39+
| `--pull "missing"` | Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing") |
40+
| `--list` | Don`t do anything, just list the images used by UCP |

‎reference/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Additional help is available for each command with the '--help' option.
6666
| `images` | Verify the UCP images on this engine |
6767
| `uninstall` | Uninstall UCP components from this engine |
6868
| `dump-certs` | Dump out the public certs for this UCP controller |
69+
| `support` | Generate a support dump for this engine |
6970
| `fingerprint` | Dump out the TLS fingerprint for the UCP controller running on this engine |
7071
| `id` | Dump out the ID of the UCP components running on this engine |
7172
| `engine-discovery` | Manage the engine discovery configuration |

‎reference/install.md‎

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,31 @@ mounting the file at '/docker_subscription.lic' in the tool. E.g.
4141

4242
## Options
4343

44-
| Option | Description |
45-
|:-----------------------------------------------------------|:-----------------------------------------------------------------------------------------------|
46-
| `--debug`, `-D` | Enable debug. |
47-
| `--jsonlog` | Produce json formatted output for easier parsing. |
48-
| `--interactive`, `-i` | Enable interactive mode.,You will be prompted to enter all required information. |
49-
| `--admin-username` | Specify the UCP admin username [$UCP_ADMIN_USER] |
50-
| `--admin-password` | Specify the UCP admin password [$UCP_ADMIN_PASSWORD] |
51-
| `--fresh-install` | Destroy any existing state and start fresh. |
52-
| `--san` `[--san option --san option]` | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`). |
53-
| `--host-address` | Specify the visible IP/hostname for this node. |
54-
| `--swarm-port "2376"` | Select what port to run the local Swarm manager on. |
55-
| `--controller-port "443"` | Select what port to run the local Controller on. |
56-
| `--dns` `[--dns option --dns option]` | Set custom DNS servers for the UCP infrastructure containers. |
57-
| `--dns-opt` `[--dns-opt option --dns-opt option]` | Set DNS options for the UCP infrastructure containers. |
58-
| `--dns-search` `[--dns-search option --dns-search option]` | Set custom DNS search domains for the UCP infrastructure containers. |
59-
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
60-
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
61-
| `--swarm-experimental` | Enable experimental Swarm features. Note: Use only for install, not join). |
62-
| `--disable-tracking` | Disable anonymous tracking and analytics. |
63-
| `--disable-usage` | Disable anonymous usage reporting. |
64-
| `--external-server-cert` | Set up UCP with an external CA. |
65-
| `--preserve-certs` | Don't (re)generate certs on the host if existing ones are found. |
66-
| `--binpack` | Set Swarm scheduler to binpack mode (default spread). |
67-
| `--random` | Set Swarm scheduler to random mode (default spread). |
68-
| `--pull "missing"` | Specify image pull behavior (`always`, when `missing`, or `never`). |
69-
| `--skip-engine-discovery` | Do not configure engine for clustering |
44+
| Option | Description |
45+
|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------|
46+
| `--debug`, `-D` | Enable debug. |
47+
| `--jsonlog` | Produce json formatted output for easier parsing. |
48+
| `--interactive`, `-i` | Enable interactive mode.,You will be prompted to enter all required information. |
49+
| `--admin-username` | Specify the UCP admin username [$UCP_ADMIN_USER] |
50+
| `--admin-password` | Specify the UCP admin password [$UCP_ADMIN_PASSWORD] |
51+
| `--fresh-install` | Destroy any existing state and start fresh. |
52+
| `--san` `[--san option --san option]` | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`). |
53+
| `--host-address` | Specify the visible IP/hostname for this node. |
54+
| `--swarm-port "2376"` | Select what port to run the local Swarm manager on (default: 2376) |
55+
| `--controller-port "443"` | Select what port to run the local Controller on (default: 443) |
56+
| `--dns` `[--dns option --dns option]` | Set custom DNS servers for the UCP infrastructure containers. |
57+
| `--dns-opt` `[--dns-opt option --dns-opt option]` | Set DNS options for the UCP infrastructure containers. |
58+
| `--dns-search` `[--dns-search option --dns-search option]` | Set custom DNS search domains for the UCP infrastructure containers. |
59+
| `--kv-timeout` | Timeout in milliseconds for the KV store (set higher for a multi-datacenter cluster) |
60+
| `--kv-snapshot-count` | Number of changes between KV store snapshots (all controllers must use the same value) (default: 10000) |
61+
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
62+
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
63+
| `--swarm-experimental` | Enable experimental Swarm features. Note: Use only for install, not join). |
64+
| `--disable-tracking` | Disable anonymous tracking and analytics. |
65+
| `--disable-usage` | Disable anonymous usage reporting. |
66+
| `--external-server-cert` | Set up UCP with an external CA. |
67+
| `--preserve-certs` | Don't (re)generate certs on the host if existing ones are found. |
68+
| `--binpack` | Set Swarm scheduler to binpack mode (default spread). |
69+
| `--random` | Set Swarm scheduler to random mode (default spread). |
70+
| `--pull "missing"` | Specify image pull behavior (`always`, when `missing`, or `never`) (default: "missing") |
71+
| `--skip-engine-discovery` | Do not configure engine for clustering |

‎reference/join.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ will be retrieved from that backup. Add the following volume mount:
5151
| `--fresh-install` | Destroy any existing state and start fresh. |
5252
| `--san` `[--san option --san option]` | Additional Subject Alternative Names for certs (e.g. `--san foo1.bar.com --san foo2.bar.com`). |
5353
| `--host-address` | Specify the visible IP/hostname for this node. (override automatic detection) [$UCP_HOST_ADDRESS] |
54-
| `--swarm-port "2376"` | Select what port to run the local Swarm manager on. |
55-
| `--controller-port "443"` | Select what port to run the local Controller on. |
54+
| `--swarm-port "2376"` | Select what port to run the local Swarm manager on (default: 2376) |
55+
| `--controller-port "443"` | Select what port to run the local Controller on (default: 443) |
5656
| `--dns` `[--dns option --dns option]` | Set custom DNS servers for the UCP infrastructure containers. |
5757
| `--dns-opt` `[--dns-opt option --dns-opt option]` | Set DNS options for the UCP infrastructure containers. |
5858
| `--dns-search` `[--dns-search option --dns-search option]` | Set custom DNS search domains for the UCP infrastructure containers. |
@@ -62,6 +62,6 @@ will be retrieved from that backup. Add the following volume mount:
6262
| `--fingerprint` | The fingerprint of the UCP controller you trust [$UCP_FINGERPRINT] |
6363
| `--replica` | Configure this node to be a UCP controller replica. |
6464
| `--external-server-cert` | (Replica only) Use externally signed certificates for the controller. |
65-
| `--pull "missing"` | Specify image pull behavior ('always', when 'missing', or 'never'). |
65+
| `--pull "missing"` | Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing") |
6666
| `--passphrase` | Decrypt the Root CA tar file with the provided passphrase [$UCP_PASSPHRASE] |
6767
| `--skip-engine-discovery` | Do not configure engine for clustering |

‎reference/support.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
+++
2+
title = "support"
3+
description = "Generate a support dump for this engine."
4+
keywords= ["docker, ucp, support, logs"]
5+
[menu.main]
6+
parent = "ucp_ref"
7+
identifier = "ucp_ref_support"
8+
+++
9+
10+
# docker/ucp support
11+
12+
Generate a support dump for this engine.
13+
14+
## Usage
15+
16+
```
17+
docker run --rm \
18+
--name ucp \
19+
-v /var/run/docker.sock:/var/run/docker.sock \
20+
docker/ucp \
21+
support > docker-support.tgz
22+
```
23+
24+
## Description
25+
26+
This utility will produce a support dump file on stdout for this local node.

‎reference/uninstall.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,14 @@ engine in your cluster.
2828

2929
## Options
3030

31-
| Option | Description |
32-
|:----------------------|:----------------------------------------------------------------------------|
33-
| `--debug`, `-D` | Enable debug |
34-
| `--jsonlog` | Produce json formatted output for easier parsing |
35-
| `--interactive`, `-i` | Enable interactive mode.,You are prompted to enter all required information |
36-
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
37-
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
38-
| `--id` | The ID of the UCP instance to uninstall |
39-
| `--preserve-certs` | Don't delete the certs on the host |
40-
| `--preserve-images` | Don't delete images on the host |
31+
| Option | Description |
32+
|:----------------------|:----------------------------------------------------------------------------------------|
33+
| `--debug`, `-D` | Enable debug |
34+
| `--jsonlog` | Produce json formatted output for easier parsing |
35+
| `--interactive`, `-i` | Enable interactive mode.,You are prompted to enter all required information |
36+
| `--pull` | Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing") |
37+
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
38+
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
39+
| `--id` | The ID of the UCP instance to uninstall |
40+
| `--preserve-certs` | Don't delete the certs on the host |
41+
| `--preserve-images` | Don't delete images on the host |

‎reference/upgrade.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ before proceeding to the next node.
3434

3535
## Options
3636

37-
| Option | Description |
38-
|:----------------------|:--------------------------------------------------------------------------------|
39-
| ` --debug, -D` | Enable debug |
40-
| ` --jsonlog` | Produce json formatted output for easier parsing |
41-
| ` --interactive, -i` | Enable interactive mode.,You will be prompted to enter all required information |
42-
| `--admin-username` | Specify the UCP admin username [$UCP_ADMIN_USER] |
43-
| `--admin-password` | Specify the UCP admin password [$UCP_ADMIN_PASSWORD] |
44-
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
45-
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
46-
| `--id` | The ID of the UCP instance to upgrade |
47-
| `--pull "always"` | Specify image pull behavior ('always', when 'missing', or 'never') |
37+
| Option | Description |
38+
|:----------------------|:----------------------------------------------------------------------------------------|
39+
| ` --debug, -D` | Enable debug |
40+
| ` --jsonlog` | Produce json formatted output for easier parsing |
41+
| ` --interactive, -i` | Enable interactive mode.,You will be prompted to enter all required information |
42+
| `--admin-username` | Specify the UCP admin username [$UCP_ADMIN_USER] |
43+
| `--admin-password` | Specify the UCP admin password [$UCP_ADMIN_PASSWORD] |
44+
| `--registry-username` | Specify the username to pull required images with [$REGISTRY_USERNAME] |
45+
| `--registry-password` | Specify the password to pull required images with [$REGISTRY_PASSWORD] |
46+
| `--id` | The ID of the UCP instance to upgrade |
47+
| `--pull "always"` | Specify image pull behavior ('always', when 'missing', or 'never') (default: "missing") |

0 commit comments

Comments
 (0)