Документация VMmanager 5 KVM

Конфигурационный файл

Параметры, пути директорий и опции, используемые панелью управления, записываются в конфигурационный файл. Конфигурационный файл по умолчанию расположен по пути: /usr/local/mgr5/etc/vmmgr.conf. Значения, указанные в нём можно изменить вручную.


Обратите внимание!

Для применения настроек после их изменения перезапустите панель управления с помощью команды:

/usr/local/mgr5/sbin/mgrctl -m vmmgr exit

Параметры


Синтаксис: каждый параметр указывается с новой строки в формате "Название параметра=Значение".

Просмотр списка параметров:

/usr/local/mgr5/sbin/mgrctl -m vmmgr paramlist

Группы параметров:

  • общие настройки панели управления;
  • резервное копирование;
  • настройки создания сети и сетевых интерфейсов;
  • создание виртуальных машин и установка ОС;
  • libvirt;
  • параметры, наследуемые от COREmanager.

Общие настройки панели управления

  • CephAuthUserName — имя пользователя, используемого для подключения к хранилищу Ceph. По умолчанию — "vmmgr";
  • DistRsyncMaxProc — количество одновременно запущенных процессов rsync (используется для синхронизации шаблонов ОС и ISO). По умолчанию — "3";
  • DBHost — адрес сервера с MySQL, на котором находится база данных VMmanager. По умолчанию — "localhost";
  • DBUser — пользователь базы данных VMmanager. По умолчанию — "vmmgr";
  • DBPassword — пароль пользователя базы данных, заданного параметром DBUser;
  • DBName — имя базы данных VMmanager. По умолчанию — "vmmgr";
  • MainIp — IP-адрес основного узла. Используется для создания NFS-хранилища;
  • NfsMountParam — параметры, с которыми будет монтироваться NFS-хранилище. По умолчанию — ''rsize=8192,wsize=8192,timeo=14,intr'';
  • NodeReservedMemPercent — количество зарезервированной памяти на узлах кластера. Указывается в процентах. По умолчанию — "0";
  • NoVncStartPort — начало диапазона портов для NoVnc. По умолчанию — "15900";
  • NoVncEndPort — конец диапазона для NoVnc. По умолчанию — "16900";
  • NoVncNextPort — порт, который будет выделен следующим для NoVnc;
  • OsTplDistributionMethod — метод синхронизации шаблонов ОС на узлах кластера (nfs, rsync, distrsync, manual). По умолчанию — "nfs";
  • OversellMemFactor — величина оверселлинга. По умолчанию — "100%";
  • RebootOnDemandTimer — длительность периода до автоматической перезагрузки виртуальных машин для применения изменений. По умолчанию — "86400 секунд";
  • RsyncBwLimit — ограничение используемого канала при синхронизации шаблонов. Значение указывается в КиБ/с;
  • sshAuthorizedKeysFile — путь к файлу authorized_keys. По умолчанию — ''/root/.ssh/authorized_keys'';
  • sshKnownHosts — путь к файлу known_host. По умолчанию — "<путь установки>/etc/known_host";
  • sshPublicKey — путь к публичному SSH-ключу. По умолчанию — "<путь установки>/etc/ssh_id_rsa.pub";
  • sshPrivatKey — путь к приватному SSH-ключу. По умолчанию — "<путь установки>/etc/ssh_id_rsa";
  • TempIpType — тип временного адреса IPv4, создаваемого при установке VM. По умолчанию — "public". Если параметр задан в конфигурационном файле, временный адрес IPv4 заданного типа будет выдаваться всегда на время установки/переустановки операционной системы;
  • UserIsoCountLimit — максимальное количество ISO-образов для конкретного пользователя. При создании пользователя, если не указано соответствующее ограничение, используется значение данного параметра;
  • UserIsoSizeLimit — максимальное значение  размера ISO-образов для конкретного пользователя. При создании пользователя, если не указано соответствующее ограничение, используется значение данного параметра;
  • VmCountHardLimit — абсолютное ограничение на количество виртуальных машин на узле кластера. По умолчанию — "unlimit";
  • VMminiPanelKey — хэшированное значение пароля для подключения к vmmini;
  • VncInterface — сетевой интерфейс, к которому будут подключаться VNC виртуальных машин. По умолчанию — "auto";
  • VmwatchListenIp — IP-адрес, на котором сервис vmwatch-master принимает сообщения;
  • VmwatchListenPort — порт, на котором сервис vmwatch-master принимает сообщения. По умолчанию — "1515".

Резервное копирование

  • BackupPriority — приоритет с которым будет запускаться процесс backupctl. Значение от -20 до 19, где -20 — самый высокий приоритет, а 19 — самый низкий. По умолчанию — "10";
  • BackupTimeout — таймаут на подготовку виртуальной машины в минутах. По умолчанию значение не ограничено;
  • LVMSnapshotSize — размер диска в процентах для снимков. По умолчанию — 100. Обращаем ваше внимание на то, что указание размера снимка менее 100% может привести к переполнению снимка и  невозможности записи на диск;
  • UserSnapshotLimit — ограничение на количество снимков виртуальной машины, которые может сделать пользователь. По умолчанию — "unlimit".

Настройки создания сети и сетевых интерфейсов

  • BridgePrefix — префикс, который будет предлагаться для создания сетевых мостов. По умолчанию — "vmbr";
  • DefaultIfaceName — имя основного сетевого интерфейса узла кластера. Используется в конфигурационном файле VMmini для сбора статистики. Если не задан, определяется автоматически с использованием утилиты "ip";
  • CollectTcStatistic — игнорировать отброшенные пакеты в статистике Управление → Виртуальные машины → Использование канала, если включено ограничение трафика ВМ. Используется в конфигурационном файле VMmini на нужном узле кластера. Если опции нет, то отброшенные пакеты будут учитываться в статистике. 

Создание виртуальных машин и установка ОС

  • CreateVmDisableNodeTimer — период исключения узла из списка доступных для автоматического размещения. Указывается в минутах. Если задан, то после создания VM на узле этот узел блокируется для автоматического размещения на заданное количество минут или до окончания установки VM. По умолчанию не задан;
  • DefaultRecipe — рецепт. устанавливающийся по умолчанию;
  • DomainDiskDriverCache — метод кэширования данных виртуальной машины в libvirt. Возможные значения: "none", "default", "writethrough", "writeback", "directsync", "unsafe";
  • GenMACPrefix — префикс генерируемых панелью управления MAC-адресов сетевых интерфейсов виртуальных машин. Два первых байта MAC-адреса в шестнадцатеричном представлении, разделённых двоеточием. По умолчанию — "52:54";
  • HTTPProxyv4 — HTTP-proxy для IPv4. Используется для кэширования пакетов при установке из шаблонов ОС;
  • HTTPProxyv6 — HTTP-proxy для IPv6. Используется для кэширования пакетов при установке из шаблонов ОС;
  • iSCSITargetDir — целевая директория для размещения дисков в iSCSI-хранилище. По умолчанию — "/iscsivolumes";
  • IsoCountLimit — максимальное количество ISO-образов для любого пользователя. По умолчанию — "0". Обратите внимание, что в панели управления можно выставить большее значение, однако применяться будет значение, указанное в конфигурационном файле;
  • IsoLifetime — количество часов, через которое будет удалён пользовательский ISO-образ. По умолчанию — "24";
  • IsoSizeLimit — максимальное значение размера ISO-образов для любого пользователя. По умолчанию — "0". Обратите внимание, что в панели управления можно выставить большее значение, однако применяться будет значение, указанное в конфигурационном файле;
  • ManagerMacId — уникальный идентификатор VMmanager для генерации MAC-адреса;
  • NextHopIPv4 — адрес IPv4, указываемый в качестве шлюза по умолчанию при установке операционной системы VM из шаблона;
  • NextHopIPv6 — адрес IPv6, указываемый в качестве шлюза по умолчанию при установке операционной системы VM из шаблона;
  • OsInstallAfterScript — путь к локальному скрипту, который будет выполнен после успешного завершения установки операционной системы;
  • OsInstallTimeZone — временная зона, передаваемая в макросах скрипту kickstart и рецептам для установки временной зоны в гостевой ОС в процессе установки. По умолчанию значение равно значению временной зоны хоста. Внутри скрипта (FreeBSD) или файла ответов (Debian/CentOS) скрипт будет доступен по ссылке из макроса $AFTER_INSTALL_SCRIPT_HTTPS.

Libvirt

  • LibVirtDebugLevel — уровень логирования libvirt. По умолчанию — "3". Самый полный лог — "1", минимальный — "4". Лог пишется в файл <путь установки>/var/libvirt.log;
  • LibvirtHooksDir — директория, в которой находятся хуки libvirt. По умолчанию — "/etc/libvirt/hooks";
  • LibvirtNcTimeout — таймаут простых (которые не связаны с копированием данных) операций libvirt. По умолчанию — "60";
  • LibvirtSockPath — путь, по которому находится сокет-файл libvirt. По умолчанию — "/var/run/libvirt/libvirt-sock".

Параметры, наследуемые от COREmanager

  • AuthenLifeTime — время жизни сессии. Сессия, в которой нет активности дольше, чем значение параметра, автоматически удаляется. Указывается в секундах. По умолчанию — "3600";
  • BuilderOnUpdateXml — путь к скрипту, который запускается при изменении XML файлов панели управления. Используется в режиме разработчика;
  • ConnectionLimit — количество одновременно обрабатываемых соединений. По умолчанию — "100";
  • DefaultAccessIp — ограничение IP-адресов для доступа к панели управления по умолчанию;
  • DefaultButtonView — вид кнопок в панели управления по умолчанию. По умолчанию — "buttontext":
    • buttontext — значки и текст.
  • DefaultHintView — способ отображения подсказок в панели управления по умолчанию. По умолчанию — "hintactive":
    • hintactive — отображение при фокусировке на подсказке;
    • hintpassive — отображение при наведении курсора на подсказку.
  • DefaultInterface — имя интерфейса, на который добавляются дополнительные IP-адреса по умолчанию;
  • DefaultLang — язык по умолчанию. Используется, если не удалось определить язык браузера или такой язык не поддерживается;
  • ExpireLogsDays — период хранения записей в журнале операций панели управления. Указывается в днях. По умолчанию — "365";
  • FileMaxEditSize — максимальный размер файла, который можно открыть в редакторе менеджера файлов. Указывается в КиБ. По умолчанию — "1024";
  • ForwardedSecret — ключ, который нужен для подстановки реального IP-адреса клиента при использовании проксирования. Подробнее см. в статье Настройка адреса панели управления;
  • FsEncoding — кодировка файловой системы для менеджера файлов. По умолчанию — "UTF-8";
  • InternalAdminName — логин администратора, от имени которого выполняются внутренние запросы панели управления;
  • LastLogin — условие отображения баннера с информацией о последнем входе в систему:
    • info — всегда показывать баннер;
    • warning — показывать баннер, только если адрес изменился;
    • none — не показывать баннер.
  • LicIp — IP-адрес лицензии;
  • LongRequest — предел времени выполнения запроса, после которого он записывается в специальный журнал долгих запросов var/<имя панели управления>.long.log. Указывается в секундах. По умолчанию — "300";
  • MailMode — тип почтового сервера для отправки почтовых уведомлений;
  • MakefileDir — путь к сборочной директории. Используется в режиме разработчика. По умолчанию — "src/builder";
  • OneTimeExpire — параметр ограничивает время действия временного ключа для авторизации. Ключ создаётся при помощи функции session.newkey. По умолчанию параметр имеет значение 3600 секунд и может принимать любое целочисленное значение. Например, чтобы уменьшить время действия ключа с 1 часа до 10 минут, установите значение параметра OneTimeExpire 600;
  • PWGenCharacters — набор символов, которые используются при автоматической генерации пароля. По умолчанию — "1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". Чтобы панель управления при генерации пароля использовала специальные символы (#, $, & и т.д.), добавьте нужные символы в значение параметра;
  • PWGenLen — длина пароля, который создаётся при автоматической генерации. По умолчанию — "8";
  • PWStrength — сложность проверки пароля. По умолчанию — "2":
    • 0 — не выполнять проверку;
    • 1 — разрешает использование слабых паролей (K = 3..6);
    • 2 — запрещает использование слабых паролей (K = 6..9);
    • 3 — разрешает только сложные пароли (K = 9..∞).
      Проверяется наличие пароля в словаре запрещённых паролей и вычисляется коэффициент его сложности (K) по формуле . N — общее количество символов. Nu — количество уникальных символов (с учётом регистра). Ns — количество специальных символов. Nr — количество букв, регистр которых отличается от предыдущей. Nc — количество идущих подряд символов одного типа (буквы, цифры, спецсимволы).

  • ProblemsAddressFrom — email отправителя уведомлений о проблемах по почте;

  • ProblemsAddressTo — email получателя уведомлений о проблемах по почте;

  • ProblemsEmailEnabled — опция отправления уведомлений о проблемах по почте. По умолчанию — "off":

    • on — включена;
    • off — выключена.
  • ProblemsKeepOld — период хранения уведомлений в панели управления. По умолчанию — "30";
  • ProblemsKeepSolved — период хранения решённых проблем в панели управления. По умолчанию — "7";
  • ProblemsLang — язык описания уведомлений о проблемах для отправки по почте;
  • ProblemsPeriod — период, через который осуществляются попытки решения проблемы в панели управления. Указывается в минутах. По умолчанию — "60";
  • ProblemsShowAll — опция отображения уведомлений о проблемах пользователей. По умолчанию — "off":
    • on — включена;
    • off — выключена.
  • ProblemsSmtpPort — порт SMTP-сервера для отправки уведомлений о проблемах по почте;
  • ProblemsSmtpServer — адрес SMTP-сервера для отправки уведомлений о проблемах по почте;
  • SMTPPass — пароль учётной записи пользователя SMTP-сервера для отправки почтовых уведомлений;
  • SMTPPort — порт SMTP-сервера для отправки почтовых уведомлений;
  • SMTPServer — адрес SMTP-сервера для отправки почтовых уведомлений;
  • SMTPUser — учётная запись пользователя SMTP-сервера для отправки почтовых уведомлений;
  • SenderName — имя отправителя, которое указывается в почтовых уведомлениях;
  • StartPage — стартовая страница по умолчанию;
  • XSLFOProc — параметры вызова внешнего FO-процессора.

Пути


Синтаксис: каждый параметр указывается с новой строки в формате "path Значение".

Просмотр списка путей:

/usr/local/mgr5/sbin/mgrctl -m vmmgr pathlist

Пути VMmanager

  • BackupTmpDir — директория для временных файлов системы резервного копирования. По умолчанию на мастер-узле — "var/.vmmgr-backup/tmp", на узле кластера — "/tmp". Обратите внимание: нельзя указывать одну и ту же директорию для remotetmp и для BackupTmpDir. Директория с временными файлами периодически очищается панелью. Не рекомендуется указывать в качестве директории для временных файлов директорию с важными данными;
  • ostemplatedir — директория, которая будет доступна по NFS на всех серверах. По умолчанию — "/nfsshare";
  • ostemplatesubdirlist — список подкаталогов репозитория шаблонов ОС (через ":"), в которых требуется выполнять поиск шаблонов;
  • recipedir — директория для хранения рецептов. По умолчанию — "/nfsshare/recipes/";
  • remotetmp — директория, в которой происходит конвертация qcow образа виртуальной машины в raw. По умолчанию — "/tmp". Обратите внимание: нельзя указывать одну и ту же директорию для remotetmp и для BackupTmpDir;
  • cmd_dd — путь к утилите "dd". По умолчанию — "dd". Используется в модулях резервного копирования, перемещения диска между хранилищами, копирования образа диска при установке. Для уменьшения нагрузки на дисковую подсистему можно указать путь с параметром ionice, например: "path cmd_dd ionice -c2 -n7 dd";
  • cmd_qemu-img — путь к утилите "qemu-img". По умолчанию — "qemu-img";
  • temppath — временная директория. По умолчанию — "/tmp".

Пути, наследуемые от COREmanager

  • ifconfig — утилита ifconfig. По умолчанию — "/sbin/ifconfig".

Опции


Синтаксис: каждая опция указывается с новой строки в формате "Option Значение".

Просмотр списка опций:

/usr/local/mgr5/sbin/mgrctl -m vmmgr optionlist

Опции VMmanager

  • BuildBridgesManually — отключение автоматического создания сетевых мостов и привязки мостов к внешним интерфейсам на узлах кластера;
  • DisableInstallQemuEvRepo — отключение добавления репозитория "centos-release-qemu-ev" перед установкой ПО на узел кластера (только для ОС CentOS 7);
  • DisableRebootOnDemand — отключение принудительной отложенной перезагрузки виртуальных машин, в конфигурацию которых были внесены изменения. Отложенная перезагрузка выполняется через сутки после внесения изменений при условии, что в течение этого периода машина не была перезагружена или остановлена из панели управления;
  • ExternalIpAllocation — отключение попыток выделить адрес в обход биллинга. Используется только при интеграции VMmanager с IPmanager и BILLManager;
  • IgnoreKVMHwSupport — добавление узла кластера, даже если на сервере не включена поддержка аппаратной виртуализации;
  • PeriodicFixIp — включение периодической проверки соответствия IP-адресов в файле конфигурации виртуальной машины и базе данных;
  • UserRecipes — разрешение доступа пользователям к редактированию рецептов. При указании опции пользователь получит доступ к списку рецептов, всем рецептам из репозитория и созданным администраторами на чтение, а также к созданию собственных рецептов, которые будут видны только ему;
  • UseOwnNetworkFilter — отключение создания правил для антиспуфинга;
  • VncSSL — включение SSL для VNC.

Опции, наследуемые от COREmanager

  • DisableAutoUpdate — опция отключения автоматического обновления панели управления;
  • DisableCookieSecure — отключить для cookies атрибут Secure. Чтобы получить доступ к панели управления по протоколу HTTP, добавьте эту опцию. По умолчанию её нет в конфигурационном файле;
  • DoNotRestoreTasks — опция отключения восстановления заданий планировщика cron. При включении опции панель управления не будет восстанавливать в планировщике необходимые задания при каждом её запуске;
  • EnableAcmeshDebug — при включении опции в файл /usr/local/mgr5/var/<имя_панели>_acme_sh.log пишется лог выпуска и обновления LE сертификатов. По умолчанию, опция отключена;

     Пояснения

    <имя_панели> — название панели управления:

    • ispmgr — ISPmanager;
    • billmgr — BILLmanager;
    • vmmgr — VMmanager KVM или Cloud;
    • vemgr — VMmanager OVZ;
    • dcimgr — DCImanager;
    • ipmgr — IPmanager;
    • dnsmgr — DNSmanager.
  • EULA — наличие опции подтверждает согласие пользователя с условиями Лицензионного соглашения на использование программного обеспечения ISPsystem;

  • FirstStart — наличие опции подтверждает, что первый вход в панель управления ещё не был выполнен. При первом входе пользователю предлагается пройти мастер начальной настройки;

  • IgnorePluginError — опция игнорирования ошибок при выполнении плагинов (если плагин не получилось запустить или он вернул неверный XML-документ). При наличии опции продолжится выполнение функции и в будет зарегистрировано уведомление об ошибке при работе плагина;

  • UsageStatAgree — опция отправки анонимных сведений об использовании функций панели и ошибок, которые при этом возникают. Значения полей форм или таблиц не относятся к таким сведениям. Полученная информация используется для улучшения продуктов ISPsystem.