Fix two bugs in `system df`: 1. The total size was calculated incorrectly as it was creating the sum of all image sizes but did not consider that a) the same image may be listed more than once (i.e., for each repo-tag pair), and that b) images share layers. The total size is now calculated directly in `libimage` by taking multi-layer use into account. 2. The reclaimable size was calculated incorrectly. This number indicates which data we can actually remove which means the total size minus what containers use (i.e., the "unique" size of the image in use by containers). NOTE: The c/storage version is pinned back to the previous commit as it is buggy. c/common already requires the buggy version, so use a `replace` to force/pin. Fixes: #16135 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com> |
||
---|---|---|
.. | ||
common | ||
completion | ||
containers | ||
diff | ||
generate | ||
healthcheck | ||
images | ||
inspect | ||
kube | ||
machine | ||
manifest | ||
networks | ||
parse | ||
pods | ||
registry | ||
secrets | ||
system | ||
utils | ||
validate | ||
volumes | ||
README.md | ||
auto-update.go | ||
diff.go | ||
early_init_linux.go | ||
early_init_unsupported.go | ||
inspect.go | ||
login.go | ||
logout.go | ||
main.go | ||
root.go | ||
root_test.go | ||
shell_completion_test.go | ||
syslog_common.go | ||
syslog_unsupported.go |
README.md
Podman CLI
The following is an example of how to add a new primary command (manifest
) and a sub-command (inspect
) to the Podman CLI.
This is example code, the production code has additional error checking and the business logic provided.
See items below for details on building, installing, contributing to Podman:
Adding a new command podman manifest
$ mkdir -p $GOPATH/src/github.com/containers/podman/cmd/podmanV2/manifests
Create the file $GOPATH/src/github.com/containers/podman/cmd/podmanV2/manifests/manifest.go
package manifests
import (
"github.com/containers/podman/cmd/podman/registry"
"github.com/containers/podman/cmd/podman/validate"
"github.com/containers/podman/pkg/domain/entities"
"github.com/spf13/cobra"
)
var (
// podman _manifests_
manifestCmd = &cobra.Command{
Use: "manifest",
Short: "Manage manifests",
Args: cobra.ExactArgs(1),
Long: "Manage manifests",
Example: "podman manifest IMAGE",
TraverseChildren: true,
RunE: validate.SubCommandExists, // Report error if there is no sub command given
}
)
func init() {
// Subscribe command to podman
registry.Commands = append(registry.Commands, registry.CliCommand{
Command: manifestCmd,
})
}
To "wire" in the manifest
command, edit the file $GOPATH/src/github.com/containers/podman/cmd/podmanV2/main.go
to add:
package main
import _ "github.com/containers/podman/cmd/podman/manifests"
Adding a new sub command podman manifests list
Create the file $GOPATH/src/github.com/containers/podman/cmd/podmanV2/manifests/inspect.go
package manifests
import (
"github.com/containers/podman/cmd/podman/registry"
"github.com/containers/podman/pkg/domain/entities"
"github.com/spf13/cobra"
)
var (
// podman manifests _inspect_
inspectCmd = &cobra.Command{
Use: "inspect IMAGE",
Short: "Display manifest from image",
Long: "Displays the low-level information on a manifest identified by image name or ID",
RunE: inspect,
Annotations: map[string]string{
// Add this annotation if this command cannot be run rootless
// registry.ParentNSRequired: "",
},
Example: "podman manifest inspect DEADBEEF",
}
)
func init() {
// Subscribe inspect sub command to manifest command
registry.Commands = append(registry.Commands, registry.CliCommand{
Command: inspectCmd,
// The parent command to proceed this command on the CLI
Parent: manifestCmd,
})
// This is where you would configure the cobra flags using inspectCmd.Flags()
}
// Business logic: cmd is inspectCmd, args is the positional arguments from os.Args
func inspect(cmd *cobra.Command, args []string) error {
// Business logic using registry.ImageEngine()
// Do not pull from libpod directly use the domain objects and types
return nil
}
Helper functions
The complete set can be found in the validate
package, here are some examples:
cobra.Command{ Args: validate.NoArgs }
used when the command does not accept errorscobra.Command{ Args: validate.IdOrLatestArgs }
used to ensure either a list of ids given or the --latest flagcobra.Command{ RunE: validate.SubCommandExists }
used to validate a subcommand given to a commandvalidate.ChoiceValue
used to create apflag.Value
that validate user input against a provided slice of values. For example:flags := cobraCommand.Flags() created := validate.ChoiceValue(&opts.Sort, "command", "created", "id", "image", "names", "runningfor", "size", "status") flags.Var(created, "sort", "Sort output by: "+created.Choices())