Package io.github.pgatzka.docker.dsl

Interface DockerExtension

All Known Implementing Classes:
DockerExtensionImpl
public interface DockerExtension
Root DSL surface registered as the docker extension on a Gradle project. Exposes the named containers, volumes, and networks the plugin should manage.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.NamedDomainObjectContainer<ContainerSpec>
    getContainers()
    Containers declared via docker { containers { register("...") { ... } } }.
    org.gradle.api.NamedDomainObjectContainer<NetworkSpec>
    getNetworks()
    Networks declared via docker { networks { register("...") { ... } } }.
    org.gradle.api.NamedDomainObjectContainer<VolumeSpec>
    getVolumes()
    Volumes declared via docker { volumes { register("...") { ... } } }.

  • Method Details

    • getContainers

      org.gradle.api.NamedDomainObjectContainer<ContainerSpec> getContainers()
      Containers declared via docker { containers { register("...") { ... } } }.
      Returns:
      the container container, keyed by logical container name

    • getVolumes

      org.gradle.api.NamedDomainObjectContainer<VolumeSpec> getVolumes()
      Volumes declared via docker { volumes { register("...") { ... } } }.
      Returns:
      the volume container, keyed by logical volume name

    • getNetworks

      org.gradle.api.NamedDomainObjectContainer<NetworkSpec> getNetworks()
      Networks declared via docker { networks { register("...") { ... } } }.
      Returns:
      the network container, keyed by logical network name