lxd_container - Управление контейнерами LXD
Новая версия 2.2.
Обзор
- Управление контейнерами LXD
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| architecture | нет | Архитектура контейнера (например, "x86_64" или "i686"). См. https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1
| ||
| cert_file | нет | "{}/.config/lxc/client.crt" .format(os.environ["HOME"]) | Путь к файлу сертификата клиента. | |
| config | нет | Настройки контейнера (например, {"limits.cpu": "2"}). См. https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1
Если контейнер уже существует и его значение "config" в метаданных, полученных из GET /1.0/containers/<name> https://github.com/lxc/lxd/blob/master/doc/rest-api.md#10containersname, отличаются, этот модуль пытается применить настройки. Ключи, начинающиеся с 'volatile.', игнорируются для этого сравнения. Не все значения config поддерживаются для применения к существующему контейнеру. Возможно, потребуется удалить и воссоздать контейнер. | ||
| devices | нет | Устройства для контейнера (например, { "rootfs": { "path": "/dev/kvm", "type": "unix-char" }). См. https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1
| ||
| ephemeral | нет | Является ли контейнер временным (например, true или false). См. https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1
| ||
| force_stop | нет | Если значение true, то lxd_container принудительно останавливает контейнер при его остановке или перезапуске. | ||
| key_file | нет | "{}/.config/lxc/client.key" .format(os.environ["HOME"]) | Путь к файлу ключа сертификата клиента. | |
| name | да | Имя контейнера. | ||
| source | нет | Источник контейнера (например, { "type": "image", "mode": "pull", "server": "https://images.linuxcontainers.org", "protocol": "lxd", "alias": "ubuntu/xenial/amd64" }). См. https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1
| ||
| state | нет | started |
| Определяет состояние контейнера. |
| timeout | нет | 30 | Таймаут изменения состояния контейнера. Также используется в качестве таймаута ожидания, пока IPv4 адреса не будут установлены для всех сетевых интерфейсов в контейнере после запуска или перезапуска. | |
| trust_password | нет | Защищенный пароль клиента. Необходимо установить этот пароль на сервере LXD перед запуском данного модуля, используя следующую команду. lxc config set core.trust_password <some random password> См. https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/
Если trust_password задан, этот модуль отправляет запрос для аутентификации перед отправкой любых запросов. | ||
| url | нет | unix:/var/lib/lxd/unix.socket | Путь к сокету доменной пары Unix или https URL сервера LXD. | |
| wait_for_ipv4_addresses | нет | Если значение true, то lxd_container ожидает, пока IPv4 адреса не будут установлены для всех сетевых интерфейсов в контейнере после запуска или перезапуска. |
Примеры
# An example for creating a Ubuntu container and install python
- hosts: localhost
connection: local
tasks:
- name: Create a started container
lxd_container:
name: mycontainer
state: started
source:
type: image
mode: pull
server: https://images.linuxcontainers.org
protocol: lxd
alias: ubuntu/xenial/amd64
profiles: ["default"]
wait_for_ipv4_addresses: true
timeout: 600
- name: check python is installed in container
delegate_to: mycontainer
raw: dpkg -s python
register: python_install_check
failed_when: python_install_check.rc not in [0, 1]
changed_when: false
- name: install python in container
delegate_to: mycontainer
raw: apt-get install -y python
when: python_install_check.rc == 1
# An example for deleting a container
- hosts: localhost
connection: local
tasks:
- name: Delete a container
lxd_container:
name: mycontainer
state: absent
# An example for restarting a container
- hosts: localhost
connection: local
tasks:
- name: Restart a container
lxd_container:
name: mycontainer
state: restarted
# An example for restarting a container using https to connect to the LXD server
- hosts: localhost
connection: local
tasks:
- name: Restart a container
lxd_container:
url: https://127.0.0.1:8443
# These cert_file and key_file values are equal to the default values.
#cert_file: "{{ lookup('env', 'HOME') }}/.config/lxc/client.crt"
#key_file: "{{ lookup('env', 'HOME') }}/.config/lxc/client.key"
trust_password: mypassword
name: mycontainer
state: restarted
# Note your container must be in the inventory for the below example.
#
# [containers]
# mycontainer ansible_connection=lxd
#
- hosts:
- mycontainer
tasks:
- name: copy /etc/hosts in the created container to localhost with name "mycontainer-hosts"
fetch:
src: /etc/hosts
dest: /tmp/mycontainer-hosts
flat: true
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| actions | Список выполненных действий для контейнера. | успех | список | ["create", "start"] |
| addresses | отображение имени сетевого устройства на список IPv4 адресов в контейнере | при state started или restarted | словарь | {'eth0': ['10.155.92.191']} |
| logs | Журналы запросов и ответов. | при вызове ansible-playbook с -vvvv. | список | (слишком длинный, чтобы быть помещен здесь) |
| old_state | Предыдущее состояние контейнера | при state started или restarted | строка | stopped |
Примечания
Примечание
- Контейнеры должны иметь уникальное имя. Если вы пытаетесь создать контейнер с именем, которое уже существует в пространстве имен пользователя, модуль просто вернет “неизменен”.
- Существует два способа выполнения команд в контейнерах: использование модуля command или использование плагина подключения ansible lxd, входящего в Ansible >= 2.1. Последний требует установки python в контейнер, что можно сделать с помощью модуля command.
- Вы можете копировать файлы с хоста в контейнер с помощью модулей Ansible copy и template и плагина подключения
lxd. См. пример ниже. - Вы можете скопировать файл из созданного контейнера на локальный компьютер с помощью
command=lxc file pull container_name/dir/filename filename. См. первый пример ниже.
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если у вас есть желание, прочитайте Информацию о сообществе и вкладе, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/lxd_container_module.html