Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getporter/docker-mixin

A docker mixin for porter
https://github.com/getporter/docker-mixin

docker mixin porter

Last synced: 2 months ago
JSON representation

A docker mixin for porter

Host: GitHub
URL: https://github.com/getporter/docker-mixin
Owner: getporter
License: apache-2.0
Created: 2020-07-08T17:12:18.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-08-23T16:38:33.000Z (5 months ago)
Last Synced: 2024-11-21T09:36:10.476Z (3 months ago)
Topics: docker, mixin, porter
Language: Go
Homepage: https://getporter.org/mixins/docker
Size: 6.31 MB
Stars: 7
Watchers: 9
Forks: 9
Open Issues: 9
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-cnab - docker-mixin - Porter mixin provides the Docker CLI by @get_porter (Implementations / Porter)

README

# A Docker Mixin for Porter

This is a Docker mixin for Porter. The mixin provides the Docker CLI.

[![Build Status](https://dev.azure.com/getporter/porter/_apis/build/status/docker-mixin?branchName=main)](https://dev.azure.com/getporter/porter/_build/latest?definitionId=12&branchName=main)

## Mixin Declaration

To use this mixin in a bundle, declare it like so:

```yaml
mixins:
- docker
```

## Mixin Configuration

The Docker client version can be specified via the `clientVersion` configuration when declaring this mixin. The default client version is currently set to 20.10.7.
```yaml
- docker:
clientVersion: 20.10.7
```
## Mixin Commands
The commands available are docker pull, push, build, run, remove, and login.

## Mixin Syntax & Examples
The same syntax applies for install, upgrade, and uninstall.

### Docker pull

#### Syntax
You can specify either the tag or the digest.
```yaml
- docker:
description: "Description of the command"
pull:
name: IMAGE_NAME
tag: IMAGE_TAG
digest: IMAGE_DIGEST
arguments:
- arg1
- arg2
flags:
FLAGNAME: FLAGVALUE
REPEATED_FLAG:
- FLAGVALUE1
- FLAGVALUE2
```

#### Example
````yaml
- docker:
description: "Install Whalesay"
pull:
name: docker/whalesay
tag: latest
````

### Docker push

#### Syntax
```yaml
- docker:
description: "Description of the command"
push:
name: IMAGE_NAME
tag: IMAGE_TAG
arguments:
- arg1
- arg2
flags:
FLAGNAME: FLAGVALUE
REPEATED_FLAG:
- FLAGVALUE1
- FLAGVALUE2
```

#### Example
````yaml
- docker:
description: "Push image"
push:
name: gmadhok/cookies
tag: v1.0
````

### Docker build

#### Syntax
```yaml
- docker:
description: "Description of the command"
build:
tag: IMAGE_TAG
file: Dockerfile #OPTIONAL
path: PATH #defaults to "." OPTIONAL
arguments:
- arg1
- arg2
flags:
FLAGNAME: FLAGVALUE
REPEATED_FLAG:
- FLAGVALUE1
- FLAGVALUE2
```

#### Example
````yaml
- docker:
description: "Build image"
build:
tag: "gmadhok/cookies:v1.0"
file: Dockerfile
````

### Docker run

#### Syntax
```yaml
- docker:
description: "Description of the command"
run:
image: IMAGE
name: NAME
detach: BOOL #defaults to false
ports:
- host: NUMBER # porter exposed on the host
container: NUMBER # port exposed by the container
env:
variable: VALUE
privileged: BOOL #defaults to false
rm: BOOL #defaults to false
command: COMMAND
arguments:
- arg1
- arg2
flags:
FLAGNAME: FLAGVALUE
REPEATED_FLAG:
- FLAGVALUE1
- FLAGVALUE2
suppress-output: BOOL #defaults to false
```

#### Example
```yaml
- docker:
description: "Run Whalesay"
run:
name: mixinpractice
image: "docker/whalesay:latest"
detach: true
ports:
- host: 8080
container: 80
env:
myvar: "whales"
privileged: true
rm: true
command: cowsay
arguments:
- "Hello World"
```

### Docker remove

#### Syntax
```yaml
- docker:
description: "Description of the command"
remove:
container: CONTAINER_NAME
force: BOOL #defaults to false
arguments:
- arg1
- arg2
flags:
FLAGNAME: FLAGVALUE
REPEATED_FLAG:
- FLAGVALUE1
- FLAGVALUE2
```

#### Example
```yaml
- docker:
description: "Remove mixinpractice"
remove:
container: mixinpractice
force: true
```

### Docker login

#### Syntax
Username and password are optional because the mixin will default to using environment variables provided by DOCKER_USERNAME and DOCKER_PASSWORD from a parameter or a credential.
See an [example](/examples/docker-mixin-test/README.md#notes-on-docker-login) for how to use docker login and securely provide your username and password.
```yaml
- docker:
description: "Description of the command"
login:
username: USERNAME #OPTIONAL
password: PASSWORD #OPTIONAL
arguments:
- arg1
- arg2
flags:
FLAGNAME: FLAGVALUE
REPEATED_FLAG:
- FLAGVALUE1
- FLAGVALUE2
```

#### Example
```yaml
- docker:
description: "Login to docker"
login:
```

## Invocation

Use of this mixin requires opting-in to Docker host access via a Porter setting. See the Porter [documentation](https://porter.sh/configuration/#allow-docker-host-access) for further details.

Here we opt-in via the CLI flag, `--allow-docker-host-access`:
```shell
$ porter install --allow-docker-host-access
```