docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: tier 1 freshness: content/config/labels-custom-metadata.md 

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2023-10-26 22:02:38 +02:00
parent c176642180
commit 657b3479ef
1 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
content/config/labels-custom-metadata.md
View File

@ -1,9 +1,9 @@
--- ---
description: Description of labels, which are used to manage metadata on Docker objects. description: Learn about labels, a tool to manage metadata on Docker objects.
keywords: Usage, user guide, labels, metadata, docker, documentation, examples, annotating keywords: labels, metadata, docker, annotations
title: Docker object labels title: Docker object labels
aliases: aliases:
- /engine/userguide/labels-custom-metadata/ - /engine/userguide/labels-custom-metadata/
--- ---
Labels are a mechanism for applying metadata to Docker objects, including: Labels are a mechanism for applying metadata to Docker objects, including:
@ -29,7 +29,7 @@ all previous values.
### Key format recommendations ### Key format recommendations
A label _key_ is the left-hand side of the key-value pair. Keys are alphanumeric A label key is the left-hand side of the key-value pair. Keys are alphanumeric
strings which may contain periods (`.`) and hyphens (`-`). Most Docker users use strings which may contain periods (`.`) and hyphens (`-`). Most Docker users use
images created by other organizations, and the following guidelines help to images created by other organizations, and the following guidelines help to
prevent inadvertent duplication of labels across objects, especially if you plan prevent inadvertent duplication of labels across objects, especially if you plan
@ -38,20 +38,20 @@ to use labels as a mechanism for automation.
- Authors of third-party tools should prefix each label key with the - Authors of third-party tools should prefix each label key with the
reverse DNS notation of a domain they own, such as `com.example.some-label`. reverse DNS notation of a domain they own, such as `com.example.some-label`.
- Do not use a domain in your label key without the domain owner's permission. - Don't use a domain in your label key without the domain owner's permission.
- The `com.docker.*`, `io.docker.*`, and `org.dockerproject.*` namespaces are - The `com.docker.*`, `io.docker.*`, and `org.dockerproject.*` namespaces are
reserved by Docker for internal use. reserved by Docker for internal use.
- Label keys should begin and end with a lower-case letter and should only - Label keys should begin and end with a lower-case letter and should only
contain lower-case alphanumeric characters, the period character (`.`), and contain lower-case alphanumeric characters, the period character (`.`), and
the hyphen character (`-`). Consecutive periods or hyphens are not allowed. the hyphen character (`-`). Consecutive periods or hyphens aren't allowed.
- The period character (`.`) separates namespace "fields". Label keys without - The period character (`.`) separates namespace "fields". Label keys without
namespaces are reserved for CLI use, allowing users of the CLI to interactively namespaces are reserved for CLI use, allowing users of the CLI to interactively
label Docker objects using shorter typing-friendly strings. label Docker objects using shorter typing-friendly strings.
These guidelines are not currently enforced and additional guidelines may apply These guidelines aren't currently enforced and additional guidelines may apply
to specific use cases. to specific use cases.
### Value guidelines ### Value guidelines
@ -62,7 +62,7 @@ that the value be serialized to a string first, using a mechanism specific to
the type of structure. For instance, to serialize JSON into a string, you might the type of structure. For instance, to serialize JSON into a string, you might
use the `JSON.stringify()` JavaScript method. use the `JSON.stringify()` JavaScript method.
Since Docker does not deserialize the value, you cannot treat a JSON or XML Since Docker doesn't deserialize the value, you can't treat a JSON or XML
document as a nested structure when querying or filtering by label value unless document as a nested structure when querying or filtering by label value unless
you build this functionality into third-party tooling. you build this functionality into third-party tooling.
@ -75,9 +75,10 @@ Docker deployments.
Labels on images, containers, local daemons, volumes, and networks are static for Labels on images, containers, local daemons, volumes, and networks are static for
the lifetime of the object. To change these labels you must recreate the object. the lifetime of the object. To change these labels you must recreate the object.
Labels on swarm nodes and services can be updated dynamically. Labels on Swarm nodes and services can be updated dynamically.
- Images and containers - Images and containers
- [Adding labels to images](../engine/reference/builder.md#label) - [Adding labels to images](../engine/reference/builder.md#label)
- [Overriding a container's labels at runtime](../engine/reference/commandline/run.md#label) - [Overriding a container's labels at runtime](../engine/reference/commandline/run.md#label)
- [Inspecting labels on images or containers](../engine/reference/commandline/inspect.md) - [Inspecting labels on images or containers](../engine/reference/commandline/inspect.md)
@ -85,26 +86,30 @@ Labels on swarm nodes and services can be updated dynamically.
- [Filtering containers by label](../engine/reference/commandline/ps.md#filter) - [Filtering containers by label](../engine/reference/commandline/ps.md#filter)
- Local Docker daemons - Local Docker daemons
- [Adding labels to a Docker daemon at runtime](../engine/reference/commandline/dockerd.md) - [Adding labels to a Docker daemon at runtime](../engine/reference/commandline/dockerd.md)
- [Inspecting a Docker daemon's labels](../engine/reference/commandline/info.md) - [Inspecting a Docker daemon's labels](../engine/reference/commandline/info.md)
- Volumes - Volumes
- [Adding labels to volumes](../engine/reference/commandline/volume_create.md) - [Adding labels to volumes](../engine/reference/commandline/volume_create.md)
- [Inspecting a volume's labels](../engine/reference/commandline/volume_inspect.md) - [Inspecting a volume's labels](../engine/reference/commandline/volume_inspect.md)
- [Filtering volumes by label](../engine/reference/commandline/volume_ls.md#filter) - [Filtering volumes by label](../engine/reference/commandline/volume_ls.md#filter)
- Networks - Networks
- [Adding labels to a network](../engine/reference/commandline/network_create.md) - [Adding labels to a network](../engine/reference/commandline/network_create.md)
- [Inspecting a network's labels](../engine/reference/commandline/network_inspect.md) - [Inspecting a network's labels](../engine/reference/commandline/network_inspect.md)
- [Filtering networks by label](../engine/reference/commandline/network_ls.md#filter) - [Filtering networks by label](../engine/reference/commandline/network_ls.md#filter)
- Swarm nodes - Swarm nodes
- [Adding or updating a swarm node's labels](../engine/reference/commandline/node_update.md#label-add)
- [Inspecting a swarm node's labels](../engine/reference/commandline/node_inspect.md) - [Adding or updating a Swarm node's labels](../engine/reference/commandline/node_update.md#label-add)
- [Filtering swarm nodes by label](../engine/reference/commandline/node_ls.md#filter) - [Inspecting a Swarm node's labels](../engine/reference/commandline/node_inspect.md)
- [Filtering Swarm nodes by label](../engine/reference/commandline/node_ls.md#filter)
- Swarm services - Swarm services
- [Adding labels when creating a swarm service](../engine/reference/commandline/service_create.md#label) - [Adding labels when creating a Swarm service](../engine/reference/commandline/service_create.md#label)
- [Updating a swarm service's labels](../engine/reference/commandline/service_update.md) - [Updating a Swarm service's labels](../engine/reference/commandline/service_update.md)
- [Inspecting a swarm service's labels](../engine/reference/commandline/service_inspect.md) - [Inspecting a Swarm service's labels](../engine/reference/commandline/service_inspect.md)
- [Filtering swarm services by label](../engine/reference/commandline/service_ls.md#filter) - [Filtering Swarm services by label](../engine/reference/commandline/service_ls.md#filter)