TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+tools/docker
History
Maximilian Wolff 64b607ce14
Revise docker layer 
Adjust the documentation to be more clear how to activate the new lsp feature.
Simplify layer setup code.
Provide missing company-lsp integration in feature list.
Remove obsolete tests for a loaded lsp layer as the docker layer loads it
itself already.
2019-12-01 02:05:55 +01:00
..
img Rename dockerfile layer to docker 2016-06-09 23:53:33 -04:00
config.el Revise docker layer 2019-12-01 02:05:55 +01:00
funcs.el Revise docker layer 2019-12-01 02:05:55 +01:00
layers.el Add LSP backend support for Dockerfile 2019-12-01 00:55:53 +01:00
packages.el Revise docker layer 2019-12-01 02:05:55 +01:00
README.org Revise docker layer 2019-12-01 02:05:55 +01:00

README.org

Docker layer

/TakeV/spacemacs/media/commit/e6997638e73c4e9ab41e0efea825bd5ace3864bf/layers/+tools/docker/img/docker.png

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 company-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