This is a mixin for Porter that provides the Docker Compose (docker-compose) CLI.
To use this mixin in a bundle, declare it like so:
mixins:
- docker-compose
To declare that Docker access is required to run the bundle, as will probably
always be the case when using this mixin, we can add docker
(the extension name)
under the required
section in the manifest, like so:
required:
- docker
Additional configuration for this extension is currently limited to whether or not the container should run as privileged or not:
required:
- docker
privileged: false
Declaring this extension as required is a great way to let potential users of your bundle know that Docker access is necessary to install.
See more information via the Porter documentation.
See the docker-compose CLI Command Reference for the supported commands.
docker-compose:
description: "Description of the command"
arguments:
- arg1
- arg2
flags:
FLAGNAME: FLAGVALUE
REPEATED_FLAG:
- FLAGVALUE1
- FLAGVALUE2
suppress-output: false
outputs:
- name: NAME
jsonPath: JSONPATH
- name: NAME
path: SOURCE_FILEPATH
The suppress-output
field controls whether output from the mixin should be
prevented from printing to the console. By default this value is false, using
Porter's default behavior of hiding known sensitive values. When
suppress-output: true
all output from the mixin (stderr and stdout) are hidden.
Step outputs (below) are still collected when output is suppressed. This allows you to prevent sensitive data from being exposed while still collecting it from a command and using it in your bundle.
The mixin supports jsonpath
and path
outputs.
The jsonPath
output treats stdout like a json document and applies the expression, saving the result to the output.
outputs:
- name: NAME
jsonPath: JSONPATH
For example, if the jsonPath
expression was $[*].id
and the command sent the following to stdout:
[
{
"id": "1085517466897181794",
"name": "my-vm"
}
]
Then the output would have the following contents:
["1085517466897181794"]
The path
output saves the content of the specified file path to an output.
outputs:
- name: kubeconfig
path: /root/.kube/config
docker-compose:
description: "Docker Compose Up"
arguments:
- up
- -d
flags:
timeout: 30
docker-compose:
description: "Docker Compose Down"
arguments:
- down
- --remove-orphans
flags:
timeout: 30
See full bundle examples in the examples
directory.
Use of this mixin requires opting-in to Docker host access via a Porter setting. See the Porter documentation for further details.
Here we opt-in via the CLI flag, --allow-docker-host-access
:
$ porter install --allow-docker-host-access
Building bundle ===>
Copying porter runtime ===>
Copying mixins ===>
Copying mixin docker-compose ===>
Generating Dockerfile =======>
Writing Dockerfile =======>
Starting Invocation Image Build =======>
installing docker-compose...
executing install action from docker-compose (bundle instance: docker-compose)
Docker docker-compose up
app_web_1 is up-to-date
app_redis_1 is up-to-date
execution completed successfully!