lxd_container – Управление контейнерами LXD
Новое в версии 2.2.
Обзор
- Управление контейнерами LXD
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| architecture - | Архитектура контейнера (например, "x86_64" или "i686"). См. https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1
| |
| client_cert - | По умолчанию: "\"{}/.config/lxc/client.crt\" .format(os.environ[\"HOME\"])" | Путь к файлу сертификата клиента. Псевдонимы: cert_file |
| client_key - | По умолчанию: "\"{}/.config/lxc/client.key\" .format(os.environ[\"HOME\"])" | Путь к файлу закрытого ключа сертификата клиента. Псевдонимы: key_file |
| 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 boolean |
| Является ли контейнер временным (например, true или false). См. https://github.com/lxc/lxd/blob/master/doc/rest-api.md#post-1
|
| force_stop boolean |
| Если это значение true, то при остановке или перезапуске контейнера lxd_container принудительно останавливает его. |
| name - / обязательно | Имя контейнера. | |
| snap_url - добавлен в 2.8 | По умолчанию: "unix:/var/snap/lxd/common/lxd/unix.socket" | Путь к сокету Unix-домена, когда LXD установлен с помощью менеджера пакетов snap. |
| 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 для полной документации API. Обратите внимание, что protocol принимает два варианта: lxd или simplestreams
| |
| state - |
| Определите состояние контейнера. |
| 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-адрес сервера LXD. |
| wait_for_ipv4_addresses boolean |
| Если это значение true, lxd_container ожидает установки IPv4-адресов на всех сетевых интерфейсах контейнера после запуска или перезапуска. |
Примечания
Примечание
- Контейнеры должны иметь уникальное имя. Если вы попытаетесь создать контейнер с именем, которое уже существует в пространстве имен пользователя, модуль просто вернет "без изменений".
- Существует два способа запуска команд в контейнерах: с помощью модуля command или с помощью плагина подключения Ansible lxd, включенного в Ansible >= 2.1. Последний требует установленного Python в контейнере, что можно сделать с помощью модуля command.
- Вы можете скопировать файл с хоста в контейнер с помощью модулей Ansible copy и template и плагина подключения
lxd. См. пример ниже. - Вы можете скопировать файл из созданного контейнера на локальный хост с помощью
command=lxc file pull container_name/dir/filename filename. См. первый пример ниже.
Примеры
# 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 # if you get a 404, try setting protocol: simplestreams
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 creating an Ubuntu 14.04 container using an image fingerprint.
# This requires changing 'server' and 'protocol' key values, replacing the
# 'alias' key with with 'fingerprint' and supplying an appropriate value that
# matches the container image you wish to use.
- hosts: localhost
connection: local
tasks:
- name: Create a started container
lxd_container:
name: mycontainer
state: started
source:
type: image
mode: pull
# Provides current (and older) Ubuntu images with listed fingerprints
server: https://cloud-images.ubuntu.com/releases
# Protocol used by 'ubuntu' remote (as shown by 'lxc remote list')
protocol: simplestreams
# This provides an Ubuntu 14.04 LTS amd64 image from 20150814.
fingerprint: e9a8bdfab6dc
profiles: ["default"]
wait_for_ipv4_addresses: true
timeout: 600
# 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 client_cert and client_key values are equal to the default values.
#client_cert: "{{ lookup('env', 'HOME') }}/.config/lxc/client.crt"
#client_key: "{{ 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 список | успех | Список выполненных действий для контейнера. Пример: ["создание", "запуск"] |
| addresses словарь | при состоянии запущен или перезапущен | Сопоставление имени сетевого устройства со списком IPv4-адресов в контейнере Пример: {'eth0': ['10.155.92.191']} |
| logs список | при вызове ansible-playbook с -vvvv. | Журналы запросов и ответов. Пример: (слишком длинный, чтобы поместить здесь) |
| old_state строка | при состоянии запущен или перезапущен | Предыдущее состояние контейнера Пример: остановлен |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Hiroaki Nakamura (@hnakamur)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/lxd_container_module.html