podman/cmd/podman
Hironori Shiina 9226ccb59f Enable 'podman run --memory-swappiness=0'
'--memory-swappiness=0' used to work. This patch fixes the regression
issue, which was caused by the change of infra container creation
process.

Signed-off-by: Hironori Shiina <shiina.hironori@jp.fujitsu.com>
2021-11-12 13:20:20 -05:00
..
common Add flag to overwrite network backend from config 2021-11-11 17:30:27 +01:00
completion update shell completion scripts 2021-07-02 17:49:12 +02:00
containers Enable 'podman run --memory-swappiness=0' 2021-11-12 13:20:20 -05:00
diff Don't use docker/pkg/archive, use containers/storage/pkg/archive 2021-10-14 10:28:42 -04:00
generate [CI:DOCS] cmd/podman: no dot for short descriptions 2021-09-28 14:53:03 +02:00
healthcheck Stop outputting 'healthy' on healthcheck 2021-09-10 11:20:01 -04:00
images Merge pull request #12224 from cdoern/scp 2021-11-12 18:44:44 +01:00
inspect standardize logrus messages to upper case 2021-09-22 15:29:34 -04:00
machine Make stop message more similar to start 2021-11-02 22:26:04 +01:00
manifest Update USE in order to fix tests 2021-07-13 10:54:26 +02:00
networks Add --time out for podman * rm -f commands 2021-10-04 07:07:56 -04:00
parse import: write stdin to tmp file 2021-07-23 10:21:37 +02:00
play Add support to play kube for --log-opt 2021-10-25 11:40:42 -04:00
pods Enable 'podman run --memory-swappiness=0' 2021-11-12 13:20:20 -05:00
registry Move CONTAINER_HOST and _CONNECTION to IsRemote Function 2021-10-15 14:40:02 -04:00
secrets Add filtering functionality to http api secrets list 2021-09-03 10:29:31 +02:00
system Print headers for system connection ls 2021-11-10 14:48:08 -05:00
utils Add no-trunc support to podman-events 2021-09-16 09:41:29 -04:00
validate Keep error semantics intact 2021-11-05 09:34:22 +01:00
volumes Add --time out for podman * rm -f commands 2021-10-04 07:07:56 -04:00
README.md [Techinal Debt] Cleanup ABI vs. Tunnel CLI commands 2021-05-27 11:40:43 -07:00
auto-update.go auto-update: simple rollback 2021-08-05 15:20:38 +02:00
diff.go podman diff accept two images or containers 2021-07-02 17:11:56 +02:00
early_init_linux.go bump go module to v3 2021-02-22 09:03:51 +01:00
early_init_unsupported.go abi: set default umask and rlimits 2020-07-17 20:53:38 +02:00
inspect.go [Techinal Debt] Cleanup ABI vs. Tunnel CLI commands 2021-05-27 11:40:43 -07:00
login.go Add `--accept-repositories` integration tests 2021-07-30 14:53:55 +02:00
logout.go Add `--accept-repositories` integration tests 2021-07-30 14:53:55 +02:00
main.go [Techinal Debt] Cleanup ABI vs. Tunnel CLI commands 2021-05-27 11:40:43 -07:00
root.go Add flag to overwrite network backend from config 2021-11-11 17:30:27 +01:00
root_test.go bump go module to v3 2021-02-22 09:03:51 +01:00
shell_completion_test.go Alias build to buildx, so it won't fail 2021-08-09 13:05:49 -04:00
syslog_linux.go Fix build on OS X 2020-05-20 18:24:56 -04:00
syslog_unsupported.go Fix build on OS X 2020-05-20 18:24:56 -04:00

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 errors
  • cobra.Command{ Args: validate.IdOrLatestArgs } used to ensure either a list of ids given or the --latest flag
  • cobra.Command{ RunE: validate.SubCommandExists } used to validate a subcommand given to a command
  • validate.ChoiceValue used to create a pflag.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())