Ansible Role: christiangda.awscli

This role create the necessary files to configure AWS Command Line Interface (awscli).

This roles is very basic, its only function is transform a variable defined in yaml format with the content of the .aws/config and .aws/credentials files to the .ini file format and put those in the place you want.

The best way to install this role is using the command ansible-galaxy install christiangda.awscli_configure, the Ansible Galaxy repository is christiangda.awscli_configure

The repository code is https://github.com/christiangda/ansible-role-awscli-configure

See the examples to understand it.

Requirements

This role work on RedHat, CentOS, Debian and Ubuntu distributions

RedHat
- 6 (*)
- 7
- 8
- 9 (Rocky Linux)
CentOS
- 6 (*)
- 7
- 8
Ubuntu
- 14.* (*)
- 16.* (*)
- 18.*
- 19.*
Debian
- jessie (8) (*)
- stretch (9)
- buster (10)
- sid (unstable)

(*) Out of tests, maybe you find problems with this OS

To see the compatibility matrix of Python vs. Ansible see the project Travis-CI build matrix

Role Variables

Variable	Default Value
awscliconf_path	"~/."
awscliconf_recursive_path_creation	false
awscliconf_files_owner	"root"
awscliconf_files_group	"root"
awscliconf_files	"" --> Empty

More Details: See the file defaults/main.yaml

Dependencies

This role has no dependencies but is important that you install AWS Command Line Interface (awscli) in order to make sense of this. My role christiangda.awscli can help you to install AWS Command Line Interface (awscli).

Example Playbook

RedHat/CentOS, Ubuntu and Debian

If you have installed AWS Command Line Interface (awscli) already

- hosts: redhat-8
    gather_facts: True
    roles:
      - role: christiangda.awscli_configure
        vars:
          awscliconf_path: '/home/christian.gonzalez'
          awscliconf_files_owner: 'christian.gonzalez'
          awscliconf_files_group: 'christian.gonzalez'
          awscliconf_files:
            credentials:
              - default:
                  aws_access_key_id: 'AKIAIOSFODNN7EXAMPLE'
                  aws_secret_access_key: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
            config:
              - default:
                  region: us-west-2
                  output: json
              - profile development:
                  role_arn: 'arn:aws:iam::123456789012:role/role-for-development'
                  mfa_serial: 'arn:aws:iam::11111111111:mfa/christian.gonzalez'
                  region: eu-west-1
                  source_profile: default

When you have RedHat/CentOS 8 or Debian/Ubuntu target and you don't have installed AWS Command Line Interface (awscli) and wants to use my role christiangda.awscli

- hosts: redhat-8
    gather_facts: True
    roles:
      - role: christiangda.awscli
      - role: christiangda.awscli_configure
        vars:
          awscliconf_files:
            credentials:
              - default:
                  aws_access_key_id: 'AKIAIOSFODNN7EXAMPLE'
                  aws_secret_access_key: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
            config:
              - default:
                  region: us-west-2
                  output: json
              - profile development:
                  role_arn: 'arn:aws:iam::123456789012:role/role-for-development'
                  mfa_serial: 'arn:aws:iam::11111111111:mfa/christian.gonzalez'
                  region: eu-west-1
                  source_profile: default

When you have RedHat/CentOS 6/7 target and you don't have installed AWS Command Line Interface (awscli) and EPEL Repository either, and wants to use my roles christiangda.epel_role, christiangda.awscli

- hosts: redhat-7
    gather_facts: True
    roles:
      - role: christiangda.epel_repo
      - role: christiangda.awscli
      - role: christiangda.awscli_configure
        vars:
          awscliconf_files:
            credentials:
              - profile: "default"
                  aws_access_key_id: 'AKIAIOSFODNN7EXAMPLE'
                  aws_secret_access_key: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
            config:
              - name: "default"
                  region: us-west-2
                  output: json
              - profile development:
                  role_arn: 'arn:aws:iam::123456789012:role/role-for-development'
                  mfa_serial: 'arn:aws:iam::11111111111:mfa/christian.gonzalez'
                  region: eu-west-1
                  source_profile: default

When you have multiples OS targets and wants to install EPEL repository only in RedHat/CentOS 6/7 using my roles christiangda.epel_role, christiangda.awscli

- hosts: servers
    gather_facts: True
    roles:
    - role: christiangda.epel_repo
      when: >
        ansible_os_family == 'RedHat' and (
          ansible_distribution == 'CentOS' or
          ansible_distribution == 'RedHat'
        )
        and (
          ansible_distribution_major_version == '6' or
          ansible_distribution_major_version == '7'
        )
      changed_when: false
    - role: christiangda.awscli
    - role: christiangda.awscli_configure
      vars:
        awscliconf_files:
          credentials:
            - default:
                aws_access_key_id: 'AKIAIOSFODNN7EXAMPLE'
                aws_secret_access_key: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'

            - production-profile:
                aws_access_key_id: 'AKIAIOSFODNN7EXAMPLE'
                aws_secret_access_key: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
          config:
            - default:
                region: us-west-2
                output: json
            - profile development:
                role_arn: arn:aws:iam::123456789012:role/role-name
                role_session_name: maria_garcia_role
                source_profile: production-profile
                aws_session_token: AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk
                s3:
                  max_concurrent_requests: 20
                  max_queue_size: 10000
                  multipart_threshold: 64MB
                  multipart_chunksize: 16MB
                  max_bandwidth: 50MB/s
                  use_accelerate_endpoint: true
                  addressing_style: path
                api_versions:
                  ec2: '2015-03-01'
                  cloudfront: '2015-09-17'
                tcp_keepalive: false

Development / Contributing

This role is tested using Molecule and was developed using Python Virtual Environments

Also, we used to main git branch

master
develop

If you want to contribute to this project what you want to do is

Fork the project
Prepare your environment
Fix the problem in develop branch
Execute molecule test
Create a Pull Request to official project develop branch

References

Prepare your environment

Python 3

mkdir ansible-roles
cd ansible-roles/

python3 -m venv venv
source venv/bin/activate
pip install pip --upgrade
pip install ansible
pip install molecule
pip install 'molecule[docker]'
pip install 'molecule[podman]'
pip install 'molecule[lint]'
pip install molecule-vagrant
pip install python-vagrant
pip install selinux
pip install docker
pip install pytest
pip install pytest-mock
pip install pylint
pip install rope
pip install autopep8
pip install yamllint
pip install flake8
pip install ansible-lint

Clone the role repository (From your fork) and create symbolic link

git clone https://github.com/christiangda/ansible-role-awscli-configure.git
ln -s ansible-role-awscli-configure christiangda.awscli_configure
cd christiangda.awscli_configure

Execute the molecule test

Scenarios available:

default --> --driver-name docker
podman --> --driver-name podman
centos-8 --> --driver-name centos-8
centos-7 --> --driver-name centos-7
ubuntu-21.04 --> --driver-name ubuntu-21.04

scenario default

Step by step

molecule create [--scenario-name default]
molecule converge [--scenario-name default]
molecule verify [--scenario-name default]
molecule destroy [--scenario-name default]

All in one

molecule test [--scenario-name default]

scenario podman