Docker Executor

Docker Executor for Screwdriver

This is an executor for Screwdriver CD that interacts with Docker (local and remote).

Usage

npm install screwdriver-executor-docker

Initialization

The class has a variety of knobs to tweak when interacting with Docker.

Parameter	Type	Description
config	Object	Configuration Object
config.docker	Object	Dockerode configuration
config.ecosystem	Object	Screwdriver Ecosystem (ui, api, store, etc.)
config.fusebox	Object	Circuit Breaker configuration
config.launchVersion	String	Launcher container version to use (stable)
config.prefix	String	Prefix to container names ("")

const executor = new DockerExecutor({
    docker: {
        socketPath: '/var/lib/docker.sock'
    },
    launchVersion: 'stable'
});

Methods

For more information on start, stop, and stats please see the executor-base.

Job annotations

Annotation	Type	Description
screwdriver.cd/dockerEnabled	Boolean	Opts the build container into Privileged mode with the host's Docker socket (/var/run/docker.sock) bind-mounted in. Off by default — only enable this for jobs that specifically need to build or run Docker containers, since it grants the build full host-level access.

Testing

npm test

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.