Spec-Zone.ru › Ansible 2.4

s3_website - Настройка s3-ведра как веб-сайта

Новое в версии 2.2.

  • Обзор
  • Требования (для хоста, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Настройка s3-ведра как веб-сайта

Требования (для хоста, на котором выполняется модуль)

  • python >= 2.6
  • boto

Параметры

параметр обязателен значение по умолчанию варианты комментарии
aws_access_key
нет
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
псевдонимы: ec2_access_key, access_key
aws_secret_key
нет
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
псевдонимы: ec2_secret_key, secret_key
ec2_url
нет
URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
error_key
нет
Имя ключа объекта для использования при возникновении ошибки 4XX. Для удаления ключа ошибки установите значение None.
name
да
Имя s3-ведра
profile
(добавлено в 1.6)
нет
Использует профиль boto. Работает только с boto >= 2.24.0.
redirect_all_requests
нет
Описывает поведение перенаправления для каждого запроса к этому веб-сайту s3-ведра.
region
нет
Регион AWS для создания ведра. Если не задан, проверяются значения переменных окружения AWS_REGION и EC2_REGION, затем настройки aws_region и ec2_region в файле конфигурации Boto. Если ни одно из этих значений не задано, регион по умолчанию — S3 Location: US Standard.
security_token
(добавлено в 1.6)
нет
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token
state
нет present
  • present
  • absent
Добавить или удалить конфигурацию веб-сайта s3
suffix
нет index.html
Суффикс, добавляемый к запросу к каталогу на веб-точке s3 (например, если суффикс — index.html, и вы отправляете запрос к samplebucket/images/, возвращаемые данные будут для объекта с именем ключа images/index.html). Суффикс не должен содержать символ слэша.
validate_certs
(добавлено в 1.5)
нет да
  • да
  • нет
Если установлено значение "нет", сертификаты SSL для boto версии >= 2.6.0 не будут проверятся.

Примеры

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

# Configure an s3 bucket to redirect all requests to example.com
- s3_website:
    name: mybucket.com
    redirect_all_requests: example.com
    state: present

# Remove website configuration from an s3 bucket
- s3_website:
    name: mybucket.com
    state: absent

# Configure an s3 bucket as a website with index and error pages
- s3_website:
    name: mybucket.com
    suffix: home.htm
    error_key: errors/404.htm
    state: present

Возвращаемые значения

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

имя описание возвращается тип пример
error_document
документ ошибки
всегда сложный
содержит:
имя описание возвращается тип пример
key
имя ключа объекта, используемого при возникновении ошибки 4XX
если параметр error_document задан строка error.html
index_document
документ index
всегда сложный
содержит:
имя описание возвращается тип пример
suffix
суффикс, добавляемый к запросу к каталогу на веб-точке s3
успех строка index.html
redirect_all_requests_to
куда перенаправить запросы
всегда сложный
содержит:
имя описание возвращается тип пример
host_name
имя хоста, куда будут перенаправлены запросы.
если параметр redirect all requests задан строка ansible.com
routing_rules
правила маршрутизации
всегда сложный
содержит:
имя описание возвращается тип пример
redirect
routing_rule
condition
префикс имени ключа объекта, когда применяется перенаправление. Например, для перенаправления запросов к ExamplePage.html префикс ключа будет ExamplePage.html
если правило маршрутизации задано строка docs/

Примечания

Примечание

  • Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION
  • Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Статус

Этот модуль помечен как превью, что означает, что гарантии обратной совместимости нет.

Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Справочную информацию по сообществу и участие в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/s3_website_module.html

Spec-Zone.ru

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