spacemacs/layers/+tools/docker/README.org

Docker layer

• Description
  • Features:
• Install
  • Docker
  • Linting
  • LSP
• Usage
  • TRAMP access to docker containers
• Key bindings

Description

This layer integrates basic container management into Spacemacs.

Features:

• Syntax highlighting for Docker files
• Docker build integration
• TRAMP access to running Docker containers
• Docker container and image management via docker.el
• docker-compose integration via docker.el
• Syntax checking via hadolint
• Code-Completion via lsp

Install

Docker

To use this configuration layer, add it to your ~/.spacemacs. You will need to add docker to the existing dotspacemacs-configuration-layers list in this file.

You will also need the native package Docker for the actual container management.

Linting

For syntax checking the external library hadolint is necessary. It can either be downloaded from here or build locally with stack as shown below:

  stack install hadolint

LSP

This layer can be enhanced with dockerfile-language-server-nodejs and emacs lsp-mode to provide richer, IDE-like capabilities. To do so set the layer variable docker-dockerfile-backend to lsp like shown below:

  (setq-default dotspacemacs-configuration-layers
                '((docker :variables docker-dockerfile-backend 'lsp)))

In addition you need to install the lsp server's executable in your system. This can be done via npm:

  npm i -g dockerfile-language-server-nodejs

Usage

TRAMP access to docker containers

This relies on the docker-tramp package which uses docker exec available in docker versions > 1.3.

docker-tramp adds a new prefix /docker: that you can use with SPC f f, this prefix allows to access your docker containers and also provides auto-completion of the running containers.

Key bindings

Key binding	Description
SPC m c b	build current buffer
SPC m c B	build current buffer without cache
SPC a D c	list docker containers
SPC a D C	docker-compose commands for current project
SPC a D d	delete image
SPC a D e	unpause container
SPC a D F	pull image
SPC a D i	list docker images
SPC a D k	delete container
SPC a D o	stop container
SPC a D p	pause container
SPC a D P	push image
SPC a D r	restart container
SPC a D s	start container