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

search: deprecate "is-automated" filter and "IsAutomated" field 

The IsAutomated field is being deprecated by Docker Hub's search API and
will always be "false" in future.

This patch:

- Deprecates the field and the related "is-automated" filter
- Removes the "AUTOMATED" column from the default output of "docker search"

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2023-07-10 20:18:28 +02:00
parent 53671c2fef
commit 4fc3f0e6f6
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
8 changed files with 83 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
cli/command/registry/formatter_search.go
View File

@ -9,7 +9,7 @@ import (
) )
const ( const (
defaultSearchTableFormat = "table {{.Name}}\t{{.Description}}\t{{.StarCount}}\t{{.IsOfficial}}\t{{.IsAutomated}}" defaultSearchTableFormat = "table {{.Name}}\t{{.Description}}\t{{.StarCount}}\t{{.IsOfficial}}"
starsHeader = "STARS" starsHeader = "STARS"
officialHeader = "OFFICIAL" officialHeader = "OFFICIAL"
@ -19,9 +19,7 @@ const (
// NewSearchFormat returns a Format for rendering using a network Context // NewSearchFormat returns a Format for rendering using a network Context
func NewSearchFormat(source string) formatter.Format { func NewSearchFormat(source string) formatter.Format {
switch source { switch source {
case "": case "", formatter.TableFormatKey:
return defaultSearchTableFormat
case formatter.TableFormatKey:
return defaultSearchTableFormat return defaultSearchTableFormat
} }
return formatter.Format(source) return formatter.Format(source)
@ -95,6 +93,9 @@ func (c *searchContext) IsOfficial() string {
return c.formatBool(c.s.IsOfficial) return c.formatBool(c.s.IsOfficial)
} }
// IsAutomated formats the IsAutomated field for printing.
//
// Deprecated: the "is_automated" field is deprecated and will always be "false" in the future.
func (c *searchContext) IsAutomated() string { func (c *searchContext) IsAutomated() string {
return c.formatBool(c.s.IsAutomated) //nolint:staticcheck // ignore SA1019 (IsAutomated is deprecated). return c.formatBool(c.s.IsAutomated) //nolint:staticcheck // ignore SA1019 (IsAutomated is deprecated).
} }

4
cli/command/registry/formatter_search_test.go
View File

@ -50,13 +50,13 @@ func TestSearchContext(t *testing.T) {
s: registrytypes.SearchResult{IsAutomated: true}, //nolint:staticcheck // ignore SA1019 (IsAutomated is deprecated). s: registrytypes.SearchResult{IsAutomated: true}, //nolint:staticcheck // ignore SA1019 (IsAutomated is deprecated).
}, },
expValue: "[OK]", expValue: "[OK]",
call: ctx.IsAutomated, call: ctx.IsAutomated, //nolint:staticcheck // ignore SA1019 (IsAutomated is deprecated).
}, },
{ {
searchCtx: searchContext{ searchCtx: searchContext{
s: registrytypes.SearchResult{}, s: registrytypes.SearchResult{},
}, },
call: ctx.IsAutomated, call: ctx.IsAutomated, //nolint:staticcheck // ignore SA1019 (IsAutomated is deprecated).
}, },
} }

4
cli/command/registry/search.go
View File

@ -2,6 +2,7 @@ package registry
import ( import (
"context" "context"
"fmt"
"github.com/docker/cli/cli" "github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
@ -49,6 +50,9 @@ func NewSearchCommand(dockerCli command.Cli) *cobra.Command {
} }
func runSearch(dockerCli command.Cli, options searchOptions) error { func runSearch(dockerCli command.Cli, options searchOptions) error {
if options.filter.Value().Contains("is-automated") {
_, _ = fmt.Fprintln(dockerCli.Err(), `WARNING: the "is-automated" filter is deprecated, and searching for "is-automated=true" will not yield any results in future.`)
}
indexInfo, err := registry.ParseSearchIndexInfo(options.term) indexInfo, err := registry.ParseSearchIndexInfo(options.term)
if err != nil { if err != nil {
return err return err

2
cli/command/registry/testdata/search-context-write-stars-table.golden vendored
View File

@ -1,2 +1,2 @@
NAME DESCRIPTION STARS OFFICIAL AUTOMATED NAME DESCRIPTION STARS OFFICIAL
result1 Official build 5000 [OK] result1 Official build 5000 [OK]

4
cli/command/registry/testdata/search-context-write-table.golden vendored
View File

@ -1,3 +1,3 @@
NAME DESCRIPTION STARS OFFICIAL AUTOMATED NAME DESCRIPTION STARS OFFICIAL
result1 Official build 5000 [OK] result1 Official build 5000 [OK]
result2 Not official 5 [OK] result2 Not official 5

16
docs/deprecated.md
View File

@ -50,6 +50,7 @@ The table below provides an overview of the current status of deprecated feature
| Status | Feature | Deprecated | Remove | | Status | Feature | Deprecated | Remove |
|------------|------------------------------------------------------------------------------------------------------------------------------------|------------|--------| |------------|------------------------------------------------------------------------------------------------------------------------------------|------------|--------|
| Deprecated | [IsAutomated field, and "is-automated" filter on docker search](#isautomated-field--and-is--automated-filter-on-docker-search) | v25.0 | - |
| Deprecated | [OOM-score adjust for the daemon](#oom-score-adjust-for-the-daemon) | v24.0 | v25.0 | | Deprecated | [OOM-score adjust for the daemon](#oom-score-adjust-for-the-daemon) | v24.0 | v25.0 |
| Removed | [Buildkit build information](#buildkit-build-information) | v23.0 | v24.0 | | Removed | [Buildkit build information](#buildkit-build-information) | v23.0 | v24.0 |
| Deprecated | [Legacy builder for Linux images](#legacy-builder-for-linux-images) | v23.0 | - | | Deprecated | [Legacy builder for Linux images](#legacy-builder-for-linux-images) | v23.0 | - |
@ -106,6 +107,21 @@ The table below provides an overview of the current status of deprecated feature
| Removed | [`--run` flag on `docker commit`](#--run-flag-on-docker-commit) | v0.10 | v1.13 | | Removed | [`--run` flag on `docker commit`](#--run-flag-on-docker-commit) | v0.10 | v1.13 |
| Removed | [Three arguments form in `docker import`](#three-arguments-form-in-docker-import) | v0.6.7 | v1.12 | | Removed | [Three arguments form in `docker import`](#three-arguments-form-in-docker-import) | v0.6.7 | v1.12 |
### IsAutomated field, and "is-automated" filter on docker search
**Deprecated in Release: v25.0**
**Target For Removal In Release: v26.0**
The "is_automated" field has been deprecated by Docker Hub's search API.
Consequently, the `IsAutomated` field in image search will always be set
to `false` in future, and searching for "is-automated=true" will yield no
results.
The `AUTOMATED` column has been removed from the default `docker search`
and `docker image search` output in v25.0, and the corresponding `IsAutomated`
templating option will be removed in v26.0.
### OOM-score adjust for the daemon ### OOM-score adjust for the daemon
**Deprecated in Release: v24.0** **Deprecated in Release: v24.0**

97
docs/reference/commandline/search.md
View File

@ -28,31 +28,31 @@ This example displays images with a name containing 'busybox':
```console ```console
$ docker search busybox $ docker search busybox
NAME DESCRIPTION STARS OFFICIAL AUTOMATED NAME DESCRIPTION STARS OFFICIAL
busybox Busybox base image. 316 [OK] busybox Busybox base image. 316 [OK]
progrium/busybox 50 [OK] progrium/busybox 50
radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK] radial/busyboxplus Full-chain, Internet enabled, busybox made... 8
odise/busybox-python 2 [OK] odise/busybox-python 2
azukiapp/busybox This image is meant to be used as the base... 2 [OK] azukiapp/busybox This image is meant to be used as the base... 2
ofayau/busybox-jvm Prepare busybox to install a 32 bits JVM. 1 [OK] ofayau/busybox-jvm Prepare busybox to install a 32 bits JVM. 1
shingonoide/archlinux-busybox Arch Linux, a lightweight and flexible Lin... 1 [OK] shingonoide/archlinux-busybox Arch Linux, a lightweight and flexible Lin... 1
odise/busybox-curl 1 [OK] odise/busybox-curl 1
ofayau/busybox-libc32 Busybox with 32 bits (and 64 bits) libs 1 [OK] ofayau/busybox-libc32 Busybox with 32 bits (and 64 bits) libs 1
peelsky/zulu-openjdk-busybox 1 [OK] peelsky/zulu-openjdk-busybox 1
skomma/busybox-data Docker image suitable for data volume cont... 1 [OK] skomma/busybox-data Docker image suitable for data volume cont... 1
elektritter/busybox-teamspeak Lightweight teamspeak3 container based on... 1 [OK] elektritter/busybox-teamspeak Lightweight teamspeak3 container based on... 1
socketplane/busybox 1 [OK] socketplane/busybox 1
oveits/docker-nginx-busybox This is a tiny NginX docker image based on... 0 [OK] oveits/docker-nginx-busybox This is a tiny NginX docker image based on... 0
ggtools/busybox-ubuntu Busybox ubuntu version with extra goodies 0 [OK] ggtools/busybox-ubuntu Busybox ubuntu version with extra goodies 0
nikfoundas/busybox-confd Minimal busybox based distribution of confd 0 [OK] nikfoundas/busybox-confd Minimal busybox based distribution of confd 0
openshift/busybox-http-app 0 [OK] openshift/busybox-http-app 0
jllopis/busybox 0 [OK] jllopis/busybox 0
swyckoff/busybox 0 [OK] swyckoff/busybox 0
powellquiring/busybox 0 [OK] powellquiring/busybox 0
williamyeh/busybox-sh Docker image for BusyBox's sh 0 [OK] williamyeh/busybox-sh Docker image for BusyBox's sh 0
simplexsys/busybox-cli-powered Docker busybox images, with a few often us... 0 [OK] simplexsys/busybox-cli-powered Docker busybox images, with a few often us... 0
fhisamoto/busybox-java Busybox java 0 [OK] fhisamoto/busybox-java Busybox java 0
scottabernethy/busybox 0 [OK] scottabernethy/busybox 0
marclop/busybox-solr marclop/busybox-solr
``` ```
@ -64,10 +64,10 @@ at least 3 stars and the description isn't truncated in the output:
```console ```console
$ docker search --filter=stars=3 --no-trunc busybox $ docker search --filter=stars=3 --no-trunc busybox
NAME DESCRIPTION STARS OFFICIAL AUTOMATED NAME DESCRIPTION STARS OFFICIAL
busybox Busybox base image. 325 [OK] busybox Busybox base image. 325 [OK]
progrium/busybox 50 [OK] progrium/busybox 50
radial/busyboxplus Full-chain, Internet enabled, busybox made from scratch. Comes in git and cURL flavors. 8 [OK] radial/busyboxplus Full-chain, Internet enabled, busybox made from scratch. Comes in git and cURL flavors. 8
``` ```
### <a name="limit"></a> Limit search results (--limit) ### <a name="limit"></a> Limit search results (--limit)
@ -78,12 +78,12 @@ value is set, the default is set by the daemon.
### <a name="filter"></a> Filtering (--filter) ### <a name="filter"></a> Filtering (--filter)
The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more
than one filter, then pass multiple flags (e.g. `--filter is-automated=true --filter stars=3`) than one filter, then pass multiple flags (e.g. `--filter is-official=true --filter stars=3`)
The currently supported filters are: The currently supported filters are:
- stars (int - number of stars the image has) - stars (int - number of stars the image has)
- is-automated (boolean - true or false) - is the image automated or not - is-automated (boolean - true or false) - is the image automated or not (deprecated)
- is-official (boolean - true or false) - is the image official or not - is-official (boolean - true or false) - is the image official or not
#### stars #### stars
@ -94,23 +94,10 @@ least 3 stars:
```console ```console
$ docker search --filter stars=3 busybox $ docker search --filter stars=3 busybox
NAME DESCRIPTION STARS OFFICIAL AUTOMATED NAME DESCRIPTION STARS OFFICIAL
busybox Busybox base image. 325 [OK] busybox Busybox base image. 325 [OK]
progrium/busybox 50 [OK] progrium/busybox 50
radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK] radial/busyboxplus Full-chain, Internet enabled, busybox made... 8
```
#### is-automated
This example displays images with a name containing 'busybox'
and are automated builds:
```console
$ docker search --filter is-automated=true busybox
NAME DESCRIPTION STARS OFFICIAL AUTOMATED
progrium/busybox 50 [OK]
radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK]
``` ```
#### is-official #### is-official
@ -121,7 +108,7 @@ This example displays images with a name containing 'busybox', at least
```console ```console
$ docker search --filter is-official=true --filter stars=3 busybox $ docker search --filter is-official=true --filter stars=3 busybox
NAME DESCRIPTION STARS OFFICIAL AUTOMATED NAME DESCRIPTION STARS OFFICIAL
busybox Busybox base image. 325 [OK] busybox Busybox base image. 325 [OK]
``` ```
@ -133,12 +120,12 @@ using a Go template.
Valid placeholders for the Go template are: Valid placeholders for the Go template are:
| Placeholder | Description | | Placeholder | Description |
|----------------|-----------------------------------| |----------------|------------------------------------------------|
| `.Name` | Image Name | | `.Name` | Image Name |
| `.Description` | Image description | | `.Description` | Image description |
| `.StarCount` | Number of stars for the image | | `.StarCount` | Number of stars for the image |
| `.IsOfficial` | "OK" if image is official | | `.IsOfficial` | "OK" if image is official |
| `.IsAutomated` | "OK" if image build was automated | | `.IsAutomated` | "OK" if image build was automated (deprecated) |
When you use the `--format` option, the `search` command will When you use the `--format` option, the `search` command will
output the data exactly as the template declares. If you use the output the data exactly as the template declares. If you use the
@ -165,13 +152,13 @@ maxexcloo/nginx: 7
This example outputs a table format: This example outputs a table format:
```console ```console
$ docker search --format "table {{.Name}}\t{{.IsAutomated}}\t{{.IsOfficial}}" nginx $ docker search --format "table {{.Name}}\t{{.IsOfficial}}" nginx
NAME AUTOMATED OFFICIAL NAME OFFICIAL
nginx [OK] nginx [OK]
jwilder/nginx-proxy [OK] jwilder/nginx-proxy
richarvey/nginx-php-fpm [OK] richarvey/nginx-php-fpm
jrcs/letsencrypt-nginx-proxy-companion [OK] jrcs/letsencrypt-nginx-proxy-companion
million12/nginx-php [OK] million12/nginx-php
webdevops/php-nginx [OK] webdevops/php-nginx
``` ```

19
man/src/search.md
View File

@ -6,7 +6,7 @@ of stars awarded, whether the image is official, and whether it is automated.
Filter output based on these conditions: Filter output based on these conditions:
- stars=<numberOfStar> - stars=<numberOfStar>
- is-automated=(true|false) - is-automated=(true|false) (deprecated)
- is-official=(true|false) - is-official=(true|false)
# EXAMPLES # EXAMPLES
@ -17,18 +17,5 @@ Search a registry for the term 'fedora' and only display those images
ranked 3 or higher: ranked 3 or higher:
$ docker search --filter=stars=3 fedora $ docker search --filter=stars=3 fedora
NAME DESCRIPTION STARS OFFICIAL AUTOMATED NAME DESCRIPTION STARS OFFICIAL
mattdm/fedora A basic Fedora image corresponding roughly... 50 fedora Official Docker builds of Fedora 1150 [OK]
fedora (Semi) Official Fedora base image. 38
mattdm/fedora-small A small Fedora image on which to build. Co... 8
goldmann/wildfly A WildFly application server running on a ... 3 [OK]
## Search Docker Hub for automated images
Search Docker Hub for the term 'fedora' and only display automated images
ranked 1 or higher:
$ docker search --filter=is-automated=true --filter=stars=1 fedora
NAME DESCRIPTION STARS OFFICIAL AUTOMATED
goldmann/wildfly A WildFly application server running on a ... 3 [OK]
tutum/fedora-20 Fedora 20 image with SSH access. For the r... 1 [OK]