Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docker Agent Warnings #210

Merged
merged 3 commits into from
Sep 20, 2022
Merged

Docker Agent Warnings #210

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ba7e32
Add warning about using this plugin when running the buildkite agent …
toote Sep 19, 2022
f38f467
Updated version numbers in ReadMe to prevent linter warnings
toote Sep 19, 2022
d006412
Add clarification about SSH agent option (closes #112)
toote Sep 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ steps:
- command: "go build -o dist/my-app ."
artifact_paths: "./dist/my-app"
plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "golang:1.11"
```

Expand All @@ -23,7 +23,7 @@ Windows images are also supported:
steps:
- command: "dotnet publish -c Release -o published"
plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "microsoft/dotnet:latest"
always-pull: true
```
Expand All @@ -33,7 +33,7 @@ If you want to control how your command is passed to the docker container, you c
```yml
steps:
- plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "mesosphere/aws-cli"
always-pull: true
command: ["s3", "sync", "s3://my-bucket/dist/", "/app/dist"]
Expand All @@ -50,7 +50,7 @@ steps:
- "yarn install"
- "yarn run test"
plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "node:7"
always-pull: true
environment:
Expand All @@ -70,7 +70,7 @@ steps:
env:
MY_SPECIAL_BUT_PUBLIC_VALUE: kittens
plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "node:7"
always-pull: true
propagate-environment: true
Expand All @@ -86,7 +86,7 @@ steps:
env:
MY_SPECIAL_BUT_PUBLIC_VALUE: kittens
plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "node:7"
always-pull: true
propagate-aws-auth-tokens: true
Expand All @@ -100,7 +100,7 @@ steps:
- "docker build . -t image:tag"
- "docker push image:tag"
plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "docker:latest"
always-pull: true
volumes:
Expand All @@ -113,12 +113,16 @@ You can disable the default behaviour of mounting in the checkout to `workdir`:
steps:
- command: "npm start"
plugins:
- docker#v4.0.0:
- docker#v4.1.0:
image: "node:7"
always-pull: true
mount-checkout: false
```

### 🚨 Warning

You need to be careful when/if [running the BuildKite agent itself in docker](https://buildkite.com/docs/agent/v3/docker) that, itself, runs pipelines that use this plugin. Make sure to read all the documentation on the matter, specially the caveats and warnings listed.

## Configuration

### Required
Expand Down Expand Up @@ -229,6 +233,8 @@ Whether to automatically mount the ssh-agent socket from the host agent machine

Default: `false`

**Important**: note that for this to work you will need the agent itself to have access to an ssh agent that is: up and running, listening on the appropriate socket, with the appropriate credentials loaded (or to be loaded). Please refer to the [agent's documentation on using SSH agent](https://buildkite.com/docs/agent/v3/ssh-keys#using-multiple-keys-with-ssh-agent) for more information

### `network` (optional, string)

Join the container to the docker network specified. The network will be created if it does not already exist. See https://docs.docker.com/engine/reference/run/#network-settings for more details.
Expand Down