Skip to content

Commit

Permalink
format option added to network inspect command.
Browse files Browse the repository at this point in the history
This helps user to print the inspect output in go template format.

Signed-off-by: Kunal Kushwaha <kunal.kushwaha@gmail.com>
  • Loading branch information
kunalkushwaha committed May 12, 2020
1 parent a3797d5 commit b0a200f
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
29 changes: 28 additions & 1 deletion cmd/podman/networks/inspect.go
Expand Up @@ -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"
Expand All @@ -24,12 +28,18 @@ var (
}
)

var (
networkInspectOptions entities.NetworkInspectOptions
)

func init() {
registry.Commands = append(registry.Commands, registry.CliCommand{
Mode: []entities.EngineMode{entities.ABIMode},
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 {
Expand All @@ -41,6 +51,23 @@ 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
}
14 changes: 14 additions & 0 deletions docs/source/markdown/podman-network-inspect.1.md
Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down

0 comments on commit b0a200f

Please sign in to comment.