From ade20f332319ff4df3eaf154f44caaae47d69011 Mon Sep 17 00:00:00 2001 From: Kunal Kushwaha Date: Mon, 11 May 2020 07:27:10 +0000 Subject: format option added to network inspect command. This helps user to print the inspect output in go template format. Signed-off-by: Kunal Kushwaha --- cmd/podman/networks/inspect.go | 28 +++++++++++++++++++++++- docs/source/markdown/podman-network-inspect.1.md | 14 ++++++++++++ 2 files changed, 41 insertions(+), 1 deletion(-) diff --git a/cmd/podman/networks/inspect.go b/cmd/podman/networks/inspect.go index 60cede894..1b2e89909 100644 --- a/cmd/podman/networks/inspect.go +++ b/cmd/podman/networks/inspect.go @@ -3,6 +3,10 @@ package network import ( "encoding/json" "fmt" + "html/template" + "io" + "os" + "strings" "github.com/containers/libpod/cmd/podman/registry" "github.com/containers/libpod/pkg/domain/entities" @@ -24,12 +28,18 @@ var ( } ) +var ( + networkInspectOptions entities.NetworkInspectOptions +) + func init() { registry.Commands = append(registry.Commands, registry.CliCommand{ Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode}, Command: networkinspectCommand, Parent: networkCmd, }) + flags := networkinspectCommand.Flags() + flags.StringVarP(&networkInspectOptions.Format, "format", "f", "", "Pretty-print network to JSON or using a Go template") } func networkInspect(cmd *cobra.Command, args []string) error { @@ -41,6 +51,22 @@ func networkInspect(cmd *cobra.Command, args []string) error { if err != nil { return err } - fmt.Println(string(b)) + if strings.ToLower(networkInspectOptions.Format) == "json" || networkInspectOptions.Format == "" { + fmt.Println(string(b)) + } else { + var w io.Writer = os.Stdout + //There can be more than 1 in the inspect output. + format := "{{range . }}" + networkInspectOptions.Format + "{{end}}" + tmpl, err := template.New("inspectNetworks").Parse(format) + if err != nil { + return err + } + if err := tmpl.Execute(w, responses); err != nil { + return err + } + if flusher, ok := w.(interface{ Flush() error }); ok { + return flusher.Flush() + } + } return nil } diff --git a/docs/source/markdown/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md index dfa7e4b0c..ca6875d18 100644 --- a/docs/source/markdown/podman-network-inspect.1.md +++ b/docs/source/markdown/podman-network-inspect.1.md @@ -9,6 +9,15 @@ podman\-network\-inspect - Displays the raw CNI network configuration for one or ## DESCRIPTION Display the raw (JSON format) network configuration. This command is not available for rootless users. +## OPTIONS +**--quiet**, **-q** + +The `quiet` option will restrict the output to only the network names. + +**--format**, **-f** + +Pretty-print networks to JSON or using a Go template. + ## EXAMPLE Inspect the default podman network @@ -43,6 +52,11 @@ Inspect the default podman network ] ``` +``` +# podman network inspect podman --format '{{(index .plugins 0).ipam.ranges}}' +[[map[gateway:10.88.0.1 subnet:10.88.0.0/16]]] +``` + ## SEE ALSO podman(1), podman-network(1), podman-network-ls(1) -- cgit v1.2.3-54-g00ecf