Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа 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 в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

aws_ca_bundle

path

Путь к пакету центров сертификации, используемому для проверки SSL-сертификатов.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

cluster_name

string / обязательный

Имя кластера EKS.

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для обработки уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action для вывода общего списка вызовов, выполненных в ходе плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws проверяются только с AWS.

Также можно использовать переменную окружения AWS_URL.

name

string / обязательный

Имя профиля EKS Fargate.

profile

псевдонимы: aws_profile

string

Именованный профиль AWS для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.

purge_tags

boolean

Если задано значение 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

string

Регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

role_arn

string

ARN роли IAM, используемой кластером EKS.

Обязателен, если state=present.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа 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 в порядке убывания приоритета.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

selectors

list / элементы=dictionary

Список селекторов для профиля Fargate.

Обязателен, если state=present.

labels

dictionary

Словарь меток, используемых в профиле Fargate.

По умолчанию: {}

namespace

string

Пространство имён, используемое в профиле Fargate.

session_token

псевдонимы: aws_session_token

string

Токен сеанса AWS STS для использования с временными учётными данными.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную окружения AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

state

string

Создать или удалить профиль Fargate.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subnets

list / элементы=string

Список идентификаторов подсетей кластера Kubernetes.

Обязателен, если state=present.

tags

псевдонимы: resource_tags

dictionary

Словарь тегов, применяемых к ресурсу.

Если параметр tags не задан, теги не будут изменены.

validate_certs

boolean

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

wait

boolean

Определяет, ожидает ли модуль создания или удаления профиля перед продолжением работы.

Варианты:

  • false ← (по умолчанию)
  • true

wait_timeout

integer

Время ожидания перехода кластера в активное состояние, в секундах. По умолчанию — 1200 секунд (20 минут).

По умолчанию: 1200

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения учётных данных и другие параметры по умолчанию, например регион, из файлов конфигурации в контексте «узла» 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

string

Имя кластера EKS.

Возвращается: если state имеет значение present

Пример: "test-cluster"

created_at

string

Дата и время создания профиля Fargate.

Возвращается: если state имеет значение present

Пример: "2022-01-18T20:00:00.111000+00:00"

fargate_profile_arn

string

ARN профиля Fargate.

Возвращается: если state имеет значение present

Пример: "arn:aws:eks:us-east-1:1231231123:safd"

fargate_profile_name

string

Имя профиля Fargate.

Возвращается: если state имеет значение present

Пример: "test_profile"

pod_execution_role_arn

string

ARN роли IAM, используемой профилем Fargate.

Возвращается: если state имеет значение present

Пример: "arn:aws:eks:us-east-1:1231231123:role/asdf"

selectors

complex

Конфигурация селекторов.

Возвращается: если state имеет значение present

labels

list / элементы=string

Список меток Kubernetes, используемых в профиле.

Возвращается: если state имеет значение present

Пример: [{"label1": "test1"}, {"label2": "test2"}]

namespace

string

Имя пространства имён Kubernetes, используемого в профиле.

Возвращается: если state имеет значение present

Пример: "nm-test"

status

string

Состояние профиля EKS Fargate.

Возвращается: если state имеет значение present

Пример: "['CREATING', 'ACTIVE']"

subnets

list / элементы=string

Список подсетей, используемых профилем Fargate.

Возвращается: если state имеет значение present

Пример: ["subnet-qwerty123", "subnet-asdfg456"]

tags

dictionary

Словарь тегов ресурса.

Возвращается: если state имеет значение present

Пример: {"env": "test", "foo": "bar"}

Авторы

  • Tiago Jarra (@tjarra)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API