cs_instance — Управляет экземплярами и виртуальными машинами на облаках Apache CloudStack.
Новое в версии 2.0.
Обзор
- Развертывание, запуск, обновление, масштабирование, перезапуск, восстановление, остановка и удаление экземпляров.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account | Аккаунт, к которому относится экземпляр. | |
| affinity_groups | Имена групп affinity, которые должны быть применены к новому экземпляру. псевдонимы: affinity_group | |
| api_http_method |
| Метод HTTP, используемый для запроса к API-точке. Если не указано, используется переменная среды CLOUDSTACK_METHOD. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию — get при отсутствии. |
| api_key | API-ключ API CloudStack. Если не указано, используется переменная среды CLOUDSTACK_KEY. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. | |
| api_region | По умолчанию: "cloudstack" | Имя раздела ini в файле cloustack.ini. Если не указано, используется переменная среды CLOUDSTACK_REGION. |
| api_secret | Секретный ключ API CloudStack. Если не задан, используется переменная среды CLOUDSTACK_SECRET. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. | |
| api_timeout | Таймаут HTTP в секундах. Если не указано, используется переменная среды CLOUDSTACK_TIMEOUT. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. Значение по умолчанию — 10 секунд при отсутствии. | |
| api_url | URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется переменная среды CLOUDSTACK_ENDPOINT. В качестве последнего варианта используется значение из файла конфигурации ini, см. также примечания. | |
| cpu | Количество ЦП, которое необходимо выделить экземпляру, используется с настраиваемыми предложениями услуг. | |
| cpu_speed | Частота тактов/доли, выделенные экземпляру, используется с настраиваемыми предложениями услуг. | |
| details (добавлен в 2.6) | Карта для указания пользовательских параметров. | |
| disk_offering | Имя предложения диска, которое необходимо использовать. | |
| disk_size | Размер диска в ГБ, необходимый при развертывании экземпляра из ISO. | |
| display_name | Пользовательское имя отображения экземпляров. Имя отображения будет установлено в name, если не указано.Требуется либо name, либо display_name. | |
| domain | Домен, к которому относится экземпляр. | |
| force bool |
| Принудительно остановить/запустить экземпляр, если требуется применить изменения, иначе работающий экземпляр не будет изменён. |
| group | Группа, в которой должен находиться новый экземпляр. | |
| host (добавлен в 2.6) | Хост, на котором должен быть развернут или запущен экземпляр. Учитывается только при state=started или экземпляр работает. Требуются права администратора root. | |
| hypervisor |
| Имя гипервизора, который нужно использовать для создания нового экземпляра. Актуально при использовании state=present, но учитывается только если не указано в ISO/шаблоне. Если не указано или не найдено в ISO/шаблоне, используется первый найденный гипервизор. |
| ip6_address | IPv6-адрес для сети экземпляра по умолчанию. | |
| ip_address | IPv4-адрес для сети экземпляра по умолчанию при создании. | |
| ip_to_networks | Список сопоставлений в формате {'network': ИмяСети, 'ip': 1.2.3.4}
Взаимоисключающий с параметром networks. псевдонимы: ip_to_network | |
| iso | Имя или идентификатор ISO, который необходимо использовать для создания нового экземпляра. Требуется при использовании state=present. Взаимоисключающий с параметром template. | |
| keyboard |
| Тип устройства клавиатуры для экземпляра. |
| memory | Память, выделенная экземпляру, используется с настраиваемыми предложениями услуг. | |
| name | Имя хоста экземпляра. name может содержать только буквы ASCII.Имя будет сгенерировано (UUID) CloudStack, если не указано, и его нельзя изменить после этого. Требуется либо name, либо display_name. | |
| networks | Список сетей для использования новым экземпляром. псевдонимы: network | |
| poll_async bool |
| Проверять асинхронные задачи, пока задача не завершена. |
| project | Имя проекта, в котором должен быть развернут экземпляр. | |
| root_disk_size | Размер корневого диска в ГБ, необходимый при развертывании экземпляра с гипервизором KVM и желании изменить размер корневого диска при запуске (требуется CloudStack >= 4.4, cloud-initramfs-growroot установлен и включен в шаблоне). | |
| security_groups | Список групп безопасности, которые должны быть применены к экземпляру. псевдонимы: security_group | |
| service_offering | Имя или идентификатор предложения услуг нового экземпляра. Если не задано, используется первое найденное предложение услуг. | |
| ssh_key | Имя SSH-ключа, который необходимо развернуть на новом экземпляре. | |
| state |
| Состояние экземпляра. |
| tags | Список тегов. Теги — список словарей с ключами key и value. Если вы хотите удалить все теги, задайте пустой список, например, tags: []. псевдонимы: tag | |
| template | Имя, текст отображения или идентификатор шаблона, который необходимо использовать для создания нового экземпляра. Требуется при использовании state=present. Взаимоисключающий с параметром ISO. | |
| template_filter (добавлен в 2.1) |
| Имя фильтра, используемого для поиска шаблона или iso. Используется для параметров iso или template при state=present.Фильтр all был добавлен в 2.6.псевдонимы: iso_filter |
| user_data | Дополнительные данные (ASCII), которые можно отправить экземпляру после успешного развертывания. Данные будут автоматически закодированы в base64. Рассмотрите переключение на HTTP_POST, используя CLOUDSTACK_METHOD=post, чтобы увеличить лимит размера HTTP_GET с 2 КБ до 32 КБ. | |
| zone | Имя зоны, в которой должен быть развернут экземпляр. Если не задано, используется зона по умолчанию. |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
csесли учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких мест в следующем порядке.CLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTпеременные среды.CLOUDSTACK_CONFIGпеременная среды, указывающая на файл.ini. Файлcloudstack.iniв текущем рабочем каталоге. Файл.cloudstack.iniв домашнем каталоге пользователя. Дополнительно можно указать несколько учетных данных и конечных точек, используя разделы ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, раздел по умолчанию —cloudstack. Более подробную информацию см. на странице https://github.com/exoscale/cs. - Подробное руководство по модулям CloudStack можно найти в Руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
# NOTE: Names of offerings and ISOs depending on the CloudStack configuration.
- name: create a instance from an ISO
cs_instance:
name: web-vm-1
iso: Linux Debian 7 64-bit
hypervisor: VMware
project: Integration
zone: ch-zrh-ix-01
service_offering: 1cpu_1gb
disk_offering: PerfPlus Storage
disk_size: 20
networks:
- Server Integration
- Sync Integration
- Storage Integration
delegate_to: localhost
- name: for changing a running instance, use the 'force' parameter
- cs_instance:
name: web-vm-1
display_name: web-vm-01.example.com
iso: Linux Debian 7 64-bit
service_offering: 2cpu_2gb
force: yes
delegate_to: localhost
# NOTE: user_data can be used to kickstart the instance using cloud-init yaml config.
- name: create or update a instance on Exoscale's public cloud using display_name.
cs_instance:
display_name: web-vm-1
template: Linux Debian 7 64-bit
service_offering: Tiny
ssh_key: john@example.com
tags:
- key: admin
value: john
- key: foo
value: bar
user_data: |
#cloud-config
packages:
- nginx
delegate_to: localhost
- name: create an instance with multiple interfaces specifying the IP addresses
cs_instance:
name: web-vm-1
template: Linux Debian 7 64-bit
service_offering: Tiny
ip_to_networks:
- network: NetworkA
ip: 10.1.1.1
- network: NetworkB
ip: 192.0.2.1
delegate_to: localhost
- name: ensure an instance is stopped
cs_instance:
name: web-vm-1
state: stopped
delegate_to: localhost
- name: ensure an instance is running
cs_instance:
name: web-vm-1
state: started
delegate_to: localhost
- name: remove an instance
cs_instance:
name: web-vm-1
state: absent
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
| account строка | успех | Учетная запись, с которой связан экземпляр. Пример: example account |
| affinity_groups список | успех | Группы соответствия, в которых находится экземпляр. Пример: [ "webservers" ] |
| created строка | успех | Дата создания экземпляра. Пример: 2014-12-01T14:57:57+0100 |
| default_ip строка | успех | IP-адрес экземпляра по умолчанию. Пример: 10.23.37.42 |
| default_ip6 строка (добавлено в 2.6) | успех | IP-адрес IPv6 экземпляра по умолчанию. Пример: 2a04:c43:c00:a07:4b4:beff:fe00:74 |
| display_name строка | успех | Отображаемое имя экземпляра. Пример: web-01 |
| domain строка | успех | Домен, с которым связан экземпляр. Пример: example domain |
| group строка | успех | Имя группы, с которой связан экземпляр. Пример: web |
| host строка (добавлено в 2.6) | успех и экземпляр запущен | Имя хоста гипервизора, на котором запущен экземпляр. Пример: host-01.example.com |
| hypervisor строка | успех | Гипервизор, связанный с этим экземпляром. Пример: KVM |
| id строка | успех | UUID экземпляра. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| instance_name строка | успех | Внутреннее имя экземпляра (только для администратора ROOT). Пример: i-44-3992-VM |
| iso строка | успех | Имя ISO, с которым был развернут экземпляр. Пример: Debian-8-64bit |
| name строка | успех | Имя экземпляра. Пример: web-01 |
| password строка | успех | Пароль экземпляра, если существует. Пример: Ge2oe7Do |
| password_enabled логическое | успех | Истина, если включена настройка пароля. Пример: True |
| project строка | успех | Имя проекта, с которым связан экземпляр. Пример: Production |
| public_ip строка | успех | Публичный IP-адрес с экземпляром через правило статического NAT. Пример: 1.2.3.4 |
| security_groups список | успех | Группы безопасности, в которых находится экземпляр. Пример: [ "default" ] |
| service_offering строка | успех | Имя предложения сервиса, которым обладает экземпляр. Пример: 2cpu_2gb |
| ssh_key строка | успех | Имя ключа SSH, развернутого на экземпляре. Пример: key@work |
| state строка | успех | Состояние экземпляра. Пример: Running |
| tags словарь | успех | Список тегов ресурсов, связанных с экземпляром. Пример: [ { "key": "foo", "value": "bar" } ] |
| template строка | успех | Имя шаблона, с которым был развернут экземпляр. Пример: Linux Debian 9 64-bit |
| template_display_text строка (добавлено в 2.6) | успех | Отображаемый текст шаблона, с которым был развернут экземпляр. Пример: Linux Debian 9 64-bit 200G Disk (2017-10-08-622866) |
| zone строка | успех | Имя зоны, в которой находится экземпляр. Пример: ch-gva-2 |
Статус
Этот модуль помечен как stableinterface, что означает, что сопровождающие этого модуля гарантируют, что не будет внесено никаких несовместимых с обратной совместимостью изменений интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Поддержка и техническое обслуживание модулей для получения дополнительной информации.
Чтобы получить список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- René Moser (@resmo)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/cs_instance_module.html