Skip to content

docs(runners.cache.s3): explicit IAM instance profile usage

Paul 🐻 requested to merge paulrbr/gitlab-runner:patch-2 into master

What does this MR do?

Adds some documentation about using IAM instance profile with the S3 caching capabilities of gitlab-runner configured with the docker+machine executor.

Why was this MR needed?

I had troubles to get the S3 caching feature to work on our hosted Gitlab instance. The setup being the following:

  • 1 AWS instance with gitlab and gitlab-runner installed. The gitlab-runner configured with the docker+machine executor and the amazon ec2 provider. With an instance profile "gitlab".
  • N AWS auto-scaled Docker instances created by gitlab-runner. With an instance profile "gitlab-runners"

Naïvely when reading the part of the documentation modified in this MR I was thinking the S3 caching capabilities were given to the "build machines" (so the auto-scaled machines with the "gitlab-runners" IAM instance profile) and not the "gitlab-runner" machine.

Hopefully this extra sentence will help someone else in the future 🙂

Merge request reports