Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of cli/namespace: add detailed flag to namespace list into release/1.13.x #20250

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelog/20243.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```release-note:improvement
cli/namespace: Add detailed flag to output additional namespace information
such as namespace IDs and custom metadata.
```
17 changes: 16 additions & 1 deletion command/namespace_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,18 @@ Usage: vault namespace list [options]
}

func (c *NamespaceListCommand) Flags() *FlagSets {
return c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
set := c.flagSet(FlagSetHTTP | FlagSetOutputFormat)

f := set.NewFlagSet("Command Options")

f.BoolVar(&BoolVar{
Name: "detailed",
Target: &c.flagDetailed,
Default: false,
Usage: "Print detailed information such as namespace ID.",
})

return set
}

func (c *NamespaceListCommand) AutocompleteArgs() complete.Predictor {
Expand Down Expand Up @@ -101,5 +112,9 @@ func (c *NamespaceListCommand) Run(args []string) int {
return 2
}

if c.flagDetailed && Format(c.UI) != "table" {
return OutputData(c.UI, secret.Data["key_info"])
}

return OutputList(c.UI, secret)
}
6 changes: 6 additions & 0 deletions website/content/docs/commands/namespace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ List all namespaces:
$ vault namespace list
```

List all namespaces with additional details such as namespace ID and custom metadata:

```shell-session
$ vault namespace list -detailed
```

Create a namespace at the path `ns1/` with no custom metadata:

```shell-session
Expand Down