cs-image-system-tf-docker-plugin 0.1.6__py3-none-any.whl

cs_image_system/tf_docker_plugin/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0

cs_image_system/tf_docker_plugin/main.py

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+
+from cs_image_system.base.basic.abstract_plugin_metadata import AbstractPluginMetadata
+
+from .tf_docker_instance_builder import TofuDockerInstanceBuilder
+from .tf_docker_models import TF_DOCKER_VOLUME, TOFU_DOCKER, TofuDockerInstanceBuilderModel, TofuDockerVolumeStorageBuilderModel
+from .tf_docker_storage_builder import TofuDockerVolumeStorageBuilder
+
+log = logging.getLogger(__name__)
+
+
+class TFDockerTypes(AbstractPluginMetadata):
+    """The container instance builder AND the volume storage builder (stage
+    103 branch 2), in one registration as the clouds' tofu plugins are."""
+
+    def __init__(self) -> None:
+        super().__init__("1", "3.13",
+                         {TOFU_DOCKER: [TofuDockerInstanceBuilderModel, TofuDockerInstanceBuilder],
+                          TF_DOCKER_VOLUME: [TofuDockerVolumeStorageBuilderModel, TofuDockerVolumeStorageBuilder]},
+                         {TofuDockerInstanceBuilderModel: TofuDockerInstanceBuilder,
+                          TofuDockerVolumeStorageBuilderModel: TofuDockerVolumeStorageBuilder})
+
+
+def initialize():
+    log.debug("Initializing the TF docker tofu provider (containers + volumes)")
+    return TFDockerTypes()

cs_image_system/tf_docker_plugin/tf_docker_instance_builder.py

@@ -0,0 +1,297 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""The container instance builder (stage 103 branch 2).
+
+One ``module`` call per instance against tfmodules/docker_container, on
+OpenTofu's ``kreuzwerker/docker`` provider. The image is the instance's
+pinned build (an image id), else the resolved provider-specific image, else
+the per-instance variable finalization fills from the packer manifest with
+the series' floating tag as the fallback (the daemon has no "newest image
+matching a pattern" query, so the tag the bake moves IS that query). Each
+container gets the canonical hostname ``<name>-NNN``, labels for the
+configuration id, the instance and the generation (the module adds the
+build), its network by name, the limits of its machine type, its volumes at
+their mount points and the restart policy ``unless-stopped``; it is declared
+so the next apply leaves a stopped container alone (``must_run = false``).
+
+Launching without user data: the same launch script the clouds feed through
+user data is rendered by ``templatefile`` and UPLOADED into the container at
+creation; the launch-delivery hook runs it through ``docker exec`` after the
+apply (the runtime's ``launch_delivery`` is ``session``). The daemon mounts
+each volume, so the script only makes the group's subtree; the hostname
+comes from the container.
+
+The daemon's address never enters the root: every tofu process the root
+runs carries the runtime's ``DOCKER_HOST`` or ``DOCKER_CONTEXT`` in its
+environment (an ENC host stays a marker in the runner script and opens
+where the line runs), and the provider block is empty.
+"""
+from __future__ import annotations
+
+import logging
+import re
+from decimal import Decimal, InvalidOperation
+from typing import Any, TypeVar, cast
+
+from cs_image_system.base import utils
+from cs_image_system.base.launch_params import ENROLLMENT_TOKEN_VARIABLE, compute_launch_params, user_data_template
+from cs_image_system.base.models.executable import ExecutableModel
+from cs_image_system.base.models.instance import Instance
+from cs_image_system.contract.assets import AssetSet
+from cs_image_system.contract.hcl import HclRaw, hcl_expr, render_module_call
+from cs_image_system.contract.lifecycle import ExecutionLifecyclePhase
+from cs_image_system.hashicorp_utils.collector import TerraformCollector, TerraformVariable
+from cs_image_system.tf_ebs_instance_plugin.tf_instance_builder import TofuInstanceBuilder
+
+from .tf_docker_models import TOFU_DOCKER, TofuDockerInstanceBuilderModel
+
+log = logging.getLogger(__name__)
+
+Q = TypeVar("Q", bound=TofuDockerInstanceBuilderModel)
+
+DOCKER_PROVIDER_SOURCE = "kreuzwerker/docker"
+_MEMORY = re.compile(r"^\s*(\d+(?:\.\d+)?)\s*([kKmMgGtT]?)[bB]?\s*$")
+_UNIT_MB = {"": 1, "k": 1 / 1024, "m": 1, "g": 1024, "t": 1024 * 1024}
+
+
+def memory_mb(value: Any) -> int:
+    """A machine type's memory in the provider's unit (MB) from docker's own
+    spelling (``512m``, ``4g``, ``2048``; a bare number is MB). 0 = none."""
+    if value is None or str(value).strip() == "":
+        return 0
+    m = _MEMORY.match(str(value))
+    if not m:
+        raise ValueError(f"memory {value!r} is not a size docker understands (512m, 4g, 2048)")
+    number, unit = m.group(1), m.group(2).lower()
+    mb = float(number) * _UNIT_MB[unit]
+    return int(round(mb))
+
+
+def cpus_as_read_back(value: Any) -> str:
+    """The provider reads ``cpus`` back with a decimal point (``1`` becomes
+    ``1.0`` and would plan a replacement forever; found while proving the
+    module): render every value with one. Empty when none."""
+    if value is None or str(value).strip() == "":
+        return ""
+    try:
+        text = format(Decimal(str(value)).normalize(), "f")
+    except InvalidOperation as e:
+        raise ValueError(f"cpus {value!r} is not a number") from e
+    return text if "." in text else text + ".0"
+
+
+def generation_of(hostname: str, name: str) -> str:
+    """The generation a canonical hostname carries (``coops-model-003`` is
+    3); a machine grandfathered without a suffix is the record's first."""
+    tail = hostname[len(name) + 1:] if hostname.startswith(name + "-") else ""
+    return str(int(tail)) if tail.isdigit() else "1"
+
+
+class TofuDockerInstanceBuilder(TofuInstanceBuilder[Q]):
+    @classmethod
+    def csis_name(cls) -> str:
+        return TOFU_DOCKER
+
+    @staticmethod
+    def _image_var(label: str) -> str:
+        return f"{label}_image"
+
+    @staticmethod
+    def _ami_var(label: str) -> str:
+        """The variable the inherited ``pre_finalize_phase`` writes into
+        ``instances.auto.tfvars`` for a build this run baked (the GCE
+        builder's lesson, stage 63 item 7)."""
+        return TofuDockerInstanceBuilder._image_var(label)
+
+    def get_executable_copy(self) -> ExecutableModel:
+        """Every tofu process of this root reaches the runtime's daemon: the
+        runtime's tool environment rides on the executable (the runner
+        script carries it as an assignment prefix)."""
+        e = super().get_executable_copy()
+        rtb = self._runtime_builder()
+        env_of = getattr(rtb, "tool_environment", None)
+        if callable(env_of):
+            extra = cast(dict[str, str], env_of())
+            e.environment = {**dict(e.environment or {}), **extra}
+        return e
+
+    @staticmethod
+    def _launch_script_template_name(label: str) -> str:
+        return f"launch-{label}.sh.tftpl"
+
+    def generate_items_before(self, phase: ExecutionLifecyclePhase) -> AssetSet:
+        items = AssetSet()
+        if phase != ExecutionLifecyclePhase.INSTANCE_GENERATION or not self._root_has_work():
+            return items
+        rpath = self.get_path_for_phase(phase, suffix=".tf")
+        items = items.with_default_path(rpath)
+        items.add(f"# Terraform configuration for containers generated by "
+                  f"{self.__class__.__name__} ({self.name})")
+        items.add("# The daemon's address is not here: every tofu process of this root carries the")
+        items.add("# runtime's DOCKER_HOST or DOCKER_CONTEXT in its environment (stage 103 branch 2).")
+        col = TerraformCollector()
+        ws = self.name
+        self._declare_ephemeral_variable(col, ws)
+        if self.model.required_plugins:
+            for plugin in self.model.required_plugins:
+                col.require_provider(ws, plugin.name, source=getattr(plugin, "source", None),
+                                     version=getattr(plugin, "version", None))
+        else:
+            col.require_provider(ws, "docker", source=DOCKER_PROVIDER_SOURCE)
+        col.configure_provider(ws, "docker", {})      # the address rides in the environment
+        for instance in self._instances:
+            label = utils.super_safe_name(instance.get_name())
+            col.declare_variable(ws, TerraformVariable(name=self._image_var(label), type="string", default=""))
+        col.declare_variable(ws, TerraformVariable(
+            name=ENROLLMENT_TOKEN_VARIABLE, type="string", default="", sensitive=True,
+            description="Identity enrollment token handed to instances at launch (TF_VAR_...); empty = no enrollment"))
+        col.bind_workspace(ws, self.model.state_configuration, self.runtime_state_configuration())   # stage 46: own, runtime's, default
+        ctx = self._get_context()
+        for sb_name, sb in ctx.storage_builders.items():
+            if getattr(sb.model, "_storages", None):
+                col.reference_remote_state(ws, producer_workspace=sb_name)
+        identity_ws: set[str] = set()
+        for instance in self._instances:
+            image = ctx.images_map.get(str(instance.image)) if instance.image else None
+            iws = self._identity_workspace_for(getattr(image, "group", None))
+            if iws:
+                identity_ws.add(iws)
+        for iws in sorted(identity_ws):
+            col.reference_remote_state(ws, producer_workspace=iws)
+        items.add_list(col.generate_terraform_block(ws))
+        items.add_list(col.generate_provider_blocks(ws))
+        variable_lines = col.generate_variable_blocks(ws)
+        if variable_lines:
+            items.add_list(variable_lines)
+        remote_lines = col.generate_remote_state_datasources(ws)
+        if remote_lines:
+            items.add_list(remote_lines)
+        backend_lines = col.generate_backend_config(ws)
+        if backend_lines:
+            items.add_list(self._backend_config_path(phase), backend_lines)
+        return items
+
+    def generate_items_during(self, phase: ExecutionLifecyclePhase) -> AssetSet:
+        items = AssetSet()
+        if phase != ExecutionLifecyclePhase.INSTANCE_GENERATION or not self._root_has_work():
+            return items                                    # ledger 70: outside --only-runtime, nothing
+        ctx = self._get_context()
+        rtb = self._runtime_builder()
+        src = utils.module_source("docker_container", self.get_path_for_phase(phase, suffix=".tf").parent)
+        bindings = TerraformCollector().provider_bindings(self.name)
+        for instance in self._instances:
+            label = utils.super_safe_name(instance.get_name())
+            rpath = self.get_path_for_phase(phase, f"instance-{label}", suffix=".tf")
+            params = compute_launch_params(ctx, instance)
+            items.add(rpath, f"# Terraform module call for container {instance.get_name()} "
+                             f"generated by {self.__class__.__name__} ({self.name})")
+            if params.get("group"):
+                items.add(rpath, f"# owning group: {params['group']} (via image {instance.image}); "
+                                 f"launch parameters recorded in meta-state/launch-params.yaml (N26)")
+            items.add_list(rpath, render_module_call(
+                f"instance_{label}", src, self._with_ephemeral_count(instance, self._module_args(ctx, rtb, instance, params)),
+                providers=bindings))
+            # the launch script beside the root: uploaded into the container at
+            # creation, run through the session after the apply
+            tpath = rpath.parent / self._launch_script_template_name(label)
+            items.add(tpath, user_data_template(params))
+        return items
+
+    def _module_args(self, ctx, rtb, instance: Instance, params: dict[str, Any] | None = None) -> dict[str, Any]:
+        from cs_image_system.base.lineage import config_tags, pinned_instance_build
+        label = utils.super_safe_name(instance.get_name())
+        name = str(instance.get_name())
+        hostname = str((params or {}).get("hostname") or name)
+        args: dict[str, Any] = {"name": name, "hostname": hostname}
+        pinned = pinned_instance_build(ctx, instance) if hasattr(ctx, "meta_state") else None
+        psi = (ctx.get_provider_specific_image(instance.image, rtb.get_name()) if rtb and instance.image else None)
+        if pinned:
+            args["image"] = pinned
+        elif psi is not None and psi.is_resolved():
+            args["image"] = psi.identifier
+        elif psi is not None:
+            # built later: the per-instance variable (filled by finalization
+            # from the packer manifest); the series' floating tag is the fallback
+            args["image"] = f"var.{self._image_var(label)}"
+            floating = getattr(psi, "floating_tag", None)
+            tag = floating() if callable(floating) else None
+            if tag:
+                args["image_tag"] = tag
+        else:
+            log.warning(f"No provider-specific image for image {instance.image!r} of instance "
+                        f"{instance.get_name()}; the module call will not resolve an image")
+        if rtb:
+            mt_name = str(getattr(instance, "machine_type", "") or "") or str(rtb.get_default_machine_type() or "")
+            get_types = getattr(rtb.model, "get_machine_types", None)
+            types: dict[str, Any] = cast(dict[str, Any], get_types()) if callable(get_types) else {}
+            mt = types.get(mt_name) if mt_name else None
+            if mt_name and types and mt is None:
+                raise ValueError(f"instance {name}: machine_type {mt_name!r} is not one of runtime "
+                                 f"{rtb.get_name()}'s machine_types ({', '.join(sorted(types))})")
+            if mt is not None:
+                cpus = cpus_as_read_back(mt.get_cpus())
+                if cpus:
+                    args["cpus"] = cpus
+                memory = memory_mb(mt.get_memory())
+                if memory:
+                    args["memory"] = memory
+            networking = getattr(rtb.model, "networking", None)
+            network = getattr(networking, "network", None) if networking else None
+            if network:
+                args["network"] = str(network)
+        labels = {str(k): str(v) for k, v in {**(instance.get_tags() or {}), **config_tags(ctx)}.items()}   # stage 93
+        labels["csis_instance"] = name
+        labels["csis_generation"] = generation_of(hostname, name)
+        args["labels"] = labels
+        if params is not None:
+            args.update(self._launch_args(ctx, label, params))
+        return args
+
+    def _launch_args(self, ctx, label: str, params: dict[str, Any]) -> dict[str, Any]:
+        """The launch script (templatefile over the recorded launch parameters,
+        the gid by the group builder's expression) and the volume mounts, each
+        by remote-state reference to the storage root's outputs."""
+        out: dict[str, Any] = {}
+        group = params.get("group")
+        gid = self._gid_expression_for(group)          # stage 75 step 3: the group builder writes it
+        template_vars: dict[str, Any] = {}
+        if gid is not None:
+            template_vars["group_gid"] = HclRaw(gid)
+        volumes: dict[str, Any] = {}
+        for m in params.get("mounts", []):
+            sb = m.get("builder") or self._storage_builder_name(m["storage"])
+            if not sb:
+                continue
+            ref = (f"data.terraform_remote_state.{utils.super_safe_name(sb)}"
+                   f".outputs.storage_{utils.super_safe_name(m['storage'])}")
+            if m.get("platform_mounted"):
+                volumes[m["storage"]] = {"volume_name": HclRaw(f"{ref}.volume_name"),
+                                         "container_path": str(m["mount_point"])}
+        template_vars["efs"] = {}
+        template_vars["filestore"] = {}
+        template_vars["ebs"] = {}
+        # an OPA group on a container runtime is refused at validation (decision
+        # 3), so no enrollment reaches here; the variable keeps the template whole
+        template_vars[ENROLLMENT_TOKEN_VARIABLE] = ""
+        tpl = self._launch_script_template_name(label)
+        out["launch_script"] = HclRaw(f'templatefile("${{path.module}}/{tpl}", {hcl_expr(template_vars, 2)})')
+        if volumes:
+            out["volumes"] = volumes
+        return out
+
+    def _attachment_address(self, instance_name: str, storage: str) -> str | None:
+        return None   # a volume mount is an attribute of docker_container; changing it re-creates
+
+    def _module_address(self, instance_name: str) -> str:
+        return f"module.instance_{utils.super_safe_name(instance_name)}"
+
+    def _replacements(self) -> list[str]:
+        ctx = self._get_context()
+        from cs_image_system.base.lineage import pending_instance_replacements
+        names = pending_instance_replacements(ctx, self._instances)   # upgrades + follow (stage 9)
+        return [f"{self._module_address(n)}.docker_container.this" for n in sorted(names)]
+
+    def _own_resources_to_let_go(self) -> list[str]:
+        return []      # the root makes nothing of its own beside the containers

cs_image_system/tf_docker_plugin/tf_docker_models.py

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""The container instance and volume builder models (stage 103 branch 2).
+
+The same shape as the clouds' tofu models: one terraform root per builder,
+a state manager by reference (the runtime's, else the default), and the
+runtime builder supplies the daemon's address through the environment of
+every tofu process the root runs.
+"""
+from __future__ import annotations
+
+from dataclasses import field
+
+from cs_image_system.contract.model_config import CSIS_MODEL_CONFIG
+from pydantic.dataclasses import dataclass  # stage 23: validation at construction
+
+from cs_image_system.base.models.module_variables import ModuleVariables
+from cs_image_system.tf_ebs_instance_plugin.tf_instance_models import TofuInstanceBuilderModel
+from cs_image_system.tf_ebs_instance_plugin.tf_storage_models import TofuStorageBuilderModel
+
+TOFU_DOCKER: str = "tofu-docker"
+TF_DOCKER_VOLUME: str = "tf-docker-volume"
+
+
+@dataclass(kw_only=True, config=CSIS_MODEL_CONFIG)
+class TofuDockerInstanceBuilderModel(TofuInstanceBuilderModel):
+    """An instance root on a docker runtime: one ``docker_container`` per
+    instance through tfmodules/docker_container."""
+    type = TOFU_DOCKER
+
+    @classmethod
+    def csis_name(cls) -> str:
+        return TOFU_DOCKER
+
+
+@dataclass(kw_only=True, config=CSIS_MODEL_CONFIG)
+class DockerVolumeVariables(ModuleVariables):
+    """tfmodules/docker_volume: the volume driver and its options, when not
+    the daemon's ``local`` default; ``tags`` are emitted as labels."""
+    driver: str | None = None
+    driver_opts: dict[str, str] | None = None
+
+
+@dataclass(kw_only=True, config=CSIS_MODEL_CONFIG)
+class TofuDockerVolumeStorageBuilderModel(TofuStorageBuilderModel):
+    """A storage root on a docker runtime: one named volume per storage
+    through tfmodules/docker_volume. Capability type ``volume``: many
+    containers may mount one, it is POSIX, it lives in no zone, and the
+    daemon mounts it at the declared path before the first command."""
+    type = TF_DOCKER_VOLUME
+    variables: DockerVolumeVariables = field(default_factory=DockerVolumeVariables)
+
+    @classmethod
+    def csis_name(cls) -> str:
+        return TF_DOCKER_VOLUME

cs_image_system/tf_docker_plugin/tf_docker_storage_builder.py

@@ -0,0 +1,177 @@
+# SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+"""The volume storage builder (stage 103 branch 2).
+
+One ``docker_volume`` per storage through tfmodules/docker_volume, on the
+``kreuzwerker/docker`` provider, reusing the clouds' tofu storage machinery
+(one terraform root per builder, a module call per storage, the storage
+state machine, the apply gate). Capability type ``volume``: many containers
+may mount one, it is POSIX (the per-group subtree is made and chgrp'ed at
+first launch by the launch script), it lives in no zone, and the daemon
+mounts it at the declared path before the container's first command
+(``platform_mounts``). Archive is a later item: a volume has no snapshot.
+"""
+from __future__ import annotations
+
+import json
+import logging
+import subprocess
+from typing import Any, TypeVar, cast
+
+from cs_image_system.base.basic.builder_base_storage import CARDINALITY_MANY
+from cs_image_system.base.models.executable import ExecutableModel
+from cs_image_system.base.models.storage import Storage
+from cs_image_system.contract.assets import AssetSet
+from cs_image_system.contract.lifecycle import ExecutionLifecyclePhase
+from cs_image_system.docker_runtime.docker_names import tag_name
+from cs_image_system.hashicorp_utils.collector import TerraformCollector
+from cs_image_system.tf_ebs_instance_plugin.tf_storage_builder import TofuStorageBuilder, storage_groups
+
+from .tf_docker_models import TF_DOCKER_VOLUME, TofuDockerVolumeStorageBuilderModel
+
+log = logging.getLogger(__name__)
+
+Q = TypeVar("Q", bound=TofuDockerVolumeStorageBuilderModel)
+DOCKER_PROVIDER_SOURCE = "kreuzwerker/docker"
+
+
+def volume_name(storage_name: str) -> str:
+    """A docker volume name from a storage's name (letters, digits, ``_``,
+    ``.`` and ``-``; the same rule as a tag)."""
+    return tag_name(storage_name)
+
+
+class TofuDockerVolumeStorageBuilder(TofuStorageBuilder[Q]):
+    @classmethod
+    def csis_name(cls) -> str:
+        return TF_DOCKER_VOLUME
+
+    @classmethod
+    def capability_type(cls) -> str:
+        return "volume"
+
+    def attachment_cardinality(self) -> str:
+        return CARDINALITY_MANY
+
+    def is_zonal(self) -> bool:
+        return False      # a daemon has no zones
+
+    def platform_mounts(self) -> bool:
+        return True       # the daemon mounts it at the declared path before the first command
+
+    def base_image_prerequisites(self, os_family: str | None = None) -> list[str]:
+        return [f"# storage type 'volume' declared: no prerequisites to bake ({self.get_name()})"]
+
+    def module_dirname(self) -> str:
+        return "docker_volume"
+
+    # ------------------------------------------------------------ the daemon
+    def _runtime(self):
+        return self._get_context().runtime_builders.get(self.model.get_runtime_provider(), None)
+
+    def get_executable_copy(self) -> ExecutableModel:
+        """Every tofu process of this root reaches the runtime's daemon (the
+        instance builder's rule)."""
+        e = super().get_executable_copy()
+        env_of = getattr(self._runtime(), "tool_environment", None)
+        if callable(env_of):
+            extra = cast(dict[str, str], env_of())
+            e.environment = {**dict(e.environment or {}), **extra}
+        return e
+
+    def _docker(self, *args: str) -> subprocess.CompletedProcess[str]:
+        """The runtime's own docker call when it has one (its binary, its
+        daemon), else ``docker`` from PATH (a stand-in runtime in a test)."""
+        rtb = self._runtime()
+        call = getattr(rtb, "_docker", None)
+        if callable(call):
+            return cast(subprocess.CompletedProcess[str], call(*args, check=False))
+        return subprocess.run(["docker", *args], capture_output=True, text=True, check=False)
+
+    def generate_items_before(self, phase: ExecutionLifecyclePhase) -> AssetSet:
+        items = AssetSet()
+        if phase != ExecutionLifecyclePhase.STORAGE_GENERATION or not self._has_work():
+            return items
+        rpath = self.get_path_for_phase(phase, suffix=".tf")
+        items = items.with_default_path(rpath)
+        items.add(f"# Terraform configuration for container volumes generated by "
+                  f"{self.__class__.__name__} ({self.name})")
+        items.add("# The daemon's address is not here: every tofu process of this root carries the")
+        items.add("# runtime's DOCKER_HOST or DOCKER_CONTEXT in its environment (stage 103 branch 2).")
+        col = TerraformCollector()
+        ws = self.name
+        if self.model.required_plugins:
+            for plugin in self.model.required_plugins:
+                col.require_provider(ws, plugin.name, source=getattr(plugin, "source", None),
+                                     version=getattr(plugin, "version", None))
+        else:
+            col.require_provider(ws, "docker", source=DOCKER_PROVIDER_SOURCE)
+        col.configure_provider(ws, "docker", {})
+        col.bind_workspace(ws, self.model.state_configuration, self.runtime_state_configuration())   # stage 46: own, runtime's, default
+        for identity_ws in sorted(self.identity_workspaces()):
+            col.reference_remote_state(ws, producer_workspace=identity_ws)
+        items.add_list(col.generate_terraform_block(ws))
+        items.add_list(col.generate_provider_blocks(ws))
+        remote_lines = col.generate_remote_state_datasources(ws)
+        if remote_lines:
+            items.add_list(remote_lines)
+        backend_lines = col.generate_backend_config(ws)
+        if backend_lines:
+            items.add_list(self._backend_config_path(phase), backend_lines)
+        return items
+
+    def _labels(self, storage: Storage) -> dict[str, str]:
+        from cs_image_system.base.lineage import config_tags
+        merged = getattr(self.model, "variables", None)
+        base = merged.merged_tags(storage.tags) if merged is not None else dict(storage.tags or {})
+        labels = {str(k): str(v) for k, v in base.items()}
+        labels["csis_storage"] = storage.get_name()
+        get_ctx: Any = getattr(self, "_get_context", None)      # a stand-in without a context gets no id
+        if callable(get_ctx):
+            labels.update(config_tags(cast(Any, get_ctx())))   # stage 93: the volume carries the id
+        for g in sorted(storage_groups(storage)):
+            labels[f"csis_group_{g}"] = "true"
+        return labels
+
+    def module_args(self, storage: Storage) -> dict[str, Any]:
+        args: dict[str, Any] = dict(self.model.variables.as_module_args())   # driver, driver_opts when declared
+        args["name"] = volume_name(storage.get_name())
+        args["labels"] = self._labels(storage)
+        return args
+
+    # ------------------------------------------------------- state query
+    def _lookup(self, storage: Storage) -> dict[str, Any] | None:
+        """``docker volume inspect``: present with its driver, mountpoint and
+        labels; absent when the daemon has no such volume; another
+        configuration's volume of our name reads as elsewhere (stage 93)."""
+        name = volume_name(storage.get_name())
+        res = self._docker("volume", "inspect", name)
+        if res.returncode != 0:
+            err = (res.stderr or "").lower()
+            if "no such volume" in err or "not found" in err:
+                return None
+            raise RuntimeError(f"docker volume inspect {name}: {(res.stderr or '').strip()[-300:]}")
+        data = json.loads(res.stdout or "[]")
+        if not data:
+            return None
+        info = dict(data[0])
+        labels = {str(k): str(v) for k, v in dict(info.get("Labels") or {}).items()}
+        from cs_image_system.base.lineage import belongs_to_another_configuration, owner_of
+        if belongs_to_another_configuration(self._get_context(), labels):
+            return {"present": False, "elsewhere": owner_of(labels), "what": "a volume"}
+        return {"id": str(info.get("Name") or name), "state": "active", "driver": str(info.get("Driver") or ""),
+                "mountpoint": str(info.get("Mountpoint") or ""), "tags": labels}
+
+    def retag_storage(self, storage: Storage, tags: dict[str, str]) -> bool:
+        """A volume's labels are fixed when it is created and a change would
+        replace it WITH ITS DATA: relabel reports and nothing re-creates."""
+        raise NotImplementedError(
+            f"volume {volume_name(storage.get_name())}: a volume's labels are fixed when it is created; "
+            f"it would carry {', '.join(f'{k}={v}' for k, v in sorted(tags.items()))} only as a new volume")
+
+    def transition_actions(self, storage: Storage, from_state: str | None, to_state: str) -> list[ExecutableModel]:
+        """``destroyed``: terraform removes the volume, and its data goes with
+        it (N19: wiped clean). Archive is a later item."""
+        return []

cs_image_system_tf_docker_plugin-0.1.6.dist-info/METADATA

@@ -0,0 +1,320 @@
+Metadata-Version: 2.5
+Name: cs-image-system-tf-docker-plugin
+Version: 0.1.6
+Summary: The OpenTofu plugin for a container runtime: containers and volumes on a Docker Engine API daemon as module calls
+Project-URL: Repository, https://github.com/infrastructurebuilder/cs-image-system-3
+Project-URL: Documentation, https://github.com/infrastructurebuilder/cs-image-system-3/blob/develop/docs/OPERATIONS.md
+Project-URL: Package README, https://github.com/infrastructurebuilder/cs-image-system-3/blob/develop/packages/tf-docker-plugin/README.md
+Author-email: Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: cs-image-system-base==0.1.6
+Requires-Dist: cs-image-system-contract==0.1.6
+Requires-Dist: cs-image-system-docker-runtime-plugin==0.1.6
+Requires-Dist: cs-image-system-hashicorp-utils==0.1.6
+Requires-Dist: cs-image-system-tf-ebs-instance-plugin==0.1.6
+Requires-Dist: pydantic>=2.13
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-FileCopyrightText: 2026 Mykel Alvis <mykelalvis@infrastructurebuilder.org>
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+# cs-image-system-tf-docker-plugin
+
+The OpenTofu plugin for a container runtime (stage 103, branch 2): the
+instance builder `tofu-docker` and the storage builder `tf-docker-volume`.
+Each emits one terraform root on the `kreuzwerker/docker` provider against a
+release-owned module (`tfmodules/docker_container`, `tfmodules/docker_volume`,
+which every starter carries), exactly as the clouds' tofu plugins do against
+theirs. The runtime is the `docker` runtime of
+[cs-image-system-docker-runtime-plugin](../docker-runtime-plugin/README.md):
+a durable host running a daemon that speaks the Docker Engine API.
+
+Three things are different from a cloud, and each is a decision recorded in
+the stage:
+
+- **The power state is the operator's.** A container is declared with
+  `must_run = false`, so the next apply leaves a stopped container stopped
+  (proved against the provider before anything else in the branch), and
+  with the restart policy `unless-stopped`, so a daemon restart brings back
+  what was running and nothing else.
+- **No first boot.** A cloud runs the launch script from user data. A
+  container has no user data: the root uploads the same rendered script
+  into the container when it is created (`/var/lib/csis/launch.sh`), and
+  the system runs it through `docker exec` after the apply, once, the way
+  it runs the accounts script. Its last act writes
+  `/var/lib/csis/launch-applied`, which the verification reads.
+- **Labels are fixed at creation.** A container's and a volume's labels
+  cannot change in place; `lineage relabel` reports what a re-create would
+  set and re-creates nothing.
+
+## What it registers
+
+One entry point under `cs_image_system.plugins.instance`
+(`tf-docker-plugin`), registering two `type:` keys:
+
+| `type:` | Model | Builder | Classified as |
+|---|---|---|---|
+| `tofu-docker` | `TofuDockerInstanceBuilderModel` | `TofuDockerInstanceBuilder` | an instance builder |
+| `tf-docker-volume` | `TofuDockerVolumeStorageBuilderModel` | `TofuDockerVolumeStorageBuilder` | a storage builder |
+
+Both subclass the AWS plugin's tofu bases (`TofuInstanceBuilder`,
+`TofuStorageBuilder`), so the apply gate, the decommission whitelist, the
+ephemeral sequence, the storage state machine and the state query are the
+shared machinery.
+
+## Models
+
+### `TofuDockerInstanceBuilderModel` (`tofu-docker`)
+
+The fields of every tofu instance builder: `runtime` (a `docker` runtime),
+`executable` (the `cfg/executables.yml` entry for tofu), `state_configuration`
+(the root's state manager; `default` inherits the runtime's, else the
+default), `required_plugins` (the terraform providers; with none declared the
+root requires `kreuzwerker/docker` unpinned). Nothing docker-specific is
+declared on the builder: the daemon's address and the machine types live on
+the runtime.
+
+### `TofuDockerVolumeStorageBuilderModel` (`tf-docker-volume`)
+
+The same universal fields, plus `variables` (a `DockerVolumeVariables`):
+`driver` (the volume driver; the daemon's `local` when unset), `driver_opts`
+(its options) and `tags`, emitted as labels under the storage item's own.
+
+### The runtime builder the plugin reads
+
+`host` or `context` (the daemon's address, which rides in the environment of
+every tofu process the roots run, never in a `.tf` file), `networking.network`
+(the network every container joins, by name), `machine_types` (a name to
+`{cpus, memory}`; an instance's `machine_type` picks one, the runtime's
+`default_machine_type` otherwise) and `repository` (where the floating tag
+of a deferred image lives).
+
+## The builder
+
+### `TofuDockerInstanceBuilder` (phase `instance-generation`)
+
+One `module "instance_<label>"` call per instance against
+`tfmodules/docker_container`:
+
+- `name` is the instance's declared name (a container's name is unique on a
+  daemon, and every instance hook finds the container by it); `hostname` is
+  the canonical name `<name>-NNN` the launch parameters decide;
+- `image` is the pinned build (an image id, `sha256:...`), else the resolved
+  provider-specific image, else the per-instance variable `<label>_image`
+  that finalization fills from the packer manifest, with `image_tag` (the
+  series' floating tag) as the module's fallback through a `docker_image`
+  data source;
+- `cpus` and `memory` are the machine type's limits (`cpus` rendered with a
+  decimal point, `1.0`, because that is how the provider reads it back;
+  memory in MB from docker's own spelling, `4g`);
+- `labels` carry the configuration id (`csis_config`), the instance
+  (`csis_instance`) and its generation (`csis_generation`); the module adds
+  `csis_build` from the image it resolved;
+- `volumes` map each attached storage to `{volume_name, container_path}`,
+  the name by remote-state reference to the storage root's outputs;
+- `launch_script` is `templatefile` over `launch-<label>.sh.tftpl`, the same
+  script `launch_params.user_data_template` renders for the clouds, with the
+  group's gid by the group builder's expression (a posix group's gid is a
+  number of the configuration). On this runtime the script sets no hostname
+  (the container was created with it) and, for a volume, formats and mounts
+  nothing: the daemon mounted it, and the script makes the group's subtree
+  and sets its ownership and mode.
+
+The module declares `must_run = false`, `start = true`, `init = true`, the
+restart policy `unless-stopped`, and ignores later changes to `image`,
+`labels`, `upload` and `memory_swap` (the daemon computes the last from
+`memory`). An upgrade is a `-replace` of `module.instance_<label>.docker_container.this`
+through the gate, as on the clouds; a decommission destroys the module.
+
+Every tofu process the root runs (`fmt`, `init`, `validate`, `plan`, `apply`)
+carries the runtime's `DOCKER_HOST` or `DOCKER_CONTEXT` (and the TLS pair)
+in its environment; the runner script renders them as an assignment prefix
+on the line, an ENC `host` as a `cs-image-system decrypt` call. The
+`provider "docker"` block is empty.
+
+### `TofuDockerVolumeStorageBuilder` (phase `storage-generation`)
+
+One `module "storage_<label>"` call per live storage against
+`tfmodules/docker_volume`: the volume's name (the storage's name as the
+daemon allows it), the driver and its options when declared, and labels
+(`csis_storage`, `csis_config`, one `csis_group_<group>` per allowed group,
+the builder's and the item's tags). Capability type `volume`: many
+containers may attach one, it is POSIX, it is not zonal (the zone comparison
+has nothing to compare), and `platform_mounts` is true. A `destroyed` storage
+is removed with its data (N19); the volume is not archivable yet (a volume
+has no snapshot; a `tar` from a throwaway container is the obvious later
+shape).
+
+### The instance hooks, on the runtime
+
+The hooks the core calls after the apply are the docker runtime's
+(`docker_runtime_builders.py`): the power state (`running`; `exited` and
+`created` as stopped; `paused` as suspended; `restarting` as starting;
+absent), `start_instance` and `stop_instance`, the identity (the container
+id is the provider id, so a re-create is a new generation), the booted image
+(`.Image`, the build id itself), `verify_instance` by exec (the launch
+marker, each declared mount point in `/proc/mounts`, the booted image),
+`run_session_command` (`docker exec -i -u root <name> bash -s`), no
+`ssh_proxy_command` (login is by exec), `inventory` by the configuration's
+label, and `instance_tags`/`retag_instance` (read; refuse to change).
+
+## Emission
+
+For an instance `docker-test` on builder `tofu-docker-local`, the root
+`generated/instance-image/tofu-docker-local/instance-generation/` holds
+`instance-generation.tf` (the `terraform` block requiring `kreuzwerker/docker`,
+an empty aliased provider, the variables, the remote-state data sources, the
+backend file beside it), `instance-docker-test.tf` (the module call) and
+`launch-docker_test.sh.tftpl` (the script). The storage root
+`generated/storage/<builder>/storage-generation/` holds the volume module
+calls and one `output "storage_<label>"` per volume for the instance root
+to read.
+
+## Example configuration
+
+```yaml
+# cfg/instance-builders.yml
+instance_builders:
+  - name: tofu-docker
+    type: tofu-docker
+    runtime: docker-host
+    executable: open-tofu-1
+    state_configuration: local-dev
+    required_plugins:
+      - name: docker
+        source: kreuzwerker/docker
+        version: ">= 3.0.0"
+
+# cfg/storage-builders.yml
+storage_builders:
+  - name: docker-volumes
+    type: tf-docker-volume
+    executable: open-tofu-1
+    runtime: docker-host
+    state_configuration: local-dev
+    variables:
+      tags:
+        project: example
+
+# storages/volumes.yaml
+storages:
+  - name: scratch
+    type: docker-volumes
+    runtime: docker-host
+    mount_point: /mnt/scratch
+    groups: [pxgroup]
+
+# instances/containers.yaml
+instances:
+  - name: docker-test
+    image: imgfile-docker          # a posix-owned image baked on docker-host
+    runtime: docker-host
+    type: tofu-docker
+    machine_type: small            # one of the runtime's machine_types
+    storages:
+      - name: scratch
+        mount_point: /mnt/scratch
+```
+
+The base image the instance image descends from declares `storage_types:
+[volume]` (N4: a type must be declared to be attached), and the image's
+group is a posix group (an OPA group on a docker runtime is refused at
+validation).
+
+## Prerequisites and integration
+
+- A `docker` runtime (the docker runtime plugin) whose daemon the operator's
+  shell can reach, and the `docker` CLI it names in `cfg/executables.yml`.
+- `tofu` in `cfg/executables.yml`, and the `kreuzwerker/docker` provider,
+  which `tofu init` downloads (version 3.0.0 or later; 4.6.0 proved it).
+- A state manager for the roots: the runtime's `state_configuration`, often
+  `local` for a tree with no cloud.
+- The modules `tfmodules/docker_container` and `tfmodules/docker_volume`
+  beside the configuration root (`module_source_base`); every starter carries
+  them.
+- `bash` on the baked image (the session runs `bash -s`), which the docker
+  runtime's settle step installs with `sudo` and `python3` where a vendor
+  container lacks them.
+
+The plugin depends on `cs-image-system-tf-ebs-instance-plugin` (the tofu
+bases) and `cs-image-system-docker-runtime-plugin` (the names and the
+runtime's hooks).
+
+## Configuration reference
+
+Builder entries (`cfg/instance-builders.yml`, `cfg/storage-builders.yml`):
+`name`, `type` (`tofu-docker` | `tf-docker-volume`), `runtime` (a `docker`
+runtime), `executable`, `state_configuration`, `required_plugins[]`
+(`{name, source, version}`), `is_default`, `description`, `tags`; the volume
+builder's `variables: {driver, driver_opts, tags}`.
+
+The instance item (`instances/*.yaml`, `type:` a `tofu-docker` builder):
+`name` (the container's name and the hostname label), `image`, `runtime`,
+`machine_type` (one of the runtime's `machine_types`; empty = its default),
+`storages[]` (`{name, mount_point}`), `image_policy`, `ephemeral`,
+`on_failure`, `teardown_after`, `userdata` (lines appended to the launch
+script), `tags` (labels, fixed at creation). `availability_zone` is accepted
+and compares with nothing (a daemon has no zones).
+
+The storage item (`storages/*.yaml`, `type:` a `tf-docker-volume` builder):
+`name`, `runtime`, `mount_point`, `groups[]`, `share_mode`, `public_read`,
+`state` (`active` | `destroyed`; `archived` is refused: not supported yet),
+`tags`. `lifecycle` is refused (no data lifecycle on a volume).
+
+Execution knobs read through the base: `config.apply_instances` and
+`config.apply_storage` (a bool, or the roots that may apply, by builder name
+or runtime), `config.use_state_backends`, `config.module_source_base`.
+
+## What it tests and verifies
+
+- `packages/tf-docker-plugin/tests/`: the module arguments from a resolved,
+  a pinned and a deferred provider-specific image; the machine type's
+  limits; the memory and cpus spellings; the volume's module arguments and
+  labels; the launch-script template on a volume mount.
+- `tests/test_v2_stage_103_instances.py`: a dry run over an overlay of the
+  frozen fixture emits both roots, the module calls, the uploaded launch
+  script, the environment prefix on every tofu line and the gated apply
+  sequence; the hooks' answers over a stubbed daemon; the fixture and the
+  golden do not change.
+- `tests/test_v2_docker_cycle_live.py` (`just test-docker-cycle`, a leg of
+  `just full-test`): the cycle on the local daemon from nothing to nothing:
+  bake, launch two containers on one volume, verify, reconcile accounts,
+  stop one and show the next apply leaves it stopped, start it, upgrade one
+  to a new build (a new generation), decommission, destroy the volume,
+  dispose the images.
+- The verification of a launched container (`verify instance`): the launch
+  marker, each declared mount point, the booted image, and the image's
+  declared post-bake tests over the session.
+
+## When it fails
+
+- `the daemon at ... cannot be reached`: the runtime's `host` or `context`
+  does not answer; preflight says the same in one line.
+- `machine_type 'x' is not one of runtime ...'s machine_types`: the instance
+  names a type the runtime does not declare.
+- `memory '...' is not a size docker understands`: a machine type's memory
+  is not `512m`, `4g` or a number of MB.
+- A plan that wants to replace a container the operator did not upgrade:
+  a volume attachment changed (a detach on a container is a re-create, not
+  an in-place detach as on the clouds), or `cpus`/`memory` of its machine
+  type changed. The gate refuses the unwhitelisted destroy; an `upgrade
+  instance` sanctions the replacement.
+- `relabel: could not retag instance ...: a container's labels are fixed`:
+  expected; the labels arrive with the next re-create.
+- `verify ...: launch script: no completion marker`: the launch script did
+  not run or failed; the next applying run delivers it again
+  (`csis launch:` lines in the log say why).
+
+## Related
+
+- [cs-image-system-docker-runtime-plugin](../docker-runtime-plugin/README.md):
+  the runtime, the bake and the instance hooks.
+- [cs-image-system-tf-ebs-instance-plugin](../tf-ebs-instance-plugin/README.md):
+  the tofu bases this plugin subclasses.
+- `tfmodules/docker_container`, `tfmodules/docker_volume`: the modules.
+- `docs/OPERATIONS.md`: the cycle, power states and generations.

cs_image_system_tf_docker_plugin-0.1.6.dist-info/RECORD

@@ -0,0 +1,10 @@
+cs_image_system/tf_docker_plugin/__init__.py,sha256=GAFRNaGWQxXquHOlCzxan4LkPZ9_NsiyswknxdPcX0c,122
+cs_image_system/tf_docker_plugin/main.py,sha256=PxjV2OPyTkcshiSTz0ds_DeRcJ-sULy7BWRNBppa7zs,1321
+cs_image_system/tf_docker_plugin/tf_docker_instance_builder.py,sha256=VaLeZnZGU1PFIzlcTqSVkHGJJqMJxSE7dxg4hmnAm-U,15645
+cs_image_system/tf_docker_plugin/tf_docker_models.py,sha256=SGmjSLQdTPr9KxOY-gixU_A4W5TmMfkf9rJqesTl3mA,2276
+cs_image_system/tf_docker_plugin/tf_docker_storage_builder.py,sha256=tNAbmMqUBEVUTadRyCyaDz2CFn9_XQcHeFl0H8gjzLY,8830
+cs_image_system_tf_docker_plugin-0.1.6.dist-info/METADATA,sha256=VH9mXC9Eq-jb7bC-pwli9qb4ZiDQwzb4DW-mfbFPGDU,15424
+cs_image_system_tf_docker_plugin-0.1.6.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+cs_image_system_tf_docker_plugin-0.1.6.dist-info/entry_points.txt,sha256=5VOpK8tYEyQQ_JSiQ5-sWvvkTnEOvwuXElOGxZibS8A,103
+cs_image_system_tf_docker_plugin-0.1.6.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cs_image_system_tf_docker_plugin-0.1.6.dist-info/RECORD,,

cs_image_system_tf_docker_plugin-0.1.6.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

cs_image_system_tf_docker_plugin-0.1.6.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[cs_image_system.plugins.instance]
+tf-docker-plugin = cs_image_system.tf_docker_plugin.main:initialize

cs_image_system_tf_docker_plugin-0.1.6.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.