opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 03:19:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
podman/docs/source/markdown/podman-secret-inspect.1.md
Ed Santiago 4334135491 [CI:DOCS] man-page checker: include --format (Go templates) 
Very belated successor to #14046.

I don't know why this is so important to me. Probably because we're
doing a halfhearted sloppy job of documenting, and new options get
added, and not documented, and that's just wrong.

I've given up on documenting internal structs. This iteration
has a $Format_Exceptions table defined at the top of the xref
script, enumerating a hardcoded defined set of podman commands
and fields that should remain undocumented.

This iteration also forgives completely-undocumented formats.
If podman-foo has a --format, but podman-foo.1.md does not
list *any* valid fields, the script warns but does not fail.
This at least is better than documenting a random mix of fields.

This version of the xref script is much slower: 10s vs 4. I
think we can live with that in a CI-only script.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2023-02-08 15:33:45 -07:00

2.0 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 will be 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
.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

EXAMPLES

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

SEE ALSO

podman(1), podman-secret(1)

HISTORY

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