Skip to content

Commit

Permalink
Engine: reorganize install topic
Browse files Browse the repository at this point in the history
- Move getting started overview to /get-started/overview/
- Move engine installation files under /engine/
- Redirect the top-level /install/ to /get-docker/
- Updated titles in left-hand navigation
- Added back some pages to the navigation that were
  currently not included.
- Reduce some steps in the installation pages
- Move devicemapper prerequisites to the devicemapper
  storage driver page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
  • Loading branch information
thaJeztah committed Apr 6, 2020
1 parent 73293d4 commit d813acb
Show file tree
Hide file tree
Showing 44 changed files with 321 additions and 333 deletions.
35 changes: 20 additions & 15 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ horizontalnav:
path: /
node: guides
- title: Product manuals
path: /install/
path: /engine/
node: manuals
- title: Reference
path: /reference/
Expand Down Expand Up @@ -1023,22 +1023,24 @@ samples:
manuals:
- sectiontitle: Docker Engine
section:
- path: /install/
- path: /engine/
title: Overview
- sectiontitle: Linux
- path: /engine/install/
title: Install
- sectiontitle: Installation per distro
section:
- path: /install/linux/docker-ce/centos/
title: CentOS
- path: /install/linux/docker-ce/debian/
title: Debian
- path: /install/linux/docker-ce/fedora/
title: Fedora
- path: /install/linux/docker-ce/ubuntu/
title: Ubuntu
- path: /install/linux/docker-ce/binaries/
title: Binaries
- path: /install/linux/linux-postinstall/
title: Optional Linux post-installation steps
- path: /engine/install/centos/
title: Install on CentOS
- path: /engine/install/debian/
title: Install on Debian
- path: /engine/install/fedora/
title: Install on Fedora
- path: /engine/install/ubuntu/
title: Install on Ubuntu
- path: /engine/install/binaries/
title: Install binaries
- path: /engine/install/linux-postinstall/
title: Optional post-installation steps
- path: /engine/release-notes/
title: Release notes
- sectiontitle: Previous versions
Expand Down Expand Up @@ -1077,6 +1079,9 @@ manuals:
title: Engine 17.03 release notes
- path: /engine/release-notes/prior-releases/
title: Engine 1.13 and earlier
- path: /engine/deprecated/
title: Deprecated features

- path: /app/working-with-app/
title: Docker App
- path: /buildx/working-with-buildx/
Expand Down
12 changes: 6 additions & 6 deletions _includes/ee-linux-install-reuse.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ on {{ linux-dist-long }}:
Docker Engine - Community is _not_ supported on {{ linux-dist-long }}.
{% endif %}
{% if linux-dist == "centos" %}
For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/install/linux/docker-ce/centos.md).
For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/engine/install/centos.md).
{% endif %}

{% elsif section == "find-ee-repo-url" %}
Expand Down Expand Up @@ -280,7 +280,7 @@ You only need to set up the repository once, after which you can install Docker
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.


Expand Down Expand Up @@ -351,7 +351,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

</div>
Expand Down Expand Up @@ -394,7 +394,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

</div>
Expand Down Expand Up @@ -444,7 +444,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.
{% endif %}

Expand Down Expand Up @@ -485,7 +485,7 @@ You must delete any edited configuration files manually.

{% elsif section == "linux-install-nextsteps" %}

- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md){: target="_blank" class="_" }
- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md){: target="_blank" class="_" }

- Continue with user guides on [Universal Control Plane (UCP)](/ee/ucp/){: target="_blank" class="_" } and [Docker Trusted Registry (DTR)](/ee/dtr/){: target="_blank" class="_" }

Expand Down
2 changes: 1 addition & 1 deletion compose/aspnet-mssql-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Compose to set up and run the sample ASP.NET Core application using the
[.NET Core SDK image](https://hub.docker.com/_/microsoft-dotnet-core-sdk)
with the
[SQL Server on Linux image](https://hub.docker.com/_/microsoft-mssql-server).
You just need to have [Docker Engine](/install/index.md)
You just need to have [Docker Engine](/get-docker.md)
and [Docker Compose](/compose/install.md) installed on your
platform of choice: Linux, Mac or Windows.

Expand Down
2 changes: 1 addition & 1 deletion compose/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ understandable even if you're not familiar with it.

## Prerequisites

Make sure you have already installed both [Docker Engine](/install/index.md)
Make sure you have already installed both [Docker Engine](/get-docker.md)
and [Docker Compose](install.md). You don't need to install Python or Redis, as
both are provided by Docker images.

Expand Down
4 changes: 2 additions & 2 deletions compose/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ have Docker Engine installed either locally or remote, depending on your setup.
included as part of those desktop installs.

- On Linux systems, first install the
[Docker](/install/index.md#server){: target="_blank" class="_"}
[Docker Engine](/engine/install/index.md#server){: target="_blank" class="_"}
for your OS as described on the Get Docker page, then come back here for
instructions on installing Compose on
Linux systems.

- To run Compose as a non-root user, see [Manage Docker as a non-root user](/install/linux/linux-postinstall.md).
- To run Compose as a non-root user, see [Manage Docker as a non-root user](/engine/install/linux-postinstall.md).

## Install Compose

Expand Down
2 changes: 1 addition & 1 deletion config/containers/resource_constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ WARNING: No swap limit support
```

Consult your operating system's documentation for enabling them.
[Learn more](/install/linux/linux-postinstall.md#your-kernel-does-not-support-cgroup-swap-limit-capabilities).
[Learn more](/engine/install/linux-postinstall.md#your-kernel-does-not-support-cgroup-swap-limit-capabilities).

## Memory

Expand Down
4 changes: 2 additions & 2 deletions config/daemon/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ not manually by a user. This makes it easier to automatically start Docker when
the machine reboots.

The command to start Docker depends on your operating system. Check the correct
page under [Install Docker](/install/index.md). To configure Docker
page under [Install Docker](/engine/install/index.md). To configure Docker
to start automatically at system boot, see
[Configure Docker to start on boot](/install/linux/linux-postinstall.md#configure-docker-to-start-on-boot).
[Configure Docker to start on boot](/engine/install/linux-postinstall.md#configure-docker-to-start-on-boot).

## Start the daemon manually

Expand Down
4 changes: 2 additions & 2 deletions config/daemon/systemd.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ do not have `systemctl`, use the `service` command.
### Start automatically at system boot

If you want Docker to start at boot, see
[Configure Docker to start on boot](/install/linux/linux-postinstall.md#configure-docker-to-start-on-boot).
[Configure Docker to start on boot](/engine/install/linux-postinstall.md#configure-docker-to-start-on-boot).

## Custom Docker daemon options

Expand Down Expand Up @@ -155,7 +155,7 @@ you need to add this configuration in the Docker systemd service file.
## Configure where the Docker daemon listens for connections

See
[Configure where the Docker daemon listens for connections](/install/linux/linux-postinstall.md#control-where-the-docker-daemon-listens-for-connections).
[Configure where the Docker daemon listens for connections](/engine/install/linux-postinstall.md#control-where-the-docker-daemon-listens-for-connections).

## Manually create the systemd unit files

Expand Down
2 changes: 1 addition & 1 deletion datacenter/ucp/1.1/installation/system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ all nodes must have:

* Linux kernel version 3.10 or higher
* CS Docker Engine version 1.10 or higher. Learn about the
[operating systems supported by CS Docker Engine](/install/).
[operating systems supported by CS Docker Engine](/ee/supported-platforms.md).
* 2.00 GB of RAM
* 3.00 GB of available disk space
* A static IP address
Expand Down
2 changes: 1 addition & 1 deletion datacenter/ucp/2.2/guides/admin/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ UCP is a containerized application that requires the commercially supported
Docker Engine to run.

Install Docker Enterprise on each host that you plan to manage with UCP.
View the [supported platforms](/install/index.md#supported-platforms)
View the [supported platforms](/ee/supported-platforms.md)
and click on your platform to get platform-specific instructions for installing
Docker Enterprise.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Before installing, be sure your infrastructure has these requirements.

You can install UCP on-premises or on a cloud provider. Common requirements:

* [Docker Enterprise Edition](/install/index.md) version 17.06 or higher
* [Docker Enterprise Edition](/ee/supported-platforms.md) version 17.06 or higher
* Linux kernel version 3.10 or higher
* A static IP address

Expand Down
2 changes: 1 addition & 1 deletion datacenter/ucp/3.0/guides/admin/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ UCP is a containerized application that requires the commercially supported
Docker Engine to run.

Install Docker EE on each host that you plan to manage with UCP.
View the [supported platforms](/install/index.md#supported-platforms)
View the [supported platforms](/ee/supported-platforms.md)
and click on your platform to get platform-specific instructions for installing
Docker EE.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Before installing, be sure your infrastructure has these requirements.

You can install UCP on-premises or on a cloud provider. Common requirements:

* [Docker Enterprise Edition](/install/index.md) version 17.06 or higher
* [Docker Enterprise Edition](/ee/supported-platforms.md) version 17.06 or higher
* Linux kernel version 3.10 or higher
* A static IP address

Expand Down
4 changes: 2 additions & 2 deletions docker-for-mac/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ Your Mac must meet the following requirements to successfully install Docker Des
## What's included in the installer

The Docker Desktop installation includes
[Docker Engine](/install/), Docker CLI client,
[Docker Compose](/compose/), [Notary](/notary/getting_started/), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/).
[Docker Engine](/engine/index.md), Docker CLI client,
[Docker Compose](/compose/index.md), [Notary](/notary/getting_started/), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/).

## Install and run Docker Desktop on Mac

Expand Down
6 changes: 5 additions & 1 deletion docker-for-windows/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ used side-by-side with Docker Desktop. However, you can still use

### What's included in the installer

The Docker Desktop installation includes [Docker Engine](/install/), Docker CLI client, [Docker Compose](/compose/overview.md), [Notary](/notary/getting_started/), [Kubernetes](https://github.com/kubernetes/kubernetes/), and [Credential Helper](https://github.com/docker/docker-credential-helpers/).
The Docker Desktop installation includes [Docker Engine](/engine/index.md),
Docker CLI client, [Docker Compose](/compose/index.md),
[Notary](/notary/getting_started.md),
[Kubernetes](https://github.com/kubernetes/kubernetes/),
and [Credential Helper](https://github.com/docker/docker-credential-helpers/).

Containers and images created with Docker Desktop are shared between all
user accounts on machines where it is installed. This is because all Windows
Expand Down
9 changes: 5 additions & 4 deletions ee/docker-ee/centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ on {{ linux-dist-long }}:
Shared between centOS.md, rhel.md, oracle.md
--->

For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/install/linux/docker-ce/centos.md).
For Docker Community Edition on {{ linux-dist-cap }}, see
[Install Docker Engine on CentOS](/engine/install/centos.md).

## Prerequisites

Expand Down Expand Up @@ -219,7 +220,7 @@ Shared between centOS.md, oracle.md
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

<!---
Expand Down Expand Up @@ -281,7 +282,7 @@ Not shared
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

<!---
Expand Down Expand Up @@ -332,6 +333,6 @@ Shared between centOS.md, rhel.md, oracle.md
## Next steps


- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md){: target="_blank" class="_" }
- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md){: target="_blank" class="_" }

- Continue with user guides on [Universal Control Plane (UCP)](/ee/ucp/){: target="_blank" class="_" } and [Docker Trusted Registry (DTR)](/ee/dtr/){: target="_blank" class="_" }
6 changes: 3 additions & 3 deletions ee/docker-ee/oracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Shared between centOS.md, oracle.md
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

<!---
Expand Down Expand Up @@ -281,7 +281,7 @@ Not shared
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

<!---
Expand Down Expand Up @@ -332,6 +332,6 @@ Shared between centOS.md, rhel.md, oracle.md
## Next steps


- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md){: target="_blank" class="_" }
- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md){: target="_blank" class="_" }

- Continue with user guides on [Universal Control Plane (UCP)](/ee/ucp/){: target="_blank" class="_" } and [Docker Trusted Registry (DTR)](/ee/dtr/){: target="_blank" class="_" }
4 changes: 2 additions & 2 deletions ee/docker-ee/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -765,8 +765,8 @@ Update your configuration if this command prints a non-empty value for `MountFla

### New features for Docker Engine EE

* [FIPS Compliance added for Windows Server 2016 and later](/install/windows/docker-ee)
* [Docker Content Trust Enforcement](/engine/security/trust/content_trust) for the Enterprise Engine. This allows the Docker Engine - Enterprise to run containers not signed by a specific organization.
* [FIPS Compliance added for Windows Server 2016 and later](/ee/docker-ee/windows/docker-ee.md)
* [Docker Content Trust Enforcement](/engine/security/trust/content_trust.md) for the Enterprise Engine. This allows the Docker Engine - Enterprise to run containers not signed by a specific organization.

### New features

Expand Down
8 changes: 4 additions & 4 deletions ee/docker-ee/rhel.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ Shared between centOS.md, rhel.md, oracle.md
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

<!---
Expand Down Expand Up @@ -479,7 +479,7 @@ Shared between centOS.md, rhel.md, oracle.md
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

</div>
Expand Down Expand Up @@ -522,7 +522,7 @@ Shared between centOS.md, rhel.md, oracle.md
```

Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See
[Linux postinstall](/install/linux/linux-postinstall.md){: target="_blank" class="_" } to allow
[Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow
non-privileged users to run Docker commands.

</div>
Expand Down Expand Up @@ -572,6 +572,6 @@ Shared between centOS.md, rhel.md, oracle.md
## Next steps


- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md){: target="_blank" class="_" }
- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md){: target="_blank" class="_" }

- Continue with user guides on [Universal Control Plane (UCP)](/ee/ucp/){: target="_blank" class="_" } and [Docker Trusted Registry (DTR)](/ee/dtr/){: target="_blank" class="_" }
6 changes: 3 additions & 3 deletions ee/docker-ee/suse.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ and update Docker from the repository.
container runs, it prints an informational message and exits.
Docker Engine - Enterprise is installed and running. You need to use `sudo` to
run Docker commands. Continue to [Linux postinstall](/install/linux/linux-postinstall.md)
run Docker commands. Continue to [Linux postinstall](/engine/install/linux-postinstall.md)
to configure the graph storage driver, allow non-privileged users to run Docker
commands, and for other optional configuration steps.
Expand Down Expand Up @@ -391,7 +391,7 @@ manually. You need to download a new file each time you want to upgrade Docker.
container runs, it prints an informational message and exits.

Docker Engine - Enterprise is installed and running. You need to use `sudo` to
run Docker commands. Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md)
run Docker commands. Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md)
to allow non-privileged users to run Docker commands and for other optional
configuration steps.

Expand Down Expand Up @@ -427,6 +427,6 @@ You must delete any edited configuration files manually.

## Next steps

- Continue to [Post-installation steps for Linux](/install/linux/linux-postinstall.md)
- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md)

- Continue with the [User Guide](/engine/userguide/index.md).
Loading

0 comments on commit d813acb

Please sign in to comment.