docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update UCP command line examples to use full form (#180)

This commit is contained in:
Jim Galasyn 2017-07-25 12:35:31 -07:00
parent c72fd6e2d2
commit b9984077a6
27 changed files with 60 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
datacenter/ucp/2.2/guides/admin/backups-and-disaster-recovery.md
View File

@ -50,7 +50,7 @@ verify its contents:
```none
# Create a backup, encrypt it, and store it on /tmp/backup.tar
$ docker run --rm -i --name ucp \
$ docker container run --rm -i --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} backup --interactive > /tmp/backup.tar
@ -65,7 +65,7 @@ following example:
```none
# Create a backup, encrypt it, and store it on /tmp/backup.tar
$ docker run --rm -i --name ucp \
$ docker container run --rm -i --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} backup --interactive \
--passphrase "secret" > /tmp/backup.tar
@ -100,7 +100,7 @@ The example below shows how to restore a UCP cluster from an existing backup
file, presumed to be located at `/tmp/backup.tar`:
```none
$ docker run --rm -i --name ucp \
$ docker container run --rm -i --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} restore < /tmp/backup.tar
```
@ -109,7 +109,7 @@ If the backup file is encrypted with a passphrase, you will need to provide the
passphrase to the restore operation:
```none
$ docker run --rm -i --name ucp \
$ docker container run --rm -i --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} restore --passphrase "secret" < /tmp/backup.tar
```
@ -119,7 +119,7 @@ backup file should be mounted to the container rather than streamed through
stdin:
```none
$ docker run --rm -i --name ucp \
$ docker container run --rm -i --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp/backup.tar:/config/backup.tar \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} restore -i

4
datacenter/ucp/2.2/guides/admin/configure/integrate-with-dtr.md
View File

@ -97,7 +97,7 @@ DTR repository you created.
```none
# Pull hello-world from Docker Store
docker pull hello-world:latest
docker image pull hello-world:latest
# Re-tag it
docker tag hello-world:latest <dtr-domain>/<user>/hello-world:latest
@ -106,7 +106,7 @@ DTR repository you created.
docker login <dtr-domain>
# Push your image to DTR
docker push <dtr-domain>/<user>/hello-world:latest
docker image push <dtr-domain>/<user>/hello-world:latest
```
3. Validate that your image is now stored in DTR.

15
datacenter/ucp/2.2/guides/admin/configure/join-windows-worker-nodes.md
View File

@ -60,8 +60,8 @@ On Windows Server 2016, in a PowerShell terminal running as Administrator,
log in to Docker Hub with the `docker login` command and pull the listed images.
```ps
PS> docker pull {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }}
PS> docker pull {{ page.ucp_org }}/ucp-dsinfo-win:{{ page.ucp_version }}
PS> docker image pull {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }}
PS> docker image pull {{ page.ucp_org }}/ucp-dsinfo-win:{{ page.ucp_version }}
```
### Run the Windows node setup script
@ -70,9 +70,13 @@ You need to open ports 2376 and 12376, and create certificates
for the Docker daemon to communicate securely. Run this command:
```ps
PS> docker run --rm {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }} windows-script | powershell -noprofile -noninteractive -command 'Invoke-Expression -Command $input'
PS> docker container run --rm {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }} windows-script | powershell -noprofile -noninteractive -command 'Invoke-Expression -Command $input'
```
> Docker daemon restart
>
> When you run `windows-script`, the Docker service is unavailable temporarily.
The Windows node is ready to join the swarm. Run the setup script on each
instance of Windows Server that will be a worker node.
@ -125,9 +129,10 @@ To see the script, you can run the `windows-script` command without piping
to the `Invoke-Expression` cmdlet.
```ps
PS> docker run --rm {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }} windows-script
PS> docker container run --rm {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }} windows-script
```
### Open ports in the Windows firewall
UCP and Docker EE require that ports 2376 and 12376 are open for inbound
@ -148,7 +153,7 @@ PS> netsh advfirewall firewall add rule name="docker_proxy" dir=in action=allow
to generate certificates.
```ps
PS> docker run --rm -v C:\ProgramData\docker\daemoncerts:C:\certs {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }} generate-certs
PS> docker container run --rm -v C:\ProgramData\docker\daemoncerts:C:\certs {{ page.ucp_org }}/ucp-agent-win:{{ page.ucp_version }} generate-certs
```
3. To set up certificates, run the following commands to stop and unregister the

6
datacenter/ucp/2.2/guides/admin/configure/store-logs-in-an-external-system.md
View File

@ -23,19 +23,19 @@ deployment which can be used for logging.
```none
docker volume create --name orca-elasticsearch-data
docker run -d \
docker container run -d \
--name elasticsearch \
-v orca-elasticsearch-data:/usr/share/elasticsearch/data \
elasticsearch elasticsearch -Des.network.host=0.0.0.0
docker run -d \
docker container run -d \
-p 514:514 \
--name logstash \
--link elasticsearch:es \
logstash \
sh -c "logstash -e 'input { syslog { } } output { stdout { } elasticsearch { hosts => [ \"es\" ] } } filter { json { source => \"message\" } }'"
docker run -d \
docker container run -d \
--name kibana \
--link elasticsearch:elasticsearch \
-p 5601:5601 \

16
datacenter/ucp/2.2/guides/admin/configure/use-trusted-images-for-ci.md
View File

@ -26,9 +26,9 @@ While still logged in as an admin, navigate to "Admin Settings" and select the "
subsection. Select the checkbox to enable content trust and in the select box that appears,
select the "CI" team we have just created. Save the settings.
This policy will require that every image that referenced in a `docker pull`, `docker run`,
or `docker service create` must be signed by a key corresponding to a member of the "CI" team.
In this case, the only member is the "jenkins" user.
This policy will require that every image that referenced in a `docker image pull`,
`docker container run`, or `docker service create` must be signed by a key corresponding
to a member of the "CI" team. In this case, the only member is the "jenkins" user.
## Create keys for the Jenkins user
@ -63,7 +63,7 @@ configuration directory. Typically this is found at `~/.docker/trust`.
There are two ways to enable content trust: globally, and per operation. To enabled content
trust globally, set the environment variable `DOCKER_CONTENT_TRUST=1`. To enable on a per
operation basis, wherever you run `docker push` in your Jenkins scripts, add the flag
operation basis, wherever you run `docker image push` in your Jenkins scripts, add the flag
`--disable-content-trust=false`. You may wish to use this second option if you only want
to sign some images.
@ -92,12 +92,12 @@ notary -s https://my_notary_server.com -d ~/.docker/trust publish my_repository
N.B. the `-s` flag provides the server hosting a notary service. If you are operating against
Docker Hub, this will be `https://notary.docker.io`. If you are operating against your own DTR
instance, this will be the same hostname you use in image names when running docker commands preceded
by the `https://` scheme. For example, if you would run `docker push my_dtr:4443/me/an_image` the value
by the `https://` scheme. For example, if you would run `docker image push my_dtr:4443/me/an_image` the value
of the `-s` flag would be expected to be `https://my_dtr:4443`.
N.B. if you are using DTR, the name of the repository should be identical to the full name you use
in a `docker push` command. If however you use Docker Hub, the name you use in a `docker push`
must be preceded by `docker.io/`. i.e. if you ran `docker push me/alpine`, you would
in a `docker image push` command. If however you use Docker Hub, the name you use in a `docker image push`
must be preceded by `docker.io/`. i.e. if you ran `docker image push me/alpine`, you would
`notary init docker.io/me/alpine`.
For brevity, we will exclude the `-s` and `-d` flags from subsequent command, but be aware you
@ -144,6 +144,6 @@ now use the key we imported to sign any images we push to this repository.
Through either the Docker CLI, or the UCP browser interface, we will find that any images
that do not meet our signing policy cannot be used. The signing policy we set up requires
that the "CI" team must have signed any image we attempt to `docker pull`, `docker run`,
that the "CI" team must have signed any image we attempt to `docker image pull`, `docker container run`,
or `docker service create`, and the only member of that team is the "jenkins" user. This
restricts us to only running images that were published by our Jenkins CI system.

4
datacenter/ucp/2.2/guides/admin/install/index.md
View File

@ -64,10 +64,10 @@ To install UCP:
```none
# Pull the latest version of UCP
$ docker pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }}
$ docker image pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }}
# Install UCP
$ docker run --rm -it --name ucp \
$ docker container run --rm -it --name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} install \
--host-address <node-ip-address> \

2
datacenter/ucp/2.2/guides/admin/install/uninstall.md
View File

@ -26,7 +26,7 @@ To uninstall UCP, log in to a manager node using ssh, and run the following
command:
```bash
$ docker run --rm -it \
$ docker container run --rm -it \
-v /var/run/docker.sock:/var/run/docker.sock \
--name ucp \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} uninstall-ucp --interactive

4
datacenter/ucp/2.2/guides/admin/install/upgrade.md
View File

@ -80,9 +80,9 @@ To upgrade from the CLI, log into a UCP manager node using ssh, and run:
```
# Get the latest version of UCP
$ docker pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }}
$ docker image pull {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }}
$ docker run --rm -it \
$ docker container run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} \

2
datacenter/ucp/2.2/guides/admin/manage-users/manage-access-with-collections.md
View File

@ -116,7 +116,7 @@ networks, containers, and services, the system identifies a set of
of the resource, like `/Shared/Private/hans`, and it tries to find the parent
that's closest to the root that the user has the `Node Schedule` permission on.
For example, when a user with a default configuration runs `docker run nginx`,
For example, when a user with a default configuration runs `docker container run nginx`,
the system interprets this to mean, "Create an `nginx` container under the
user's default collection, which is at `/Shared/Private/hans`, and deploy it
on one of the nodes under `/Shared`.

4
datacenter/ucp/2.2/guides/admin/monitor-and-troubleshoot/troubleshoot-configurations.md
View File

@ -99,7 +99,7 @@ NODE_ADDRESS=$(docker info --format '{{.Swarm.NodeAddr}}')
VERSION=$(docker image ls --format '{{.Tag}}' docker/ucp-auth | head -n 1)
# This command will output detailed status of all servers and database tables
# in the RethinkDB cluster.
docker run --rm -v ucp-auth-store-certs:/tls docker/ucp-auth:${VERSION} --db-addr=${NODE_ADDRESS}:12383 db-status
docker container run --rm -v ucp-auth-store-certs:/tls docker/ucp-auth:${VERSION} --db-addr=${NODE_ADDRESS}:12383 db-status
Server Status: [
{
@ -132,7 +132,7 @@ NUM_MANAGERS=$(docker node ls --filter role=manager -q | wc -l)
VERSION=$(docker image ls --format '{{.Tag}}' docker/ucp-auth | head -n 1)
# This reconfigure-db command will repair the RethinkDB cluster to have a
# number of replicas equal to the number of manager nodes in the cluster.
docker run --rm -v ucp-auth-store-certs:/tls docker/ucp-auth:${VERSION} --db-addr=${NODE_ADDRESS}:12383 --debug reconfigure-db --num-replicas ${NUM_MANAGERS} --emergency-repair
docker container run --rm -v ucp-auth-store-certs:/tls docker/ucp-auth:${VERSION} --db-addr=${NODE_ADDRESS}:12383 --debug reconfigure-db --num-replicas ${NUM_MANAGERS} --emergency-repair
time="2017-07-14T20:46:09Z" level=debug msg="Connecting to db ..."
time="2017-07-14T20:46:09Z" level=debug msg="connecting to DB Addrs: [192.168.1.25:12383]"

6
datacenter/ucp/2.2/guides/admin/monitor-and-troubleshoot/troubleshoot-with-logs.md
View File

@ -40,9 +40,9 @@ specially useful if the UCP web application is not working.
```bash
$ docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
8b77cfa87889 dockerorcadev/ucp-agent:2.2.0-latest "/bin/ucp-agent re..." 3 hours ago Exited (0) 3 hours ago ucp-reconcile
b844cf76a7a5 dockerorcadev/ucp-agent:2.2.0-latest "/bin/ucp-agent agent" 3 hours ago Up 3 hours 2376/tcp ucp-agent.tahzo3m4xjwhtsn6l3n8oc2bf.xx2hf6dg4zrphgvy2eohtpns9
de5b45871acb dockerorcadev/ucp-controller:2.2.0-latest "/bin/controller s..." 3 hours ago Up 3 hours (unhealthy) 0.0.0.0:443->8080/tcp ucp-controller
8b77cfa87889 docker/ucp-agent:2.2.0-latest "/bin/ucp-agent re..." 3 hours ago Exited (0) 3 hours ago ucp-reconcile
b844cf76a7a5 docker/ucp-agent:2.2.0-latest "/bin/ucp-agent agent" 3 hours ago Up 3 hours 2376/tcp ucp-agent.tahzo3m4xjwhtsn6l3n8oc2bf.xx2hf6dg4zrphgvy2eohtpns9
de5b45871acb docker/ucp-controller:2.2.0-latest "/bin/controller s..." 3 hours ago Up 3 hours (unhealthy) 0.0.0.0:443->8080/tcp ucp-controller
...
```

2
datacenter/ucp/2.2/guides/get-support.md
View File

@ -32,7 +32,7 @@ To get the support dump from the CLI, use SSH to log into a UCP manager node
and run:
```none
docker run --rm \
docker container run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} \

2
datacenter/ucp/2.2/reference/cli/backup.md
View File

@ -9,7 +9,7 @@ Create a backup of a UCP manager node
## Usage
```bash
docker run --rm -i \
docker container run --rm -i \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/dump-certs.md
View File

@ -9,7 +9,7 @@ Print the public certificates used by this UCP web server
## Usage
```
docker run --rm \
docker container run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/example-config.md
View File

@ -9,7 +9,7 @@ Display an example configuration file for UCP
## Usage
```
docker run --rm -i \
docker container run --rm -i \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/fingerprint.md
View File

@ -8,7 +8,7 @@ Print the TLS fingerprint for this UCP web server
## Usage
```
docker run --rm \
docker container run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/id.md
View File

@ -8,7 +8,7 @@ Print the ID of UCP running on this node
## Usage
```
docker run --rm \
docker container run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/images.md
View File

@ -9,7 +9,7 @@ Verify the UCP images on this node
## Usage
```
docker run --rm -it \
docker container run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

6
datacenter/ucp/2.2/reference/cli/index.md
View File

@ -8,8 +8,8 @@ This image has commands to install and manage
Docker Universal Control Plane (UCP) on a Docker Engine.
You can configure the commands using flags or environment variables. When using
environment variables use the `docker run -e VARIABLE_NAME` syntax to pass the
value from your shell, or `docker run -e VARIABLE_NAME=value` to specify the
environment variables use the `docker container run -e VARIABLE_NAME` syntax to pass the
value from your shell, or `docker container run -e VARIABLE_NAME=value` to specify the
value explicitly on the command line.
The container running this image needs to be named `ucp` and bind-mount the
@ -20,7 +20,7 @@ Additional help is available for each command with the `--help` flag.
## Usage
```bash
docker run -it --rm \
docker container run -it --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
{{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_version }} \

4
datacenter/ucp/2.2/reference/cli/install.md
View File

@ -9,7 +9,7 @@ Install UCP on this node
## Usage
```bash
docker run --rm -it \
docker container run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \
@ -41,7 +41,7 @@ firewall:
* 4789 (udp) and 7946 (tcp/udp) for overlay networking
If you have SELinux policies enabled for your Docker install, you will need to
use `docker run --rm -it --security-opt label=disable ...` when running this
use `docker container run --rm -it --security-opt label=disable ...` when running this
command.
## Options

2
datacenter/ucp/2.2/reference/cli/restart.md
View File

@ -9,7 +9,7 @@ Start or restart UCP components running on this node
## Usage
```
docker run --rm -it \
docker container run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/restore.md
View File

@ -9,7 +9,7 @@ Restore a UCP cluster from a backup
## Usage
```
docker run --rm -i \
docker container run --rm -i \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/stop.md
View File

@ -9,7 +9,7 @@ Stop UCP components running on this node
## Usage
```
docker run --rm -it \
docker container run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/support.md
View File

@ -9,7 +9,7 @@ Create a support dump for this UCP node
## Usage
```
docker run --rm \
docker container run --rm \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/uninstall-ucp.md
View File

@ -9,7 +9,7 @@ Uninstall UCP from this swarm
## Usage
```
docker run --rm -it \
docker container run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

2
datacenter/ucp/2.2/reference/cli/upgrade.md
View File

@ -9,7 +9,7 @@ Upgrade the UCP cluster
## Usage
```
docker run --rm -it \
docker container run --rm -it \
--name ucp \
-v /var/run/docker.sock:/var/run/docker.sock \
docker/ucp \

6
engine/installation/windows/docker-ee.md
View File

@ -34,7 +34,7 @@ on a Windows 10 machine, see [Install Docker for Windows](/docker-for-windows/in
2. Test your Docker EE installation by running the `hello-world` container.
```ps
PS> docker run hello-world:nanoserver
PS> docker container run hello-world:nanoserver
Unable to find image 'hello-world:nanoserver' locally
nanoserver: Pulling from library/hello-world
@ -79,7 +79,7 @@ register, and start the Docker service.
$null = Install-WindowsFeature containers
# Add Docker to the path for the current session.
PS> $env:path += "$env:ProgramFiles\docker"
PS> $env:path += ";$env:ProgramFiles\docker"
# Optionally, modify PATH to persist across sessions.
PS> $newPath = "$env:ProgramFiles\docker;" +
@ -99,7 +99,7 @@ register, and start the Docker service.
3. Test your Docker EE installation by running the `hello-world` container.
```ps
PS> docker run hello-world:nanoserver
PS> docker container run hello-world:nanoserver
```