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

Материал из ALT Linux Wiki
(Новая страница: «Category:Sisyphus 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 |- |Image:stub.png |- | '''Данная страница находится в разработке'''.<br /><small style="line-height:1.1em;">Эта страница ещё не зак...»)
 
 
(не показано 8 промежуточных версий 1 участника)
Строка 10: Строка 10:
<noinclude>[[Категория:Неоконченные страницы|{{PAGENAME}}]]</noinclude>
<noinclude>[[Категория:Неоконченные страницы|{{PAGENAME}}]]</noinclude>


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


=== Основная информация ===
=== Основная информация ===
'''Компоненты''' — целостный набор пакетов, обеспечивающий функциональные возможности продукта. Для управления компонентами используется приложение [[Alt-components|'''alt-components''']] и данный модуль приложения alteratorctl.


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


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


Для работы некоторых команд модуля могут потребоваться права администратора.
Для работы некоторых команд модуля могут потребоваться права администратора.
=== Информация по компонентам ===
Компонент — набор пакетов, предоставляющих определённую функциональность, и некоторую последовательность действий (deploy) для их конфигурации.
=== Структура компонента ===
Подробнее про состав и структуру компонентов можно прочитать на соответствующей станице [[alt-components]]. Также здесь можно прочитать про аналог alteratorctl в виде графического приложения для работы с компонентами — '''alterator-application-components'''.


=== Использование модуля ===
=== Использование модуля ===
Модуль предусматривает использование следующих команд и опций:
Модуль предусматривает использование следующих команд и опций:
<pre>
<source lang="text" highlight="1">
Формат использования:
$ alteratorctl components --help
alteratorctl components                 вывести все компоненты в виде дерева с псевдографикой.
Использование:
alteratorctl components [КОМАНДА [аргументы]] [ОПЦИИ] [ПАРАМЕТРЫ <аргументы…>]
  alteratorctl components     Вывод всех компонентов в виде дерева с
                              псевдографикой
  alteratorctl components [КОМАНДА [аргументы]] [ОПЦИИ] [ПАРАМЕТРЫ <аргументы...>]


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


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


Опции:
Опции:
--draft                                 выводить черновые компоненты и категории.
  --draft                     Добавить отображение черновых компонентов
-I, --ignore-sections                   игнорировать секции редакции при выводе компонентов.
  -I, --ignore-sections       Вывести все компоненты игнорируя секции текущей
-L, --ignore-legend                     игнорировать вывод условных обозначений при выводе компонентов.
                              редакции
-g, --graphic-tree                     вывести компоненты и категории в виде дерева с псевдографикой.
  -L, --ignore-legend         Скрыть описание условных обозначений при выводе
-t, --simple-tree                       вывести компоненты и категории в виде простого дерева.
                              компонентов
-l, --list                             вывести компоненты и категории в виде списка.
  -g, --graphic-tree         Вывести компоненты с категориями в виде дерева
                                        для вывода отображаемых имён можно использовать опцию --show-display-name  
                              с псевдографикой (выводится по умолчанию)
                                        (опция используется только в данном представлении вывода компонентов).
  -t, --simple-tree           Вывести компоненты с категориями в виде простого
--no-update                            не обновлять списки пакетов перед установкой или удалением компонента.
                              дерева
-p, --path-only                        отобразить пути объектов компонентов на D-Bus.
  -l, --list                 Вывести компоненты с категориями в виде списка
-d, --display-name-only                 показать только отображаемые имена компонентов и категорий.
                              Для вывода отображаемых имён используйте опцию
-D, --no-display-name                   скрыть отображаемые имена компонентов и категорий.
                              --show-display-name (её можно использовать лишь в
-s, --show-display-name                показывать отображаемые имена компонентов и категорий.
                              данном представлении вывода)
-n, --name-only                         отобразить только имена объектов компонентов.
  -v, --verbose              Добавить вывод путей к компонентам на DBus
-N, --no-name                           скрыть отображение имён компонентов и категорий.
  -d, --display-name-only     Показать только отображаемые имена компонентов и
-i, --installed                         отображать только установленные компоненты.
                              категорий
-u, --uninstalled                      отображать только неустановленные компоненты.
  -D, --no-display-name       Скрыть отображаемые имена компонентов и категорий
-h, --help                             вызвать справку модуля components.
  -p, --path-only            Отобразить только пути к объектам компонентов
</pre>
  -n, --name-only             Отобразить только имена объектов компонентов
  -N, --no-name               Скрыть отображение имён компонентов и категорий
  --no-update                Не обновлять списки пакетов перед установкой или
                              удалением компонента
 
  -s, --show-display-name    Показать отображаемые имена компонентов и
                              категорий при выводе в виде списка
  -i, --installed             Отобразить только установленные компоненты
  -u, --not-installed        Отобразить только неустановленные компоненты
  -h, --help                 Вызов справки модуля components
</source>
 
=== Примеры вывода компонентов ===
Вывод '''компонентов''' в виде дерева с псевдографикой:
<source lang="text" highlight="1">
$ 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)
</source>
 
Вывод путей объектов '''компонентов''' на D-Bus в виде дерева с псевдографикой:
<source lang="text" highlight="1">
$ 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
</source>
 
Вывод списка установленных '''компонентов''':
<source lang="text" highlight="1">
$ 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
</source>
 
Вывод статуса '''компонента''':
<source lang="text" highlight="1,10,17,22">
$ alteratorctl components status samba-dc
Компонент: Samba AD - контроллер домена
Категория: Доменная инфраструктура
Статус: не установлен
Список пакетов, входящих в компонент:
[*] bind-utils
[ ] samba-winbind-clients
[ ] task-samba-dc
</source>
 
=== Установка и удаление компонентов ===
 
Установка '''компонента''' (установка может занять какое-то время):
<source lang="text" highlight="1,10,17,22">
# alteratorctl components install samba-dc
Устанавливаемые пакеты:
task-samba-dc
samba-winbind-clients
</source>


=== Примеры использования модуля ===
Удаление '''компонента''':
# Отображение категорий и компонентов.
<source lang="text" highlight="1,7">
#* Команда <code>alteratorctl components -g</code> выведет компоненты в виде дерева с псевдографикой:
# alteratorctl components remove samba-dc
#: [[Файл:Alteratorctl-components1.png|600px|alteratorctl-components1.png]]
Удаляемые пакеты:
#: В данном случае команда <code>alteratorctl components -g</code> будет аналогичная команде <code>alteratorctl components</code>
bind-utils
#* Команда <code>alteratorctl components -t</code> выводит компоненты в виде простого дерева:
task-samba-dc
#: [[Файл:Alteratorctl-components2.png|600px|alteratorctl-components2.png]]
samba-winbind-clients
#* Команда <code>alteratorctl components -l</code> выводит компоненты в виде списка:
</source>
#: [[Файл:Alteratorctl-components3.png|600px|alteratorctl-components3.png]]
#* Также можно вывести список компонентов с отображением их имён, а не только имён объектов при помощи команды <code>alteratorctl components -l —show-display-name</code>:
#: [[Файл:Alteratorctl-components4.png|600px|alteratorctl-components4.png]]
#* Команда <code>alteratorctl components list -p</code> выводит пути объектов компонентов на D-Bus в виде дерева с псевдографикой:
#: [[Файл:Alteratorctl-components5.png|600px|alteratorctl-components5.png]]
# Отображение статусов компонентов.
#* Команда <code>alteratorctl components list -l -i</code> выведет список установленных на данный момент компонентов:
#: [[Файл:Alteratorctl-components9.png|600px|alteratorctl-components9.png]]
#* Команда <code>alteratorctl components list -l -u</code> выведет список не установленных компонентов:
#: [[Файл:Alteratorctl-components6.png|600px|alteratorctl-components6.png]]
# Установка и удаление компонентов.
#* Команда <code>alteratorctl components description</code> samba-dc позволит посмотреть описание компонента samba-dc, а команда <code>alteratorctl components install samba-dc</code> позволит его установить:
#: [[Файл:Alteratorctl-components7.png|600px|alteratorctl-components7.png]]
#* Команда <code>alteratorctl components remove samba-dc</code> позволит удалить компонент samba-dc:
#: [[Файл:Alteratorctl-components8.png|600px|alteratorctl-components8.png]]

Текущая версия от 14:37, 4 июня 2025


Stub.png
Данная страница находится в разработке.
Эта страница ещё не закончена. Информация, представленная здесь, может оказаться неполной или неверной.

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

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

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

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

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

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

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

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

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

$ alteratorctl components --help
Использование:
  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 (её можно использовать лишь в
                              данном представлении вывода)
  -v, --verbose               Добавить вывод путей к компонентам на DBus
  -d, --display-name-only     Показать только отображаемые имена компонентов и
                              категорий
  -D, --no-display-name       Скрыть отображаемые имена компонентов и категорий
  -p, --path-only             Отобразить только пути к объектам компонентов
  -n, --name-only             Отобразить только имена объектов компонентов
  -N, --no-name               Скрыть отображение имён компонентов и категорий
  --no-update                 Не обновлять списки пакетов перед установкой или
                              удалением компонента

  -s, --show-display-name     Показать отображаемые имена компонентов и
                              категорий при выводе в виде списка
  -i, --installed             Отобразить только установленные компоненты
  -u, --not-installed         Отобразить только неустановленные компоненты
  -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)

Вывод путей объектов компонентов на 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 status samba-dc
Компонент: Samba AD - контроллер домена
Категория: Доменная инфраструктура
Статус: не установлен
Список пакетов, входящих в компонент:
[*] bind-utils
[ ] samba-winbind-clients
[ ] task-samba-dc

Установка и удаление компонентов

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

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

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

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