Class DockerService

Adapter over dockerode to expose a minimal API for the purpose of this application. Responsible for any interaction with dockerode, including:

Initializing dockerode
Encapsulating exceptions
Querying for containers with labels based on our criteria
Deserializing and validating the JSON labels

Index

Constructors

Methods

extractDNSEntries getContainers initialize

Constructors

constructor

new DockerService(
    dockerFactory: DockerFactory,
    configService: ConfigService<IConfiguration>,
    loggerService: ConsoleLoggerService,
): DockerService
Parameters
- dockerFactory: DockerFactory
- configService: ConfigService<IConfiguration>
- loggerService: ConsoleLoggerService
Returns DockerService
- Defined in src/docker/docker.service.ts:46

Methods

extractDNSEntries

extractDNSEntries(containers: ContainerInfo[]): DnsbaseEntry[]
Contains behavior to deserialize the labels on the containers. Converts to appropriate type and validates
Parameters
- containers: ContainerInfo[]
  containers with labels to deserialize
Returns DnsbaseEntry[]
deserialized labels

Throws
If serivce hasn't been initialized
- Defined in src/docker/docker.service.ts:112

getContainers

getContainers(): Promise<ContainerInfo[]>
Finds containers with the labels associated with this instance of the docker-compose-external-dns project. Returns the containers information verbatim.

Returns Promise<ContainerInfo[]>
Promise resolving to the docker containers

Throws
If serivce hasn't been initialized

Throws
If docker throws an error fetching containers
- Defined in src/docker/docker.service.ts:87

initialize

initialize(): void
Initializes the class by fetching the docker instance

Returns void
Throws
If service is already initialized

Throws
throws if err initializing docker
- Defined in src/docker/docker.service.ts:59