tonnyed.letencrypt_aws_secret_reader

Parameter Store Variable Reader

========= This role retrieves aws_secret and aws_access_key_id from the parameter store on the local machine during deployment. These values are used by Let's Encrypt when setting up a certificate.

Requirements

Any prerequisites not addressed by Ansible or this role should be listed here. For example, if the role utilizes the EC2 module, it's useful to state that the boto package is required.

Role Variables

This section should describe the variables that can be set for this role, including those in defaults/main.yml, vars/main.yml, and any that should be provided as parameters. Also, mention any variables sourced from other roles or the global scope (e.g., hostvars, group vars).

• Input

  • secret_key_id (string): The name of the parameter store for the AWS secret key variable.
  • secret_access (string): The name of the parameter store for the AWS secret access variable.
  • aws_region (string): The name of the parameter store for the AWS region variable.
  • decrypt (bool, default=true): Indicates whether to decrypt the parameter store variable.
  • aws_profile (string): The name of the parameter store for the AWS profile variable.
  • check_lookup (bool, default=false): A debugger to view values retrieved from the parameter store.

• Output

  • aws_secret_access: The AWS secret access fact retrieved from the parameter store, used by Let's Encrypt.
  • aws_secret_key_id: The AWS secret key ID fact retrieved from the parameter store, used by Let's Encrypt.

Dependencies

List any other roles available on Galaxy that this role depends on, along with any necessary parameters or variables required for those roles.

This role depends on Let's Encrypt.

Example Playbook

Providing an example of how to use your role (for instance, with variables as parameters) is helpful for users:

- hosts: servers
  roles:
    - letencrypt-aws-secret-reader
  vars:
    secret_key_id: "secret_key_id"
    secret_access: "secret_access"
    aws_region: "eu-west-2"
    decrypt: true
    aws_profile: "dev"
    check_lookup: false

License

BSD

Author Information

[email protected]