readme.md

docker-swarm-snyk

Welcome to docker-swarm-snyk!

With docker-swarm-snyk you can enable simple global image scanning for your entire Docker Swarm.

See docs: https://docs.docker.com/engine/scan/

Variables

Required	Variable	Description
*	SNYK_AUTH_TOKEN	Auth token for Snyk. (see docs)
	DOCKER_USERNAME	Docker Hub account. Not required, but useful if Docker Hub rate-limiting is an issue.
	DOCKER_PASSWORD	Docker Hub password. (tip: this can be an access token)
	JOB_SCAN_INTERVAL_SECONDS	How frequently to query Swarm for new images to scan. Default is 60 seconds.
	JOB_CHECK_INTERVAL_SECONDS	How frequently the Job should update queues. Default is 10 seconds.
	JOB_MAX_CONCURRENCY	Maximum concurrency for image scanning. Default is 1.
	DATA_PATH	Destination path to write scan data (internal). Default is /docker-swarm-snyk/data.
	SEVERITY	You can set the severity flag to low, medium, or high. Default is high. (docs)

Volumes

Volume	Description
/var/run/docker.sock:/var/run/docker.sock	Map the Docker socket from host to container.
/path/to/docker-swarm-snyk/data:/docker-swarm-snyk/data	Host or network level path to map docker-swarm-snyk data to for persistence.

Example

Create a sample docker-compose.yml...

version: "3.8"

services:
  docker-swarm-snyk:
    image: rjchicago/docker-swarm-snyk:${VERSION:-latest}
    environment:
      - SEVERITY=${SEVERITY:-high}
    secrets:
      - source: env_secrets
        target: /docker-swarm-snyk/.env
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - docker-swarm-snyk_data:/docker-swarm-snyk/data
    ports:
      - "3000:3000"
    deploy:
      replicas: 1
      placement:
        constraints:
          - node.role == manager

volumes:
  docker-swarm-snyk_data:

secrets:
  env_secrets:
    name: docker-swarm-snyk.v1.env
    file: .env

note: change the port as needed. default is 3000.

Next create a .env file and replace the values with your username and tokens...

# write example .env
printf "DOCKER_USERNAME=user
DOCKER_PASSWORD=password
SNYK_AUTH_TOKEN=token" > .env

# replace .env values
vi .env

Docker must be running in Swarm mode - call init as needed...

# init swarm mode
docker swarm init

Now deploy the stack locally - optionally name your stack...

# deploy docker-swarm-snyk
docker stack deploy -c docker-compose.yml ${STACK:-demo}

Trigger a scan of your local Swarm...

# trigger a local scan
curl -s -X GET "http://localhost:3000/scan" | jq

{
  "pushed": [
    "rjchicago/docker-swarm-snyk:latest@sha256:85353320eab99904dac065464f3d6742f59611d6f22d79bf7cf8df3b1fa6a7c5"
  ]
}

You can monitor the job queue here...

# check queue
curl -s -X GET "http://localhost:3000/queue" | jq

{
  "inProgress": [
    {
      "image": "rjchicago/docker-swarm-snyk:latest@sha256:85353320eab99904dac065464f3d6742f59611d6f22d79bf7cf8df3b1fa6a7c5",
      "start": "2022-01-27T18:41:21.268Z",
      "seconds_elapsed": 2.761
    }
  ],
  "queue": []
}

Finally, check the status of your Swarm scans...

# swarm info
curl -s -X GET "http://localhost:3000/swarm" | jq

[
  {
    "stackName": "demo",
    "serviceName": "demo_docker-swarm-snyk",
    "imageFull": "rjchicago/docker-swarm-snyk:latest",
    "image": "rjchicago/docker-swarm-snyk",
    "tag": "latest",
    "sha": "sha256:85353320eab99904dac065464f3d6742f59611d6f22d79bf7cf8df3b1fa6a7c5",
    "result": "http://localhost:3000/results?image=rjchicago/docker-swarm-snyk:latest",
    "snyk": "https://app.snyk.io/org/..."
  }
]

Scans that are complete will display in the result & snyk links.

UI

While there isn't a UI yet, all requests are GET and navigable from the browser:

http://localhost:3000

[GET] ./health
[GET] ./version
[GET] ./swarm
[GET] ./scan
[GET] ./queue

Cleanup

To cleanup, simply call...

# remove stack
docker stack rm ${STACK:-demo}

# remove volume
docker volume rm ${STACK:-demo}_docker-swarm-snyk_data

# remove secret
docker secret rm docker-swarm-snyk.v1.env