podman/podman-network-inspect.1.md at c6090c290e1eb8b60148a026773c5f8cce6eb435

mirror of https://github.com/containers/podman.git synced 2025-05-17 23:26:08 +08:00

Files

Ed Santiago c6090c290e Docs: consistency between man / --help

New functionality in hack/man-page-checker: start cross-
referencing the man page 'Synopsis' line against the
output of 'podman foo --help'. This is part 1, flag/option
consistency. Part 2 (arg consistency) is too big and will
have to wait for later.

flag/option consistency means: if 'podman foo --help'
includes the string '[flags]' in the Usage message,
make sure the man page includes '[*options*]' in its
Synopsis line, and vice-versa. This found several
inconsistencies, which I've fixed.

While doing this I realized that Cobra automatically
includes a 'Flags:' subsection in its --help output
for all subcommands that have defined flags. This
is great - it lets us cross-check against the
usage synopsis, and make sure that '[flags]' is
present or absent as needed, without fear of
human screwups. If a flag-less subcommand ever
gets extended with flags, but the developer forgets
to add '[flags]' and remove DisableFlagsInUseLine,
we now have a test that will catch that. (This,
too, caught two instances which I fixed).

I don't actually know if the new man-page-checker
functionality will work in CI: I vaguely recall that
it might run before 'make podman' does; and also
vaguely recall that some steps were taken to remedy
that.

Signed-off-by: Ed Santiago <santiago@redhat.com>

2020-06-24 10:39:10 -06:00

1.2 KiB

Raw Blame History

% podman-network-inspect(1)

NAME

podman-network-inspect - Displays the raw CNI network configuration for one or more networks

SYNOPSIS

podman network inspect [options] [network ...]

DESCRIPTION

Display the raw (JSON format) network configuration. This command is not available for rootless users.

OPTIONS

--format, -f

Pretty-print networks to JSON or using a Go template.

EXAMPLE

Inspect the default podman network

# podman network inspect podman
[{
    "cniVersion": "0.3.0",
    "name": "podman",
    "plugins": [
      {
        "type": "bridge",
        "bridge": "cni0",
        "isGateway": true,
        "ipMasq": true,
        "ipam": {
            "type": "host-local",
            "subnet": "10.88.1.0/24",
            "routes": [
                { "dst": "0.0.0.0/0" }
            ]
        }
      },
      {
        "type": "portmap",
        "capabilities": {
          "portMappings": true
        }
      }
    ]
}
]

# podman network inspect podman --format '{{(index  .plugins  0).ipam.ranges}}'
[[map[gateway:10.88.0.1 subnet:10.88.0.0/16]]]

HISTORY

August 2019, Originally compiled by Brent Baude bbaude@redhat.com

1.2 KiB Raw Blame History