LABEL

A instrução LABEL em um Dockerfile é usada para adicionar metadados à imagem Docker na forma de pares chave-valor. Esses metadados podem incluir informações sobre o autor da imagem, a versão da aplicação, descrições, e outros dados relevantes. LABEL é útil para organizar, identificar e gerenciar imagens Docker, especialmente em ambientes complexos ou com várias imagens.

Sintaxe Básica

LABEL chave1=valor1 chave2=valor2 ...

Exemplos de Uso

Adicionar Metadados Simples

FROM nginx:alpine
LABEL maintainer="[e-mail]"
LABEL version="1.0"
LABEL description="Imagem Docker para um servidor web NGINX"

Neste exemplo:

• maintainer especifica o autor ou mantenedor da imagem.

• version define a versão da imagem ou da aplicação contida nela.

• description fornece uma breve descrição da imagem.

Adicionar Vários Metadados em uma Única Instrução

Você pode definir várias etiquetas em uma única instrução LABEL:

FROM ubuntu:20.04
LABEL maintainer="[e-mail]" \
      version="1.0" \
      description="Imagem de base para uma aplicação Python"

Aqui, as chaves e valores são separados por espaço e a linha é dividida usando a barra invertida (\) para melhor legibilidade.

Usos Comuns de LABEL

• Informações do Mantenedor: Usar LABEL para incluir o e-mail ou nome do mantenedor da imagem facilita a comunicação e a rastreabilidade.

• Versão da Imagem: Etiquetar a versão da imagem ou da aplicação ajuda a gerenciar diferentes versões em um registro de contêineres.

• Licenciamento: Incluir informações de licenciamento com LABEL pode ser útil para imagens distribuídas publicamente.

• Documentação e Links: Você pode adicionar links para a documentação, repositórios Git, ou sites relacionados à aplicação contida na imagem.

Exemplos Avançados

Etiquetar com Informação de Build e Git

FROM python:3.10
LABEL maintainer="[e-mail]" \
      version="1.0" \
      build_date="2024-08-22" \
      git_commit="abc1234"

Neste exemplo:

• build_date armazena a data de construção da imagem.

• git_commit armazena o hash da commit Git associado à versão do código que foi usada para construir a imagem.

Convenções e Boas Práticas

• Consistência de Nomenclatura: Use uma convenção de nomenclatura consistente para as chaves, como usar nomes em minúsculas e separar palavras com underscores (_) ou hifens (-).

• Chaves Prefixadas: Em ambientes corporativos ou para imagens distribuídas publicamente, é comum prefixar as chaves com o nome do domínio da organização para evitar colisões com outras chaves.

  LABEL com.exemplo.mantenedor="[e-mail]"
  LABEL com.exemplo.versao="1.0"

• Evite Informações Sensíveis: Não armazene informações sensíveis como senhas, chaves de API ou segredos em labels, pois esses dados podem ser facilmente acessados ao inspecionar a imagem.

Como Verificar Labels em uma Imagem

Após construir a imagem, você pode visualizar os labels usando o comando docker inspect:

docker inspect <nome_da_imagem> | grep -i label

Este comando exibirá todas as labels associadas à imagem.

Resumo

• LABEL permite adicionar metadados na forma de pares chave-valor à imagem Docker.

• É útil para descrever a imagem, fornecer informações sobre o autor, versionamento, links para documentação, e muito mais.

• Boas práticas incluem usar uma nomenclatura consistente, evitar informações sensíveis, e prefixar chaves em ambientes corporativos.

Laboratório

Não entra como uma camada no filesystem da imagem. Ela é um metadado.

FROM ubuntu
RUN apt update && apt install curl --yes
LABEL contato="[e-mail]"
WORKDIR /app
ADD https://www.google.com pagina.html
ADD teste.tar.gz ./

$ docker build -t ubuntu-curl .
[+] Building 0.4s (11/11) FINISHED                                  docker:default
 => [internal] load build definition from Dockerfile                          0.0s
 => => transferring dockerfile: 195B                                          0.0s
 => [internal] load metadata for docker.io/library/ubuntu:latest              0.0s
 => [internal] load .dockerignore                                             0.0s
 => => transferring context: 2B                                               0.0s
 => [1/5] FROM docker.io/library/ubuntu:latest                                0.0s
 => [internal] load build context                                             0.0s
 => => transferring context: 34B                                              0.0s
 => [4/5] ADD https://www.google.com pagina.html                              0.2s
 => CACHED [2/5] RUN apt update && apt install curl --yes                     0.0s
 => CACHED [3/5] WORKDIR /app                                                 0.0s
 => [4/5] ADD https://www.google.com pagina.html                              0.0s
 => [5/5] ADD teste.tar.gz ./                                                 0.0s
 => exporting to image                                                        0.1s
 => => exporting layers                                                       0.0s
 => => writing image sha256:766a8c708d5f306684d5a5f7b1cf12bab5bdc19779647f87  0.0s
 => => naming to docker.io/library/ubuntu-curl                                0.0s

A LABEL não aparece no processo de construção da imagem.

$ docker inspect ubuntu-curl

...
            "Labels": {
                "contato": "[e-mail]",
...

Vários LABEL

FROM ubuntu
RUN apt update && apt install curl --yes
LABEL contato="[e-mail]"
LABEL versao="1.1"
WORKDIR /app
ADD https://www.google.com pagina.html
ADD teste.tar.gz ./

$ docker inspect ubuntu-curl

...
            "Labels": {
                "contato": "[e-mail]",
                "versao": "1.1"                
...