Skip to content

Commit

Permalink
docs: addition argument_specs
Browse files Browse the repository at this point in the history
  • Loading branch information
sbaerlocher committed Feb 28, 2024
1 parent 5bd1a99 commit 80e4e92
Showing 1 changed file with 206 additions and 0 deletions.
206 changes: 206 additions & 0 deletions roles/docker/meta/argument_specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,212 @@ argument_specs:
experimental:
type: bool
description: Enable experimental features.
labels:
type: list
elements: str
description: A list of labels to set on the Docker daemon.
mtu:
type: int
description: Sets the maximum transmission unit (MTU) for the Docker daemon network interfaces.
max-concurrent-downloads:
type: int
description: Sets the maximum number of parallel image downloads for the Docker daemon.
max-concurrent-uploads:
type: int
description: Sets the maximum number of parallel image uploads for the Docker daemon.
disable-legacy-registry:
type: bool
description: Disables the use of the legacy V1 Docker registry.
shutdown-timeout:
type: int
description: Sets the timeout value (in seconds) for the Docker daemon to wait before forcibly shutting down containers on daemon shutdown.
bip:
type: str
description: Specifies a custom network bridge IP address in CIDR notation. This is used for the default bridge network.
default-address-pools:
type: list
elements: dict
description: A list of IP address pools for dynamic network allocation. Each pool is specified with a base (in CIDR notation) and a size.
options:
base:
type: str
description: The base address in CIDR notation.
size:
type: int
description: The size of the network pool.
allow-nondistributable-artifacts:
type: list
elements: str
description: A list of allowed nondistributable artifacts.
api-cors-header:
type: str
description: Sets the CORS header for the Docker API.
authorization-plugins:
type: list
elements: str
description: A list of authorization plugins to use with Docker.
bridge:
type: str
description: Specifies the network bridge Docker will use.
builder:
type: dict
description: Configuration options for Docker builds.
options:
gc:
type: dict
description: Configuration options for build cache garbage collection.
options:
enabled:
type: bool
description: Enables or disables build cache garbage collection.
defaultKeepStorage:
type: str
description: The default amount of build cache storage to keep.
policy:
type: list
elements: dict
description: Policies for managing build cache storage.
options:
keepStorage:
type: str
description: The amount of build cache storage to keep.
filter:
type: list
elements: str
description: Filters to apply for the policy.
all:
type: bool
description: Whether the policy applies to all build cache.
cgroup-parent:
type: str
description: Sets the parent cgroup for all containers.
containerd:
type: str
description: The path to the containerd socket.
containerd-namespace:
type: str
description: The namespace to use within containerd.
containerd-plugin-namespace:
type: str
description: The namespace for containerd plugins.
default-cgroupns-mode:
type: str
description: The default namespace mode to use for cgroups.
default-gateway:
type: str
description: The default IPv4 gateway.
default-gateway-v6:
type: str
description: The default IPv6 gateway.
default-network-opts:
type: dict
description: Default network options.
default-shm-size:
type: str
description: The default size of the shm for containers.
dns:
type: list
elements: str
description: A list of DNS servers.
dns-opts:
type: list
elements: str
description: A list of DNS options.
dns-search:
type: list
elements: str
description: A list of DNS search domains.
exec-root:
type: str
description: The root directory for execution state files.
features:
type: dict
description: A map of Docker daemon feature flags.
fixed-cidr:
type: str
description: IPv4 subnet for fixed IPs.
fixed-cidr-v6:
type: str
description: IPv6 subnet for fixed IPs.
group:
type: str
description: The group for the Docker socket.
host-gateway-ip:
type: str
description: The host gateway IP address.
hosts:
type: list
elements: str
description: A list of daemon host addresses.
icc:
type: bool
description: Enable or disable inter-container communication.
init:
type: bool
description: Use Docker's init system.
init-path:
type: str
description: Path to the Docker init binary.
ip:
type: str
description: The IP address Docker will bind to.
ip-forward:
type: bool
description: Enable net.ipv4.ip_forward.
ip-masq:
type: bool
description: Enable IP masquerading.
iptables:
type: bool
description: Enable addition of iptables rules.
ip6tables:
type: bool
description: Enable addition of ip6tables rules.
ipv6:
type: bool
description: Enable IPv6 networking.
no-new-privileges:
type: bool
description: Set no-new-privileges by default for new containers.
oom-score-adjust:
type: int
description: Adjust the OOM score.
pidfile:
type: str
description: Path to the PID file.
raw-logs:
type: bool
description: Enable raw logs.
runtimes:
type: dict
description: Specifies OCI compliant runtimes to use for running containers.
seccomp-profile:
type: str
description: The path to the seccomp security profile.
selinux-enabled:
type: bool
description: Enable SELinux support.
swarm-default-advertise-addr:
type: str
description: Set default swarm advertise address.
tlscacert:
type: str
description: Trust certs signed only by this CA.
tlscert:
type: str
description: Path to TLS certificate file.
tlskey:
type: str
description: Path to TLS key file.
userland-proxy:
type: bool
description: Use userland proxy for loopback traffic.
userland-proxy-path:
type: str
description: Path to the userland proxy binary.
userns-remap:
type: str
description: User/Group setting for user namespaces.

docker_systemd_units:
type: list
Expand Down

0 comments on commit 80e4e92

Please sign in to comment.