Alterator/module/debug: различия между версиями

Текущая версия от 13:13, 30 марта 2011

Отладка модулей

Работа с модулем без установки в систему

Все компоненты alterator используют особые переменные среды для определения местоположения основных рабочих каталогов:

Переменная	Значение по умолчанию	Описание
`ALTERATOR_LIBDIR`	`/usr/lib/alterator`	бэкенды и иные архитектурно-зависимые компоненты.
`ALTERATOR_DATADIR`	`/usr/share/alterator`	описания интерфейсов и иные архитектурно-независимые компоненты.
`ALTERATOR_DEBUG`		сигнализирует что система находится в режиме отладки

Для обоих переменных допустимо перечисление нескольких каталогов через двоеточие - в этом случае поиск производится последовательно в порядке указания имён. Например, если ALTERATOR_DATADIR="/a:/b", то файл ui.scm будет искаться сначала по адресу /a/ui.scm, а потом /b/ui.scm.

Для удобства использования у утилит командной строки alterator существует ключ '-l', который добавляет текущий каталог в начало списка в переменные ALTERATOR_LIBDIR и ALTERATOR_DATADIR.

Таким образом, находясь в модуле, можно отлаживать и запускать его не устанавливая в систему.

Интерфейс	Команда запуска
Командная строка	`alterator-cmdline -l <запрос>`
Графический интерфейс	`/usr/sbin/alterator-standalone -l <имя desktop-файла описания>`
Web-интерфейс	`/usr/sbin/configd -l`

В последнем варианте сервер configd не будет отцепляться от терминала и будет работать с локальными бэкендами и файлами шаблонов. Для старой системы шаблонов (template-*), дополнительно существует переменная ALTERATOR_HTMLDIR, которая модифицируется при использовании '-l' аналогично остальным переменным.

alterator-standalone следует запускать с указанием /usr/sbin, поскольку утилита consolehelper (/usr/bin/alterator-standalone ссылается на неё) изменяет состав переменных окружения.

Интерфейс командной строки

Утилита alterator-cmdline служит для выполнения запросов к бэкендам из интерфейса командой строки и может с успехом использоваться для написания скриптов. Параметр -l позволяет работать с локальными бэкендами, а параметр -k указывает выводить значения конкретного параметра.

Пример:

# alterator-cmdline /users/stas action read

gecos:Stanislav I. Ievlev
home:/home/stas
shell:/bin/bash
allow_su:#t

# alterator-cmdline /users/stas action read -k home
/home/stas

#alterator-cmdline /net-eth action list 

name:eth0
label:eth0

name:eth1
label:eth1
# alterator-cmdline /net-eth action list -k name
eth0
eth1


# alterator-cmdline /openldap/config action read

daemon:#t
daemon_state:slapd is running
local:#t
enable_tls:#t
key_state:Certificate expire: 29.03.2012	20:45
# alterator-cmdline /openldap action save local '#t'
# alterator-cmdline /openldap/config action read

daemon:#t
daemon_state:slapd is running
local:#t
key_state:Certificate expire: 29.03.2012	20:45
# alterator-cmdline /openldap action save local_and_tls '#t'
# alterator-cmdline /openldap/config action read

daemon:#t
daemon_state:slapd is running
local:#t
enable_tls:#t
key_state:Certificate expire: 29.03.2012	20:45

Alterator modules

Alterator/module bugfix • Alterator/module delete • Alterator/module new • Alterator/module transform • Alterator/module/backend • Alterator/module/debug • Alterator/module/first • Alterator/module/interface • Alterator/module/structure • Alterator/module/testing • Alterator/todo • Alterator/module/types

@@ Строка 1: / Строка 1: @@
-[[Category:Sisyphus]]
+<onlyinclude>
-{{MovedFromFreesourceInfo|AltLinux/Sisyphus/Alterator/module/debug}}
 === Отладка модулей ===
@@ Строка 7: / Строка 5: @@
 Все компоненты alterator используют особые переменные среды для определения местоположения основных рабочих каталогов:
-{| border="1" cellspacing="0"
+{| class="standard"
-!переменная
+!Переменная
-!значение по умолчанию
+!Значение по умолчанию
-!описание
+!Описание
 |-
+|<tt>ALTERATOR_LIBDIR</tt>
+|<tt>/usr/lib/alterator</tt>
-|ALTERATOR_LIBDIR
+|бэкенды и иные архитектурно-зависимые компоненты.
-|/usr/lib/alterator
-|бакенды и иные архитектурно-зависимые компоненты. Значение по умолчанию - ''/usr/lib/alterator''
 |-
+|<tt>ALTERATOR_DATADIR</tt>
-|ALTERATOR_DATADIR
+|<tt>/usr/share/alterator</tt>
-|/usr/share/alterator
 |описания интерфейсов и иные архитектурно-независимые компоненты.
 |-
+|<tt>ALTERATOR_DEBUG</tt>
+|
+|сигнализирует что система находится в режиме отладки
 |}
@@ Строка 31: / Строка 28: @@
 Таким образом, находясь в модуле, можно отлаживать и запускать его не устанавливая в систему.
-* '''командная строка''': ''alterator-cmdline -l <запрос>''
+{| class="standard"
-* '''GUI интерфейс''': ''/usr/sbin/alterator-standalone -l <имя>''
+!Интерфейс
-* '''HTML интерфейс''': ''/usr/sbin/configd -l''
+!Команда запуска
+|-
+|Командная строка
+|<tt>alterator-cmdline -l <запрос></tt>
+|-
+|Графический интерфейс
+|<tt>/usr/sbin/alterator-standalone -l <имя desktop-файла описания></tt>
+|-
+|Web-интерфейс
+|<tt>/usr/sbin/configd -l</tt>
+|-
+|}
-Во последнем варианте сервер configd не будет отцепляться от терминала и будет работать с локальными бакендами и файлами шаблонов. Для старой системы шаблонов (template-*), дополнительно существует переменная '''ALTERATOR_HTMLDIR''', которая модифицируется при использовании '-l' аналогично остальным переменным.
+В последнем варианте сервер configd не будет отцепляться от терминала и будет работать с локальными бэкендами и файлами шаблонов. Для старой системы шаблонов (template-*), дополнительно существует переменная '''ALTERATOR_HTMLDIR''', которая модифицируется при использовании '-l' аналогично остальным переменным.
-alterator-standalone лучше всего запускать с указанием /usr/sbin, поскольку утилита consolehelper (/usr/bin/alterator-standalone ссылается на неё) может менять состав переменных окружения.
+alterator-standalone '''следует запускать''' с указанием /usr/sbin, поскольку утилита consolehelper (/usr/bin/alterator-standalone ссылается на неё) изменяет состав переменных окружения.
-Обратите также внимание на то, что с локальными desktop-файлами будет работать только alterator-standalone. Поэтому при создании нового модуля вы не увидите его в общем меню центра управления.
 ==== Интерфейс командной строки ====
-Утилита alterator-cmdline служит для выполнения запросов к бакендам из интерфейса командой строки и может с успехом использоваться для написания скриптов. Параметр -l позволяет работать с локальными бакендами, а параметр -k указывает выводить значения конкретного параметра.
+Утилита alterator-cmdline служит для выполнения запросов к бэкендам из интерфейса командой строки и может с успехом использоваться для написания скриптов. Параметр -l позволяет работать с локальными бэкендами, а параметр -k указывает выводить значения конкретного параметра.
 Пример:
@@ Строка 64: / Строка 70: @@
 # alterator-cmdline /net-eth action list -k name
 eth0
-eth1</pre>
+eth1
+# alterator-cmdline /openldap/config action read
+daemon:#t
+daemon_state:slapd is running
+local:#t
+enable_tls:#t
+key_state:Certificate expire: 29.03.2012	20:45
+# alterator-cmdline /openldap action save local '#t'
+# alterator-cmdline /openldap/config action read
+daemon:#t
+daemon_state:slapd is running
+local:#t
+key_state:Certificate expire: 29.03.2012	20:45
+# alterator-cmdline /openldap action save local_and_tls '#t'
+# alterator-cmdline /openldap/config action read
+daemon:#t
+daemon_state:slapd is running
+local:#t
+enable_tls:#t
+key_state:Certificate expire: 29.03.2012	20:45
+</pre>
+</onlyinclude>
+{{Alterator modules-nav}}