http://composerize.com - Turns docker run commands into compose.yaml files and even merge with existing compose.yaml!
Looking for the reverse : http://decomposerize.com / Decomposerize
Want to convert from Docker compose file formats : http://composeverter.com / Composeverter
composerize can be run in the cli.
npm install composerize -g to install, and run as such:
$ composerize docker run -p 80:80 -v /var/run/docker.sock:/tmp/docker.sock:ro --restart always --log-opt max-size=1g nginx
See composerize --help for more options.
A docker image of composerize, decomposerize and composeverter websites is available here: https://github.com/Oaklight/composerize-minimal/blob/master/README_en.md (thanks to @Oaklight)
Make sure to install the composerize package in your project by running:
npm install composerize
With the following code, you can easily integrate Composerize into your Node.js project and generate Docker Compose configurations from Docker run commands.
const composerize = require('composerize'); const dockerRunCommand = 'docker run -d -p 8080:80 --name my-web-app nginx:latest'; // Convert the Docker run command to a Docker Compose configuration const composeConfig = composerize(dockerRunCommand); console.log(composeConfig);
You can also merge docker run command(s) with an existing Docker Compose file content :
const composerize = require('composerize'); const dockerRunCommand = 'docker run -d -p 8080:80 --name my-web-app nginx:latest'; // An existing Docker Compose configuration as a string const existingComposeConfig = ` version: '3' services: existing-service: image: my-existing-image:latest ports: - '8000:80' `; // Convert the Docker run command to a Docker Compose configuration and merge with provided docker compose const composeConfig = composerize(dockerRunCommand, existingComposeConfig); console.log(composeConfig);
You can also choose which version of Docker compose V2, you target : 2.x, 3.x or Common Specification by specifying a third parameter composeVersion on convertDockerRunToCompose :
- 'v2x'
- 'v3x'
- 'latest'
const composerize = require('composerize'); const dockerRunCommand = 'docker run -d -p 8080:80 --name my-web-app nginx:latest'; // Convert the Docker run command to a Docker Compose configuration for 2.x const composeConfig = composerize(dockerRunCommand, null, 'v2x'); console.log(composeConfig);
You can also choose indentation level by specifying a fourth parameter indent on convertDockerRunToCompose :
- 'v2x'
- 'v3x'
- 'latest'
const composerize = require('composerize'); const dockerRunCommand = 'docker run -d -p 8080:80 --name my-web-app nginx:latest'; // Convert the Docker run command to a Docker Compose configuration for 2.x const composeConfig = composerize(dockerRunCommand, null, 'latest', 2); console.log(composeConfig);
- Clone a fork of the repo and install the project dependencies by running
yarn - Make your changes, and build the project by running
make build - Test your changes with
make test
- Mark Larah (Twitter: @mark_larah)
- ShareVB GitHub