digital_ocean – Создание/удаление виртуальной машины/ключа SSH в DigitalOcean

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

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

Описание

Создание/удаление виртуальной машины в DigitalOcean и, необязательно, ожидание её запуска, или развёртывание ключа SSH.

Требования

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

python >= 2.6
dopy

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_token - Добавлен в 1.9.5		Токен API DigitalOcean.
backups_enabled boolean Добавлен в 1.6	Варианты: нет ← да	Необязательный, Boolean, включает резервное копирование для виртуальной машины.
command -	Варианты: droplet ← ssh	Какой объект вы хотите обработать.
id -		Числовое значение, идентификатор виртуальной машины, которую вы хотите обработать. Псевдонимы: droplet_id
image_id -		Это псевдоним образа, который вы хотите использовать для создания виртуальной машины.
ipv6 boolean Добавлен в 2.2	Варианты: нет ← да	Необязательный, Boolean, включить IPv6 для вашей виртуальной машины.
name -		Строка, это имя виртуальной машины — должно соответствовать правилам именования хостов или имя ключа SSH.
private_networking boolean Добавлен в 1.4	Варианты: нет ← да	Булево значение, добавить дополнительный частный сетевой интерфейс к виртуальной машине для межвиртуальной связи.
region_id -		Это псевдоним региона, в котором вы хотите создать свой сервер.
size_id -		Это псевдоним размера, который вы хотите использовать для создания виртуальной машины.
ssh_key_ids -		Необязательный, массив идентификаторов ключей SSH (числовых), которые вы хотите добавить к серверу.
ssh_pub_key -		Открытый ключ SSH, который вы хотите добавить к своей учетной записи.
state -	Варианты: present ← active absent deleted	Указывает желаемое состояние объекта.
unique_name boolean Добавлен в 1.4	Варианты: нет ← да	Булево значение, требует уникальных имен хостов. По умолчанию DigitalOcean разрешает несколько хостов с одинаковым именем. Установка в «да» разрешает только один хост на имя. Полезно для идемпотентности.
user_data - Добавлен в 2.0		неявно заданный набор данных, предоставляемый виртуальной машине
virtio boolean Добавлен в 1.4	нет да ←	Булево значение, включить драйвер virtio в виртуальной машине для улучшенного ввода-вывода сети и хранилища.
wait boolean	нет да ←	Ожидать, пока виртуальная машина не перейдет в состояние «запущена», прежде чем возвращаться. Если wait — «нет», ip_address может не быть возвращен.
wait_timeout -	По умолчанию: 300	Через сколько времени ожидание прекратится, в секундах.

Примечания

Примечание

Можно использовать две переменные окружения: DO_API_KEY и DO_API_TOKEN. Обе они относятся к токену v2.
Начиная с Ansible 1.9.5 и 2.0, используется версия 2 API DigitalOcean. Это убирает client_id и api_key в пользу api_token.
Если вы используете Ansible 1.9.4 или более раннюю версию, возможно, вы не сможете использовать включённую версию этого модуля, так как используемая версия API была удалена. Обновите Ansible или, если это невозможно, попробуйте загрузить последнюю версию этого модуля с github и поместить её в директорию «library».

Примеры

# Ensure a SSH key is present
# If a key matches this name, will return the ssh key id and changed = False
# If no existing key matches this name, a new key is created, the ssh key id is returned and changed = False

- digital_ocean:
    state: present
    command: ssh
    name: my_ssh_key
    ssh_pub_key: 'ssh-rsa AAAA...'
    api_token: XXX

# Create a new Droplet
# Will return the droplet details including the droplet id (used for idempotence)

- digital_ocean:
    state: present
    command: droplet
    name: mydroplet
    api_token: XXX
    size_id: 2gb
    region_id: ams2
    image_id: fedora-19-x64
    wait_timeout: 500
  register: my_droplet

- debug:
    msg: "ID is {{ my_droplet.droplet.id }}"

- debug:
    msg: "IP is {{ my_droplet.droplet.ip_address }}"

# Ensure a droplet is present
# If droplet id already exist, will return the droplet details and changed = False
# If no droplet matches the id, a new droplet will be created and the droplet details (including the new id) are returned, changed = True.

- digital_ocean:
    state: present
    command: droplet
    id: 123
    name: mydroplet
    api_token: XXX
    size_id: 2gb
    region_id: ams2
    image_id: fedora-19-x64
    wait_timeout: 500

# Create a droplet with ssh key
# The ssh key id can be passed as argument at the creation of a droplet (see ssh_key_ids).
# Several keys can be added to ssh_key_ids as id1,id2,id3
# The keys are used to connect as root to the droplet.

- digital_ocean:
    state: present
    ssh_key_ids: 123,456
    name: mydroplet
    api_token: XXX
    size_id: 2gb
    region_id: ams2
    image_id: fedora-19-x64

Статус

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

Авторы

Vincent Viallet (@zbal)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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