thiagoalmeidasa.aws_ecr_credential_helper

Panoramica Versioni Approfondimenti

ansible-aws_ecr_credential_helper

Ansible role for AWS ECR credential helper.

Ansible Requirements

Ansible Version

You need at least Ansible version 2.4.

Ansible Role Dependencies

There are no dependencies.

Installation

Install with Ansible Galaxy

To install, use the following command:

ansible-galaxy install thiagoalmeidasa.aws_ecr_credential_helper

Here's how to use it in your playbook:

- hosts: all
  roles:
    - role: thiagoalmeidasa.aws_ecr_credential_helper

Install with Git

If you don't want to install it globally, you can clone the repository into your roles_path:

git clone [email protected]:thiagoalmeidasa/ansible-role-aws_ecr_credential_helper.git /path/to/roles_path

It's also common to add it as a submodule in your playbook_dir repository:

git submodule add [email protected]:thiagoalmeidasa/ansible-role-aws_ecr_credential_helper.git <playbook_dir>/roles/aws_ecr_credential_helper

Since this role is not on Ansible Galaxy, you don't have to specify the GitHub user account.

Use it in your playbook like this:

- hosts: all
  roles:
  - role: aws_ecr_credential_helper

Role Variables

There are three types of variables.

The default vars section lists variables you can change in your Ansible inventory. It's a good idea to define all variables there for clarity, documentation, and easier management of the role.

The mandatory variables section describes important variables you must define in the inventory. If they're not defined, the role will fail. Try to avoid needing these as much as possible, or ensure that the role has clear behavior if they're missing.

The context variables section explains how the runtime context can affect how the role works.

Default Vars

Here are the default variables from defaults/main.yml:

aws_ecr_cred_helper_bin_version: 0.5.0
aws_ecr_cred_helper_pkg: "amazon-ecr-credential-helper"
aws_ecr_cred_helper_users:
  - "{{ ansible_env.USER }}"
install_from_binary: false

# cred_helper_config: {}
# credsStore: ecr-login