Skip to content

aktsk/googleauth_aws_container_credential_provider

Repository files navigation

GoogleAuthAWSContainerCredentialProvider

The googleauth gem supports AWS Workload Identity, but it cannot handle container credentials provided by ECS, CodeBuild and so on, which is passed via the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environmental variable. This gem enables it to use the container credential provider.

Usage

Adding the following the require statement will patch the googleauth to make it fetch the container credentials when AWS_CONTAINER_CREDENTIALS_RELATIVE_URI or AWS_CONTAINER_CREDENTIALS_FULL_URI environmental variable is defined.

require 'googleauth_aws_container_credential_provider'

For example, this gem can allow a fluentd container running on ECS to authenticate to access BigQuery using Workload Identity with its task role:

FROM fluentd:latest
USER root

# Install BigQuery plugin and this gem
RUN apk add build-base ruby-dev \
 && fluent-gem install fluent-plugin-bigquery googleauth_aws_container_credential_provider

# Require this gem to enable googleauth to use ECS task role for Workload Identity
CMD ["-r", "googleauth_aws_container_credential_provider"]

USER fluent
COPY workload-identity.json /home/fluent/.config/gcloud/application_default_credentials.json

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aktsk/googleauth_aws_container_credential_provider.

License

The gem is available as open source under the terms of the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published