opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-23 09:18:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
podman/docs/source/markdown/podman-secret-inspect.1.md
Ed Santiago dbe0e67897 Man pages: tighter documenting of --format fields 
Initial impetus was #20958 (ps --format .Label abc). This is
a complicated solution to a simple-seeming problem.

The problem: .Label is a cobra *function*, something I did not
know about nor handle.

Solution: recognize cobra functions. Switch to __complete,
not __completeNoDesc, so we can see the number of arguments
required. Invent new man-page format for documenting functions.
And, finally, start enforcing how functions (and cobra structs)
are documented.

This discovered a never-used completion function, .Recycle(),
in podman-events. Remove it.

[NO NEW TESTS NEEDED] - the .go change is an excision of dead code.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2024-01-15 13:11:27 -07:00

2.2 KiB
Raw Blame History

% podman-secret-inspect 1

NAME

podman-secret-inspect - Display detailed information on one or more secrets

SYNOPSIS

podman secret inspect [options] secret [...]

DESCRIPTION

Inspects the specified secret.

By default, this renders all results in a JSON array. If a format is specified, the given template is executed for each result. Secrets can be queried individually by providing their full name or a unique partial name.

OPTIONS

--format, -f=format

Format secret output using Go template.

Placeholder Description
.CreatedAt ... When secret was created (relative timestamp, human-readable)
.ID ID of secret
.SecretData Secret Data (Displayed only with --showsecret option)
.Spec ... Details of secret
.Spec.Driver ... Driver info
.Spec.Driver.Name Driver name (string)
.Spec.Driver.Options ... Driver options (map of driver-specific options)
.Spec.Labels ... Labels for this secret
.Spec.Name Name of secret
.UpdatedAt ... When secret was last updated (relative timestamp, human-readable)

--help

Print usage statement.

--pretty

Print inspect output in human-readable format

--showsecret

Display secret data

EXAMPLES

$ podman secret inspect mysecret
$ podman secret inspect --format "{{.Name} {{.Scope}}" mysecret
$ podman secret inspect --showsecret --format "{{.Name} {{.SecretData}}" mysecret

SEE ALSO

podman(1), podman-secret(1)

HISTORY

January 2021, Originally compiled by Ashley Cui acui@redhat.com