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_ls.md

153 lines
7.2 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
# config ls
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_START-->
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
List configs
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
### Aliases
`docker config ls`, `docker config list`
### Options
| Name | Type | Default | Description |
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided |
| [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `-q`, `--quiet` | `bool` | | Only display IDs |
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
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
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_END-->
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
## Description
docs: minor editorial improvements, typo fixes Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-13 09:16:56 -05:00
Run this command on a manager node to list the configs in the Swarm.
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
For detailed information about using configs, refer to [store configuration data using Docker Configs](https://docs.docker.com/engine/swarm/configs/).
> **Note**
>
docs: minor editorial improvements, typo fixes Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-13 09:16:56 -05:00
> This is a cluster management command, and must be executed on a Swarm
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
> manager node. To learn about managers and workers, refer to the
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
> documentation.
## Examples
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
6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago
9u9hk4br2ej0wgngkga6rp4hq my_config 5 weeks ago 5 weeks ago
mem02h8n73mybpgqjf0kfi1n0 test_config 3 seconds ago 3 seconds ago
```
docs: fix anchors Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:28:29 -05:00
### <a name="filter"></a> Filtering (-f, --filter)
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
The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
The currently supported filters are:
- [id](#id) (config's ID)
- [label](#label) (`label=<key>` or `label=<key>=<value>`)
- [name](#name) (config's name)
#### id
The `id` filter matches all or prefix of a config's id.
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 -f "id=6697bflskwj1998km1gnnjr38"
ID NAME CREATED UPDATED
6697bflskwj1998km1gnnjr38 q5s5570vtvnimefos1fyeo2u2 6 weeks ago 6 weeks ago
```
#### label
The `label` filter matches configs based on the presence of a `label` alone or
a `label` and a value.
The following filter matches all configs with a `project` label regardless of
its value:
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 --filter label=project
ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_config About an hour ago About an hour ago
```
The following filter matches only services with the `project` label with the
`project-a` value.
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 service ls --filter label=project=test
ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_config About an hour ago About an hour ago
```
#### name
The `name` filter matches on all or prefix of a config's name.
The following filter matches config with a name containing a prefix of `test`.
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 --filter name=test_config
ID NAME CREATED UPDATED
mem02h8n73mybpgqjf0kfi1n0 test_config About an hour ago About an hour ago
```
docs: fix anchors Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:28:29 -05: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
The formatting option (`--format`) pretty prints configs output
using a Go template.
Valid placeholders for the Go template are listed below:
| Placeholder | Description |
docs: fix (table) formatting, fix some broken links Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 08:33:44 -04:00
|--------------|--------------------------------------------------------------------------------------|
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
| `.ID` | Config ID |
| `.Name` | Config name |
| `.CreatedAt` | Time when the config was created |
| `.UpdatedAt` | Time when the config was updated |
| `.Labels` | All labels assigned to the config |
| `.Label` | Value of a specific label for this config. For example `{{.Label "my-label"}}` |
When using the `--format` option, the `config ls` command will either
output the data exactly as the template declares or, when using the
`table` directive, will include column headers as well.
The following example uses a template without headers and outputs the
`ID` and `Name` entries separated by a colon (`:`) for all images:
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 --format "{{.ID}}: {{.Name}}"
77af4d6b9913: config-1
b6fa739cedf5: config-2
78a85c484f71: config-3
```
To list all configs with their name and created date in a table format you
can use:
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 --format "table {{.ID}}\t{{.Name}}\t{{.CreatedAt}}"
ID NAME CREATED
77af4d6b9913 config-1 5 minutes ago
b6fa739cedf5 config-2 3 hours ago
78a85c484f71 config-3 10 days ago
```
## Related commands
* [config create](config_create.md)
* [config inspect](config_inspect.md)
* [config rm](config_rm.md)