diff options
| author | Charlie Doern <cdoern@redhat.com> | 2022-07-12 15:23:45 -0400 |
|---|---|---|
| committer | Charlie Doern <cdoern@redhat.com> | 2022-08-04 13:59:58 -0400 |
| commit | 842c6c7c6748f8705698d25a29945f8437f1bed2 (patch) | |
| tree | 944a6f4e50f76a9f5a2d5e1eae0f698a69f39fd4 /docs | |
| parent | 1cf6afb788a681fc379d58d7f1cb69eb1690dba9 (diff) | |
| download | podman-842c6c7c6748f8705698d25a29945f8437f1bed2.tar.gz podman-842c6c7c6748f8705698d25a29945f8437f1bed2.tar.bz2 podman-842c6c7c6748f8705698d25a29945f8437f1bed2.zip | |
podman generate spec
implement a new command `podman generate spec` which can formulate a json specgen to be consumed by both the pod
and container creation API.
supported flags are
--verbose (default true) print output to the terminal
--compact print the json output in a single line format to be piped to the API
--filename put the output in a file
--clone rename the pod/ctr in the spec so it won't conflict w/ an existing entity
Signed-off-by: Charlie Doern <cdoern@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-generate-spec.1.md | 26 | ||||
| -rw-r--r-- | docs/source/markdown/podman-generate.1.md | 3 |
2 files changed, 28 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-generate-spec.1.md b/docs/source/markdown/podman-generate-spec.1.md new file mode 100644 index 000000000..08c939698 --- /dev/null +++ b/docs/source/markdown/podman-generate-spec.1.md @@ -0,0 +1,26 @@ +% podman-generate-spec(1) + +## NAME +podman\-generate\-spec - Generate Specgen JSON based on containers or pods + +## SYNOPSIS +**podman generate spec** [*options*] *container | *pod* + +## DESCRIPTION +**podman generate spec** will generate Specgen JSON from Podman Containers and Pods. This JSON can either be printed to a file, directly to the command line, or both. + +This JSON can then be used as input for the Podman API, specifically for Podman container and pod creation. Specgen is Podman's internal structure for formulating new container-related entities. + +## OPTIONS + +#### **--compact**, **-c** + +Print the output in a compact, one line format. This is useful when piping the data to the Podman API + +#### **--filename**, **-f**=**filename** + +Output to the given file. + +#### **--name**, **-n** + +Rename the pod or container, so that it does not conflict with the existing entity. This is helpful when the JSON is to be used before the source pod or container is deleted. diff --git a/docs/source/markdown/podman-generate.1.md b/docs/source/markdown/podman-generate.1.md index 415a53875..8466068f2 100644 --- a/docs/source/markdown/podman-generate.1.md +++ b/docs/source/markdown/podman-generate.1.md @@ -13,7 +13,8 @@ The generate command will create structured output (like YAML) based on a contai | Command | Man Page | Description | |---------|------------------------------------------------------------|-------------------------------------------------------------------------------------| -| kube | [podman-generate-kube(1)](podman-generate-kube.1.md) | Generate Kubernetes YAML based on containers, pods or volumes. | +| kube | [podman-generate-kube(1)](podman-generate-kube.1.md) | Generate Kubernetes YAML based on containers, pods or volumes. | +| spec | [podman-generate-spec(1)](podman-generate-spec.1.md) | Generate Specgen JSON based on containers or pods. | | systemd | [podman-generate-systemd(1)](podman-generate-systemd.1.md) | Generate systemd unit file(s) for a container or pod. | |