From f24e2f1b4d55538b0285c29c25b5cb1db8187bf2 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 6 Dec 2019 11:54:36 +0100 Subject: [PATCH 1/2] Remove "docker engine" subcommands Signed-off-by: Sebastiaan van Stijn --- _data/toc.yaml | 10 -- ee/licensing.md | 8 - ee/supported-platforms.md | 8 +- engine/ce-ee-node-activate.md | 143 ------------------ engine/index.md | 1 + engine/reference/commandline/engine.md | 15 -- .../reference/commandline/engine_activate.md | 15 -- engine/reference/commandline/engine_check.md | 15 -- engine/reference/commandline/engine_update.md | 15 -- 9 files changed, 4 insertions(+), 226 deletions(-) delete mode 100644 engine/ce-ee-node-activate.md delete mode 100644 engine/reference/commandline/engine.md delete mode 100644 engine/reference/commandline/engine_activate.md delete mode 100644 engine/reference/commandline/engine_check.md delete mode 100644 engine/reference/commandline/engine_update.md diff --git a/_data/toc.yaml b/_data/toc.yaml index 1d49412636..89bd5d7e99 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -587,16 +587,6 @@ reference: title: docker export - path: /engine/reference/commandline/history/ title: docker history - - sectiontitle: docker engine - section: - - path: /engine/reference/commandline/engine/ - title: docker engine - - path: /engine/reference/commandline/engine_activate/ - title: docker engine activate - - path: /engine/reference/commandline/engine_check/ - title: docker engine check - - path: /engine/reference/commandline/engine_update/ - title: docker engine update - sectiontitle: docker image section: - path: /engine/reference/commandline/image/ diff --git a/ee/licensing.md b/ee/licensing.md index 513b1f075b..9a71335c6b 100644 --- a/ee/licensing.md +++ b/ee/licensing.md @@ -83,14 +83,6 @@ For details, see [Licensing DTR](https://docs.docker.com/ee/dtr/admin/configure/ When you license UCP, the same license is applied to the underlying engines in the cluster. Docker recommends that Enterprise customers use UCP to manage their license. -Standalone Docker Engine - Enterprise users can license engines using the command `docker engine activate`. - -You can perform offline activation of standalone enterprise engines by downloading the license and running the command `docker engine activate --license filename.lic`. - -For more information on the command, see the reference on [docker engine activate](https://docs.docker.com/engine/reference/commandline/engine_activate/). - -Additionally, from Docker Engine 18.09 onward, there is a feature called [CE-EE Node Activate](https://docs.docker.com/engine/ce-ee-node-activate/), which is a seamless in-place upgrade from Docker Engine - Community to Docker Engine - Enteprise. - ### Desktop Enterprise > Docker Desktop Enterprise licenses are not included as part of your UCP, DTR, and Engine - Enterprise license. It is a separate license installed on developer workstations. Please contact your Sales team to obtain [Docker Desktop Enterprise](https://docs.docker.com/ee/desktop/) licenses. diff --git a/ee/supported-platforms.md b/ee/supported-platforms.md index fb32c6cca8..6c6117bb6b 100644 --- a/ee/supported-platforms.md +++ b/ee/supported-platforms.md @@ -59,11 +59,9 @@ For Docker Enterprise customers, when you license Universal Control Plane (UCP), this same license is applied to the underlying engines in the cluster. Docker recommends that Enterprise customers use UCP to manage their license. -Standalone Docker Engine - Enterprise users can license engines using `docker engine activate`. - -Offline activation of standalone enterprise engines can be performed by downloading the license and using the command `docker engine activate --license filename.lic`. - -Additionally, Docker is now distributing the CLI as a separate installation package. This gives Docker Enterprise users the ability to install as many CLI packages as needed without using the Engine node licenses for client-only systems. +Docker distributing the CLI as a separate installation package. This gives Docker +Enterprise users the ability to install as many CLI packages as needed without +using the Engine node licenses for client-only systems. [Learn more about Docker Enterprise](/ee/index.md). diff --git a/engine/ce-ee-node-activate.md b/engine/ce-ee-node-activate.md deleted file mode 100644 index a88eb9d824..0000000000 --- a/engine/ce-ee-node-activate.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -description: Engine -keywords: Engine, Docker Engine - Community, EE, node, activation, enterprise, patching -title: CE-EE Node Activate ---- - -The Docker Engine `18.09` release introduces a new feature called **CE-EE Node Activate**, which allows a user to perform an in-place seamless activation of the Enterprise engine feature set on an existing Docker Engine - Community node through the Docker command line. - -CE-EE Node Activate will apply a license, and switch the Docker engine to the Enterprise engine binary. - -## Requirements: -* The Docker Engine - Community version must be 18.09 or higher. -* All of the Docker packages must be installed: docker-cli, docker-server, and containerd. - -## Limitations - -* This feature is only supported on x86 Linux nodes. -* Windows nodes are not currently supported. -* Node-level Engine activation between Docker Engine - Community and EE is only supported in the same version of Docker Enterprise Engine for Docker. -* Prior versions of Docker Engine - Community do not support this feature. - -## Notes on patching after running Docker Engine - Community to EE Node Activation - -Docker recommends replacing the apt or yum repository from Docker Engine - Community with the EE repository that appears -on your hub/store account after starting the trial or paid license. This allows apt/yum -upgrade operations to work as expected and keep them current as long as your license is still -valid and has not expired. - -> **Note**: You can use the `docker engine update` command. However, if you continue to use -> the Docker Engine - Community packages, the OS package will no longer replace the active daemon binary during apt/yum -> updates, so you are responsible for performing the `docker engine update` operation periodically -> to keep your engine up to date. - -## Docker Engine 18.09 Docker Engine - Community to EE Node Activation Process - -The activation can be performed either online with connection to Docker Hub, or offline. - -1. Check the current Docker version. Both the Docker client and server (`containerd`) need to be installed. Your output may vary slightly from what is displayed on this page. - -``` -$ docker version -Client: - Version: 18.09.0 - API version: 1.39 - Go version: go1.10.4 - Git commit: 4d60db4 - Built: Wed Nov 7 00:48:22 2018 - OS/Arch: linux/amd64 - Experimental: false - -Server: Docker Engine - Community - Engine: - Version: 18.09.0 - API version: 1.39 (minimum version 1.12) - Go version: go1.10.4 - Git commit: 4d60db4 - Built: Wed Nov 7 00:19:08 2018 - OS/Arch: linux/amd64 - Experimental: false -``` - -2. Log into the Docker engine from the command line. - -> **Note**: When running the command `docker login`, the shell stores the credentials in the current user's home -> directory. RHEL and Ubuntu-based Linux distributions have different behavior for sudo. RHEL sets $HOME to point -> to `/root` while Ubuntu leaves `$HOME` pointing to the user's home directory who ran `sudo` and this can cause -> permission and access problems when switching between `sudo` and non-sudo'd commands. - - -For Ubuntu or Debian: -``` -$ docker login -Login with your Docker ID to push and pull images from Docker Hub. If you don't have a Docker ID, head over to https://hub.docker.com to create one. -Username: beluga -Password: -WARNING! Your password will be stored unencrypted in /home/docker/.docker/config.json. -Configure a credential helper to remove this warning. See -https://docs.docker.com/engine/reference/commandline/login/#credentials-store -Login Succeeded -``` - -For CentOS, use `sudo`: -``` -$ sudo docker login -Login with your Docker ID to push and pull images from Docker Hub. If you don't have a Docker ID, head over to https://hub.docker.com to create one. -Username: beluga -Password: -WARNING! Your password will be stored unencrypted in /home/docker/.docker/config.json. -Configure a credential helper to remove this warning. See -https://docs.docker.com/engine/reference/commandline/login/#credentials-store -Login Succeeded -``` - -3. [Download your Docker Enterprise license](https://success.docker.com/article/where-is-my-docker-enterprise-edition-license) and distribute it to your Docker engines. - -4. Activate the EE license. You must use `sudo` even if your user is part of the docker group. - -``` -$ sudo docker engine activate --license ee-engine-license-1000-nodes.lic -License: Quantity: 400 Nodes Expiration date: 2019-05-12 License is currently active -18.09.0: resolved -e3cba72cdf2e: done [==================================================>] 434B/434B -3642e2b52398: done [==================================================>] 1.161kB/1.161kB -eb6fe2abc4ad: done [==================================================>] 4.544MB/4.544MB -f2f08b0292f2: done [==================================================>] 25.65MB/25.65MB -a539281ee17b: done [==================================================>] 1.122MB/1.122MB -515c4dc2b0fe: done [==================================================>] 333.9kB/333.9kB -2cf04a6ee63e: done [==================================================>] 4.84kB/4.84kB -Successfully activated engine. -Restart docker with 'systemctl restart docker' to complete the activation. -``` - -5. Check the Docker Engine version. The engine server will become EE, and the engine client will stay CE. - -``` -$ docker version -Client: - Version: 18.09.0 - API version: 1.39 - Go version: go1.10.4 - Git commit: 4d60db4 - Built: Wed Nov 7 00:48:22 2018 - OS/Arch: linux/amd64 - Experimental: false - -Server: Docker Engine - Enterprise - Engine: - Version: 18.09.0 - API version: 1.39 (minimum version 1.12) - Go version: go1.10.4 - Git commit: 33a45cd - Built: Wed Nov 7 00:19:46 2018 - OS/Arch: linux/amd64 - Experimental: false -``` - -**NOTE**: Your output may vary slightly from what is displayed on this page. - -6. If you are running a Swarm cluster with CE, please repeat these steps on each node. - -## Offline CE-EE node activation - -For offline CE-EE node activation, you'll need to get the Docker Enterprise Engine onto the system. The recommended model is to download the EE `.deb` or `.rpm` packages manually and copy them to the target systems. Afterward, download the license manually, and copy that license to the target systems. Use the `--license ` command line option to the activate command. diff --git a/engine/index.md b/engine/index.md index ee2195297f..62dd5aa291 100644 --- a/engine/index.md +++ b/engine/index.md @@ -3,6 +3,7 @@ description: Engine keywords: Engine redirect_from: - /engine/misc/ +- /engine/ce-ee-node-activate/ title: About Docker Engine --- diff --git a/engine/reference/commandline/engine.md b/engine/reference/commandline/engine.md deleted file mode 100644 index 6232ac9f56..0000000000 --- a/engine/reference/commandline/engine.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -datafolder: engine-cli -datafile: docker_engine -title: docker engine -skip_read_time: true ---- - - -{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/engine_activate.md b/engine/reference/commandline/engine_activate.md deleted file mode 100644 index f291627112..0000000000 --- a/engine/reference/commandline/engine_activate.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -datafolder: engine-cli -datafile: docker_engine_activate -title: docker engine activate -skip_read_time: true ---- - - -{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/engine_check.md b/engine/reference/commandline/engine_check.md deleted file mode 100644 index b5fe6856f0..0000000000 --- a/engine/reference/commandline/engine_check.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -datafolder: engine-cli -datafile: docker_engine_check -title: docker engine check -skip_read_time: true ---- - - -{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/engine_update.md b/engine/reference/commandline/engine_update.md deleted file mode 100644 index 7b78e5459f..0000000000 --- a/engine/reference/commandline/engine_update.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -datafolder: engine-cli -datafile: docker_engine_update -title: docker engine update -skip_read_time: true ---- - - -{% include cli.md datafolder=page.datafolder datafile=page.datafile %} From ebc3b502ee941c887fbd2d3d7d1937306c9dcda0 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 6 Dec 2019 12:24:12 +0100 Subject: [PATCH 2/2] Update yaml files to remove "engine" subcommands Signed-off-by: Sebastiaan van Stijn --- _data/engine-cli/docker.yaml | 2 - _data/engine-cli/docker_engine.yaml | 20 ----- _data/engine-cli/docker_engine_activate.yaml | 95 -------------------- _data/engine-cli/docker_engine_check.yaml | 85 ------------------ _data/engine-cli/docker_engine_update.yaml | 47 ---------- 5 files changed, 249 deletions(-) delete mode 100644 _data/engine-cli/docker_engine.yaml delete mode 100644 _data/engine-cli/docker_engine_activate.yaml delete mode 100644 _data/engine-cli/docker_engine_check.yaml delete mode 100644 _data/engine-cli/docker_engine_update.yaml diff --git a/_data/engine-cli/docker.yaml b/_data/engine-cli/docker.yaml index 2e2ed758e7..32c756ea69 100644 --- a/_data/engine-cli/docker.yaml +++ b/_data/engine-cli/docker.yaml @@ -12,7 +12,6 @@ cname: - docker create - docker deploy - docker diff -- docker engine - docker events - docker exec - docker export @@ -72,7 +71,6 @@ clink: - docker_create.yaml - docker_deploy.yaml - docker_diff.yaml -- docker_engine.yaml - docker_events.yaml - docker_exec.yaml - docker_export.yaml diff --git a/_data/engine-cli/docker_engine.yaml b/_data/engine-cli/docker_engine.yaml deleted file mode 100644 index 765ab27d53..0000000000 --- a/_data/engine-cli/docker_engine.yaml +++ /dev/null @@ -1,20 +0,0 @@ -command: docker engine -short: Manage the docker engine -long: Manage the docker engine -usage: docker engine COMMAND -pname: docker -plink: docker.yaml -cname: -- docker engine activate -- docker engine check -- docker engine update -clink: -- docker_engine_activate.yaml -- docker_engine_check.yaml -- docker_engine_update.yaml -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli/docker_engine_activate.yaml b/_data/engine-cli/docker_engine_activate.yaml deleted file mode 100644 index f62725866d..0000000000 --- a/_data/engine-cli/docker_engine_activate.yaml +++ /dev/null @@ -1,95 +0,0 @@ -command: docker engine activate -short: Activate Enterprise Edition -long: | - Activate Enterprise Edition. - - With this command you may apply an existing Docker enterprise license, or - interactively download one from Docker. In the interactive exchange, you can - sign up for a new trial, or download an existing license. If you are - currently running a Community Edition engine, the daemon will be updated to - the Enterprise Edition Docker engine with additional capabilities and long - term support. - - For more information about different Docker Enterprise license types visit - https://www.docker.com/licenses - - For non-interactive scriptable deployments, download your license from - https://hub.docker.com/ then specify the file with the '--license' flag. -usage: docker engine activate [OPTIONS] -pname: docker engine -plink: docker_engine.yaml -options: -- option: containerd - value_type: string - description: override default location of containerd endpoint - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: display-only - value_type: bool - default_value: "false" - description: only display license information and exit - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: engine-image - value_type: string - description: Specify engine image - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print licenses using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: license - value_type: string - description: License File - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - value_type: bool - default_value: "false" - description: Only display available licenses by ID - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: registry-prefix - value_type: string - default_value: docker.io/store/docker - description: Override the default location where engine images are pulled - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: version - value_type: string - description: | - Specify engine version (default is to use currently running version) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli/docker_engine_check.yaml b/_data/engine-cli/docker_engine_check.yaml deleted file mode 100644 index 2a4c3ca390..0000000000 --- a/_data/engine-cli/docker_engine_check.yaml +++ /dev/null @@ -1,85 +0,0 @@ -command: docker engine check -short: Check for available engine updates -long: Check for available engine updates -usage: docker engine check [OPTIONS] -pname: docker engine -plink: docker_engine.yaml -options: -- option: containerd - value_type: string - description: override default location of containerd endpoint - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: downgrades - value_type: bool - default_value: "false" - description: Report downgrades (default omits older versions) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: engine-image - value_type: string - description: | - Specify engine image (default uses the same image as currently running) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: format - value_type: string - description: Pretty-print updates using a Go template - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: pre-releases - value_type: bool - default_value: "false" - description: Include pre-release versions - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: quiet - shorthand: q - value_type: bool - default_value: "false" - description: Only display available versions - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: registry-prefix - value_type: string - default_value: docker.io/store/docker - description: | - Override the existing location where engine images are pulled - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: upgrades - value_type: bool - default_value: "true" - description: Report available upgrades - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false - diff --git a/_data/engine-cli/docker_engine_update.yaml b/_data/engine-cli/docker_engine_update.yaml deleted file mode 100644 index 1ea2f7495f..0000000000 --- a/_data/engine-cli/docker_engine_update.yaml +++ /dev/null @@ -1,47 +0,0 @@ -command: docker engine update -short: Update a local engine -long: Update a local engine -usage: docker engine update [OPTIONS] -pname: docker engine -plink: docker_engine.yaml -options: -- option: containerd - value_type: string - description: override default location of containerd endpoint - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: engine-image - value_type: string - description: | - Specify engine image (default uses the same image as currently running) - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: registry-prefix - value_type: string - default_value: docker.io/store/docker - description: Override the current location where engine images are pulled - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -- option: version - value_type: string - description: Specify engine version - deprecated: false - experimental: false - experimentalcli: false - kubernetes: false - swarm: false -deprecated: false -experimental: false -experimentalcli: false -kubernetes: false -swarm: false -