The installation script's main purpose is to perform a fresh install, because
it's not guaranteed to work correctly when updating an existing installation,
and we print a warning if we find docker is already installed. However, it's
known that the script is used to update existing installations.
The current script has some limitations for the update scenario;
- When using the script for installing from the staging domain, the existing
repo configuration is not overwritten. When using `yum`, or older `dnf` versions
this resulted in 2 separate repo files to be created (docker-ce.repo and
docker-ce-staging.repo), which resulted in errors due to duplicate repo
definitions with the same name.
- When using `dnf5`, we specified the filename to store the configuration,
which resulted in an error;
+ sh -c 'dnf5 config-manager addrepo --save-filename=docker-ce.repo --from-repofile='\''https://download-stage.docker.com/linux/fedora/docker-ce-staging.repo'\'''
File "/etc/yum.repos.d/docker-ce.repo" already exists and configures repositories with IDs "docker-ce-stable docker-ce-stable-debuginfo docker-ce-stable-source docker-ce-test docker-ce-test-debuginfo docker-ce-test-source docker-ce-nightly docker-ce-nightly-debuginfo docker-ce-nightly-source". Add "--overwrite" to overwrite.
- On SLES, it would result in a similar error;
+ sh -c 'zypper addrepo https://download-stage.docker.com/linux/sles/docker-ce-staging.repo'
Adding repository 'Docker CE Nightly - s390x' ......................................................................................[error]
Repository named 'docker-ce-nightly' already exists. Please use another alias.
Adding repository 'Docker CE Nightly - Debuginfo s390x' ............................................................................[error]
Repository named 'docker-ce-nightly-debuginfo' already exists. Please use another alias.
This patch updates the script to overwrite / replace the existing repo config.
This brings the rpm-based installations in line with the Debian approach, which
unconditionally overwrites `/etc/apt/sources.list.d/docker.list`.
It's worth noting that this change will therefore overwrite any customisations
made to the repo-configurations, so a warning is added for that.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
commit 766b70c5be quoted these values to
prevent globbing, but used single quotes. However, these commands are
executed with `sh -c` using single quotes, which makes the output hard
to read because of the embedded quotes being escaped.
This patch changes to use double-quotes, which should still prevent
globbing to happen, but make the output more readable.
Before:
CHANNEL=test ./install.sh
...
Adding repo from: https://download.docker.com/linux/centos/docker-ce.repo
+ '[' test '!=' stable ']'
+ sh -c 'dnf config-manager --set-disabled '\''docker-ce-*'\'''
+ sh -c 'dnf config-manager --set-enabled '\''docker-ce-test'\'''
+ sh -c 'dnf makecache'
After:
CHANNEL=test ./install.sh
...
Adding repo from: https://download.docker.com/linux/centos/docker-ce.repo
+ '[' test '!=' stable ']'
+ sh -c 'dnf config-manager --set-disabled "docker-ce-*"'
+ sh -c 'dnf config-manager --set-enabled "docker-ce-test"'
+ sh -c 'dnf makecache'
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The addrepo command has a bug that causes it to fail if the `.repo` file
contains empty lines, causing it to fail;
dnf config-manager addrepo --from-repofile="https://download.docker.com/linux/fedora/docker-ce.repo"
Error in added repository configuration file. Cannot set repository option "#1=
": Option "#1" not found
Use a temporary file and strip empty lines as a workaround until the bug
is fixed.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
We only need the config-manager, but it comes with a large number of weak
dependencies;
dnf -q install dnf-plugins-core
Transaction Summary:
Installing: 78 packages
Disable weak dependencies to skip those, as they're not essential for this
script;
dnf -q --setopt=install_weak_deps=False install dnf-plugins-core
Transaction Summary:
Installing: 32 packages
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Fedora 41 and up use the new dnf5 as default, which is a rewrite of
the dnf commands with different options;
+ dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo
Unknown argument "--add-repo" for command "config-manager". Add "--help" for more information about the arguments.
make: *** [Makefile:95: verify] Error 2
script returned exit code 2
This patch:
- adds a check for dnf5
- removes some indirection through env-vars, and instead inlines the code
Note that with CentOS 7 being EOL, we can probably remove the `yum` variant
from the script, but I left those in place for now.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The `-y` and `-q` options are global options, and can be set before the
command that's run;
apt-get --help
...
Usage: apt-get [options] command
apt-get [options] install|remove pkg1 [pkg2 ...]
apt-get [options] source pkg1 [pkg2 ...]
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The `-y` and `-q` options are global options, and can be set before the
command that's run. There's some ambiguity in the USAGE output of different
versions (`yum`, `dnf`, `dnf5`)
yum always outputs the same usage, but shows that options go _before_
the command;
yum --help
Usage: yum [options] COMMAND
yum install --help
Usage: yum [options] COMMAND
dnf (dnf4) is ambiguous; when showing usage for `install` it shows the
options to be set _after_ the command;
dnf install --help
usage: dnf install [-c [config file]] [-q] [-v] [--version] ....
but the global `--help` shows them to be before the command;
dnf --help
usage: dnf [options] COMMAND
General DNF options:
...
-q, --quiet quiet operation
-v, --verbose verbose operation
,,,
--setopt SETOPTS set arbitrary config and repo options
dnf5 is more explicit about global vs per-command options;
dnf --help
Usage:
dnf5 [GLOBAL OPTIONS] <COMMAND> ...
dnf install --help
Usage:
dnf5 [GLOBAL OPTIONS] install [OPTIONS] [ARGUMENTS]
Testing shows that older versions (`dnf4` and `yum`) handle both fine,
and because `dnf5` (per the above) prefers global options to go before
the command, we can use that convention in this script.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This check was added in 63fb2060c9, at which
time we did not provide packages fro RHEL on architectures other than s390x.
We now provide packages for RHEL 8 and 9 for amd64 (x86), arm64, and s390x,
so we can remove this check.
Note that we do not (yet?) provide packages for ppc64le, but this is more
of a niche use-case, so not adding a special condition for that, as we
don't provide that check for other distros.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This package is no longer needed on all current distro versions we support. From
the package description (https://packages.debian.org/buster/apt-transport-https);
> This is a dummy transitional package - https support has been moved into the
> apt package in 1.5. It can be safely removed.
Verifying the version of apt that's available in Ubuntu and Debian:
Ubuntu:
docker run --rm ubuntu:xenial apt --version
apt 1.2.35 (amd64)
docker run --rm ubuntu:17.04 apt --version
apt 1.4.6 (amd64)
docker run --rm ubuntu:17.10 apt --version
apt 1.5.2 (amd64)
docker run --rm ubuntu:18.04 apt --version
apt 1.6.14 (amd64)
docker run --rm ubuntu:20.04 apt --version
apt 2.0.6 (amd64)
Debian:
docker run --rm debian:stretch apt --version
apt 1.4.11 (amd64)
docker run --rm debian:buster apt --version
apt 1.8.2.3 (amd64)
docker run --rm debian:bullseye apt --version
apt 2.2.4 (amd64)
From the above; all currently supported versions of Ubuntu (18.04 and up), and
Debian (old-stable and stable) have apt > 1.5, so we can remove this dependency
from the installation instructions.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
With this patch:
sh -c install.sh
# Executing docker install script, commit:
DEPRECATION WARNING
This Linux distribution (centos 7) reached end-of-life and is no longer supported by this script.
No updates or security fixes will be released for this distribution, and users are recommended
to upgrade to a currently maintained version of centos.
Press Ctrl+C now to abort this script, or wait for the installation to continue.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Thse channels have been deprecated for quite a while, and the script
has produced an error for them for a long time, so nobody using this
script can depend on it being there.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
... instead of yum. The yum command is no longer available by default
in recent versions.
Closes#394
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
Current distro versions now allow the GPG key to be stored as an `.asc` file,
which simplifies installation. Changing the file extension for the GPG key
to .asc lets apt-get know the GPG key is in ASCII armor format, in which case
there is no need to "dearmor", and we no longer need gpg as a pre-requisite.
Instructions for manual installation on Debian based distros were updated in
our documentation through [docker/docs@33befd6].
It's common for users to install packages in a combination of the convenience
script and manual (e.g. to update the packages after install, or vice-versa).
Given that both the script and the manual steps configure the repository, we
want those steps to align, otherwise (potentially?) warnings / errors may occur;
$ sudo apt-get update
E: Conflicting values set for option Signed-By regarding source https://download.docker.com/linux/debian/ bullseye: /usr/share/keyrings/docker-ce-archive-keyring.gpg != /usr/share/keyrings/docker-archive-keyring.gpg
E: The list of sources could not be read.
In either case; let's make sure that our script aligns with the manual steps
that we document.
[docker/docs@33befd6]: https://github.com/docker/docs/commit/33befd692249d11ce7bc88052d82709a07a8107f
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Provide more information how to use the script, its intended purpose, and
limitations of the script.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The edge channel was already deprecated; the nightly channel has not been
updated for a long time, so (for now) mark it as deprecated as well.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Some users confuse "YY.04" versions for LTS versions, and not all users
pay close attention to versions reaching EOL. Print a warning for those
as well, because we no longer publish packages for these.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
While I haven't found cases where this caused issues, it probably doesn't
hurt to use single-quotes for these to prevent globbing.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
I ran into this when I ran the script from within `/etc/yum.repos.d`:
+ sh -c 'dnf config-manager --set-disabled docker-ce-*'
Error: No matching repo to modify: docker-ce-staging.repo.
Took me a bit to understand why the script was failing, and then realized
the shell was expanding `docker-ce-*` to filenames in my current directory;
ls -l docker-ce-*
-rw-r--r--. 1 root root 2027 May 6 09:32 docker-ce-staging.repo
This patch quotes the channel name to prevent globbing.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This step in the installation script was added to take non-standard umasks
into account (which is sometimes the case on some cloud providers).
The existing command was changing modes a bit too eagerly, as it recursively
set the "execute" bit, which would not only affect the /etc/apt/keyrings
directory, but also any file inside it (including files we don't own);
mkdir -m 0700 keyrings
touch keyrings/one.sh
touch keyrings/docker.gpg
ls -al keyrings/
total 8
drwx------ 4 root root 128 May 7 11:43 .
drwx------ 17 root root 544 May 7 11:43 ..
-rw-r--r-- 1 root root 0 May 7 11:43 docker.gpg
-rw-r--r-- 1 root root 0 May 7 11:43 one.sh
chmod -R a+rx keyrings
ls -al keyrings/
total 0
drwxr-xr-x 4 root root 128 May 7 11:43 .
drwx------ 17 root root 544 May 7 11:43 ..
-rwxr-xr-x 1 root root 0 May 7 11:43 docker.gpg
-rwxr-xr-x 1 root root 0 May 7 11:43 one.sh
This patch changes the script to use `install`, which creates the directory
if it doesn't exist, and sets the permissions on the directory itself, without
recursing to files inside it:
mkdir -m 0700 keyrings2
touch keyrings2/one.sh
touch keyrings2/docker.gpg
ls -al keyrings2/
total 8
drwx------ 2 root root 4096 May 7 11:44 .
drwxr-xr-x 1 root root 4096 May 7 11:44 ..
-rw-r--r-- 1 root root 0 May 7 11:44 docker.gpg
-rw-r--r-- 1 root root 0 May 7 11:44 one.sh
install -m 0755 -d keyrings2/
total 8
drwxr-xr-x 2 root root 4096 May 7 11:44 .
drwxr-xr-x 1 root root 4096 May 7 11:44 ..
-rw-r--r-- 1 root root 0 May 7 11:44 docker.gpg
-rw-r--r-- 1 root root 0 May 7 11:44 one.sh
Changing permissions of the `docker.gpg` file itself is already handled
separately through `chmod a+r /etc/apt/keyrings/docker.gpg`.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The script strips leading zeros to accommodate CalVer versions, which
led to an empty when passing a SemVer(ish) version:
VERSION=23.0.0 ./install.sh --dry-run
...
./install.sh: 118: [: Illegal number:
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This explict install was added because docker 20.10 did not have an explicit
dependency on the plugin. The current release of the Docker CLI (23.0) already
has a "Recommends:" dependency on the plugin, and 0095742fb5
removed the "--no-install-recommends", so fresh installs of Docker 23.0 will
already install this plugin through that dependency.
Removing the explicit install, because the scan-cli-plugin has been deprecated,
and will no longer receive updates, so we don't want it to be installed for the
upcoming 24.0 release when using this script. see;
https://github.com/docker/scan-cli-plugin/blob/b69ac460a6c23243b858326f0e26f6bd202ca781/internal/deprecation.go#L13-L15
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Now that 0095742fb5 removed the "--no-install-recommends"
option for all packages, we no longer need to special-case installation of the rootless-extras
package.
This patch moves the package together with other conditional packages for 20.10 and up. The
order of these conditionals was updated to match the equivalent steps of the RPM packages.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>