os_server – Создание/удаление вычислительных экземпляров из OpenStack
Описание
- Создание или удаление вычислительных экземпляров из OpenStack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должно ожидать подключение сокета перед истечением времени ожидания для вызовов API. Если этот параметр опущен, ничего не будет передано в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной авторизации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено. | |
| auto_ip булево |
| Убедиться, что у экземпляра есть публичный IP-адрес, как хочет облако Псевдонимы: auto_floating_ip, public_ip |
| availability_zone - | Зона доступности, в которой необходимо создать сервер. | |
| boot_from_volume булево |
| Должен ли экземпляр загружаться с постоянного тома, созданного на основе предоставленного образа. Взаимоисключающее с boot_volume. |
| boot_volume - | Имя или идентификатор тома для использования в качестве тома для загрузки. Подразумевает boot_from_volume. Взаимоисключающее с image и boot_from_volume. Псевдонимы: root_volume | |
| ca_cert строка | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. Псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату, который необходимо использовать в рамках транзакции SSL. Псевдонимы: cert | |
| client_key строка | Путь к ключу клиента, который необходимо использовать в рамках транзакции SSL. Псевдонимы: key | |
| cloud сырые данные | Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| config_drive булево |
| Включить ли запуск сервера с включенным диском конфигурации |
| delete_fip булево |
| Если параметр state отсутствует, а этот параметр имеет значение true, любой плавающий IP-адрес, связанный с экземпляром, будет удален вместе с экземпляром. |
| flavor - | По умолчанию: 1 | Имя или идентификатор флейвера, в котором необходимо создать новый экземпляр. Взаимоисключающее с flavor_ram |
| flavor_include - | Текст для фильтрации имён флейверов, например, в случае Rackspace, где есть несколько флейверов с одинаковым объёмом ОЗУ. flavor_include является фильтром положительного соответствия - он должен присутствовать в имени флейвера. | |
| flavor_ram - | По умолчанию: 1 | Минимальный объём ОЗУ в МБ, который должен иметь флейвер, в котором необходимо создать новый экземпляр. Взаимоисключающее с flavor. |
| floating_ip_pools - | Имя пула плавающих IP-адресов, из которого выбрать плавающий IP-адрес | |
| floating_ips - | Список допустимых существующих плавающих IP-адресов, которые нужно назначить этому узлу | |
| image - / обязательно | Имя или идентификатор базового образа для загрузки. | |
| image_exclude - | Текст для фильтрации имён образов, например, в случае HP, где есть несколько имён образов, совпадающих с общими идентифицирующими частями. image_exclude - фильтр отрицательного соответствия - это текст, который не должен присутствовать в имени образа. По умолчанию "(deprecated)" | |
| interface строка |
| Тип URL конечной точки для получения из каталога служб. Псевдонимы: endpoint_type |
| key_name - | Имя пары ключей, которые необходимо использовать при создании экземпляра | |
| meta - | Список пар ключ-значение, которые должны быть предоставлены в качестве метаданных новому экземпляру или строка, содержащая список пар ключ-значение. Пример: meta: "key1=value1,key2=value2" | |
| name - / обязательно | Имя, которое необходимо присвоить экземпляру. Также можно указать ID экземпляра вместо его имени, если state равен absent. | |
| network - | Имя или ID сети, к которой следует подключить этот экземпляр. Более простой вариант параметра nics, только один из network или nics должен быть предоставлен. | |
| nics - | Список сетей, к которым следует подключить интерфейс экземпляра. К сетям можно обращаться по net-id/net-name/port-id или port-name. Также это принимает строку, содержащую список (net/port)-(id/name). Пример: nics: "net-id=uuid-1,port-name=myport" Только один из network или nics должен быть предоставлен. | |
| region_name строка | Имя региона. | |
| reuse_ips булево |
| Когда auto_ip имеет значение true, а этот параметр имеет значение true, код auto_ip попытается повторно использовать неназначенные плавающие IP-адреса в проекте перед созданием нового. Важно отметить, что это невозможно безопасно выполнить одновременно, поэтому, если ваш сценарий предполагает одновременное создание серверов, настоятельно рекомендуется установить это значение в false и удалить плавающий IP-адрес, связанный с сервером, при удалении сервера с помощью delete_fip. |
| scheduler_hints - | Произвольные пары ключ/значение для планировщика для пользовательского использования | |
| security_groups - | Имена групп безопасности, к которым необходимо добавить экземпляр. Это может быть список YAML или строка, разделённая запятыми. | |
| state - |
| Должен ли ресурс быть присутствующим или отсутствовать. |
| terminate_volume булево |
| Если yes, удалить том при удалении экземпляра (если загружен с тома) |
| timeout целое число | Значение по умолчанию: 180 | Время ожидания модулем, пока экземпляр не перейдет в активное состояние. |
| userdata - | Непрозрачный фрагмент данных, доступный экземпляру. | |
| validate_certs логический тип |
| Нужно ли проверять запросы API SSL. До Ansible 2.3 по умолчанию было yes. псевдонимы: verify |
| volume_size - | Размер создаваемого тома в ГБ, если загрузка выполняется из тома на основе образа. | |
| volumes - | Значение по умолчанию: [] | Список имен или идентификаторов существующих томов для подключения к экземпляру. |
| wait логический тип |
| Нужно ли ждать создания экземпляра модулем. |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явных значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Create a new instance and attaches to a network and passes metadata to the instance
os_server:
state: present
auth:
auth_url: https://identity.example.com
username: admin
password: admin
project_name: admin
name: vm1
image: 4f905f38-e52a-43d2-b6ec-754a13ffb529
key_name: ansible_key
timeout: 200
flavor: 4
nics:
- net-id: 34605f38-e52a-25d2-b6ec-754a13ffb723
- net-name: another_network
meta:
hostname: test1
group: uge_master
# Create a new instance in HP Cloud AE1 region availability zone az2 and
# automatically assigns a floating IP
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
state: present
auth:
auth_url: https://identity.example.com
username: username
password: Equality7-2521
project_name: username-project1
name: vm1
region_name: region-b.geo-1
availability_zone: az2
image: 9302692b-b787-4b52-a3a6-daebb79cb498
key_name: test
timeout: 200
flavor: 101
security_groups: default
auto_ip: yes
# Create a new instance in named cloud mordred availability zone az2
# and assigns a pre-known floating IP
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
state: present
cloud: mordred
name: vm1
availability_zone: az2
image: 9302692b-b787-4b52-a3a6-daebb79cb498
key_name: test
timeout: 200
flavor: 101
floating_ips:
- 12.34.56.79
# Create a new instance with 4G of RAM on Ubuntu Trusty, ignoring
# deprecated images
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
name: vm1
state: present
cloud: mordred
region_name: region-b.geo-1
image: Ubuntu Server 14.04
image_exclude: deprecated
flavor_ram: 4096
# Create a new instance with 4G of RAM on Ubuntu Trusty on a Performance node
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
name: vm1
cloud: rax-dfw
state: present
image: Ubuntu 14.04 LTS (Trusty Tahr) (PVHVM)
flavor_ram: 4096
flavor_include: Performance
# Creates a new instance and attaches to multiple network
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance with a string
os_server:
auth:
auth_url: https://identity.example.com
username: admin
password: admin
project_name: admin
name: vm1
image: 4f905f38-e52a-43d2-b6ec-754a13ffb529
key_name: ansible_key
timeout: 200
flavor: 4
nics: "net-id=4cb08b20-62fe-11e5-9d70-feff819cdc9f,net-id=542f0430-62fe-11e5-9d70-feff819cdc9f..."
- name: Creates a new instance and attaches to a network and passes metadata to the instance
os_server:
state: present
auth:
auth_url: https://identity.example.com
username: admin
password: admin
project_name: admin
name: vm1
image: 4f905f38-e52a-43d2-b6ec-754a13ffb529
key_name: ansible_key
timeout: 200
flavor: 4
nics:
- net-id: 34605f38-e52a-25d2-b6ec-754a13ffb723
- net-name: another_network
meta: "hostname=test1,group=uge_master"
- name: Creates a new instance and attaches to a specific network
os_server:
state: present
auth:
auth_url: https://identity.example.com
username: admin
password: admin
project_name: admin
name: vm1
image: 4f905f38-e52a-43d2-b6ec-754a13ffb529
key_name: ansible_key
timeout: 200
flavor: 4
network: another_network
# Create a new instance with 4G of RAM on a 75G Ubuntu Trusty volume
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
name: vm1
state: present
cloud: mordred
region_name: ams01
image: Ubuntu Server 14.04
flavor_ram: 4096
boot_from_volume: True
volume_size: 75
# Creates a new instance with 2 volumes attached
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
name: vm1
state: present
cloud: mordred
region_name: ams01
image: Ubuntu Server 14.04
flavor_ram: 4096
volumes:
- photos
- music
# Creates a new instance with provisioning userdata using Cloud-Init
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
name: vm1
state: present
image: "Ubuntu Server 14.04"
flavor: "P-1"
network: "Production"
userdata: |
#cloud-config
chpasswd:
list: |
ubuntu:{{ default_password }}
expire: False
packages:
- ansible
package_upgrade: true
# Creates a new instance with provisioning userdata using Bash Scripts
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
name: vm1
state: present
image: "Ubuntu Server 14.04"
flavor: "P-1"
network: "Production"
userdata: |
{%- raw -%}#!/bin/bash
echo " up ip route add 10.0.0.0/8 via {% endraw -%}{{ intra_router }}{%- raw -%}" >> /etc/network/interfaces.d/eth0.conf
echo " down ip route del 10.0.0.0/8" >> /etc/network/interfaces.d/eth0.conf
ifdown eth0 && ifup eth0
{% endraw %}
# Create a new instance with server group for (anti-)affinity
# server group ID is returned from os_server_group module.
- name: launch a compute instance
hosts: localhost
tasks:
- name: launch an instance
os_server:
state: present
name: vm1
image: 4f905f38-e52a-43d2-b6ec-754a13ffb529
flavor: 4
scheduler_hints:
group: f5c8c61a-9230-400a-8ed2-3b023c190a7f
# Deletes an instance via its ID
- name: remove an instance
hosts: localhost
tasks:
- name: remove an instance
os_server:
name: abcdef01-2345-6789-0abc-def0123456789
state: absent
Статус
- Отсутствие гарантии обратной совместимости интерфейса модуля. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Monty Taylor (@emonty)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/os_server_module.html