AMC: различия между версиями
Мария (обсуждение | вклад) (Наполнение) |
Мария (обсуждение | вклад) |
||
(не показаны 4 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
[[Category:Sisyphus]] | [[Category:Sisyphus]] | ||
[[Category: | [[Category:Alterator_на_D-Bus]] | ||
{| style="border:1px solid #AAA; background:#F9F9F9; width:200px; margin: 0 0 1em 1em; padding:.2em; text-align:center; float: right;" class=noprint | {| style="border:1px solid #AAA; background:#F9F9F9; width:200px; margin: 0 0 1em 1em; padding:.2em; text-align:center; float: right;" class=noprint | ||
Строка 8: | Строка 8: | ||
| '''Данная страница находится в [[:Категория:Неоконченные страницы|разработке]]'''.<br /><small style="line-height:1.1em;">Эта страница ещё не закончена. Информация, представленная здесь, может оказаться неполной или неверной.</small> | | '''Данная страница находится в [[:Категория:Неоконченные страницы|разработке]]'''.<br /><small style="line-height:1.1em;">Эта страница ещё не закончена. Информация, представленная здесь, может оказаться неполной или неверной.</small> | ||
|} | |} | ||
< | <noinclude>[[Категория:Неоконченные страницы|{{PAGENAME}}]]</noinclude> | ||
'''AMC - Alterator Module Components''' | '''AMC - Alterator (Module) Components - alterator-components''' - приложение с графическим интерфейсом для управления наборами пакетов, называемых компонентами. | ||
=== Цель создания === | === Цель создания === | ||
AMC позволяет устанавливать и удалять | AMC позволяет устанавливать и удалять компоненты. | ||
Компонент представляет собой набор пакетов, предоставляющих определенную функциональность, и некоторую последовательность действий (deploy) для его конфигурации. AMC должен запускаться при первом запуске системы, но доступен всегда, т.е. набор установленных компонент можно поменять в любой момент. | |||
=== Назначение === | === Назначение === | ||
Приложение alterator-components предназначено для управления группами пакетов под названием компоненты. Использование компонент позволяет работать с функциональными подсистемами без необходимости самостоятельного поиска отдельных пакетов. Для работы достаточно выбрать желаемый компонент, после чего alterator-components установит недостающие пакеты или удалит избыточные. Приложение ориентировано на корпоративную инфраструктуру. | |||
Предназначен для: | Предназначен для: | ||
# | # Администраторов | ||
# | # Продвинутых пользователей | ||
Возможности программы: | |||
* Установка компонент. | |||
* Удаление компонент. | |||
* Проверка наличия компонент. | |||
=== Условия применения === | |||
Приложение Alterator Components может использоваться как на серверах, так и на рабочих станциях. Для корректной работы alterator-components требуется apt, сконфигурированный на работу с репозиториями, содержащими необходимые RPM-пакеты и доступ к этим репозиториям. | |||
= Установка = | = Установка = | ||
Для установки alterator | Для установки alterator-components из задания (таски), воспользуйтесь [https://packages.altlinux.org/ru/tasks/search/?q=alterator-application-components поиском]. | ||
Команды установки | |||
<pre> | |||
# apt-repo add <номер задания> | |||
# apt-get update | |||
# apt-get install alterator-application-components | |||
</pre> | |||
= Запуск = | |||
Вызов инструмента Alterator Components возможен через графическое меню либо через терминал. | |||
=== Через графическое окружение === | |||
# Запустить [[Alterator_Browser | Alterator Browser]] из меню приложений. | |||
# Ввести пароль учетной записи root. | |||
# Выбрать пункт '''Управление компонентами'''. | |||
=== Через терминал === | |||
Выполнить команду | |||
<pre> | |||
$ alterator-application-components | |||
</pre> | |||
[[Файл:Alterator-application-components.png|Внешний вид программы]] | |||
=== Интерфейс === | |||
Пользовательский интерфейс программы состоит из секций: | |||
* Компоненты - представлен список компонент по категориям. | |||
* Описание - выводится информация о компонентах. | |||
= Спецификация = | = Спецификация = | ||
Строка 28: | Строка 62: | ||
* [https://gitlab.basealt.space/alt/alterator-interface-component/-/blob/main/categories/README.md Реализация интерфейса component-categories]. | * [https://gitlab.basealt.space/alt/alterator-interface-component/-/blob/main/categories/README.md Реализация интерфейса component-categories]. | ||
* [https://gitlab.basealt.space/alt/alterator-entry/-/blob/kozyrevid/specification/doc/README.md#%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D1%8C-%D1%82%D0%B8%D0%BF%D0%B0-component Документация на Component]. | * [https://gitlab.basealt.space/alt/alterator-entry/-/blob/kozyrevid/specification/doc/README.md#%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D1%8C-%D1%82%D0%B8%D0%BF%D0%B0-component Документация на Component]. | ||
== Руководство пользователя == | |||
* Чтобы раскрыть список компонент в категории, необходимо нажать на её имя. | |||
* Чтобы увидеть информацию о компоненте, необходимо нажать на её имя. | |||
* Чтобы установить/удалить компоненту, необходимо установить/снять галочку рядом с именем компоненты. | |||
* Чтобы установить/удалить все компоненты из одной категории, необходимо установить/снять галочку рядом с именем категории. | |||
* Чтобы изменения вступили в силу, необходимо нажать Применить. | |||
* Чтобы отменить не примененные изменения, необходимо нажать Cбросить. | |||
== Руководство администратора == | |||
=== Создание компонент === | |||
Для создания компоненты необходимо сформировать три файла: | |||
* '''.backend''' | |||
* '''.component''' | |||
* '''описание''' | |||
==== Файлы .backend и .component ==== | |||
Файлы .backend и .component являются текстовыми и содержат описание в виде секций. Имеют следующий синтаксис: | |||
<pre> | |||
[имя секции1] | |||
Поле1 = значение | |||
Поле2 = значение | |||
ПолеN = значение | |||
[имя секции2] | |||
Поле1 = значение | |||
Поле2 = значение | |||
ПолеN = значение | |||
[имя секциN] | |||
Поле1 = значение | |||
Поле2 = значение | |||
ПолеN = значение | |||
</pre> | |||
===== Принятые правила написания ===== | |||
* все поля чувствительны к регистру и начинаются с большой буквы; | |||
* перед и после знака <code>=</code> пробелы; | |||
* значения полей указываются без кавычек; | |||
* значения могут содержать пробелы; | |||
* если строка начинается с <code>#</code>, то она считается комментарием и при чтении информации из файла игнорируется. | |||
==== Файл описания ==== | |||
Файл с описанием содержит информацию о компоненте и имеет синтаксис, соответствующий языку html. | |||
==== Создание категории ==== | |||
Категории компонент являются сущностями [https://gitlab.basealt.space/alt/alterator-entry/-/blob/specification/doc/README.md?ref_type=heads#введение Alterator Entry] и описываются файлами ''.category'' в каталоге '''/usr/share/alterator/components/'''. Имена этих файлов имеют формат '''<номер>-<имя>.category''', содержат секцию ''Alterator Entry'' и следующие параметры: | |||
* Type - тип сущности, всегда <code>Category</code>; | |||
* Name - | |||
* DisplayName - имя категории; | |||
* DisplayName[локаль] - имя категории, которое выводится с использованием указанной в скобках локали. | |||
===== Пример готового файла ===== | |||
<pre> | |||
[Alterator Entry] | |||
Type=Category | |||
Name=centaurus/20-server-apps | |||
DisplayName=Server applications | |||
DisplayName[ru_RU]=Серверные приложения | |||
</pre> | |||
==== Создание компоненты ==== | |||
Каждая компонента представлена следующими файлами: | |||
* /usr/share/alterator/backends/samba.backend | |||
* /usr/share/alterator/components/20-server-apps.category | |||
* /usr/share/alterator/components/centaurus/samba/description.html | |||
* /usr/share/alterator/components/centaurus/samba/samba.component | |||
===== Файл .backend ===== | |||
<pre> | |||
# cat /usr/share/alterator/backends/samba.backend | |||
[Alterator Entry] | |||
Type = Backend | |||
Module = executor | |||
Name = component_centaurus_samba | |||
Interface = component1 | |||
[Info] | |||
execute = cat /usr/share/alterator/components/centaurus/samba/samba.component | |||
stdout_strings = enabled | |||
[Description] | |||
execute = /usr/lib/alterator-interface-component/basic_get_component_description /usr/share/alterator/components/centaurus/samba | |||
stdout_strings = enabled | |||
[Status] | |||
execute = /usr/lib/alterator-interface-component/basic_check_component_installed /usr/share/alterator/components/centaurus/samba/samba.component | |||
</pre> | |||
===== Файл .category ===== | |||
<pre> | |||
# cat /usr/share/alterator/components/20-server-apps.category | |||
[Alterator Entry] | |||
Type = Component | |||
Name = centaurus/samba | |||
Category = centaurus/20-server-apps | |||
DisplayName = Samba Server | |||
DisplayName[ru_RU] = Сервер Samba | |||
Packages = samba samba-common-tools samba-usershares samba-client | |||
</pre> | |||
===== Файл description.html ===== | |||
<pre> | |||
# cat /usr/share/alterator/components/centaurus/samba/description.html | |||
<ul> | |||
<li>samba</li> | |||
<li>samba-common-tools</li> | |||
<li>samba-usershares</li> | |||
<li>samba-client</li> | |||
</ul> | |||
</pre> | |||
===== Файл samba.component ===== | |||
<pre> | |||
# cat /usr/share/alterator/components/centaurus/samba/samba.component | |||
[Alterator Entry] | |||
Type = Component | |||
Name = centaurus/samba | |||
Category = centaurus/20-server-apps | |||
DisplayName = Samba Server | |||
DisplayName[ru_RU] = Сервер Samba | |||
Packages = samba samba-common-tools samba-usershares samba-client | |||
</pre> | |||
Планируются "редакции" - наборы компонентов. | Планируются "редакции" - наборы компонентов. |
Текущая версия от 10:31, 30 июля 2024
AMC - Alterator (Module) Components - alterator-components - приложение с графическим интерфейсом для управления наборами пакетов, называемых компонентами.
Цель создания
AMC позволяет устанавливать и удалять компоненты. Компонент представляет собой набор пакетов, предоставляющих определенную функциональность, и некоторую последовательность действий (deploy) для его конфигурации. AMC должен запускаться при первом запуске системы, но доступен всегда, т.е. набор установленных компонент можно поменять в любой момент.
Назначение
Приложение alterator-components предназначено для управления группами пакетов под названием компоненты. Использование компонент позволяет работать с функциональными подсистемами без необходимости самостоятельного поиска отдельных пакетов. Для работы достаточно выбрать желаемый компонент, после чего alterator-components установит недостающие пакеты или удалит избыточные. Приложение ориентировано на корпоративную инфраструктуру.
Предназначен для:
- Администраторов
- Продвинутых пользователей
Возможности программы:
- Установка компонент.
- Удаление компонент.
- Проверка наличия компонент.
Условия применения
Приложение Alterator Components может использоваться как на серверах, так и на рабочих станциях. Для корректной работы alterator-components требуется apt, сконфигурированный на работу с репозиториями, содержащими необходимые RPM-пакеты и доступ к этим репозиториям.
Установка
Для установки alterator-components из задания (таски), воспользуйтесь поиском.
Команды установки
# apt-repo add <номер задания> # apt-get update # apt-get install alterator-application-components
Запуск
Вызов инструмента Alterator Components возможен через графическое меню либо через терминал.
Через графическое окружение
- Запустить Alterator Browser из меню приложений.
- Ввести пароль учетной записи root.
- Выбрать пункт Управление компонентами.
Через терминал
Выполнить команду
$ alterator-application-components
Интерфейс
Пользовательский интерфейс программы состоит из секций:
- Компоненты - представлен список компонент по категориям.
- Описание - выводится информация о компонентах.
Спецификация
- Реализация интерфейса component.
- Реализация интерфейса component-categories.
- Документация на Component.
Руководство пользователя
- Чтобы раскрыть список компонент в категории, необходимо нажать на её имя.
- Чтобы увидеть информацию о компоненте, необходимо нажать на её имя.
- Чтобы установить/удалить компоненту, необходимо установить/снять галочку рядом с именем компоненты.
- Чтобы установить/удалить все компоненты из одной категории, необходимо установить/снять галочку рядом с именем категории.
- Чтобы изменения вступили в силу, необходимо нажать Применить.
- Чтобы отменить не примененные изменения, необходимо нажать Cбросить.
Руководство администратора
Создание компонент
Для создания компоненты необходимо сформировать три файла:
- .backend
- .component
- описание
Файлы .backend и .component
Файлы .backend и .component являются текстовыми и содержат описание в виде секций. Имеют следующий синтаксис:
[имя секции1] Поле1 = значение Поле2 = значение ПолеN = значение [имя секции2] Поле1 = значение Поле2 = значение ПолеN = значение [имя секциN] Поле1 = значение Поле2 = значение ПолеN = значение
Принятые правила написания
- все поля чувствительны к регистру и начинаются с большой буквы;
- перед и после знака
=
пробелы; - значения полей указываются без кавычек;
- значения могут содержать пробелы;
- если строка начинается с
#
, то она считается комментарием и при чтении информации из файла игнорируется.
Файл описания
Файл с описанием содержит информацию о компоненте и имеет синтаксис, соответствующий языку html.
Создание категории
Категории компонент являются сущностями Alterator Entry и описываются файлами .category в каталоге /usr/share/alterator/components/. Имена этих файлов имеют формат <номер>-<имя>.category, содержат секцию Alterator Entry и следующие параметры:
- Type - тип сущности, всегда
Category
; - Name -
- DisplayName - имя категории;
- DisplayName[локаль] - имя категории, которое выводится с использованием указанной в скобках локали.
Пример готового файла
[Alterator Entry] Type=Category Name=centaurus/20-server-apps DisplayName=Server applications DisplayName[ru_RU]=Серверные приложения
Создание компоненты
Каждая компонента представлена следующими файлами:
- /usr/share/alterator/backends/samba.backend
- /usr/share/alterator/components/20-server-apps.category
- /usr/share/alterator/components/centaurus/samba/description.html
- /usr/share/alterator/components/centaurus/samba/samba.component
Файл .backend
# cat /usr/share/alterator/backends/samba.backend [Alterator Entry] Type = Backend Module = executor Name = component_centaurus_samba Interface = component1 [Info] execute = cat /usr/share/alterator/components/centaurus/samba/samba.component stdout_strings = enabled [Description] execute = /usr/lib/alterator-interface-component/basic_get_component_description /usr/share/alterator/components/centaurus/samba stdout_strings = enabled [Status] execute = /usr/lib/alterator-interface-component/basic_check_component_installed /usr/share/alterator/components/centaurus/samba/samba.component
Файл .category
# cat /usr/share/alterator/components/20-server-apps.category [Alterator Entry] Type = Component Name = centaurus/samba Category = centaurus/20-server-apps DisplayName = Samba Server DisplayName[ru_RU] = Сервер Samba Packages = samba samba-common-tools samba-usershares samba-client
Файл description.html
# cat /usr/share/alterator/components/centaurus/samba/description.html <ul> <li>samba</li> <li>samba-common-tools</li> <li>samba-usershares</li> <li>samba-client</li> </ul>
Файл samba.component
# cat /usr/share/alterator/components/centaurus/samba/samba.component [Alterator Entry] Type = Component Name = centaurus/samba Category = centaurus/20-server-apps DisplayName = Samba Server DisplayName[ru_RU] = Сервер Samba Packages = samba samba-common-tools samba-usershares samba-client
Планируются "редакции" - наборы компонентов.