Docker Registry configuration parameters

To configure the service, use the following configuration parameters in ADCM.

NOTE

To apply a changed parameter in ADCM, perform one of the following actions:

  • Restart the Docker Registry service using the Restart service action.

  • Reinstall the ADET cluster using the Reinstall cluster action.

Repositories
Parameter Description Default value

Working directory

The absolute path on the host where Docker Registry stores container images and installation artifacts.

This directory is required for both the initial deployment and subsequent cluster operations. Do not delete the unpacked bundle installation files from this directory; otherwise, system package managers (apt/dnf/yum) will fail, causing ADCM UI actions to fail with errors

/opt/arenadata/etools/registry

HTTPS listener
Parameter Description Default value

Host

The IP address through which the Docker Registry repository is accessible to the hosts where Arenadata products are being deployed

 — 

HTTPS port

The port through which the Docker Registry repository is accessible

443

Server certificate

The TLS/HTTPS certificate for the Docker Registry repository in PEM (Privacy-Enhanced Mail) format. By default, this field contains the self-signed certificate generated during the installation of Arenadata products

 — 

Server private key

The cryptographic private key matching the server certificate. It is used to secure TLS/HTTPS connections to the Docker Registry repository. RSA algorithm is recommended.

Note that ADCM does not automatically validate whether the private key matches the provided server certificate. Ensure that the key pair is correct before saving the configuration

 — 

TLS Min Version

The minimum allowed version of the TLS protocol. Possible values:

  • tls1.0

  • tls1.1

  • tls1.2

  • tls1.3

tls1.2

Enable Auth
Parameter Description Default value

Auth Type

Authentication method used to control access to the Docker Registry repository. If Enable Auth is enabled, this field is mandatory. Possible values: token, htpasswd.

Use htpasswd to authenticate users with a username and password managed by Arenadata Enterprise Tools.

Use token to delegate authentication to an external token service compatible with Docker Registry token authentication.

 — 

List of users

List of users allowed to access the Docker Registry repository when htpasswd authentication is used. You can add properties to this list in the <username>:<password> format. Arenadata Enterprise Tools uses this list to generate and manage the .htpasswd file that Docker Registry uses to verify user credentials

 — 

htpasswd Authentication realm

Authentication realm displayed to Docker clients when htpasswd authentication is requested. The realm identifies the protected access area for which the client must provide credentials. Example: Registry Realm

Registry Realm

htpasswd file path (managed by ET)

Read-only path to the ADET-managed .htpasswd file, which is used by Docker Registry for htpasswd authentication

/opt/arenadata/etools/registry/config/.htpasswd

Token auth realm URL

URL of the external endpoint used for token-based authentication. When a Docker client requests access to the registry, Docker Registry redirects the client to this URL to obtain an access token. Example: http://10.1.1.1:8080/realms/registry/protocol/docker-v2/auth. For details, see Docker Registry authentication documentation

 — 

Token issuer

Issuer of tokens used for token-based authentication. Docker Registry checks this value to verify that an access token was issued by a trusted token service.

The value is case-sensitive and must exactly match the issuer value included in tokens by the token service. For example, if Keycloak is used and the realm configured for Docker Registry authentication is registry, the token issuer can be http://<keycloak-address>:8080/realms/registry

 — 

Token service name

Service name for which tokens must be issued. Docker Registry uses this value to verify that an access token is intended for this registry service.

The value must match the service name used by the token service. For example, when Keycloak is used, this value can match the client ID configured for Docker Registry authentication. Only one service name is supported. The value must not contain spaces and special characters such as &, ?, #, and /. Example: registry-client

 — 

CA bundle for token validation

CA bundle used by Docker Registry to validate tokens received from the external token service. The value must contain one certificate or a certificate bundle in PEM format. If you specify multiple certificates, place them one after another in the same value, with each certificate starting with -----BEGIN CERTIFICATE----- and ending with -----END CERTIFICATE-----

 — 

Other
Parameter Description Default value

Enable image deletion

Allows deleting images from the Docker Registry repository. When enabled, clients can delete image manifests and tags through the Docker Registry API. Deleted data may not be removed from disk immediately

false

Storage directory

Directory where Docker Registry stores its internal data

/var/lib/registry

Registry listen address

Address and port on which Docker Registry listens for incoming connections. This address can differ from the external HTTPS port used by clients to access the registry.

The default value 0.0.0.0:8443 means that Docker Registry listens on port 8443 on all available network interfaces

0.0.0.0:8443

Log verbosity

Logging level used by Docker Registry. Possible values ordered from most detailed to least detailed: debug, info, warn, error

info

Log formatter

Format used for Docker Registry logs. Possible values: text, json, logstash

text

Container restart policy

Restart policy applied to the Docker Registry container. Possible values: no, always, on-failure, unless-stopped.

The default value always helps keep Docker Registry available by restarting the container after failures or host restarts. See details in Docker Engine documentation

always

Custom Configuration Overrides

Custom configuration parameters that override the default Docker Registry configuration. Custom configuration parameters have priority over individual configuration fields. Use this parameter for advanced settings that are not available as individual configuration fields. Nested keys are specified via dot notation, for example, storage.delete.enabled

 — 

Found a mistake? Seleсt text and press Ctrl+Enter to report it