nix/modules/virtualisation/oci-containers/options.nix

{ lib, ... }:

with lib;
let
  portOptions = {
    host = mkOption {
      type = types.int;
      description = mdDoc ''
        Host port (on 127.0.0.1) to expose the container port on.
      '';
    };

    inner = mkOption {
      type = types.int;
      description = mdDoc ''
        The container port to expose to the hosti.
      '';
    };
  };

  volumeOptions = {
    name = mkOption {
      type = types.nullOr types.str;
      default = null;
      description = mdDoc ''
        Name of the volume.  This is equivalent to:

        ```nix
        host = "''${volumeBaseDir}/''${volumeSubDir}/''${name}";
        ```

        This option c.logonflicts with `''${host}`.
      '';
    };

    host = mkOption {
      type = types.nullOr types.str;
      default = null;
      description = mdDoc ''
        Directory on the host to bind-mount into the container.

        This option conflicts with `''${name}`.
      '';
    };

    inner = mkOption {
      type = types.str;
      description = mdDoc ''
        Directory in the container to mount the volume to.
      '';
    };
  };

  containerOptions = {
    /* regular oci-containers */
    autoStart = mkOption {
      type = types.bool;
      default = true;
      description = mdDoc ''
        Start the container automatically on boot.
      '';
    };

    cmd = mkOption {
      type = types.listOf types.str;
      default = [ ];
      description = mdDoc ''
        Command-line arguments to pass to the container image's entrypoint.
      '';
    };

    dependsOn = mkOption {
      type = types.listOf types.str;
      default = [ ];
      example = [ "concourse-db" ];
      description = mdDoc ''
        Other containers that this one depends on, in `''${pod}-''${name}`
        format.
      '';
    };

    environment = mkOption {
      type = types.attrsOf types.str;
      default = { };
      description = mdDoc ''
        Environment variables to set for this container.
      '';
    };

    environmentFiles = mkOption {
      type = types.listOf types.path;
      default = [ ];
      description = mdDoc ''
        List of environment files for this container.
      '';
    };

    extraOptions = mkOption {
      type = types.listOf types.str;
      default = [ ];
      description = mdDoc ''
        Extra options to pass to `docker run` / `podman run`.
      '';
    };

    image = mkOption {
      type = types.str;
      description = mdDoc ''
        Container image to run.
      '';
    };

    login = {
      username = mkOption {
        type = types.nullOr types.str;
        default = null;
        description = mdDoc ''
          Username for the container registry.
        '';
      };
      passwordFile = mkOption {
        type = types.nullOr types.str;
        default = null;
        description = mdDoc ''
          File containing the password for the container registry.
        '';
      };
      registry = mkOption {
        type = types.nullOr types.str;
        default = null;
        description = mdDoc ''
          Container registry to authenticate with.
        '';
      };
    };

    /* changed */
    ports = mkOption {
      type = types.listOf (types.submodule { options = portOptions; });
      default = [ ];
      description = mdDoc ''
        List of ports to expose.
      '';
    };

    volumes = mkOption {
      type = types.listOf (types.submodule { options = volumeOptions; });
      default = [ ];
      description = mdDoc ''
        List of volume definitions.
      '';
    };

    /* new options */
    pullOnStart = mkOption {
      type = types.bool;
      default = true;
      description = mdDoc ''
        Pull the container image when starting (useful for `:latest` images).
      '';
    };
  };
in
{
  options.nixfiles.oci-containers = {
    backend = mkOption {
      type = types.enum [ "docker" "podman" ];
      default = "docker";
      description = mdDoc ''
        The container runtime.
      '';
    };

    pods = mkOption {
      type = types.attrsOf (types.submodule ({ name, ... }: {
        options = {
          containers = mkOption {
            type = types.attrsOf (types.submodule { options = containerOptions; });
            default = { };
            description = mdDoc ''
              Attrset of container definitions.
            '';
          };
          volumeSubDir = mkOption {
            type = types.str;
            default = name;
            description = mdDoc ''
              Subdirectory of the `''${volumeBaseDir}` to store bind-mounts
              under.
            '';
          };
        };
      }));
      default = { };
      description = mdDoc ''
        Attrset of pod definitions.
      '';
    };

    volumeBaseDir = mkOption {
      type = types.str;
      description = mdDoc ''
        Directory to store volume bind-mounts under.
      '';
    };
  };
}