rules_docker_compose

bazel_dep(name = "rules_docker_compose", version = "0.2.6")

common --registry=https://registry.fastverk.com/
common --registry=https://bcr.bazel.build/

bazel_dep(name = "rules_docker_compose", version = "0.1.0")

load(
    "@rules_docker_compose//compose:defs.bzl",
    "docker_compose",
    "docker_compose_network",
    "docker_compose_service",
    "docker_compose_up",
    "docker_compose_volume",
)

docker_compose_network(name = "appnet", driver = "bridge")
docker_compose_volume(name = "cache")

docker_compose_service(
    name = "web",
    image = "nginx:1.27",
    ports = ["8080:80"],
    networks = ["appnet"],
    depends_on = ["redis"],
    restart = "unless-stopped",
    environment = {"NGINX_HOST": "example.local"},
)

docker_compose_service(
    name = "redis",
    image = "redis:7",
    networks = ["appnet"],
    volumes = ["cache:/data"],
    # Complex nested objects (build, healthcheck, deploy, …) are
    # JSON-encoded — the Rust shard reader parses them straight into
    # the typed schema model.
    healthcheck = json.encode({
        "test": ["CMD", "redis-cli", "ping"],
        "interval": "10s",
        "retries": 3,
    }),
)

docker_compose(
    name = "stack",
    project_name = "myapp",
    deps = [":appnet", ":cache", ":redis", ":web"],
    out = "compose.yaml",
)

docker_compose_up(name = "stack.up", project = ":stack")

load("@rules_oci//oci:defs.bzl", "oci_image")
load(
    "@rules_docker_compose//compose:defs.bzl",
    "docker_compose_oci_image_ref",
    "docker_compose_service",
    "docker_compose",
)

oci_image(name = "worker_image", ...)

docker_compose_service(
    name = "worker",
    # image left unset — supplied at build time via image_ref below.
    command = ["./worker"],
)

docker_compose_oci_image_ref(
    name = "worker_image_ref",
    service_name = "worker",
    oci_image = ":worker_image",
    oci_repo = "ghcr.io/myorg/worker",
)

docker_compose(
    name = "stack",
    deps = [":worker", ":worker_image_ref"],
    out = "compose.yaml",
)

# 1. Pick a commit from https://github.com/compose-spec/compose-spec
# 2. Edit _COMPOSE_SPEC_COMMIT + _COMPOSE_SPEC_SHA256 in
#    compose/private/extensions.bzl
#    (compute the sha256 with: curl -fsSL <url> | shasum -a 256)
# 3. Re-run codegen + docs:
bazel run //compose:update_compose_rules
bazel run //docs:update
bazel test //...

bazel test //...

Real usage, taken from the module’s examples/.

examples/configs_secrets/BUILD.bazel

load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
load(
    "@rules_docker_compose//compose:defs.bzl",
    "docker_compose",
    "docker_compose_config",
    "docker_compose_network",
    "docker_compose_secret",
    "docker_compose_service",
)

# Demonstrates the v0.2.0 top-level `configs:` + `secrets:` rules. Both
# replace the previous workaround of bind-mounting config files via the
# per-service `volumes:` block; compose-spec's `configs:` semantics
# (immutable, project-scoped, mountable into multiple services from a
# single source) are now first-class.

docker_compose_network(name = "appnet", driver = "bridge")

# Top-level config — file-backed. Referenced by `app` via the
# schema-derived `configs = ["prometheus"]` list.
docker_compose_config(
    name = "prometheus",
    src = "prometheus.yml",
)

# Top-level secret — file-backed. Referenced by `app` via `secrets`.
docker_compose_secret(
    name = "api_key",
    src = "api_key.txt",
)

# Top-level secret — environment-backed. Demonstrates the alternative
# source path; compose reads the env var's value at runtime.
docker_compose_secret(
    name = "session_key",
    environment = "SESSION_KEY",
)

docker_compose_service(
    name = "app",
    image = "nginx:1.27",
    configs = ["prometheus"],
    secrets = [
        "api_key",
        "session_key",
    ],
    networks = ["appnet"],
)

docker_compose(
    name = "stack",
    project_name = "configs_secrets",
    out = "compose.yaml",
    deps = [
        ":api_key",
        ":app",
        ":appnet",
        ":prometheus",
        ":session_key",
    ],
)

# Pin the rendered output so intentional rule changes show up in PR review.
diff_test(
    name = "stack_yaml_up_to_date",
    file1 = "expected.yaml",
    file2 = ":stack",
)

examples/coverage/BUILD.bazel

load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
load(
    "@rules_docker_compose//compose:defs.bzl",
    "docker_compose",
    "docker_compose_network",
    "docker_compose_service_raw",
    "docker_compose_volume",
)

# Exercises the schema-derived raw rule's long-tail attrs (build, labels,
# shm_size, stop_grace_period, cap_add, sysctls, …) that aren't lifted
# into the v0.2 public façade. Consumers needing these reach for
# `docker_compose_service_raw`; the façade `docker_compose_service`
# covers the high-traffic 80% of services without exposing the full
# 95-attr schema-derived surface.
docker_compose_service = docker_compose_service_raw

docker_compose_network(
    name = "internal",
    driver = "bridge",
    driver_opts = {"com.docker.network.bridge.name": "covnet0"},
    internal = True,
    attachable = True,
    labels = {"tier": "internal"},
)

docker_compose_network(
    name = "external_net",
    external = True,
    name_override = "shared_public",
)

docker_compose_volume(
    name = "shared",
    driver = "local",
    driver_opts = {
        "type": "none",
        "device": "/var/lib/cov/shared",
        "o": "bind",
    },
    labels = {"backup": "nightly"},
    name_override = "cov_shared",
)

docker_compose_volume(
    name = "ext",
    external = True,
)

docker_compose_service(
    name = "api",
    build = json.encode({
        "context": "./api",
        "dockerfile": "Dockerfile.api",
        "target": "runtime",
        "args": {
            "BUILD_VERSION": "1.2.3",
            "GIT_SHA": "abc123",
        },
    }),
    entrypoint = ["/bin/sh", "-c"],
    command = ["./bin/api --listen :8080"],
    environment = {"LOG_LEVEL": "info"},
    env_file = [".env", ".env.local"],
    working_dir = "/srv/api",
    user = "1000:1000",
    hostname = "api-host",
    labels = {
        "traefik.enable": "true",
        "traefik.http.routers.api.rule": "Host(`api.example.com`)",
    },
    profiles = ["dev", "prod"],
    # Networks/volumes are addressed by their *Starlark name* (which
    # becomes the top-level compose key), not by their `name_override`
    # — the override is the runtime resource name, not the lookup key.
    networks = [
        "internal",
        "external_net",
    ],
    volumes = ["shared:/srv/shared"],
    healthcheck = json.encode({
        "test": ["CMD-SHELL", "curl -fsS http://localhost:8080/healthz || exit 1"],
        "interval": "30s",
        "timeout": "5s",
        "retries": 5,
        "start_period": "20s",
    }),
    # These used to require `extra_config`; with v0.2 codegen they're
    # first-class typed Bazel attrs derived from the spec.
    init = True,
    shm_size = "256m",
    stop_grace_period = "1m30s",
    cap_add = ["NET_ADMIN", "SYS_TIME"],
    sysctls = {"net.core.somaxconn": "1024"},
)

docker_compose(
    name = "stack",
    project_name = "coverage",
    deps = [
        ":api",
        ":ext",
        ":external_net",
        ":internal",
        ":shared",
    ],
    out = "compose.yaml",
)

diff_test(
    name = "stack_yaml_up_to_date",
    file1 = "expected.yaml",
    file2 = ":stack",
)

examples/smoke/BUILD.bazel

load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
load(
    "@rules_docker_compose//compose:defs.bzl",
    "docker_compose",
    "docker_compose_command",
    "docker_compose_down",
    "docker_compose_exec",
    "docker_compose_network",
    "docker_compose_run",
    "docker_compose_service",
    "docker_compose_up",
    "docker_compose_volume",
)

# Two-service stack (nginx + redis) using one named volume and one
# private network. Plus a worker service whose image is supplied at
# build time from an OCI image layout label.
#
# This example exercises the v0.2 docker_compose_service façade:
#   * `deps`, `networks`, `named_volume_mounts` are label_lists / dicts.
#   * `oci_image` is a label that the façade resolves to
#     `<repo>@sha256:<digest>` at build time (replaces the separate
#     `docker_compose_oci_image_ref` target previously needed for that).
#   * `healthcheck` is JSON-encoded (no schema-derived typed attr exists
#     for the nested healthcheck object).

docker_compose_network(
    name = "appnet",
    driver = "bridge",
)

docker_compose_volume(name = "cache")

docker_compose_service(
    name = "redis",
    image = "redis:7",
    networks = [":appnet"],
    named_volume_mounts = {":cache": "/data"},
    healthcheck = json.encode({
        "test": ["CMD", "redis-cli", "ping"],
        "interval": "10s",
        "retries": 3,
    }),
)

docker_compose_service(
    name = "web",
    image = "nginx:1.27",
    ports = ["8080:80"],
    networks = [":appnet"],
    deps = [":redis"],
    restart = "unless-stopped",
    environment = {
        "NGINX_HOST": "example.local",
    },
)

# OCI image source — a real repo would point this at `oci_pull` or
# `oci_image`; the fixture keeps the test hermetic.
filegroup(
    name = "fake_alpine_layout",
    srcs = glob(["fake_oci_layout/**"]),
)

docker_compose_service(
    name = "worker",
    oci_image = ":fake_alpine_layout",
    oci_repo = "ghcr.io/fastverk/example-worker",
    command = ["echo", "hello from worker"],
    networks = [":appnet"],
)

docker_compose(
    name = "stack",
    project_name = "smoke",
    # Root services only — `_compose_transitive_aspect` walks each
    # service's `deps`/`networks`/`named_volume_mounts` to discover the
    # volume, network, and image-ref shards automatically.
    deps = [
        ":web",
        ":worker",
    ],
    out = "compose.yaml",
)

docker_compose_up(
    name = "stack.up",
    project = ":stack",
)

docker_compose_down(
    name = "stack.down",
    project = ":stack",
)

# `bazel run :redis.shell` -> docker compose -f <yml> exec -T redis redis-cli
docker_compose_exec(
    name = "redis.shell",
    project = ":stack",
    service = "redis",
    command = ["redis-cli"],
    no_tty = True,
)

# `bazel run :worker.once -- --extra-arg` -> docker compose -f <yml> run --rm
# worker echo "smoke run" --extra-arg
docker_compose_run(
    name = "worker.once",
    project = ":stack",
    service = "worker",
    command = ["echo", "smoke run"],
)

# `bazel run :stack.logs -- redis` -> docker compose -f <yml> logs -f redis
docker_compose_command(
    name = "stack.logs",
    project = ":stack",
    subcommand = "logs",
    args = ["-f"],
)

# Pins the entire end-to-end output. Refresh the committed
# `expected.yaml` after intentional rule changes with:
#   bazel build //examples/smoke:stack
#   cp bazel-bin/examples/smoke/compose.yaml examples/smoke/expected.yaml
diff_test(
    name = "stack_yaml_up_to_date",
    file1 = "expected.yaml",
    file2 = ":stack",
)

from docs/compose_rules.md

docker_compose_network

load("@rules_docker_compose//compose:compose_rules.bzl", "docker_compose_network")

docker_compose_network(name, attachable, driver, driver_opts, enable_ipv4, enable_ipv6, external,
                       internal, ipam, labels, name_override, network_name)

Network configuration for the Compose application.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
attachable	If true, standalone containers can attach to this network.	Boolean	optional	False
driver	Specify which driver should be used for this network. Default is ‘bridge’.	String	optional	""
driver_opts	Specify driver-specific options defined as key/value pairs.	Dictionary: String -> String	optional	{}
enable_ipv4	Enable IPv4 networking.	Boolean	optional	False
enable_ipv6	Enable IPv6 networking.	Boolean	optional	False
external	Specifies that this network already exists and was created outside of Compose.	Boolean	optional	False
internal	Create an externally isolated network.	Boolean	optional	False
ipam	Custom IP Address Management configuration for this network. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
labels	Add metadata to the network using labels.	Dictionary: String -> String	optional	{}
name_override	Custom name for this network.	String	optional	""
network_name	Top-level key for this network in the rendered project. Defaults to the rule name.	String	optional	""

docker_compose_service

load("@rules_docker_compose//compose:compose_rules.bzl", "docker_compose_service")

docker_compose_service(name, annotations, attach, blkio_config, build, cap_add, cap_drop, cgroup,
                       cgroup_parent, command, configs, container_name, cpu_count, cpu_percent,
                       cpu_period, cpu_quota, cpu_rt_period, cpu_rt_runtime, cpu_shares, cpus, cpuset,
                       credential_spec, depends_on, deploy, develop, device_cgroup_rules, devices,
                       dns, dns_opt, dns_search, domainname, entrypoint, env_file, environment,
                       expose, extends, external_links, extra_hosts, gpus, group_add, healthcheck,
                       hostname, image, init, ipc, isolation, label_file, labels, links, logging,
                       mac_address, mem_limit, mem_reservation, mem_swappiness, memswap_limit, models,
                       network_mode, networks, oom_kill_disable, oom_score_adj, pid, pids_limit,
                       platform, ports, post_start, pre_stop, privileged, profiles, provider,
                       pull_policy, pull_refresh_after, read_only, restart, runtime, scale, secrets,
                       security_opt, service_name, shm_size, stdin_open, stop_grace_period,
                       stop_signal, storage_opt, sysctls, tmpfs, tty, ulimits, use_api_socket, user,
                       userns_mode, uts, volumes, volumes_from, working_dir)

Configuration for a service.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
annotations	-	Dictionary: String -> String	optional	{}
attach	-	Boolean	optional	False
blkio_config	Block IO configuration for the service. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
build	Configuration options for building the service’s image. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
cap_add	Add Linux capabilities. For example, ‘CAP_SYS_ADMIN’, ‘SYS_ADMIN’, or ‘NET_ADMIN’.	List of strings	optional	[]
cap_drop	Drop Linux capabilities. For example, ‘CAP_SYS_ADMIN’, ‘SYS_ADMIN’, or ‘NET_ADMIN’.	List of strings	optional	[]
cgroup	Specify the cgroup namespace to join. Use ‘host’ to use the host’s cgroup namespace, or ‘private’ to use a private cgroup namespace.	String	optional	""
cgroup_parent	Specify an optional parent cgroup for the container.	String	optional	""
command	Override the default command declared by the container image, for example ‘CMD’ in Dockerfile.	List of strings	optional	[]
configs	Grant access to Configs on a per-service basis.	List of strings	optional	[]
container_name	Specify a custom container name, rather than a generated default name.	String	optional	""
cpu_count	Number of usable CPUs. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
cpu_percent	Percentage of CPU resources to use. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
cpu_period	Limit the CPU CFS (Completely Fair Scheduler) period.	String	optional	""
cpu_quota	Limit the CPU CFS (Completely Fair Scheduler) quota.	String	optional	""
cpu_rt_period	Limit the CPU real-time period in microseconds or a duration.	String	optional	""
cpu_rt_runtime	Limit the CPU real-time runtime in microseconds or a duration.	String	optional	""
cpu_shares	CPU shares (relative weight) for the container.	String	optional	""
cpus	Number of CPUs to use. A floating-point value is supported to request partial CPUs.	String	optional	""
cpuset	CPUs in which to allow execution (0-3, 0,1).	String	optional	""
credential_spec	Configure the credential spec for managed service account. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
depends_on	Express dependency between services. Service dependencies cause services to be started in dependency order. The dependent service will wait for the dependency to be ready before starting.	List of strings	optional	[]
deploy	JSON-encoded value. The shard reader deserialises the parsed JSON straight into the typed schema model.	String	optional	""
develop	JSON-encoded value. The shard reader deserialises the parsed JSON straight into the typed schema model.	String	optional	""
device_cgroup_rules	Add rules to the cgroup allowed devices list.	List of strings	optional	[]
devices	List of device mappings for the container.	List of strings	optional	[]
dns	Custom DNS servers to set for the service container.	List of strings	optional	[]
dns_opt	Custom DNS options to be passed to the container’s DNS resolver.	List of strings	optional	[]
dns_search	Custom DNS search domains to set on the service container.	List of strings	optional	[]
domainname	Custom domain name to use for the service container.	String	optional	""
entrypoint	Override the default entrypoint declared by the container image, for example ‘ENTRYPOINT’ in Dockerfile.	List of strings	optional	[]
env_file	Add environment variables from a file or multiple files. Can be a single file path or a list of file paths.	List of strings	optional	[]
environment	Add environment variables. You can use either an array or a list of KEY=VAL pairs.	Dictionary: String -> String	optional	{}
expose	Expose ports without publishing them to the host machine - they’ll only be accessible to linked services. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
extends	Extend another service, in the current file or another file. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
external_links	Link to services started outside this Compose application. Specify services as <service_name>:.	List of strings	optional	[]
extra_hosts	Add hostname mappings to the container network interface configuration.	List of strings	optional	[]
gpus	Define GPU devices to use. Can be set to ‘all’ to use all GPUs, or a list of specific GPU devices. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
group_add	Add additional groups which user inside the container should be member of. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
healthcheck	Configure a health check for the container to monitor its health status. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
hostname	Define a custom hostname for the service container.	String	optional	""
image	Specify the image to start the container from. Can be a repository/tag, a digest, or a local image ID.	String	optional	""
init	Run as an init process inside the container that forwards signals and reaps processes.	Boolean	optional	False
ipc	IPC sharing mode for the service container. Use ‘host’ to share the host’s IPC namespace, ‘service:[service_name]’ to share with another service, or ‘shareable’ to allow other services to share this service’s IPC namespace.	String	optional	""
isolation	Container isolation technology to use. Supported values are platform-specific.	String	optional	""
label_file	Add metadata to containers using files containing Docker labels.	List of strings	optional	[]
labels	Add metadata to containers using Docker labels. You can use either an array or a list.	Dictionary: String -> String	optional	{}
links	Link to containers in another service. Either specify both the service name and a link alias (SERVICE:ALIAS), or just the service name.	List of strings	optional	[]
logging	Logging configuration for the service. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
mac_address	Container MAC address to set.	String	optional	""
mem_limit	Memory limit for the container. A string value can use suffix like ‘2g’ for 2 gigabytes.	String	optional	""
mem_reservation	Memory reservation for the container.	String	optional	""
mem_swappiness	Container memory swappiness as percentage (0 to 100).	String	optional	""
memswap_limit	Amount of memory the container is allowed to swap to disk. Set to -1 to enable unlimited swap.	String	optional	""
models	AI Models to use, referencing entries under the top-level models key.	List of strings	optional	[]
network_mode	Network mode. Values can be ‘bridge’, ‘host’, ‘none’, ‘service:[service name]’, or ‘container:[container name]’.	String	optional	""
networks	Networks to join, referencing entries under the top-level networks key. Can be a list of network names or a mapping of network name to network configuration.	List of strings	optional	[]
oom_kill_disable	Disable OOM Killer for the container.	Boolean	optional	False
oom_score_adj	Tune host’s OOM preferences for the container (accepts -1000 to 1000). (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
pid	PID mode for container.	String	optional	""
pids_limit	Tune a container’s PIDs limit. Set to -1 for unlimited PIDs.	String	optional	""
platform	Target platform to run on, e.g., ‘linux/amd64’, ‘linux/arm64’, or ‘windows/amd64’.	String	optional	""
ports	Expose container ports. Short format ([HOST:]CONTAINER[/PROTOCOL]).	List of strings	optional	[]
post_start	Commands to run after the container starts. If any command fails, the container stops. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
pre_stop	Commands to run before the container stops. If any command fails, the container stop is aborted. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
privileged	Give extended privileges to the service container.	Boolean	optional	False
profiles	List of profiles for this service. When profiles are specified, services are only started when the profile is activated.	List of strings	optional	[]
provider	Specify a service which will not be manage by Compose directly, and delegate its management to an external provider. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
pull_policy	Policy for pulling images. Options include: ‘always’, ‘never’, ‘if_not_present’, ‘missing’, ‘build’, or time-based refresh policies.	String	optional	""
pull_refresh_after	Time after which to refresh the image. Used with pull_policy=refresh.	String	optional	""
read_only	Mount the container’s filesystem as read only.	Boolean	optional	False
restart	Restart policy for the service container. Options include: ‘no’, ‘always’, ‘on-failure’, and ‘unless-stopped’.	String	optional	""
runtime	Runtime to use for this container, e.g., ‘runc’.	String	optional	""
scale	Number of containers to deploy for this service.	String	optional	""
secrets	Grant access to Secrets on a per-service basis.	List of strings	optional	[]
security_opt	Override the default labeling scheme for each container.	List of strings	optional	[]
service_name	Top-level key for this service in the rendered project. Defaults to the rule name.	String	optional	""
shm_size	Size of /dev/shm. A string value can use suffix like ‘2g’ for 2 gigabytes.	String	optional	""
stdin_open	Keep STDIN open even if not attached.	Boolean	optional	False
stop_grace_period	Time to wait for the container to stop gracefully before sending SIGKILL (e.g., ‘1s’, ‘1m30s’).	String	optional	""
stop_signal	Signal to stop the container (e.g., ‘SIGTERM’, ‘SIGINT’).	String	optional	""
storage_opt	Storage driver options for the container. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
sysctls	Kernel parameters to set in the container. You can use either an array or a list.	Dictionary: String -> String	optional	{}
tmpfs	Mount a temporary filesystem (tmpfs) into the container. Can be a single value or a list.	List of strings	optional	[]
tty	Allocate a pseudo-TTY to service container.	Boolean	optional	False
ulimits	Override the default ulimits for a container. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
use_api_socket	Bind mount Docker API socket and required auth.	Boolean	optional	False
user	Username or UID to run the container process as.	String	optional	""
userns_mode	User namespace to use. ‘host’ shares the host’s user namespace.	String	optional	""
uts	UTS namespace to use. ‘host’ shares the host’s UTS namespace.	String	optional	""
volumes	Mount host paths or named volumes accessible to the container. Short syntax (VOLUME:CONTAINER_PATH[:MODE])	List of strings	optional	[]
volumes_from	Mount volumes from another service or container. Optionally specify read-only access (ro) or read-write (rw).	List of strings	optional	[]
working_dir	The working directory in which the entrypoint or command will be run	String	optional	""

docker_compose_volume

load("@rules_docker_compose//compose:compose_rules.bzl", "docker_compose_volume")

docker_compose_volume(name, driver, driver_opts, external, labels, name_override, volume_name)

Volume configuration for the Compose application.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
driver	Specify which volume driver should be used for this volume.	String	optional	""
driver_opts	Specify driver-specific options.	Dictionary: String -> String	optional	{}
external	Specifies that this volume already exists and was created outside of Compose.	Boolean	optional	False
labels	Add metadata to the volume using labels.	Dictionary: String -> String	optional	{}
name_override	Custom name for this volume.	String	optional	""
volume_name	Top-level key for this volume in the rendered project. Defaults to the rule name.	String	optional	""

ComposeNetworkInfo

load("@rules_docker_compose//compose:compose_rules.bzl", "ComposeNetworkInfo")

ComposeNetworkInfo(network_name, json)

A network contributed by a target. Shard JSON matches the network schema.

FIELDS

Name	Description
network_name	string: top-level key for this network in the rendered project.
json	File: the JSON shard.

ComposeServiceInfo

load("@rules_docker_compose//compose:compose_rules.bzl", "ComposeServiceInfo")

ComposeServiceInfo(service_name, json)

A service contributed by a target. Shard JSON matches the service schema.

FIELDS

Name	Description
service_name	string: top-level key for this service in the rendered project.
json	File: the JSON shard.

ComposeVolumeInfo

load("@rules_docker_compose//compose:compose_rules.bzl", "ComposeVolumeInfo")

ComposeVolumeInfo(volume_name, json)

A volume contributed by a target. Shard JSON matches the volume schema.

FIELDS

Name	Description
volume_name	string: top-level key for this volume in the rendered project.
json	File: the JSON shard.

from docs/defs.md

User-facing Bazel rules for rules_docker_compose.

The typed schema-derived rules live in compose/compose_rules.bzl — they’re regenerated from the canonical compose-spec schema via rules_jsonschema’s jsonschema_starlark_codegen. Every spec property becomes a typed Bazel attr.* automatically. This file owns the pieces that aren’t schema-derivable:

• docker_compose — collects shards from the graph and invokes the Rust compose-gen binary to emit canonical YAML.
• docker_compose_oci_image_ref — resolves an @rules_oci image to <repo>@sha256:<digest> at build time, contributes that ref to the aggregator via ComposeServiceImageRefInfo. The aggregator threads it to compose-gen --service-image=... so the rendered image: field carries the build-time digest.
• docker_compose_up / _down — bazel run wrappers.

Re-exports the generated typed rules + providers so callers can load everything from a single file.

docker_compose

load("@rules_docker_compose//compose:defs.bzl", "docker_compose")

docker_compose(name, deps, out, project_name)

Assemble service / volume / network shards into one canonical compose.yaml.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
deps	Targets contributing services, volumes, networks, or service-image overrides.	List of labels	optional	[]
out	Path for the generated compose YAML (e.g. compose.yaml).	Label	required
project_name	Top-level name: field. Defaults to empty (compose derives a name from the file’s containing directory).	String	optional	""

docker_compose_network

load("@rules_docker_compose//compose:defs.bzl", "docker_compose_network")

docker_compose_network(name, attachable, driver, driver_opts, enable_ipv4, enable_ipv6, external,
                       internal, ipam, labels, name_override, network_name)

Network configuration for the Compose application.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
attachable	If true, standalone containers can attach to this network.	Boolean	optional	False
driver	Specify which driver should be used for this network. Default is ‘bridge’.	String	optional	""
driver_opts	Specify driver-specific options defined as key/value pairs.	Dictionary: String -> String	optional	{}
enable_ipv4	Enable IPv4 networking.	Boolean	optional	False
enable_ipv6	Enable IPv6 networking.	Boolean	optional	False
external	Specifies that this network already exists and was created outside of Compose.	Boolean	optional	False
internal	Create an externally isolated network.	Boolean	optional	False
ipam	Custom IP Address Management configuration for this network. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
labels	Add metadata to the network using labels.	Dictionary: String -> String	optional	{}
name_override	Custom name for this network.	String	optional	""
network_name	Top-level key for this network in the rendered project. Defaults to the rule name.	String	optional	""

docker_compose_oci_image_ref

load("@rules_docker_compose//compose:defs.bzl", "docker_compose_oci_image_ref")

docker_compose_oci_image_ref(name, oci_image, oci_repo, service_name)

Resolve an OCI image layout to <repo>@sha256:<digest> at build time and override the named service’s image: in the rendered compose YAML.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
oci_image	Target producing an OCI image layout (typically @rules_oci//oci:defs.bzl%oci_image).	Label	required
oci_repo	Registry/repo prefix joined with the resolved digest (e.g. ghcr.io/myorg/myapp).	String	required
service_name	Name of the docker_compose_service whose image: to override.	String	required

docker_compose_service

load("@rules_docker_compose//compose:defs.bzl", "docker_compose_service")

docker_compose_service(name, annotations, attach, blkio_config, build, cap_add, cap_drop, cgroup,
                       cgroup_parent, command, configs, container_name, cpu_count, cpu_percent,
                       cpu_period, cpu_quota, cpu_rt_period, cpu_rt_runtime, cpu_shares, cpus, cpuset,
                       credential_spec, depends_on, deploy, develop, device_cgroup_rules, devices,
                       dns, dns_opt, dns_search, domainname, entrypoint, env_file, environment,
                       expose, extends, external_links, extra_hosts, gpus, group_add, healthcheck,
                       hostname, image, init, ipc, isolation, label_file, labels, links, logging,
                       mac_address, mem_limit, mem_reservation, mem_swappiness, memswap_limit, models,
                       network_mode, networks, oom_kill_disable, oom_score_adj, pid, pids_limit,
                       platform, ports, post_start, pre_stop, privileged, profiles, provider,
                       pull_policy, pull_refresh_after, read_only, restart, runtime, scale, secrets,
                       security_opt, service_name, shm_size, stdin_open, stop_grace_period,
                       stop_signal, storage_opt, sysctls, tmpfs, tty, ulimits, use_api_socket, user,
                       userns_mode, uts, volumes, volumes_from, working_dir)

Configuration for a service.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
annotations	-	Dictionary: String -> String	optional	{}
attach	-	Boolean	optional	False
blkio_config	Block IO configuration for the service. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
build	Configuration options for building the service’s image. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
cap_add	Add Linux capabilities. For example, ‘CAP_SYS_ADMIN’, ‘SYS_ADMIN’, or ‘NET_ADMIN’.	List of strings	optional	[]
cap_drop	Drop Linux capabilities. For example, ‘CAP_SYS_ADMIN’, ‘SYS_ADMIN’, or ‘NET_ADMIN’.	List of strings	optional	[]
cgroup	Specify the cgroup namespace to join. Use ‘host’ to use the host’s cgroup namespace, or ‘private’ to use a private cgroup namespace.	String	optional	""
cgroup_parent	Specify an optional parent cgroup for the container.	String	optional	""
command	Override the default command declared by the container image, for example ‘CMD’ in Dockerfile.	List of strings	optional	[]
configs	Grant access to Configs on a per-service basis.	List of strings	optional	[]
container_name	Specify a custom container name, rather than a generated default name.	String	optional	""
cpu_count	Number of usable CPUs. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
cpu_percent	Percentage of CPU resources to use. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
cpu_period	Limit the CPU CFS (Completely Fair Scheduler) period.	String	optional	""
cpu_quota	Limit the CPU CFS (Completely Fair Scheduler) quota.	String	optional	""
cpu_rt_period	Limit the CPU real-time period in microseconds or a duration.	String	optional	""
cpu_rt_runtime	Limit the CPU real-time runtime in microseconds or a duration.	String	optional	""
cpu_shares	CPU shares (relative weight) for the container.	String	optional	""
cpus	Number of CPUs to use. A floating-point value is supported to request partial CPUs.	String	optional	""
cpuset	CPUs in which to allow execution (0-3, 0,1).	String	optional	""
credential_spec	Configure the credential spec for managed service account. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
depends_on	Express dependency between services. Service dependencies cause services to be started in dependency order. The dependent service will wait for the dependency to be ready before starting.	List of strings	optional	[]
deploy	JSON-encoded value. The shard reader deserialises the parsed JSON straight into the typed schema model.	String	optional	""
develop	JSON-encoded value. The shard reader deserialises the parsed JSON straight into the typed schema model.	String	optional	""
device_cgroup_rules	Add rules to the cgroup allowed devices list.	List of strings	optional	[]
devices	List of device mappings for the container.	List of strings	optional	[]
dns	Custom DNS servers to set for the service container.	List of strings	optional	[]
dns_opt	Custom DNS options to be passed to the container’s DNS resolver.	List of strings	optional	[]
dns_search	Custom DNS search domains to set on the service container.	List of strings	optional	[]
domainname	Custom domain name to use for the service container.	String	optional	""
entrypoint	Override the default entrypoint declared by the container image, for example ‘ENTRYPOINT’ in Dockerfile.	List of strings	optional	[]
env_file	Add environment variables from a file or multiple files. Can be a single file path or a list of file paths.	List of strings	optional	[]
environment	Add environment variables. You can use either an array or a list of KEY=VAL pairs.	Dictionary: String -> String	optional	{}
expose	Expose ports without publishing them to the host machine - they’ll only be accessible to linked services. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
extends	Extend another service, in the current file or another file. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
external_links	Link to services started outside this Compose application. Specify services as <service_name>:.	List of strings	optional	[]
extra_hosts	Add hostname mappings to the container network interface configuration.	List of strings	optional	[]
gpus	Define GPU devices to use. Can be set to ‘all’ to use all GPUs, or a list of specific GPU devices. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
group_add	Add additional groups which user inside the container should be member of. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
healthcheck	Configure a health check for the container to monitor its health status. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
hostname	Define a custom hostname for the service container.	String	optional	""
image	Specify the image to start the container from. Can be a repository/tag, a digest, or a local image ID.	String	optional	""
init	Run as an init process inside the container that forwards signals and reaps processes.	Boolean	optional	False
ipc	IPC sharing mode for the service container. Use ‘host’ to share the host’s IPC namespace, ‘service:[service_name]’ to share with another service, or ‘shareable’ to allow other services to share this service’s IPC namespace.	String	optional	""
isolation	Container isolation technology to use. Supported values are platform-specific.	String	optional	""
label_file	Add metadata to containers using files containing Docker labels.	List of strings	optional	[]
labels	Add metadata to containers using Docker labels. You can use either an array or a list.	Dictionary: String -> String	optional	{}
links	Link to containers in another service. Either specify both the service name and a link alias (SERVICE:ALIAS), or just the service name.	List of strings	optional	[]
logging	Logging configuration for the service. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
mac_address	Container MAC address to set.	String	optional	""
mem_limit	Memory limit for the container. A string value can use suffix like ‘2g’ for 2 gigabytes.	String	optional	""
mem_reservation	Memory reservation for the container.	String	optional	""
mem_swappiness	Container memory swappiness as percentage (0 to 100).	String	optional	""
memswap_limit	Amount of memory the container is allowed to swap to disk. Set to -1 to enable unlimited swap.	String	optional	""
models	AI Models to use, referencing entries under the top-level models key.	List of strings	optional	[]
network_mode	Network mode. Values can be ‘bridge’, ‘host’, ‘none’, ‘service:[service name]’, or ‘container:[container name]’.	String	optional	""
networks	Networks to join, referencing entries under the top-level networks key. Can be a list of network names or a mapping of network name to network configuration.	List of strings	optional	[]
oom_kill_disable	Disable OOM Killer for the container.	Boolean	optional	False
oom_score_adj	Tune host’s OOM preferences for the container (accepts -1000 to 1000). (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
pid	PID mode for container.	String	optional	""
pids_limit	Tune a container’s PIDs limit. Set to -1 for unlimited PIDs.	String	optional	""
platform	Target platform to run on, e.g., ‘linux/amd64’, ‘linux/arm64’, or ‘windows/amd64’.	String	optional	""
ports	Expose container ports. Short format ([HOST:]CONTAINER[/PROTOCOL]).	List of strings	optional	[]
post_start	Commands to run after the container starts. If any command fails, the container stops. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
pre_stop	Commands to run before the container stops. If any command fails, the container stop is aborted. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
privileged	Give extended privileges to the service container.	Boolean	optional	False
profiles	List of profiles for this service. When profiles are specified, services are only started when the profile is activated.	List of strings	optional	[]
provider	Specify a service which will not be manage by Compose directly, and delegate its management to an external provider. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
pull_policy	Policy for pulling images. Options include: ‘always’, ‘never’, ‘if_not_present’, ‘missing’, ‘build’, or time-based refresh policies.	String	optional	""
pull_refresh_after	Time after which to refresh the image. Used with pull_policy=refresh.	String	optional	""
read_only	Mount the container’s filesystem as read only.	Boolean	optional	False
restart	Restart policy for the service container. Options include: ‘no’, ‘always’, ‘on-failure’, and ‘unless-stopped’.	String	optional	""
runtime	Runtime to use for this container, e.g., ‘runc’.	String	optional	""
scale	Number of containers to deploy for this service.	String	optional	""
secrets	Grant access to Secrets on a per-service basis.	List of strings	optional	[]
security_opt	Override the default labeling scheme for each container.	List of strings	optional	[]
service_name	Top-level key for this service in the rendered project. Defaults to the rule name.	String	optional	""
shm_size	Size of /dev/shm. A string value can use suffix like ‘2g’ for 2 gigabytes.	String	optional	""
stdin_open	Keep STDIN open even if not attached.	Boolean	optional	False
stop_grace_period	Time to wait for the container to stop gracefully before sending SIGKILL (e.g., ‘1s’, ‘1m30s’).	String	optional	""
stop_signal	Signal to stop the container (e.g., ‘SIGTERM’, ‘SIGINT’).	String	optional	""
storage_opt	Storage driver options for the container. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
sysctls	Kernel parameters to set in the container. You can use either an array or a list.	Dictionary: String -> String	optional	{}
tmpfs	Mount a temporary filesystem (tmpfs) into the container. Can be a single value or a list.	List of strings	optional	[]
tty	Allocate a pseudo-TTY to service container.	Boolean	optional	False
ulimits	Override the default ulimits for a container. (JSON-encoded; the Rust shard reader parses this verbatim.)	String	optional	""
use_api_socket	Bind mount Docker API socket and required auth.	Boolean	optional	False
user	Username or UID to run the container process as.	String	optional	""
userns_mode	User namespace to use. ‘host’ shares the host’s user namespace.	String	optional	""
uts	UTS namespace to use. ‘host’ shares the host’s UTS namespace.	String	optional	""
volumes	Mount host paths or named volumes accessible to the container. Short syntax (VOLUME:CONTAINER_PATH[:MODE])	List of strings	optional	[]
volumes_from	Mount volumes from another service or container. Optionally specify read-only access (ro) or read-write (rw).	List of strings	optional	[]
working_dir	The working directory in which the entrypoint or command will be run	String	optional	""

docker_compose_volume

load("@rules_docker_compose//compose:defs.bzl", "docker_compose_volume")

docker_compose_volume(name, driver, driver_opts, external, labels, name_override, volume_name)

Volume configuration for the Compose application.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
driver	Specify which volume driver should be used for this volume.	String	optional	""
driver_opts	Specify driver-specific options.	Dictionary: String -> String	optional	{}
external	Specifies that this volume already exists and was created outside of Compose.	Boolean	optional	False
labels	Add metadata to the volume using labels.	Dictionary: String -> String	optional	{}
name_override	Custom name for this volume.	String	optional	""
volume_name	Top-level key for this volume in the rendered project. Defaults to the rule name.	String	optional	""

ComposeNetworkInfo

load("@rules_docker_compose//compose:defs.bzl", "ComposeNetworkInfo")

ComposeNetworkInfo(network_name, json)

A network contributed by a target. Shard JSON matches the network schema.

FIELDS

Name	Description
network_name	string: top-level key for this network in the rendered project.
json	File: the JSON shard.

ComposeProjectInfo

load("@rules_docker_compose//compose:defs.bzl", "ComposeProjectInfo")

ComposeProjectInfo(yaml)

A rendered compose project.

FIELDS

Name	Description
yaml	File: the rendered compose.yaml.

ComposeServiceImageRefInfo

load("@rules_docker_compose//compose:defs.bzl", "ComposeServiceImageRefInfo")

ComposeServiceImageRefInfo(service_name, file)

A build-time-resolved <repo>@<digest> image reference targeted at a named service.

FIELDS

Name	Description
service_name	string: name of the service whose image: to override.
file	File: a one-line text file containing the reference.

ComposeServiceInfo

load("@rules_docker_compose//compose:defs.bzl", "ComposeServiceInfo")

ComposeServiceInfo(service_name, json)

A service contributed by a target. Shard JSON matches the service schema.

FIELDS

Name	Description
service_name	string: top-level key for this service in the rendered project.
json	File: the JSON shard.

ComposeVolumeInfo

load("@rules_docker_compose//compose:defs.bzl", "ComposeVolumeInfo")

ComposeVolumeInfo(volume_name, json)

A volume contributed by a target. Shard JSON matches the volume schema.

FIELDS

Name	Description
volume_name	string: top-level key for this volume in the rendered project.
json	File: the JSON shard.

docker_compose_down

load("@rules_docker_compose//compose:defs.bzl", "docker_compose_down")

docker_compose_down(name, project, **kwargs)

bazel run :<name> -> docker compose -f <generated.yaml> down.

PARAMETERS

Name	Description	Default Value
name	-	none
project	-	none
kwargs	-	none

docker_compose_up

load("@rules_docker_compose//compose:defs.bzl", "docker_compose_up")

docker_compose_up(name, project, **kwargs)

bazel run :<name> -> docker compose -f <generated.yaml> up.

Args after -- are passed through to docker compose (e.g. bazel run :stack.up -- -d for detached mode).

PARAMETERS

Name	Description	Default Value
name	-	none
project	-	none
kwargs	-	none