Skip to content

Commit b868e6b

Browse files
Mary AnthonyJoao Fernandes
Mary Anthony
authored and
Joao Fernandes
committed
Updating install; Initial docs rearrangement
Creating specs directory; may be moved later Adding fix for Issue docker#348 Adding in updates for networking Updating with Dan's comments: removing old -beta Updating networking after talking to Madhu Updated install with HA as optional Moved HA spec into specs Did "customer-facing" HA page Renamed server > controller in docs Entering comments from reviewers Signed-off-by: Mary Anthony <[email protected]>
1 parent 84a11c4 commit b868e6b

28 files changed

+911
-489
lines changed

bootstrap/install.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# install Command
2+
3+
USAGE:
4+
```
5+
docker run --rm -it \
6+
--name ucp \
7+
-v /var/run/docker.sock:/var/run/docker.sock \
8+
dockerorca/ucp \
9+
install [OPTIONS]
10+
```
11+
DESCRIPTION:
12+
13+
Install the UCP controller on a machine. You can only install on machines where
14+
Docker Engine is already installed. If you intend to install a multi-node
15+
cluster, you must open firewall ports between the engines for the following
16+
ports:
17+
18+
* 443
19+
* 12376
20+
* 12379 through 12382
21+
* 2376 (system default '--swarm-port')
22+
23+
You can optionally use an externally generated and signed certificate for the
24+
UCP controller by specifying '--external-ucp-ca'. Create a storage volume named
25+
'ucp-server-certs' with ca.pem, cert.pem, and key.pem in the root directory
26+
before running the install.
27+
28+
29+
OPTIONS:
30+
`--debug`, `-D `
31+
Enable debug
32+
`--jsonlog`
33+
Produce json formatted output for easier parsing
34+
`--interactive`, `-i`
35+
Enable interactive mode. The system prompts you to enter all required information.
36+
`--fresh-install`
37+
Destroy any existing state and start fresh
38+
`--san` A subject alternative sames (SAN) for certs. You can specify multiple SAN's, for example, `--san foo1.bar.com --san foo2.bar.com`.
39+
`--host-address`
40+
Specify the visible IP/hostname for this node. (override automatic detection) [$UCP_HOST_ADDRESS]
41+
`--old-kernel`
42+
Install on older kernels (some features may not be supported)
43+
`--image-version "latest"`
44+
Select a specific UCP version
45+
--swarm-port "2376"
46+
Select what port to run the local Swarm manager on
47+
--external-ucp-ca
48+
Set up UCP with an external CA.
49+
--preserve-certs
50+
Don't (re)generate certs on the host if existing ones are found
51+
--binpack
52+
Set Swarm scheduler to binpack mode (default spread)
53+
--random
54+
Set Swarm scheduler to random mode (default spread)
55+
--pull "missing"
56+
Specify image pull behavior ('always', when 'missing', or 'never')

bootstrap/join.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# join Command

bootstrap/upgrade.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# upgrade
2+
3+
docker run --rm -it \
4+
--name ucp \
5+
-v /var/run/docker.sock:/var/run/docker.sock \
6+
dockerorca/ucp \
7+
upgrade [OPTIONS]
8+
9+
DESCRIPTION:
10+
11+
Upgrades UCP on a node. When upgrading UCP, you must run
12+
the 'upgrade' command against every server and node running Docker Engine in
13+
your cluster. You should upgrade your controller and replica nodes first,
14+
followed by your compute nodes.
15+
16+
Depending on the upgrade path for your version of UCP, you may also need to upgrade Docker Engine. You can also choose to upgrade Docker Engine simply because a new version is available. Always upgrade a nodes Docker Engine installation before upgrading its UCP installation.
17+
18+
After upgrading each node, confirm the node is present in the UCP console
19+
before proceeding to the next node.
20+
21+
OPTIONS:
22+
--debug, -D enable debug
23+
--jsonlog Produce json formatted output for easier parsing
24+
--interactive, -i Enable interactive mode. You will be prompted to enter all required information.
25+
--image-version "latest" Select a specific UCP version
26+
--id The ID of the UCP instance to upgrade
27+
--pull "always" Specify image pull behavior ('always', when 'missing', or 'never')

certs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Manually setting up a CA
22

3-
A few features of Orca require an external CA (cfssl or equivalent) to sign certs.
4-
By default in developer mode, these services aren't created (maybe we'll set them up
5-
someday, but there's some bootstrapping challenges...) The following instructions
6-
explain how to set this up manually so you can do developer mode with CA support.
3+
A few features of UCP require an external CA (cfssl or equivalent) to sign
4+
certs. By default in developer mode, these services aren't created (maybe we'll
5+
set them up someday, but there's some bootstrapping challenges...) The
6+
following instructions explain how to set this up manually so you can do
7+
developer mode with CA support.
78

89

910
```bash
@@ -152,7 +153,7 @@ sudo mv /etc/docker/ssl/orca/orca_server-key.pem /etc/docker/ssl/orca/orca_serve
152153
```
153154

154155

155-
**Now you can run Orca**
156+
**Now you can run UCP**
156157

157158

158159
(proxy)

dashboard.png

-69.5 KB
Binary file not shown.

images/browser_cert_open.png

117 KB
Loading

images/browser_cert_san.png

67.3 KB
Loading

images/dashboard.png

58 KB
Loading

images/ip_cloud_provider.png

115 KB
Loading

images/login.png

33.3 KB
Loading

images/network_gui_error.png

82.5 KB
Loading

images/nodes.png

83.5 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)