Fix containers-registries.conf.5 man page to match upstream

This commit is contained in:
Daniel J Walsh 2020-05-01 13:40:30 -04:00
parent b039ee7cbb
commit e6a15e0edd
No known key found for this signature in database
GPG Key ID: A2DF901DABE2C028
2 changed files with 37 additions and 3 deletions

View File

@ -11,8 +11,6 @@ file for container image registries. The file format is TOML.
Container engines will use the `$HOME/.config/containers/registries.conf` if it exists, otherwise they will use `/etc/containers/registries.conf` Container engines will use the `$HOME/.config/containers/registries.conf` if it exists, otherwise they will use `/etc/containers/registries.conf`
# FORMATS
### GLOBAL SETTINGS ### GLOBAL SETTINGS
`unqualified-search-registries` `unqualified-search-registries`
@ -149,6 +147,39 @@ Given the above, a pull of `example.com/foo/image:latest` will try:
in order, and use the first one that exists. in order, and use the first one that exists.
## VERSION 1 FORMAT - DEPRECATED
VERSION 1 format is still supported but it does not support
using registry mirrors, longest-prefix matches, or location rewriting.
The TOML format is used to build a simple list of registries under three
categories: `registries.search`, `registries.insecure`, and `registries.block`.
You can list multiple registries using a comma separated list.
Search registries are used when the caller of a container runtime does not fully specify the
container image that they want to execute. These registries are prepended onto the front
of the specified container image until the named image is found at a registry.
Note that insecure registries can be used for any registry, not just the registries listed
under search.
The `registries.insecure` and `registries.block` lists have the same meaning as the
`insecure` and `blocked` fields in the current version.
### EXAMPLE
The following example configuration defines two searchable registries, one
insecure registry, and two blocked registries.
```
[registries.search]
registries = ['registry1.com', 'registry2.com']
[registries.insecure]
registries = ['registry3.com']
[registries.block]
registries = ['registry.untrusted.com', 'registry.unsafe.com']
```
# NOTE: RISK OF USING UNQUALIFIED IMAGE NAMES # NOTE: RISK OF USING UNQUALIFIED IMAGE NAMES
We recommend always using fully qualified image names including the registry We recommend always using fully qualified image names including the registry
server (full dns name), namespace, image name, and tag server (full dns name), namespace, image name, and tag

View File

@ -46,7 +46,7 @@ Epoch: 1
Epoch: 2 Epoch: 2
%endif %endif
Version: 0.2.0 Version: 0.2.0
Release: 0.4.dev.git%{shortcommit0}%{?dist} Release: 0.5.dev.git%{shortcommit0}%{?dist}
Summary: Inspect container images and repositories on registries Summary: Inspect container images and repositories on registries
License: ASL 2.0 License: ASL 2.0
URL: %{git0} URL: %{git0}
@ -436,6 +436,9 @@ export GOPATH=%{buildroot}/%{gopath}:$(pwd)/vendor:%{gopath}
%{_datadir}/%{name}/test %{_datadir}/%{name}/test
%changelog %changelog
* Fri May 1 2020 Dan Walsh <dwalsh@fedoraproject.org> - 1:0.2.0-0.5.dev.git2415f3f
- Fix containers-registries.conf.5 man page to match upstream
* Wed Apr 29 2020 Dan Walsh <dwalsh@fedoraproject.org> - 1:0.2.0-0.4.dev.git2415f3f * Wed Apr 29 2020 Dan Walsh <dwalsh@fedoraproject.org> - 1:0.2.0-0.4.dev.git2415f3f
- Fix registries.conf file to correctly pass the unqualified-search-registries - Fix registries.conf file to correctly pass the unqualified-search-registries