digital_ocean – Создание/удаление каплей/ключей SSH в DigitalOcean
УСТЕРЕГШЕЕ
| Удалено в Ansible: | |
|---|---|
| версия: 2.12 | |
| Почему: | Модуль обновлен для удаления внешней зависимости с увеличенной функциональностью. |
| Альтернатива: | Используйте digital_ocean_droplet вместо этого. |
Обзор
- Создание/удаление каплей в DigitalOcean и, по желанию, ожидание, пока она будет в состоянии «запущенная», или развертывание ключа SSH.
Требования
Ниже перечислены требования, необходимые на хосте, выполняющем этот модуль.
- python >= 2.6
- dopy
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_token - | Токен API DigitalOcean. | |
| backups_enabled boolean |
| Необязательно, логическое значение, включает резервное копирование капли. |
| command - |
| Целей, над которыми нужно произвести операцию. |
| id - | Числовое значение, ид капли, над которым нужно произвести операцию. алиасы: droplet_id | |
| image_id - | Это имя изображения, с которым будет создана капля. | |
| ipv6 boolean |
| Необязательно, логическое значение, включающее IPv6 для капли. |
| name - | Строка, это имя капли - должно быть отформатировано по правилам именования хостов или имя ключа SSH. | |
| private_networking boolean |
| Логическое значение, добавляет дополнительный частный сетевой интерфейс для капли для межкаплевого взаимодействия. |
| region_id - | Это имя региона, в котором вы хотите создать сервер. | |
| size_id - | Это имя размера, с которым вы хотите создать каплю. | |
| ssh_key_ids - | Необязательный массив идентификаторов ключей SSH (числовые), которые нужно добавить к серверу. | |
| ssh_pub_key - | Открытый ключ SSH, который нужно добавить к вашей учетной записи. | |
| state - |
| Указывает желаемое состояние целевого объекта. |
| unique_name boolean |
| Логическое значение, требует уникальные имена хостов. По умолчанию DigitalOcean позволяет несколько хостов с одинаковым именем. Установка в «да» позволяет только один хост на имя. Полезно для идемпотентности. |
| user_data - | неструктурированные данные, доступные для капли | |
| virtio boolean |
| Логическое значение, включить драйвер virtio в капле для улучшенного ввода-вывода сети и хранилища. |
| wait boolean |
| Ожидать, пока капля будет в состоянии «запущенная», прежде чем возвращаться. Если wait = «нет», IP-адрес может не быть возвращен. |
| 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 и поместить его в каталог «библиотека».
Примеры
# 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
Статус
- Этот модуль будет удален в версии 2.12. [устаревший]
- Для получения дополнительной информации см. УСТЕРЕГШЕЕ.
Авторы
- 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.9/modules/digital_ocean_module.html