From 466bd48339a560cedfde252f37a0e89e1c2cc456 Mon Sep 17 00:00:00 2001 From: kobayashi Date: Mon, 20 Apr 2020 16:43:13 -0400 Subject: [PATCH] Add examples of inspect cmd --- cmd/ignite/cmd/inspect.go | 9 +++++++++ docs/cli/ignite/ignite_inspect.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/cmd/ignite/cmd/inspect.go b/cmd/ignite/cmd/inspect.go index 08fa115ed..71f13de91 100644 --- a/cmd/ignite/cmd/inspect.go +++ b/cmd/ignite/cmd/inspect.go @@ -22,6 +22,15 @@ func NewCmdInspect(out io.Writer) *cobra.Command { The kind can be "image", "kernel" or "vm". The object is matched by prefix based on its ID and name. Outputs JSON by default, can be overridden with the output flag (-o, --output). + + Example usage: + $ ignite inspect vm my-vm + + $ ignite inspect vm my-vm -t {{.Status.IPAddresses}} + + $ ignite inspect vm my-vm -t {{.ObjectMeta.Name}} + + $ ignite inspect vm my-vm -t {{.Spec.Image.OCI}} `), Args: cobra.ExactArgs(2), Run: func(cmd *cobra.Command, args []string) { diff --git a/docs/cli/ignite/ignite_inspect.md b/docs/cli/ignite/ignite_inspect.md index 1e98806b6..f8282218e 100644 --- a/docs/cli/ignite/ignite_inspect.md +++ b/docs/cli/ignite/ignite_inspect.md @@ -10,6 +10,15 @@ The kind can be "image", "kernel" or "vm". The object is matched by prefix based on its ID and name. Outputs JSON by default, can be overridden with the output flag (-o, --output). +Example usage: + $ ignite inspect vm my-vm + + $ ignite inspect vm my-vm -t {{.Status.IPAddresses}} + + $ ignite inspect vm my-vm -t {{.ObjectMeta.Name}} + + $ ignite inspect vm my-vm -t {{.Spec.Image.OCI}} + ``` ignite inspect [flags]