https://github.com/leighmcculloch/vagrant-docker-compose

A Vagrant provisioner for docker compose.
https://github.com/leighmcculloch/vagrant-docker-compose

docker docker-compose vagrant vagrant-plugin vagrant-provisioner

Last synced: 25 days ago
JSON representation

A Vagrant provisioner for docker compose.

• Host: GitHub
• URL: https://github.com/leighmcculloch/vagrant-docker-compose
• Owner: leighmcculloch
• License: isc
• Created: 2015-05-08T08:09:07.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-12-17T10:04:12.000Z (almost 3 years ago)
• Last Synced: 2024-09-30T23:43:10.631Z (about 1 month ago)
• Topics: docker, docker-compose, vagrant, vagrant-plugin, vagrant-provisioner
• Language: Ruby
• Size: 56.6 KB
• Stars: 657
• Watchers: 10
• Forks: 72
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Vagrant Provisioner: Docker Compose

[![CircleCI](https://img.shields.io/circleci/build/github/leighmcculloch/vagrant-docker-compose?style=for-the-badge)](https://circleci.com/gh/leighmcculloch/vagrant-docker-compose/tree/master)

A Vagrant provisioner for [Docker Compose](https://docs.docker.com/compose/). Installs Docker Compose and can also bring up the containers defined by a [docker-compose.yml](https://docs.docker.com/compose/yml/).

## Install

```bash

vagrant plugin install vagrant-docker-compose

```

## Usage

### To install docker and docker-compose

```ruby

Vagrant.configure("2") do |config|

  config.vm.box = "ubuntu/bionic64"

  config.vm.provision :docker

  config.vm.provision :docker_compose

end

```

### To install and run docker-compose on `vagrant up`

```ruby

Vagrant.configure("2") do |config|

  config.vm.box = "ubuntu/bionic64"

  config.vm.provision :docker

  config.vm.provision :docker_compose, yml: "/vagrant/docker-compose.yml", run: "always"

end

```

Equivalent to running:

```bash

docker-compose -f [yml] up -d

```

### To install and run docker-compose, with multiple files, on `vagrant up`

```ruby

Vagrant.configure("2") do |config|

  config.vm.box = "ubuntu/bionic64"

  config.vm.provision :docker

  config.vm.provision :docker_compose,

    yml: [

      "/vagrant/docker-compose-base.yml",

      "/vagrant/docker-compose.yml",

      ...

    ],

    run: "always"

end

```

Equivalent to running:

```bash

docker-compose -f [yml-0] -f [yml-1] ... up -d

```

### To install, rebuild and run docker-compose on `vagrant up`

```ruby

Vagrant.configure("2") do |config|

  config.vm.box = "ubuntu/bionic64"

  config.vm.provision :docker

  config.vm.provision :docker_compose, yml: "/vagrant/docker-compose.yml", rebuild: true, run: "always"

end

```

Equivalent to running:

```bash

docker-compose -f [yml] rm --force

docker-compose -f [yml] build

docker-compose -f [yml] up -d

```

### To install, rebuild and run docker-compose with options on `vagrant up`

```ruby

Vagrant.configure("2") do |config|

  config.vm.box = "ubuntu/bionic64"

  config.vm.provision :docker

  config.vm.provision :docker_compose, yml: "/vagrant/docker-compose.yml", rebuild: true,

    options: "--x-networking", command_options: { rm: "", up: "-d --timeout 20"}, run: "always"

end

```

Equivalent to running:

```bash

docker-compose --x-networking -f [yml] rm

docker-compose --x-networking -f [yml] build

docker-compose --x-networking -f [yml] up -d --timeout 20

```

### Other configs

* `yml` – one or more [Compose files](https://docs.docker.com/compose/compose-file/) (YAML), may be a `String` for a single file, or `Array` for multiple.

* `compose_version` – defaults to `1.24.1`.

* `project_name` – compose will default to naming the project `vagrant`.

* `env` – a `Hash` of environment variables to value that are passed to the `docker-compose` commands, defaults to an empty `Hash`.

* `executable_symlink_path` – the location the executable will be symlinked to, defaults to `/usr/local/bin/docker-compose`.

* `executable_install_path` – the location the executable will be stored, defaults to `-`, i.e. `/usr/local/bin/docker-compose-1.5.0`.

* `options` - a `String` that's included as the first arguments when calling the docker-compose executable, you can use this to pass arbitrary options/flags to docker-compose, default to `nil`.

* `command_options` - a `Hash` of docker-compose commands to options, you can use this to pass arbitrary options/flags to the docker-compose commands, defaults to: `{ rm: "--force", up: "-d" }`.

## Example

See `example` in the repository for a full working example.