Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for volume prune until filter to http api #10756

Merged
merged 1 commit into from
Jun 23, 2021
Merged

Add support for volume prune until filter to http api #10756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions pkg/api/server/register_volumes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// description: |
// JSON encoded value of filters (a map[string][]string) to match volumes against before pruning.
// Available filters:
// - label (label=<key>, label=<key>=<value>, label!=<key>, or label!=<key>=<value>) Prune volumes with (or without, in case label!=... is used) the specified labels.
// - `until=<timestamp>` Prune volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
// - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...` is used) the specified labels.
// responses:
// '200':
// "$ref": "#/responses/VolumePruneResponse"
Expand Down Expand Up @@ -268,7 +269,8 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// description: |
// JSON encoded value of filters (a map[string][]string) to match volumes against before pruning.
// Available filters:
// - label (label=<key>, label=<key>=<value>, label!=<key>, or label!=<key>=<value>) Prune volumes with (or without, in case label!=... is used) the specified labels.
// - `until=<timestamp>` Prune volumes created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
// - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...` is used) the specified labels.
// responses:
// '200':
// "$ref": "#/responses/DockerVolumePruneResponse"
Expand Down
15 changes: 13 additions & 2 deletions pkg/domain/filters/volumes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,22 @@ func GeneratePruneVolumeFilters(filters url.Values) ([]libpod.VolumeFilter, erro
var vf []libpod.VolumeFilter
for filter, v := range filters {
for _, val := range v {
filterVal := val
switch filter {
case "label":
filter := val
vf = append(vf, func(v *libpod.Volume) bool {
return util.MatchLabelFilters([]string{filter}, v.Labels())
return util.MatchLabelFilters([]string{filterVal}, v.Labels())
})
case "until":
until, err := util.ComputeUntilTimestamp([]string{filterVal})
if err != nil {
return nil, err
}
vf = append(vf, func(v *libpod.Volume) bool {
if !until.IsZero() && v.CreatedTime().Before(until) {
return true
}
return false
})
default:
return nil, errors.Errorf("%q is an invalid volume filter", filter)
Expand Down
47 changes: 42 additions & 5 deletions test/apiv2/30-volumes.at
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,11 +125,6 @@ t POST libpod/volumes/prune?filters='{"label":["tes' 500 \
t POST libpod/volumes/prune?filters='{"label":["testlabel"]}' 200
t GET libpod/volumes/json?filters='{"label":["testlabel"]}' 200 length=0

## Prune volumes
t POST libpod/volumes/prune 200
#After prune volumes, there should be no volume existing
t GET libpod/volumes/json 200 length=0

# libpod api: do not use list filters for prune
t POST libpod/volumes/prune?filters='{"name":["anyname"]}' 500 \
.cause="\"name\" is an invalid volume filter"
Expand All @@ -146,4 +141,46 @@ t POST volumes/prune?filters='{"driver":["anydriver"]}' 500 \
t POST volumes/prune?filters='{"scope":["anyscope"]}' 500 \
.cause="\"scope\" is an invalid volume filter"

## Prune volumes using until filter
t POST libpod/volumes/create \
Name=foo5 \
Label='{"testuntil":""}' \
Options='{"type":"tmpfs","o":"nodev,noexec"}}' \
201 \
.Name=foo5 \
.Labels.testuntil="" \
.Options.type=tmpfs \
.Options.o=nodev,noexec

# with date way back in the past, volume should not be deleted
t POST libpod/volumes/prune?filters='{"until":["500000"]}' 200
t GET libpod/volumes/json?filters='{"label":["testuntil"]}' 200 length=1

# with date far in the future, volume should be deleted
t POST libpod/volumes/prune?filters='{"until":["5000000000"]}' 200
t GET libpod/volumes/json?filters='{"label":["testuntil"]}' 200 length=0

t POST libpod/volumes/create \
Name=foo6 \
Label='{"testuntilcompat":""}' \
Options='{"type":"tmpfs","o":"nodev,noexec"}}' \
201 \
.Name=foo6 \
.Labels.testuntilcompat="" \
.Options.type=tmpfs \
.Options.o=nodev,noexec

# with date way back in the past, volume should not be deleted (compat api)
t POST volumes/prune?filters='{"until":["500000"]}' 200
t GET libpod/volumes/json?filters='{"label":["testuntilcompat"]}' 200 length=1

# with date far in the future, volume should be deleted (compat api)
t POST volumes/prune?filters='{"until":["5000000000"]}' 200
t GET libpod/volumes/json?filters='{"label":["testuntilcompat"]}' 200 length=0

## Prune volumes
t POST libpod/volumes/prune 200
#After prune volumes, there should be no volume existing
t GET libpod/volumes/json 200 length=0

# vim: filetype=sh