community.general.packet_device – Управление сервером с голой железной платой в Packet Host.
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.packet_device.
Обзор
- Управление сервером с голой железной платой в Packet Host (в терминах API — «устройство»).
- При создании машины можно необязательно дождаться публичного IP-адреса или активного состояния.
- Этот модуль зависит от packet >= 1.0.
- Документация API находится по адресу https://www.packet.net/developers/api/devices.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- packet-python >= 1.35
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| always_pxe boolean |
| Удерживать PXE в качестве первого параметра загрузки. Обычно процесс PXE происходит только при первой загрузке. Установите этот параметр, чтобы ваше устройство постоянно загружалось в iPXE. |
| auth_token string | Токен Packet API. Вы также можете указать его в переменной среды PACKET_API_TOKEN. | |
| count string | По умолчанию: 1 | Количество устройств для создания. Количество можно включить в имя хоста с помощью формата строк %d. |
| count_offset string | По умолчанию: 1 | С какого номера начинать отсчёт. |
| device_ids string | Список идентификаторов устройств, над которыми нужно выполнить операцию. | |
| facility string | Идентификатор (slug) объекта для создания устройства. См. список Packet API — https://www.packet.net/developers/api/facilities/. | |
| features string | Словарь с "параметрами" для создания устройства. См. документацию Packet API для получения подробных сведений. | |
| hostnames string | Имя хоста устройства или список имён хостов. Если указана строка или список из одного элемента, можно использовать "%d" для расширения чисел из параметра count.Если указано только одно имя хоста, оно может быть преобразовано в список, если count > 1. псевдонимы: name | |
| ipxe_script_url string | URL пользовательского скрипта iPXE для настройки. Дополнительная информация о пользовательском iPXE для устройств Packet по адресу https://help.packet.net/technical/infrastructure/custom-ipxe. | |
| locked boolean |
| Блокировать созданное устройство? псевдонимы: lock |
| operating_system string | Идентификатор (slug) ОС для создания устройства. См. список Packet API — https://www.packet.net/developers/api/operatingsystems/. | |
| plan string | Идентификатор (slug) плана для создания устройства. См. список Packet API — https://www.packet.net/developers/api/plans/. | |
| project_id string / обязательно | Идентификатор проекта устройства. | |
| state string |
| Желаемое состояние устройства. Если установлено значение present (по умолчанию), вызов модуля вернёт результат сразу после успешного возвращения HTTP-запроса создания устройства.Если установлено значение active, вызов модуля будет заблокирован, пока все указанные устройства не перейдут в состояние active в соответствии с API Packet, или пока не истечёт время ожидания wait_timeout. |
| tags list / элементы=string добавлен в 0.2.0 community.general | Список тегов устройства. В настоящее время реализован только для создания устройства. | |
| user_data string | Данные пользователя, доступные машине. | |
| wait_for_public_IPv string |
| Дожидаться назначения публичного IPv4/IPv6-адреса экземпляру. Если установлено значение 4, дождаться назначения IPv4-адреса экземпляру. Если установлено значение 6, дождаться назначения публичного IPv6-адреса экземпляру. |
| wait_timeout string | По умолчанию: 900 | Время ожидания (в секундах) либо автоматического назначения IP-адреса, либо достижения устройством состояния active state.Если wait_for_public_IPv установлено и state равно active, модуль будет ждать обоих событий последовательно, применяя таймаут дважды. |
Примечания
Примечание
- Не поддерживает режим проверки.
Примеры
# All the examples assume that you have your Packet API token in env var PACKET_API_TOKEN.
# You can also pass it to the auth_token parameter of the module instead.
# Creating devices
- name: Create 1 device
hosts: localhost
tasks:
- community.general.packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
hostnames: myserver
tags: ci-xyz
operating_system: ubuntu_16_04
plan: baremetal_0
facility: sjc1
# Create the same device and wait until it is in state "active", (when it's
# ready for other API operations). Fail if the device is not "active" in
# 10 minutes.
- name: Create device and wait up to 10 minutes for active state
hosts: localhost
tasks:
- community.general.packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
hostnames: myserver
operating_system: ubuntu_16_04
plan: baremetal_0
facility: sjc1
state: active
wait_timeout: 600
- name: Create 3 ubuntu devices called server-01, server-02 and server-03
hosts: localhost
tasks:
- community.general.packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
hostnames: server-%02d
count: 3
operating_system: ubuntu_16_04
plan: baremetal_0
facility: sjc1
- name: Create 3 coreos devices with userdata, wait until they get IPs and then wait for SSH
hosts: localhost
tasks:
- name: Create 3 devices and register their facts
community.general.packet_device:
hostnames: [coreos-one, coreos-two, coreos-three]
operating_system: coreos_stable
plan: baremetal_0
facility: ewr1
locked: true
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
wait_for_public_IPv: 4
user_data: |
#cloud-config
ssh_authorized_keys:
- {{ lookup('file', 'my_packet_sshkey') }}
coreos:
etcd:
discovery: https://discovery.etcd.io/6a28e078895c5ec737174db2419bb2f3
addr: $private_ipv4:4001
peer-addr: $private_ipv4:7001
fleet:
public-ip: $private_ipv4
units:
- name: etcd.service
command: start
- name: fleet.service
command: start
register: newhosts
- name: Wait for ssh
ansible.builtin.wait_for:
delay: 1
host: "{{ item.public_ipv4 }}"
port: 22
state: started
timeout: 500
with_items: "{{ newhosts.devices }}"
# Other states of devices
- name: Remove 3 devices by uuid
hosts: localhost
tasks:
- community.general.packet_device:
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
state: absent
device_ids:
- 1fb4faf8-a638-4ac7-8f47-86fe514c30d8
- 2eb4faf8-a638-4ac7-8f47-86fe514c3043
- 6bb4faf8-a638-4ac7-8f47-86fe514c301f
Возвращаемые значения
Общие значения возвращаемых данных описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | успех | Истина, если устройство было изменено каким-либо способом (создано, изменено или удалено) Пример: Истина |
| devices list / элементы=string | успех | Информация о каждом обработанном устройстве Пример: [{"hostname": "my-server.com", "id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7", "public_ipv4": "147.229.15.12", "private-ipv4": "10.0.15.12", "tags": [], "locked": false, "state": "provisioning", "public_ipv6": ""2604:1380:2:5200::3"}] |
Авторы
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>
- Matt Baldwin (@baldwinSPC) <baldwin@stackpointcloud.com>
- Thibaud Morel l’Horset (@teebes) <teebes@gmail.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/packet_device_module.html