НАЗВА¶

ОПИС¶

Основні кроки:

• Встановити вимоги.
• Збирання, з коду зі сховища git або з архіву з кодом.
• Виконати тестування.
• Запуск засобів з каталогу з початковим кодом або встановлення.

ВИМОГИ¶

 dnf builddep libguestfs
 dnf install autoconf automake libtool gettext-devel

 yum-builddep libguestfs
 yum install autoconf automake libtool gettext-devel

 apt-get build-dep libguestfs
 apt-get install autoconf automake libtool-bin gettext

ЗБИРАННЯ ІЗ GIT¶

 git clone https://github.com/libguestfs/libguestfs
 cd libguestfs
 ./autogen.sh
 make

ЗБИРАННЯ ІЗ АРХІВІВ TAR¶

Отримайте і розпакуйте архів.

 cd libguestfs-1.xx.yy
 ./configure
 make

ТЕСТУВАННЯ¶

Для перевірки, чи працюватиме збирання, віддайте таку команду:

 make quickcheck

Щоб запустити основні тести, віддайте таку команду:

 make check

Існує доволі багато інших тестів, які ви можете запустити. Опис цих тестів наведено у підручнику з guestfs-hacking(1).

ВСТАНОВЛЕННЯ¶

Пакувальники дистрибутивів можуть скористатися ось цим:

 make INSTALLDIRS=vendor DESTDIR=[temp-build-dir] install

СКРИПТ ./run¶

Приклад:

 ./run guestfish [звичайні аргументи guestfish ...]

 ./run virt-inspector [звичайні аргументи virt-inspector ...]

Скрипт ./run додає усі виконувані файли libguestfs до $PATH, отже у наведених вище прикладах guestfish і virt-inspector запускаються із каталогу збирання (не із загального каталогу встановленого guestfish, якщо такий існує).

Ви можете скористатися скриптом з будь-якого каталогу. Якщо вам потрібно запустити вашу програму, яка використовує libguestfs, має спрацювати така команда:

 /шлях/до/libguestfs/run ./ваша_програма [...]

Також можна запускати програми C під керуванням valgrind ось так:

 ./run valgrind [параметри valgrind...] virt-cat [параметри virt-cat...]

або у gdb:

 ./run gdb --аргументи virt-cat [параметри virt-cat...]

Це також працює із sudo (наприклад, якщо вам потрібен адміністративний доступ для libvirt або для доступу до блокового пристрою):

 sudo ./run virt-cat -d LinuxGuest /etc/passwd

Для встановлення значення змінних середовища ви можете скористатися або цим:

 LIBGUESTFS_HV=/my/qemu ./run guestfish

або:

 ./run env LIBGUESTFS_HV=/my/qemu guestfish

ФАЙЛИ local*¶

Можна створити файл із назвою localconfigure, який буде простою обгорткою autogen.sh, яка міститиме локальні зміни у налаштуваннях. Його вміст виглядатиме так:

 . localenv
 ./autogen.sh \
     -C \
     --enable-werror \
     "$@"

Далі, ви зможете скористатися цим файлом для збирання libguestfs:

 ./localconfigure && make

Якщо у кореневому каталозі збирання буде файл із назвою localenv, "make" обробить його вміст. У цьому файлі можуть міститися усі потрібні змінні середовища, наприклад змінні для пропускання тестів:

 # Використовувати інший інтерпретатор python.
 export PYTHON=python3
 # Пропустити цю перевірку, вона не працює.
 export SKIP_TEST_BTRFS_FSCK=1

Зауважте, що localenv включається до Makefile верхнього рівня (стає частиною Makefile). Але, якщо цей файл обробляється також вашим скриптом localconfigure, його буде використано як скрипт оболонки.

ВИБРАНІ ПАРАМЕТРИ ./configure¶

 ./configure --help

показує список усіх цих параметрів. У цьому розділі наведено лише найважливіші з них.

--disable-appliance --disable-daemon

Див. "ВИКОРИСТАННЯ ПОПЕРЕДНЬО ЗІБРАНОЇ БІНАРНОЇ ОСНОВНОЇ СИСТЕМИ" нижче.

--disable-erlang

--disable-gobject

--disable-golang

--disable-haskell

--disable-lua

--disable-ocaml

--disable-perl

--disable-php

--disable-python

--disable-ruby

Вимкнути вказані прив'язки до мов, навіть якщо "./configure" знайде усі потрібні бібліотеки і ці прив'язки можна буде зібрати.

Зауважте, що вимикання OCaml (прив'язок) або Perl призведе до того, що буде вимкнено частину комплексу засобів тестування та деякі інструменти.

Для збирання libguestfs необхідний OCaml. Цю залежність не можна вилучити. Використання прапорця --disable-ocaml вимикає лише збирання прив'язок та інструментів мовою OCaml.

--disable-fuse

Вимкнути підтримку FUSE у програмному інтерфейсі і програмі guestmount(1).

--disable-gnulib-tests

На деяких платформах працездатність комплексу тестування GNUlib перебуває під сумнівом. За допомогою цього прапорця можна вимкнути комплекс тестування, оскільки помилки, на які вказує GNUlib, часто є несуттєвими.

--disable-static

Не збирати версії бібліотеки libguestfs зі статичною прив'язкою.

--enable-install-daemon

Зазвичай, guestfsd(8) не встановлюється "make install", оскільки ця фонова служба у основній системі непотрібна (вона корисна, лише коли її «встановлено» у базовій системі supermin). Втім, якщо пакувальники збирають «портативну версію libguestfs», їм слід скористатися цим параметром.

--enable-werror

За допомогою цього параметра можна перетворити попередження на помилки (тобто додати "-Werror"). Скористайтеся цим параметром для розробки, особливо, якщо надсилатимете латки. Загалом, цей параметр не слід використовувати для робочих або дистрибутивних збірок.

--with-default-backend=libvirt

Визначає типовий спосіб, у який libguestfs запускає qemu (див. "МОДУЛЬ" in guestfs(3)). Якщо не вказано, типовим модулем буде "direct", що означає, що libguestfs запускатиме qemu безпосередньо.

У Fedora і Red Hat Enterprise Linux (RHEL) ≥ 7 цим прапорцем можна скористатися для зміни типового модуля обробки на "libvirt", оскільки (особливо у RHEL) правила безпеки забороняють запуск qemu, інакше як за допомогою libvirt.

Зауважте, що незважаючи на цей параметр, у libguestfs збираються усі модулі обробки, і ви можете перевизначити модуль обробки під час запуску програм встановленням змінної середовища $LIBGUESTFS_BACKEND (або за допомогою програмних інтерфейсів).

--with-distro=REDHAT|DEBIAN|...

Libguestfs потребує відомостей, який дистрибутив Linux використовується, щоб бібліотека могла вибрати назви пакунків базової системи належним чином (див., наприклад, appliance/packagelist.in). Зазвичай, це завдання виконується автоматично.

Втім, якщо ви збираєте і пакуєте libguestfs у новому дистрибутиві, ви можете скористатися --with-distro, щоб вказати, що дистрибутив є подібним до наявного (наприклад, --with-distro=REDHAT, якщо дистрибутив є новою похідною від Red Hat або CentOS).

Зауважте, що якщо ваш дистрибутив є повністю новим, він може потребувати внесення змін до основної гілки коду бібліотеки.

--with-extra="назва_дистрибутива=версія,libvirt,..."

--with-extra="local"

Цей параметр визначає вміст поля «extra», яке повертає "guestfs_version" in guestfs(3), а також виводиться параметром --version засобів віртуалізації. Вміст цього поля є довільним, втім, слід записати до нього список відокремлених комами фактів, зокрема щодо назви і версії бібліотеки, те, чи libvirt є типовим модулем обробки, і взагалі усе, що може допомогти користувачам із діагностичними проблемами.

Для нетипових і/або локальних збірок можете встановити для цього параметра значення "local", щоб позначити, що це не дистрибутивна збірка.

--without-libvirt

Зібрати libguestfs без підтримки libvirt, навіть якщо буде виявлено встановлені бібліотеки для розробки libvirt.

--with-gtk=2

Цей параметр примусово визначає для virt-p2v збирання із Gtk 2, у конфігурації, яка у поточній версії є найкраще перевіреною.

--with-qemu="виконуваний файл1 виконуваний файл2 ..."

Визначає альтернативний виконуваний файл qemu (або список виконуваних файлів). Назву виконуваного файла можна змінити встановленням значення змінної середовища "LIBGUESTFS_HV".

--with-supermin-packager-config=yum.conf

Передає параметр --packager-config до supermin(1).

Найпоширенішим випадком використання цього параметра є збирання базової системи за допомогою альтернативного сховища пакунків (замість використання встановлених налаштувань yum, dnf, apt тощо для пошуку і отримання пакунків). Можливо, вам захочеться скористатися цим, якщо ви захочете зібрати libguestfs без використання з'єднання із мережею. Приклади використання цього параметра можна знайти у файлі "libguestfs.spec" для Fedora (див. "ЗБИРАННЯ ПАКУНКА ДЛЯ FEDORA" нижче, щоб дізнатися більше).

--with-supermin-extra-options="--парам1 --парам2 ..."

Передати додаткові параметри supermin(1). Див. appliance/make.sh.in, щоб зрозуміти, як саме це слід робити.

PYTHON

Цією змінною середовища можна скористатися для того, щоб вказати виконуваний файл python (наприклад, "python3"). Під час запуску "./configure" програма виконує визначення версії цього виконуваного файла Python, розташування бібліотек Python тощо. Див. "ЗБИРАННЯ ПРИВ'ЯЗОК ДО PYTHON 2 І PYTHON 3" нижче.

SUPERMIN

Цією змінною середовища можна скористатися для вибору альтернативного виконуваного файла supermin(1). Вона може пригодитися, якщо ви хочете скористатися новішою версією supermin, ніж та, яка є частиною пакунків вашого дистрибутива, або якщо у вашому дистрибутиві взагалі немає пакунка supermin. У RHEL 7 вам слід встановити "SUPERMIN=/usr/bin/supermin5" під час збирання libguestfs.

НОТАТКИ ЩОДО QEMU І KVM¶

У різних версіях qemu можуть із різних причин виникати проблеми із завантаженням базової системи. Проблеми залежать від версії qemu та дистрибутивів Linux, які можуть накладати на код пакунка різні латки.

Якщо вами буде виявлено проблему, ви можете спробувати скористатися власним зібраним із початкових кодів виконуваним файлом qemu (qemu дуже просто зібрати із початкових кодів) за допомогою «обгортки qemu». Див. "ОБГОРТКИ QEMU" in guestfs(3).

Типово, скрипт налаштовування шукатиме qemu-kvm (підтримку KVM). KVM є набагато швидшим за звичайний qemu.

Крім того, може виникнути потреба у вмиканні підтримки KVM для користувачів, відмінних від root. Слід скористатися цими настановами: http://www.linux-kvm.org/page/FAQ#How_can_I_use_kvm_with_a_non-privileged_user.3F

У деяких системах таке теж спрацює:

 chmod 0666 /dev/kvm

У деяких системах, де зміна режиму доступу не переживає перезавантаження системи, вам доведеться внести зміни до налаштувань udev.

ВИКОРИСТАННЯ CLANG (LLVM) ЗАМІСТЬ GCC¶

 export CC=clang
 ./configure
 make

ВИКОРИСТАННЯ ПОПЕРЕДНЬО ЗІБРАНОЇ БІНАРНОЇ ОСНОВНОЇ СИСТЕМИ¶

Якщо ви користуєтеся операційною системою, відмінною від Linux, або дистрибутивом Linux, у якому немає пакунка supermin(1), або просто не хочете збирати власну базову систему libguestfs, ви можете скористатися попередньо зібраними двійковими базовими системами, які ми постачаємо: http://libguestfs.org/download/binaries/appliance

Зберіть libguestfs ось таким чином:

 ./configure --disable-appliance --disable-daemon
 make

Встановіть для змінної $LIBGUESTFS_PATH значення шляху, до якого ви розпакували архів tar із базовою системою, ось так:

 export LIBGUESTFS_PATH=/usr/local/lib/guestfs/appliance

і запускайте програми libguestfs та засоби віртуалізації у звичайний спосіб, наприклад, за допомогою скрипту ./run (див. вище).

ЗБИРАННЯ ПРИВ’ЯЗОК ДО PYTHON 2 І PYTHON 3¶

Ви можете перевизначити цю поведінку, якщо вкажете альтернативний виконуваний файл Python. Приклад:

 PYTHON=/usr/bin/python3 ./configure

Щоб зібрати одночасно прив'язки до Python 2 і Python 3, вам доведеться збирати libguestfs двічі. Під час другого збирання ви можете вимкнути усі інші прив'язки та інструменти і зібрати лише прив'язки до Python. Із повним прикладом того, як це зробити, можна ознайомитися за допомогою файла spec з Fedora (див. нижче).

ЗБИРАННЯ ПАКУНКА ДЛЯ FEDORA¶

Libguestfs зібрано у Fedora за допомогою типової системи збирання Fedora (Koji).

ЗБИРАННЯ ПАКУНКА ДЛЯ RED HAT ENTERPRISE LINUX¶

• Вимикання багатьох можливостей, підтримку яких ми не хочемо здійснювати для користувачів RHEL. Наприклад, ми вимикаємо підтримку можливості «libguestfs live».
• Ми виконуємо зворотне портування можливостей основної версії.

Латки, які ми застосовуємо для випусків RHEL загально доступні у нашому основному сховищі коду git, гілка називається "rhel-x.y"

Наприклад, із латками для RHEL 7.3 можна ознайомитися тут: https://github.com/libguestfs/libguestfs/commits/rhel-7.3

Початкові коди і файли spec для версії libguestfs для RHEL можна знайти на сторінці https://git.centos.org/project/rpms. Також варто ознайомитися із вмістом сторінки https://wiki.centos.org/Sources.

ЗБИРАННЯ VIRT-P2V ДЛЯ 32-БІТОВОЇ АРХІТЕКТУРИ i686¶

Збирання 32-бітової версії виконуваного файла virt-p2v (i686) покращує сумісність із застарілим обладнанням. Докладніший опис наведено у підручнику з virt-p2v-make-disk(1). Хоча virt-p2v є простою програмою на основі Gtk, зібрати 32-бітову версію програми virt-p2v на 64-бітовій основній системі доволі непросто. Зазвичай, найпростішим способом є використання 32-бітової пісочниці chroot або навіть 32-бітової віртуальної машини для збирання libguestfs.

У Fedora ви можете скористатися інструментом mock(1). Приклад:

 fedpkg mockbuild --root fedora-23-i386

У результаті буде створено файл virt-v2v-*.i686.rpm, який можна розпакувати для видобування 32-бітового виконуваного файла virt-p2v.

Виконуваний файл може бути стиснуто у p2v/virt-p2v.i686.xz, $libdir/virt-p2v/virt-p2v.i686.xz або $VIRT_P2V_DATA_DIR/virt-p2v.i686.xz. Це вмикає параметр --arch virt-p2v-make-disk(1).

ТАКОЖ ПЕРЕГЛЯНЬТЕ¶

АВТОРИ¶

АВТОРСЬКІ ПРАВА¶

LICENSE¶

BUGS¶

To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools

When reporting a bug, please supply:

• The version of libguestfs.
• Where you got libguestfs (eg. which Linux distro, compiled from source, etc)
• Describe the bug accurately and give a way to reproduce it.
• Run libguestfs-test-tool(1) and paste the complete, unedited output into the bug report.