aws_ssm – Получение значения параметра SSM или всех параметров в рамках пути

• Описание
• Требования
• Параметры
• Примеры
• Статус

Описание

• Получение значения параметра Amazon Simple Systems Manager или иерархии параметров. Первый аргумент для поиска может быть именем параметра или иерархией параметров. Иерархии начинаются с обратного слэша и заканчиваются именем параметра. Может быть указано до 5 уровней.
• Если ищется явно указанный параметр по имени, которого не существует, поиск вернёт значение None, которое Jinja2 интерпретирует как пустую строку. Можно использовать фильтр `default` для задания значения по умолчанию в этом случае, но при этом необходимо установить второй параметр в true (см. примеры ниже).
• При поиске пути для параметров под ним будет возвращён словарь для каждого пути. Если под этим путём нет параметра, то возврат будет успешным, но словарь будет пустым.
• Если поиск завершается неудачей из-за отсутствия разрешений или из-за ошибки клиента AWS, aws_ssm сгенерирует ошибку, обычно завершая текущую задачу Ansible. Это обычно правильно, так как игнорирование значения, к которому IAM не предоставляет доступ, может привести к более серьёзным проблемам, неверному поведению или потере данных. Если вы хотите продолжить в этом случае, вам придётся настроить две задачи Ansible: одну для установки переменной и игнорирования ошибок, и одну для использования значения этой переменной со значением по умолчанию. См. примеры ниже.

Требования

Ниже перечислены требования к локальному узлу-мастеру, на котором выполняется этот поиск.

• boto3
• botocore

Параметры

Примеры

# lookup sample:
- name: lookup ssm parameter store in the current region
  debug: msg="{{ lookup('aws_ssm', 'Hello' ) }}"

- name: lookup ssm parameter store in nominated region
  debug: msg="{{ lookup('aws_ssm', 'Hello', region='us-east-2' ) }}"

- name: lookup ssm parameter store without decrypted
  debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=False ) }}"

- name: lookup ssm parameter store in nominated aws profile
  debug: msg="{{ lookup('aws_ssm', 'Hello', aws_profile='myprofile' ) }}"

- name: lookup ssm parameter store using explicit aws credentials
  debug: msg="{{ lookup('aws_ssm', 'Hello', aws_access_key=my_aws_access_key, aws_secret_key=my_aws_secret_key, aws_security_token=my_security_token ) }}"

- name: lookup ssm parameter store with all options.
  debug: msg="{{ lookup('aws_ssm', 'Hello', decrypt=false, region='us-east-2', aws_profile='myprofile') }}"

- name: lookup a key which doesn't exist, returns ""
  debug: msg="{{ lookup('aws_ssm', 'NoKey') }}"

- name: lookup a key which doesn't exist, returning a default ('root')
  debug: msg="{{ lookup('aws_ssm', 'AdminID') | default('root', true) }}"

- name: lookup a key which doesn't exist failing to store it in a fact
  set_fact:
    temp_secret: "{{ lookup('aws_ssm', '/NoAccess/hiddensecret') }}"
  ignore_errors: true

- name: show fact default to "access failed" if we don't have access
  debug: msg="{{ 'the secret was:' ~ temp_secret | default('could not access secret') }}"

- name: return a dictionary of ssm parameters from a hierarchy path
  debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region='ap-southeast-2', bypath=true, recursive=true ) }}"

- name: return a dictionary of ssm parameters from a hierarchy path with shortened names (param instead of /PATH/to/param)
  debug: msg="{{ lookup('aws_ssm', '/PATH/to/params', region='ap-southeast-2', shortnames=true, bypath=true, recursive=true ) }}"

- name: Iterate over a parameter hierarchy
  debug: msg='key contains {{item.Name}} with value {{item.Value}} '
  loop: '{{ query("aws_ssm", "/TEST/test-list", region="ap-southeast-2", bypath=true) }}'

Статус

• Этот поиск не гарантирует обратную совместимость. [превью]
• Этот поиск поддерживается сообществом Ansible. [сообщество]

Авторы

• Bill Wang <ozbillwang(at)gmail.com>
• Marat Bakeev <hawara(at)gmail.com>
• Michael De La Rue <ansiblemitcom.mddlr@spamgourmet.com>