Модуль community.aws.eks_fargate_profile – Управление профилем EKS Fargate

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.aws.eks_fargate_profile.

Новая функция в community.aws 4.0.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Управление профилем EKS Fargate.

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа AWS. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение пакета CA для проверки сертификатов SSL. Также может быть использована переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cluster_name строка / обязательно	Имя кластера EKS.
debug_botocore_endpoint_logs логический	Использовать `botocore.endpoint` логгер для анализа уникальных (а не общих) `"resource:action"` API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода полного списка, выполненного во время выполнения книги. Также может быть использована переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут использоваться переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
name строка / обязательно	Имя профиля EKS Fargate.
profile псевдонимы: aws_profile строка	Используемый именованный профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может быть использована переменная среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.
purge_tags логический	Если purge_tags=true и tags задано, существующие теги будут удалены из ресурса, чтобы точно соответствовать значениям параметра tags. Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому они будут игнорироваться в параметре purge_tags. См. документацию Amazon для получения дополнительной информации https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region, ec2_region строка	AWS регион для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные среды `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
role_arn строка	ARN роли IAM, используемой кластером EKS. Требуется при state=present.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

selectors список / элементы=словарь	Список селекторов для использования в профиле fargate. Требуется при state=present.
labels словарь	Словарь меток, используемых в профиле fargate. По умолчанию: `{}`
namespace строка	Пространство имён, используемое в профиле fargate.
session_token псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка	Токен сеанса AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access токенах https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, при этом параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state строка	Создать или удалить профиль Fargate. Варианты: `"absent"` `"present"` ← (по умолчанию)
subnets список / элементы=строка	Список идентификаторов подсетей для кластера Kubernetes. Требуется при state=present.
tags псевдонимы: resource_tags словарь	Словарь, представляющий метки, которые необходимо применить к ресурсу. Если параметр tags не задан, метки не будут изменены.
validate_certs логическое	Если установлено значение `false`, сертификаты SSL для связи с API AWS не будут проверены. Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите возможность установки aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)
wait логическое	Указывает, ожидает ли модуль, пока профиль не будет создан или удален, прежде чем перейти дальше. Варианты: `false` ← (по умолчанию) `true`
wait_timeout целое число	Продолжительность ожидания в секундах, пока кластер не станет активным. По умолчанию 1200 секунд (20 минут). По умолчанию: `1200`

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться скопировать явно на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create an EKS Fargate Profile
  community.aws.eks_fargate_profile:
    name: test_fargate
    cluster_name: test_cluster
    role_arn: my_eks_role
    subnets:
      - subnet-aaaa1111
    selectors:
      - namespace: nm-test
        labels:
          - label1: test
    state: present
    wait: true

- name: Remove an EKS Fargate Profile
  community.aws.eks_fargate_profile:
    name: test_fargate
    cluster_name: test_cluster
    wait: true
    state: absent

Значения возврата

Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
cluster_name строка	Имя кластера EKS. Возвращается: при состоянии присутствия Пример: `"test-cluster"`
created_at строка	Дата и время создания профиля Fargate. Возвращается: при состоянии присутствия Пример: `"2022-01-18T20:00:00.111000+00:00"`
fargate_profile_arn строка	ARN профиля Fargate. Возвращается: при состоянии присутствия Пример: `"arn:aws:eks:us-east-1:1231231123:safd"`
fargate_profile_name строка	Имя профиля Fargate. Возвращается: при состоянии присутствия Пример: `"test_profile"`
pod_execution_role_arn строка	ARN роли IAM, используемой профилем Fargate. Возвращается: при состоянии присутствия Пример: `"arn:aws:eks:us-east-1:1231231123:role/asdf"`
selectors сложная	Настройка селектора. Возвращается: при состоянии присутствия
labels список / элементы=строка	Список меток Kubernetes, используемых в профиле. Возвращается: при состоянии присутствия Пример: `[{"label1": "test1"}, {"label2": "test2"}]`
namespace строка	Имя пространства имен Kubernetes, используемого в профиле. Возвращается: при состоянии присутствия Пример: `"nm-test"`
status строка	Статус профиля EKS Fargate. Возвращается: при состоянии присутствия Пример: `"['CREATING', 'ACTIVE']"`
subnets список / элементы=строка	Список подсетей, используемых в профиле Fargate. Возвращается: при состоянии присутствия Пример: `["subnet-qwerty123", "subnet-asdfg456"]`
tags словарь	Словарь тегов ресурса. Возвращается: при состоянии присутствия Пример: `{"env": "test", "foo": "bar"}`

Авторы

Tiago Jarra (@tjarra)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/eks_fargate_profile_module.html