Alteratorctl/components module

Alteratorctl components — модуль консольного приложения alteratorctl, позволяющий устанавливать, удалять компоненты и узнавать различную информацию о них.

Основная информация

Модуль использует интерфейс org.altlinux.alterator.component1 объектов установленных компонентов.

Модуль позволяет:

• Просматривать список компонентов;
• Просматривать информацию о компонентах (статус, описание, состав);
• Устанавливать/удалять компоненты.

Для работы некоторых команд модуля могут потребоваться права администратора.

Информация по компонентам

Компонент — набор пакетов, предоставляющих определённую функциональность, и некоторую последовательность действий (deploy) для их конфигурации.

Структура компонента

Подробнее про состав и структуру компонентов можно прочитать на соответствующей станице alt-components. Также здесь можно прочитать про аналог alteratorctl в виде графического приложения для работы с компонентами — alterator-application-components.

Использование модуля

Модуль предусматривает использование следующих команд и опций:

Формат использования:
alteratorctl components                 вывести все компоненты в виде дерева с псевдографикой.
alteratorctl components [КОМАНДА [аргументы]] [ОПЦИИ] [ПАРАМЕТРЫ <аргументы…>]

Команды:
description <название компонента>       получить описание выбранного компонента.
list [ОПЦИИ] [ПАРАМЕТРЫ <аргументы…>]   вывести все компоненты с категориями.
info <название компонента>              получить информацию о выбранном компоненте.
install <название компонента>           установить выбранный компонент.
remove <название компонента>            удалить выбранный компонент.
status <название компонента>            узнать статус установки компонента (установлен/не установлен).

Параметры:
-c, --category <название категории>     вывести список всех компонентов выбранной категории.

Опции:
--draft                                 выводить черновые компоненты и категории.
-I, --ignore-sections                   игнорировать секции редакции при выводе компонентов.
-L, --ignore-legend                     игнорировать вывод условных обозначений при выводе компонентов.
-g, --graphic-tree                      вывести компоненты и категории в виде дерева с псевдографикой.
-t, --simple-tree                       вывести компоненты и категории в виде простого дерева.
-l, --list                              вывести компоненты и категории в виде списка.
                                        для вывода отображаемых имён можно использовать опцию --show-display-name 
                                        (опция используется только в данном представлении вывода компонентов).
--no-update                             не обновлять списки пакетов перед установкой или удалением компонента.
-p, --path-only                         отобразить пути объектов компонентов на D-Bus.
-d, --display-name-only                 показать только отображаемые имена компонентов и категорий.
-D, --no-display-name                   скрыть отображаемые имена компонентов и категорий.
-s, --show-display-name                 показывать отображаемые имена компонентов и категорий.
-n, --name-only                         отобразить только имена объектов компонентов.
-N, --no-name                           скрыть отображение имён компонентов и категорий.
-i, --installed                         отображать только установленные компоненты.
-u, --uninstalled                       отображать только неустановленные компоненты.
-h, --help                              вызвать справку модуля components.

Примеры использования модуля

Вывод компонентов в виде дерева с псевдографикой:

$ alteratorctl components -g
Обозначения:
  [*] Установлен(а)
  [ ] Не установлен(а)
  [~] Частично установлен(а)
  [?] Черновой элемент (--draft) или неизвестный статус установки

Базовые компоненты (base):
┌─[ ] Документация (docs)
│  └─[ ] Документация Альт Сервер (alt-server-docs)
├─[~] Инфраструктурные решения (infra)
│  ├─[~] Доменная инфраструктура (domain-infra)
│  │  ├─[ ] FreeIPA - клиент (freeipa-client)
│  │  ├─[*] FreeIPA - сервер (freeipa-server)
│  │  ├─[ ] Samba AD - клиент (sssd) (samba-ad-client-sssd)
│  │  ├─[ ] Samba AD - клиент (winbind) (samba-ad-client-winbind)
│  │  ├─[ ] Samba AD - контроллер домена (samba-dc)
│  │  ├─[ ] Samba AD - поддержка клиентской инфраструктуры (samba-ad-client-support)
│  │  └─[ ] Шаблоны групповых политик (admx-templates)

Вывод компонентов в виде простого дерева:

$ alteratorctl components -t
Обозначения:
  [*] Установлен(а)
  [ ] Не установлен(а)
  [~] Частично установлен(а)
  [?] Черновой элемент (--draft) или неизвестный статус установки

Базовые компоненты (base):
[ ] /Документация (docs)
  [ ] Документация Альт Сервер (alt-server-docs)
[~] /Инфраструктурные решения (infra)
  [~] /Доменная инфраструктура (domain-infra)
    [ ] FreeIPA - клиент (freeipa-client)
    [*] FreeIPA - сервер (freeipa-server)
    [ ] Samba AD - клиент (sssd) (samba-ad-client-sssd)
    [ ] Samba AD - клиент (winbind) (samba-ad-client-winbind)
    [ ] Samba AD - контроллер домена (samba-dc)
    [ ] Samba AD - поддержка клиентской инфраструктуры (samba-ad-client-support)
    [ ] Шаблоны групповых политик (admx-templates)

Вывод компонентов в виде списка:

$ alteratorctl components -l
Обозначения:
  [*] Установлен(а)
  [ ] Не установлен(а)
  [~] Частично установлен(а)
  [?] Черновой элемент (--draft) или неизвестный статус установки

base:
[ ] /apps/admin-apps/samba-ad-admin-tools
[*] /apps/alterator/alterator-base
[ ] /docs/alt-server-docs
[ ] /infra/containers/cgroup
[ ] /infra/domain-infra/admx-templates
[ ] /infra/domain-infra/freeipa-client
[*] /infra/domain-infra/freeipa-server
[ ] /infra/domain-infra/samba-ad-client-sssd
[ ] /infra/domain-infra/samba-ad-client-support
[ ] /infra/domain-infra/samba-ad-client-winbind
[ ] /infra/domain-infra/samba-dc

Вывод путей объектов компонентов на D-Bus в виде дерева с псевдографикой:

$ alteratorctl components list -p
Обозначения:
  [*] Установлен(а)
  [ ] Не установлен(а)
  [~] Частично установлен(а)
  [?] Черновой элемент (--draft) или неизвестный статус установки

Базовые компоненты (base):
┌─[~] apps
│  ├─[ ] admin-apps
│  │  └─[ ] /org/altlinux/alterator/component_samba_ad_admin_tools
│  └─[*] alterator
│     └─[*] /org/altlinux/alterator/component_alterator_base
├─[ ] docs
│  └─[ ] /org/altlinux/alterator/component_alt_server_docs
├─[~] infra
│  ├─[ ] containers
│  │  └─[ ] /org/altlinux/alterator/component_cgroup
│  ├─[~] domain-infra
│  │  ├─[ ] /org/altlinux/alterator/component_admx_templates
│  │  ├─[ ] /org/altlinux/alterator/component_freeipa_client
│  │  ├─[*] /org/altlinux/alterator/component_freeipa_server
│  │  ├─[ ] /org/altlinux/alterator/component_samba_ad_client_sssd
│  │  ├─[ ] /org/altlinux/alterator/component_samba_ad_client_support
│  │  ├─[ ] /org/altlinux/alterator/component_samba_ad_client_winbind
│  │  └─[ ] /org/altlinux/alterator/component_samba_dc

Вывод списка установленных компонентов:

$ alteratorctl components list -l -i
Обозначения:
  [*] Установлен(а)
  [ ] Не установлен(а)
  [~] Частично установлен(а)
  [?] Черновой элемент (--draft) или неизвестный статус установки

base:
[*] /apps/alterator/alterator-base
[*] /system/archiving/cpio
[*] /system/archiving/p7zip
[*] /system/archiving/unzip
[*] /system/boot/boot-utils
[*] /system/boot/grub
[*] /system/core/base
[*] /system/core/init-other

Вывод списка не установленных компонентов:

$ alteratorctl components list -l -u
Обозначения:
  [*] Установлен(а)
  [ ] Не установлен(а)
  [~] Частично установлен(а)
  [?] Черновой элемент (--draft) или неизвестный статус установки

base:
[ ] /apps/admin-apps/samba-ad-admin-tools
[ ] /docs/alt-server-docs
[ ] /infra/containers/cgroup
[ ] /infra/domain-infra/admx-templates
[ ] /infra/domain-infra/freeipa-client
[ ] /infra/domain-infra/samba-ad-client-sssd
[ ] /infra/domain-infra/samba-ad-client-support
[ ] /infra/domain-infra/samba-ad-client-winbind

Установка компонента (установка может занять какое-то время):

$ alteratorctl components status samba-dc
Компонент: Samba AD - контроллер домена
Категория: Доменная инфраструктура
Статус: не установлен
Список пакетов, входящих в компонент:
[*] bind-utils
[ ] samba-winbind-clients
[ ] task-samba-dc

$ alteratorctl components description samba-dc
Компонент samba-dc

Контроллер домена (Active Directory).
Обеспечивает централизованное управление учётными записями пользователей,
доступ к сетевым ресурсам, а также безопасность корпоративной сети.

# alteratorctl components install samba-dc
Устанавливаемые пакеты:
task-samba-dc
samba-winbind-clients

$ alteratorctl components status samba-dc
Компонент: Samba AD - контроллер домена
Категория: Доменная инфраструктура
Статус: установлен
Список пакетов, входящих в компонент:
[*] bind-utils
[*] samba-winbind-clients
[*] task-samba-dc

Удаление компонента:

# alteratorctl components remove samba-dc
Удаляемые пакеты:
bind-utils
task-samba-dc
samba-winbind-clients

$ alteratorctl components status samba-dc
Компонент: Samba AD - контроллер домена
Категория: Доменная инфраструктура
Статус: не установлен
Список пакетов, входящих в компонент:
[ ] bind-utils
[ ] samba-winbind-clients
[ ] task-samba-dc