Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/config_inspect.md

102 lines
2.6 KiB
Markdown
Raw Normal View History

docs: add reference for "docker config" commands This is mostly a copy of the equivalent `docker secret` commands, which uses the same mechanisms behind the hood (hence, are 90% the same). We can make further refinements to these docs, but this gives us a starting point. Adding these documents, because there were some links pointing to these pages in the docs, but there was no markdown file to link to on GitHub. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-30 08:49:14 -04:00
---
title: "config inspect"
description: "The config inspect command description and usage"
keywords: ["config, inspect"]
---
# config inspect
```Markdown
Usage: docker config inspect [OPTIONS] CONFIG [CONFIG...]
Display detailed information on one or more configs
Options:
Add "json" as default value to format flag in all inspect commands. Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-18 05:43:29 -05:00
-f, --format string Format output using a custom template:
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Output compact JSON by default for --format=json With this change all `inspect` commands will output a compact JSON representation of the elements, the default format (indented JSON) stays the same. Signed-off-by: Djordje Lukic <djordje.lukic@docker.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-08 08:54:21 -05:00
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates
Add "json" as default value to format flag in all inspect commands. Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-18 05:43:29 -05:00
--pretty Print the information in a human friendly format
docs: add reference for "docker config" commands This is mostly a copy of the equivalent `docker secret` commands, which uses the same mechanisms behind the hood (hence, are 90% the same). We can make further refinements to these docs, but this gives us a starting point. Adding these documents, because there were some links pointing to these pages in the docs, but there was no markdown file to link to on GitHub. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-30 08:49:14 -04:00
--help Print usage
```
## Description
Inspects the specified config.
By default, this renders all results in a JSON array. If a format is specified,
the given template will be executed for each result.
Update most links in docs to use https by default cc @thaJeztah docker/docker.github.io#13680 Signed-off-by: Peter Dave Hello <hsu@peterdavehello.org>
2021-10-14 18:04:36 -04:00
Go's [text/template](https://golang.org/pkg/text/template/) package
docs: add reference for "docker config" commands This is mostly a copy of the equivalent `docker secret` commands, which uses the same mechanisms behind the hood (hence, are 90% the same). We can make further refinements to these docs, but this gives us a starting point. Adding these documents, because there were some links pointing to these pages in the docs, but there was no markdown file to link to on GitHub. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-30 08:49:14 -04:00
describes all the details of the format.
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
> **Note**
>
> This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
> documentation.
## Examples
### Inspect a config by name or ID
You can inspect a config, either by its *name*, or *ID*
For example, given the following config:
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
docs: add reference for "docker config" commands This is mostly a copy of the equivalent `docker secret` commands, which uses the same mechanisms behind the hood (hence, are 90% the same). We can make further refinements to these docs, but this gives us a starting point. Adding these documents, because there were some links pointing to these pages in the docs, but there was no markdown file to link to on GitHub. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-30 08:49:14 -04:00
$ docker config ls
ID NAME CREATED UPDATED
eo7jnzguqgtpdah3cm5srfb97 my_config 3 minutes ago 3 minutes ago
```
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
docs: add reference for "docker config" commands This is mostly a copy of the equivalent `docker secret` commands, which uses the same mechanisms behind the hood (hence, are 90% the same). We can make further refinements to these docs, but this gives us a starting point. Adding these documents, because there were some links pointing to these pages in the docs, but there was no markdown file to link to on GitHub. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-30 08:49:14 -04:00
$ docker config inspect config.json
```
The output is in JSON format, for example:
```json
[
{
"ID": "eo7jnzguqgtpdah3cm5srfb97",
"Version": {
"Index": 17
},
"CreatedAt": "2017-03-24T08:15:09.735271783Z",
"UpdatedAt": "2017-03-24T08:15:09.735271783Z",
"Spec": {
"Name": "my_config",
"Labels": {
"env": "dev",
"rev": "20170324"
},
"Data": "aGVsbG8K"
}
}
]
```
docs: add anchor-tags for flags This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 09:05:29 -04:00
### <a name=format></a> Format the output (--format)
docs: add reference for "docker config" commands This is mostly a copy of the equivalent `docker secret` commands, which uses the same mechanisms behind the hood (hence, are 90% the same). We can make further refinements to these docs, but this gives us a starting point. Adding these documents, because there were some links pointing to these pages in the docs, but there was no markdown file to link to on GitHub. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-30 08:49:14 -04:00
You can use the --format option to obtain specific information about a
config. The following example command outputs the creation time of the
config.
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
docs: add reference for "docker config" commands This is mostly a copy of the equivalent `docker secret` commands, which uses the same mechanisms behind the hood (hence, are 90% the same). We can make further refinements to these docs, but this gives us a starting point. Adding these documents, because there were some links pointing to these pages in the docs, but there was no markdown file to link to on GitHub. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-04-30 08:49:14 -04:00
$ docker config inspect --format='{{.CreatedAt}}' eo7jnzguqgtpdah3cm5srfb97
2017-03-24 08:15:09.735271783 +0000 UTC
```
## Related commands
* [config create](config_create.md)
* [config ls](config_ls.md)
* [config rm](config_rm.md)