Red Hat Enterprise Linux および Fedora インストールプログラムである Anaconda では、最新バージョンに多くの改良が追加されました。これらの改善の 1 つは、カスタマイズの可能性が強化されました。アドオンを作成して、ベースインストーラー機能を拡張し、グラフィカルユーザーインターフェイスの外観を変更できるようになりました。

本書では、以下をカスタマイズする方法について説明します。

また、本ガイドは、Red Hat Enterprise Linux 8 および Fedora 17 以降にのみ適用されることに注意してください。

本セクションでは、以下の方法について説明します。

インストーラーのカスタマイズを開始する前に、Red Hat が提供するブートイメージをダウンロードします。アカウントにログインした後に、Red Hat カスタマーポータル から Red Hat Enterprise Linux 9 ブートメディアを取得できます。

Binary DVD および Boot ISO のダウンロードの詳細は、Red Hat Enterprise Linux 9 高度な RHEL 9 インストールの実行 を参照してください。

以下の手順に従って、ブートイメージの内容を抽出します。

ブートメニュー は、インストールイメージを使用してシステムを起動すると表示されるメニューです。通常、このメニューでは、Install Red Hat Enterprise Linux、Boot from local drive、または Rescue an installed system などのオプションを選択できます。Boot メニューをカスタマイズするには、以下を行います。

インストールメディアは、ISOLINUX および GRUB2 ブートローダーで設定されます。ISOLINUX ブートローダーは BIOS ファームウェアのシステムで使用され、GRUB2 ブートローダーは UEFI ファームウェアが搭載されているシステムで使用されます。AMD64 システムおよび Intel 64 システム用のすべての Red Hat イメージに、ブートローダーが両方存在します。

起動オプションのカスタマイズは、特にキックスタートで役に立ちます。インストールを開始する前に、キックスタートファイルをインストーラーに提供する必要があります。通常、これは、inst.ks= ブートオプションを追加するために、既存の起動オプションを手動で編集して行います。メディア上のブートローダー設定ファイルを編集する場合は、このオプションを事前設定されたエントリーのいずれかに追加できます。

ISOLINUX ブートローダーは、BIOS ファームウェアのあるシステムで使用されます。

図3.1 ISOLINUX ブートメニュー

ブートメディアの isolinux/isolinux.cfg 設定ファイルには、色スキームとメニュー構造 (Enterly および submenu) を設定するためのディレクティブが含まれています。

設定ファイルでは、Red Hat Enterprise Linux のデフォルトメニューエントリー (Test this media & Install Red Hat Enterprise Linux  9) が以下のブロックで定義されます。

label check
  menu label Test this ^media & install Red Hat Enterprise Linux 9.
  menu default
  kernel vmlinuz
  append initrd=initrd.img inst.stage2=hd:LABEL=RHEL-9-BaseOS-x86_64 rd.live.check
quiet

ここでは、以下のようになります。

メニューエントリー定義に含まれていないその他の重要なオプションは、以下のとおりです。

GRUB2 ブートローダーは、UEFI ファームウェアが搭載されているシステムで使用されます。

ブートメディアの EFI/BOOT/grub.cfg 設定ファイルには、事前設定されたメニューエントリーのリストと、外観とブートメニュー機能を制御する他のディレクティブが含まれます。

設定ファイルでは、Red Hat Enterprise Linux のデフォルトメニューエントリー (Test this media & install Red Hat Enterprise Linux 9) が以下のブロックで定義されます。

menuentry 'Test this media & install Red Hat Enterprise Linux 9' --class fedora --class gnu-linux --class gnu --class os {
    linuxefi /images/pxeboot/vmlinuz inst.stage2=hd:LABEL=RHEL-9-BaseOS-x86_64 rd.live.check quiet
    initrdefi /images/pxeboot/initrd.img
}

ここでは、以下のようになります。

Red Hat Enterprise Linux 9 高度な RHEL 9 インストールの実行

+ 主なオプションは inst.ks= で、キックスタートファイルの場所を指定できます。ブート ISO イメージにキックスタートファイルを配置し、inst.ks= オプションを使用してその場所を指定できます。たとえば、kickstart.ks ファイルをイメージの root ディレクトリーに配置し、inst.ks=hd:LABEL=RHEL-9-BaseOS-x86_64:/kickstart.ks を使用します。

+ また、dracut オプションを使用することもできます。詳細は、dracut.cmdline(7) の man ページを参照してください。

+

grub.cfg 設定ファイルで使用されるその他のオプションは以下のとおりです。

グラフィカル要素をカスタマイズするには、カスタマイズ可能な要素をカスタムブランドの資料に変更または置き換え、コンテナーファイルを更新します。

インストーラーのカスタマイズ可能なグラフィカル要素は、インストーラーランタイムファイルシステムの /usr/share/anaconda/pixmaps/ ディレクトリーに保存されます。このディレクトリーには、以下のカスタマイズ可能なファイルが含まれます。

pixmaps
├─ anaconda-password-show-off.svg
├─ anaconda-password-show-on.svg
├─ right-arrow-icon.png
├─ sidebar-bg.png
├─ sidebar-logo.png
└─ topbar-bg.png

さらに、/usr/share/anaconda/ ディレクトリーには、anaconda-gtk.css という名前の CSS スタイルシートが含まれており、メインの UI 要素のファイル名とパラメーター (サイドバーとトップバーのロゴおよび背景) を決定します。このファイルには、要件に従ってカスタマイズできる以下の内容が含まれます。

/* theme colors/images */

@define-color product_bg_color @redhat;

/* logo and sidebar classes */

.logo-sidebar {
   background-image: url('/usr/share/anaconda/pixmaps/sidebar-bg.png');
   background-color: @product_bg_color;
   background-repeat: no-repeat;
}

/* Add a logo to the sidebar */

.logo {
   background-image: url('/usr/share/anaconda/pixmaps/sidebar-logo.png');
   background-position: 50% 20px;
   background-repeat: no-repeat;
   background-color: transparent;
}

/* This is a placeholder to be filled by a product-specific logo. */

.product-logo {
   background-image: none;
   background-color: transparent;
}

AnacondaSpokeWindow #nav-box {
   background-color: @product_bg_color;
   background-image: url('/usr/share/anaconda/pixmaps/topbar-bg.png');
   background-repeat: no-repeat;
   color: white;
}

CSS ファイルの最も重要な部分は、解決に基づいてスケーリングを処理する方法です。PNG イメージの背景はスケーリングされず、常に実際の画面に表示されます。代わりに、バックグラウンドには透過的な背景があり、スタイルシートは @define-color 行に一致する背景色を定義します。そのため、バックグラウンド イメージ は背景の 色 にフェードします。これは、イメージのスケーリングを必要とせずに、すべての解像度でバックグラウンドが機能することを意味します。

また、background-repeat パラメーターをバックグラウンドのタイル配置に変更することもできます。インストールするすべてのシステムが同じディスプレイの解像度を持つことを保証している場合は、バー全体を埋めるバックグラウンドイメージを使用できます。

上記のファイルはどれでもカスタマイズできます。これを行ったら、セクション 2.2 の product.img ファイルの作成の手順に従い、カスタムグラフィックスを備えた独自の product.img を作成します。その後、セクション 2.3 のカスタムブートイメージの作成を参照し、変更が含まれる新しいブート可能な ISO イメージを作成します。

プロダクト名をカスタマイズするには、カスタム .buildstamp ファイルを作成する必要があります。これを行うには、以下の内容で新しいファイル .buildstamp.py を作成します。

[Main]
Product=My Distribution
Version=9
BugURL=https://bugzilla.redhat.com/
IsFinal=True
UUID=202007011344.x86_64
[Compose]
Lorax=28.14.49-1

ここでの My Distribution をインストーラーで表示したい名前に置き換えます。

カスタム .buildstamp ファイルを作成したら、Creating a product.img file セクションの手順に従い、カスタマイズを含む新しい product.img ファイルを作成します。また、Creating custom boot images セクションに従い、を含む変更が含まれる新しい起動可能な ISO ファイルを作成します。

独自の設定ファイルを作成し、これを使用してインストーラーの設定をカスタマイズすることができます。

[Anaconda]
# Run Anaconda in the debugging mode.
debug = False

# Enable Anaconda addons.
# This option is deprecated and will be removed in the future.
# addons_enabled = True

# List of enabled Anaconda DBus modules.
# This option is deprecated and will be removed in the future.
# kickstart_modules =

# List of Anaconda DBus modules that can be activated.
# Supported patterns: MODULE.PREFIX., MODULE.NAME activatable_modules = org.fedoraproject.Anaconda.Modules.
    org.fedoraproject.Anaconda.Addons.*

# List of Anaconda DBus modules that are not allowed to run.
# Supported patterns: MODULE.PREFIX., MODULE.NAME forbidden_modules = # List of Anaconda DBus modules that can fail to run. # The installation won't be aborted because of them. # Supported patterns: MODULE.PREFIX., MODULE.NAME
optional_modules =
    org.fedoraproject.Anaconda.Modules.Subscription
    org.fedoraproject.Anaconda.Addons.*


[Installation System]

# Should the installer show a warning about enabled SMT?
can_detect_enabled_smt = False


[Installation Target]
# Type of the installation target.
type = HARDWARE

# A path to the physical root of the target.
physical_root = /mnt/sysimage

# A path to the system root of the target.
system_root = /mnt/sysroot

# Should we install the network configuration?
can_configure_network = True


[Network]
# Network device to be activated on boot if none was configured so.
# Valid values:
#
#   NONE                   No device
#   DEFAULT_ROUTE_DEVICE   A default route device
#   FIRST_WIRED_WITH_LINK  The first wired device with link
#
default_on_boot = NONE


[Payload]
# Default package environment.
default_environment =

# List of ignored packages.
ignored_packages =

# Names of repositories that provide latest updates.
updates_repositories =

# List of .treeinfo variant types to enable.
# Valid items:
#
#   addon
#   optional
#   variant
#
enabled_repositories_from_treeinfo = addon optional variant

# Enable installation from the closest mirror.
enable_closest_mirror = True

# Default installation source.
# Valid values:
#
#    CLOSEST_MIRROR  Use closest public repository mirror.
#    CDN             Use Content Delivery Network (CDN).
#
default_source = CLOSEST_MIRROR

# Enable ssl verification for all HTTP connection
verify_ssl = True

# GPG keys to import to RPM database by default.
# Specify paths on the installed system, each on a line.
# Substitutions for $releasever and $basearch happen automatically.
default_rpm_gpg_keys =

[Security]
# Enable SELinux usage in the installed system.
# Valid values:
#
#  -1  The value is not set.
#   0  SELinux is disabled.
#   1  SELinux is enabled.
#
selinux = -1


[Bootloader]
# Type of the bootloader.
# Supported values:
#
#   DEFAULT   Choose the type by platform.
#   EXTLINUX  Use extlinux as the bootloader.
#
type = DEFAULT

# Name of the EFI directory.
efi_dir = default

# Hide the GRUB menu.
menu_auto_hide = False

# Are non-iBFT iSCSI disks allowed?
nonibft_iscsi_boot = False

# Arguments preserved from the installation system.
preserved_arguments =
    cio_ignore rd.znet rd_ZNET zfcp.allow_lun_scan
    speakup_synth apic noapic apm ide noht acpi video
    pci nodmraid nompath nomodeset noiswmd fips selinux
    biosdevname ipv6.disable net.ifnames net.ifnames.prefix
    nosmt


[Storage]
# Enable dmraid usage during the installation.
dmraid = True

# Enable iBFT usage during the installation.
ibft = True

# Do you prefer creation of GPT disk labels?
gpt = False

# Tell multipathd to use user friendly names when naming devices during the installation.
multipath_friendly_names = True

# Do you want to allow imperfect devices (for example, degraded mdraid array devices)?
allow_imperfect_devices = False

# Default file system type. Use whatever Blivet uses by default.
file_system_type =

# Default partitioning.
# Specify a mount point and its attributes on each line.
#
# Valid attributes:
#
#   size <SIZE>    The size of the mount point.
#   min <MIN_SIZE> The size will grow from MIN_SIZE to MAX_SIZE.
#   max <MAX_SIZE> The max size is unlimited by default.
#   free <SIZE>    The required available space.
#
default_partitioning =
    /     (min 1 GiB, max 70 GiB)
    /home (min 500 MiB, free 50 GiB)

# Default partitioning scheme.
# Valid values:
#
#   PLAIN      Create standard partitions.
#   BTRFS      Use the Btrfs scheme.
#   LVM        Use the LVM scheme.
#   LVM_THINP  Use LVM Thin Provisioning.
#
default_scheme = LVM

# Default version of LUKS.
# Valid values:
#
#   luks1  Use version 1 by default.
#   luks2  Use version 2 by default.
#
luks_version = luks2


[Storage Constraints]

# Minimal size of the total memory.
min_ram = 320 MiB

# Minimal size of the available memory for LUKS2.
luks2_min_ram = 128 MiB

# Should we recommend to specify a swap partition?
swap_is_recommended = False

# Recommended minimal sizes of partitions.
# Specify a mount point and a size on each line.
min_partition_sizes =
    /      250 MiB
    /usr   250 MiB
    /tmp   50  MiB
    /var   384 MiB
    /home  100 MiB
    /boot  200 MiB

# Required minimal sizes of partitions.
# Specify a mount point and a size on each line.
req_partition_sizes =

# Allowed device types of the / partition if any.
# Valid values:
#
#   LVM        Allow LVM.
#   MD         Allow RAID.
#   PARTITION  Allow standard partitions.
#   BTRFS      Allow Btrfs.
#   DISK       Allow disks.
#   LVM_THINP  Allow LVM Thin Provisioning.
#
root_device_types =

# Mount points that must be on a linux file system.
# Specify a list of mount points.
must_be_on_linuxfs = / /var /tmp /usr /home /usr/share /usr/lib

# Paths that must be directories on the / file system.
# Specify a list of paths.
must_be_on_root = /bin /dev /sbin /etc /lib /root /mnt lost+found /proc

# Paths that must NOT be directories on the / file system.
# Specify a list of paths.
must_not_be_on_root =

# Mount points that are recommended to be reformatted.
#
# It will be recommended to create a new file system on a mount point
# that has an allowed prefix, but does not have a blocked one.
# Specify lists of mount points.
reformat_allowlist = /boot /var /tmp /usr
reformat_blocklist = /home /usr/local /opt /var/www


[User Interface]
# The path to a custom stylesheet.
custom_stylesheet =

# The path to a directory with help files.
help_directory = /usr/share/anaconda/help

# A list of spokes to hide in UI.
# FIXME: Use other identification then names of the spokes.
hidden_spokes =

# Should the UI allow to change the configured root account?
can_change_root = False

# Should the UI allow to change the configured user accounts?
can_change_users = False

# Define the default password policies.
# Specify a policy name and its attributes on each line.
#
# Valid attributes:
#
#   quality <NUMBER>  The minimum quality score (see libpwquality).
#   length <NUMBER>   The minimum length of the password.
#   empty             Allow an empty password.
#   strict            Require the minimum quality.
#
password_policies =
    root (quality 1, length 6)
    user (quality 1, length 6, empty)
    luks (quality 1, length 6)


[License]
# A path to EULA (if any)
#
# If the given distribution has an EULA & feels the need to
# tell the user about it fill in this variable by a path
# pointing to a file with the EULA on the installed system.
#
# This is currently used just to show the path to the file to
# the user at the end of the installation.
eula =

# Anaconda configuration file for Red Hat Enterprise Linux.

[Product]
product_name = Red Hat Enterprise Linux

[Installation System]

# Show a warning if SMT is enabled.
can_detect_enabled_smt = True

[Network]
default_on_boot = DEFAULT_ROUTE_DEVICE

[Payload]
ignored_packages =
    ntfsprogs
    btrfs-progs
    dmraid

enable_closest_mirror = False
default_source = CDN

[Bootloader]
efi_dir = redhat

[Storage]
file_system_type = xfs
default_partitioning =
    /     (min 1 GiB, max 70 GiB)
    /home (min 500 MiB, free 50 GiB)
    swap

[Storage Constraints]
swap_is_recommended = True

[User Interface]

help_directory = /usr/share/anaconda/help/rhel

[License]
eula = /usr/share/redhat-release/EULA

# Anaconda configuration file for Red Hat Virtualization.

[Product]
product_name = Red Hat Virtualization (RHVH)

[Base Product]
product_name = Red Hat Enterprise Linux

[Storage]
default_scheme = LVM_THINP
default_partitioning =
    /              (min 6 GiB)
    /home          (size 1 GiB)
    /tmp           (size 1 GiB)
    /var           (size 15 GiB)
    /var/crash     (size 10 GiB)
    /var/log       (size 8 GiB)
    /var/log/audit (size 2 GiB)
    swap

[Storage Constraints]
root_device_types = LVM_THINP
must_not_be_on_root = /var
req_partition_sizes =
	/var   10 GiB
	/boot  1  GiB

Anaconda: Fedora、Red Hat Enterprise Linux、およびその他の派生製品に使用されるオペレーティングシステムインストーラーです。これは、Gtk ウィジェット (C で記述)、systemd ユニット、dracut ライブラリーなどの一部の追加ファイルが含まれる、一連の Python モジュールおよびスクリプトです。同時に、これらは、作成される (ターゲット) システムのパラメーターを設定してから、このシステムをマシンにセットアップできるツールを形成します。インストールプロセスには、主に 4 つのステップがあります。

Anaconda を使用すると、以下の 3 つの方法で Fedora、Red Hat Enterprise Linux、および派生製品をインストールできます。

グラフィカルユーザーインターフェイス (GUI) の使用:

これは、最も一般的なインストール方法です。インターフェイスを使用すると、インストールを開始する前に、設定がほとんどまたは何も必要のない状態でシステムを対話的にインストールできます。この方法は、複雑なパーティションレイアウトの設定など、一般的なすべてのユースケースを取り上げます。

グラフィカルインターフェイスは VNC を介したリモートアクセスをサポートします。これにより、グラフィックカードやモニターが接続されていないシステムでも GUI を使用できます。

テキストユーザーインターフェイス (TUI) の使用:

TUI はモノクロラインプリンターと同様に動作します。これにより、カーソルの移動、色、その他の高度な機能に対応しないシリアルコンソールで作業できます。テキストモードは限定されており、ネットワーク設定、言語オプション、インストール (0 パッケージ) ソースなど、最も一般的なオプションのみをカスタマイズできます。このインターフェイスでは、手動パーティション設定などの高度な機能は利用できません。

キックスタートファイルの使用:

キックスタートファイルは、シェルのような構文を持つプレーンテキストファイルで、インストールプロセスを実行するためのデータを含めることができます。キックスタートファイルを使用すると、インストールを部分的または完全に自動化できます。インストールを完全に自動化するには、すべての必要なエリアを設定する一連のコマンドが必要になります。1 つ以上のコマンドが見つからない場合は、インストールに対話が必要です。

インストーラー自体の自動化以外に、キックスタートファイルには、インストールプロセス中に特定の時点で実行するカスタムスクリプトを含めることができます。

Anaconda は Python モジュールおよびスクリプトのセットです。また、外部パッケージおよびライブラリーも使用します。このツールセットの主要コンポーネントには、以下のパッケージが含まれます。

前述したパッケージへの分割以外に、Anaconda は内部的にユーザーインターフェイスと、別個のプロセスとして実行され、D-Bus ライブラリーを使用して通信するモジュールセットに分けられています。これらのモジュールは以下のとおりです。

各モジュールは、処理するキックスタート部分を宣言し、キックスタートから設定を適用してインストール環境とインストール済みシステムに適用します。

Anaconda の Python コード部分 (pyanaconda) は、ユーザーインターフェイスを所有するメインプロセスとして起動します。指定のキックスタートデータはすべて pykickstart モジュールと Boss モジュールを使用して解析され、その他のすべてのモジュールを検出し、起動します。その後、メインプロセスは宣言された機能に応じてキックスタートデータをモジュールに送信します。モジュールはデータを処理し、インストール環境に設定を適用し、必要な選択がすべて行われているかどうかを UI が検証します。インストールされていない場合は、対話式インストールモードでデータを指定する必要があります。必要な選択がすべて行われると、インストールを開始できます。モジュールは、インストール済みシステムにデータを書き込むことができます。

Anaconda ユーザーインターフェイス (UI) には、ハブおよびスポークモデルとして知られる非リニア構造があります。

Anaconda のハブおよびスポークモデルの利点は以下のとおりです。

以下の図は、インストーラーレイアウトと ハブ と スポーク (スクリーン) 間の対話を可能にします。

図5.1 ハブおよびスリープモデル

この図では、画面 2-13 は 通常のスポーク と呼ばれ、スクリーン 1 および 14 は スタンドアロンのスポーク です。スタンドアロンのスリープとは、スタンドアロンのドアまたはハブの前後に使用できる画面です。たとえば、インストール先頭の Welcome 画面では、残りのインストールに言語を選択するように求められます。

各スポークには、ハブを反映する以下の事前定義 プロパティー があります。

ユーザーインターフェイスを明確にするために、スポークは カテゴリー に分類されます。たとえば、ローカライゼーションカテゴリーグループは、キーボードレイアウト の選択、言語サポート、タイムゾーン設定などに使用できます。

各スリープには UI 制御が含まれており、1 つ以上のモジュールから値を表示し、変更できます。アドオンが提供するスポークにも同様のことが言えます。

インストールプロセス中に実行する必要のあるアクションの一部には時間がかかる場合があります。たとえば、既存のパーティションのディスクをスキャンしたり、パッケージメタデータをダウンロードしたりできます。待機して応答しなくなるため、Anaconda はこれらのアクションを別のスレッドで実行します。

Gtk ツールキットは、複数のスレッドからの要素の変更をサポートしません。Gtk の主なイベントループは、Anaconda プロセスのメインスレッドで実行されます。したがって、GUI に関連するすべてのアクションはメインスレッドで実行する必要があります。これを行うには、GLib.idle_add を使用しますが、これは常に簡単でも望ましい訳ではありません。pyanaconda.ui.gui.utils モジュールに定義されているいくつかのヘルパー関数およびデコレーターが難易度に追加される場合があります。

@gtk_action_wait および @gtk_action_nowait デコレーターにより、デコードされた関数またはメソッドが呼び出されたときに、メインスレッドで実行される Gtk のメインループに自動的にキューに置かれるように、デコレートされた関数またはメソッドが変更されます。戻り値はそれぞれ呼び出し元またはドロップされた値に返されます。

スポークやハブの通信では、準備ができ、ブロックされていないときにスポークが通知します。hubQ メッセージキューはこの機能を処理し、メインのイベントループを定期的に確認します。スポークがアクセス可能になると、メッセージをキューに送付し、メッセージをブロックしないようにします。

スポークがステータスを更新するか、フラグを完了する必要がある場合にも、同じことが当てはまります。Configuration and Progress ハブには、progressQ と呼ばれる異なるキューがあり、インストール進捗の更新を転送するためのメディアとして機能します。

これらのメカニズムは、テキストベースのインターフェイスにも使用されます。テキストモードではメインループはありませんが、キーボード入力にかかる時間がほとんどありません。

Anaconda のモジュールは、独立したプロセスとして実行されます。D-Bus API を使用してこれらのプロセスと通信するには、dasbus ライブラリーを使用します。

D-Bus API を使用したメソッドへの呼び出しは非同期ですが、dasbus ライブラリーでは Python で同期メソッド呼び出しに変換できます。以下のプログラムのいずれかを記述することもできます。

スレッドと通信の詳細については、Anaconda スレッド間 の通信を参照してください。

また、Anaconda は、モジュールで実行している Task オブジェクトを使用します。タスクには、追加のスレッドで自動的に実行される D-Bus API とメソッドがあります。タスクを正常に実行するには、sync_run_task 関数および async_run_task ヘルパー関数を使用します。

Anaconda 開発者が、GitHub で利用可能な Hello World というサンプルを公開しています。https://github.com/rhinstaller/hello-world-anaconda-addon/ その他のセクションの説明は、これで再現しています。

Anaconda アドオンは、__init__.py とその他のソースディレクトリー (サブパッケージ) のディレクトリーが含まれる Python パッケージです。Python では各パッケージ名を一度だけインポートできるため、パッケージの最上層のディレクトリーに一意の名前を指定します。アドオンは名前に関係なく読み込まれるため、任意の名前を使用できます。唯一の要件は、特定のディレクトリーに配置する必要があることです。

そのため、推奨のアドオン命名規則は Java パッケージまたは D-Bus サービス名に似ています。

ディレクトリー名を Python パッケージの一意の名前にするには、アドオン名を、ドットではなくアンダースコア (_) を使用して組織の逆引きドメイン名に接頭辞を指定します。例: com_example_hello_world

アドオンを作成する場合は、以下を確認してください。

以下は、全インターフェイス (Kickstart、GUI、および TUI) をサポートするアドオンのディレクトリー構造の例です。

com_example_hello_world
├─ gui
│  ├─ init.py
│  └─ spokes
│     └─ init.py
└─ tui
   ├─ init.py
   └─ spokes
   └─ init.py

各パッケージには、API で定義される 1 つ以上のクラスから継承されるクラスを定義する任意の名前を持つモジュールが少なくとも 1 つ含まれる必要があります。

アドオンが新しいカテゴリーを定義する必要がある場合は、カテゴリーサブパッケージを追加できますが、これは推奨していません。

Anaconda サービスと設定ファイルは data/ ディレクトリーに含まれます。アドオンサービスを起動し、D-Bus を設定するには、これらのファイルが必要です。

以下は、Anaconda Hello World アドオンの例です。

<!DOCTYPE busconfig PUBLIC
"-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
<busconfig>
       <policy user="root">
               <allow own="org.fedoraproject.Anaconda.Addons.HelloWorld"/>
               <allow send_destination="org.fedoraproject.Anaconda.Addons.HelloWorld"/>
       </policy>
       <policy context="default">
               <deny own="org.fedoraproject.Anaconda.Addons.HelloWorld"/>
               <allow send_destination="org.fedoraproject.Anaconda.Addons.HelloWorld"/>
       </policy>
</busconfig>

このファイルは、インストール環境の /usr/share/anaconda/dbus/confs/ ディレクトリーに置く必要があります。org.fedoraproject.Anaconda.Addons.HelloWorld は D-Bus 上の addon のサービスの場所に対応する必要があります。

[D-BUS Service]
# Start the org.fedoraproject.Anaconda.Addons.HelloWorld service.
# Runs org_fedora_hello_world/service/main.py
Name=org.fedoraproject.Anaconda.Addons.HelloWorld
Exec=/usr/libexec/anaconda/start-module org_fedora_hello_world.service
User=root

このファイルは、インストール環境の /usr/share/anaconda/dbus/services/ ディレクトリーに置く必要があります。org.fedoraproject.Anaconda.Addons.HelloWorld は D-Bus 上の addon のサービスの場所に対応する必要があります。Exec= で始まる行の値は、インストール環境でサービスを開始する有効なコマンドである必要があります。

アドオンのキックスタートサポートと同様に、GUI サポートでは、アドオンのすべての部分に、API で定義される特定のクラスから継承されたクラスを定義するモジュールが少なくとも 1 つ含まれる必要があります。グラフィカルアドオンサポートの場合、追加すべき唯一のクラスは NormalSpoke クラスで、これはスクリーンの通常スポークタイプのクラスとして pyanaconda.ui.gui.spokes に定義されています。詳細については、Anaconda ユーザーインターフェイス を参照してください。

NormalSpoke から継承された新しいクラスを実装するには、API が必要とする以下のクラス属性を定義する必要があります。

本セクションでは、以下の大まかな手順を実行することで、アドオンのグラフィカルユーザーインターフェイス (GUI) にサポートを追加する方法を説明します。

# will never be translated
_ = lambda x: x
N_ = lambda x: x

# the path to addons is in sys.path so we can import things from org_fedora_hello_world
from org_fedora_hello_world.gui.categories.hello_world import HelloWorldCategory
from pyanaconda.ui.gui.spokes import NormalSpoke

# export only the spoke, no helper functions, classes or constants
all = ["HelloWorldSpoke"]

class HelloWorldSpoke(FirstbootSpokeMixIn, NormalSpoke):
    """
    Class for the Hello world spoke. This spoke will be in the Hello world
    category and thus on the Summary hub. It is a very simple example of a unit
    for the Anaconda's graphical user interface. Since it is also inherited form
    the FirstbootSpokeMixIn, it will also appear in the Initial Setup (successor
    of the Firstboot tool).

    :see: pyanaconda.ui.common.UIObject
    :see: pyanaconda.ui.common.Spoke
    :see: pyanaconda.ui.gui.GUIObject
    :see: pyanaconda.ui.common.FirstbootSpokeMixIn
    :see: pyanaconda.ui.gui.spokes.NormalSpoke

    """

    # class attributes defined by API #

    # list all top-level objects from the .glade file that should be exposed
    # to the spoke or leave empty to extract everything
    builderObjects = ["helloWorldSpokeWindow", "buttonImage"]

    # the name of the main window widget
    mainWidgetName = "helloWorldSpokeWindow"

    # name of the .glade file in the same directory as this source
    uiFile = "hello_world.glade"

    # category this spoke belongs to
    category = HelloWorldCategory

    # spoke icon (will be displayed on the hub)
    # preferred are the -symbolic icons as these are used in Anaconda's spokes
    icon = "face-cool-symbolic"

    # title of the spoke (will be displayed on the hub)
    title = N_("_HELLO WORLD")

__all__ 属性は spoke クラスをエクスポートします。この後に、以前 GUI アドオンの基本機能 で言及した、属性の定義を含む定義の最初の行が続きます。これらの属性値は、com_example_hello_world/gui/spokes/hello.glade ファイルで定義されるウィジェットを参照します。この他に、以下の 2 つの重要な属性があります。

通常、クラス定義のヘッダーとクラス attributes の定義に続くのは、クラスのインスタンスを初期化するコンストラクターです。Anaconda グラフィカルインターフェイスオブジェクトの場合、新しいインスタンスの初期化には __init__ メソッドおよび initialize メソッドの 2 つのメソッドがあります。

このようなメソッドが 2 つある理由は、spoke の初期化に時間がかかる可能性があるため、あるタイミングで GUI オブジェクトがメモリーに作成され、別のタイミングで完全に初期化される可能性があるためです。したがって、__init__ メソッドは親の _init__ メソッドのみを呼び出し、たとえば、GUI 以外の属性を初期化する必要があります。一方、インストーラーのグラフィカルユーザーインターフェイスの初期化時に呼び出される initialize メソッドは、スポークの完全な初期化を完了する必要があります。

Hello World add-on の例で、以下のようにこの 2 つのメソッドを定義します。__init__ メソッドに渡される引数の数および説明をメモしてください。

def __init__(self, data, storage, payload):
    """
    :see: pyanaconda.ui.common.Spoke.init
    :param data: data object passed to every spoke to load/store data
    from/to it
    :type data: pykickstart.base.BaseHandler
    :param storage: object storing storage-related information
    (disks, partitioning, bootloader, etc.)
    :type storage: blivet.Blivet
    :param payload: object storing packaging-related information
    :type payload: pyanaconda.packaging.Payload

    """

    NormalSpoke.init(self, data, storage, payload)
    self._hello_world_module = HELLO_WORLD.get_proxy()

def initialize(self):
    """
    The initialize method that is called after the instance is created.
    The difference between init and this method is that this may take
    a long time and thus could be called in a separate thread.
    :see: pyanaconda.ui.common.UIObject.initialize
    """
    NormalSpoke.initialize(self)
    self._entry = self.builder.get_object("textLines")
    self._reverse = self.builder.get_object("reverseCheckButton")

__init__ メソッドに渡されるデータパラメーターは、すべてのデータが保存されるキックスタートファイルのメモリー内ツリーのような表示になります。ancestor の __init__ メソッドのいずれかで、self.data 属性に格納されます。これにより、クラス内の他のすべてのメソッドで構造の読み取りおよび修正が可能になります。

HelloWorldData クラスは Hello World アドオンの例 ですでに定義されているため、このアドオンの self.data にはすでにサブツリーがあります。クラスのインスタンスである root は self.data.addons.com_example_hello_world として利用できます。

ancestor の __init__ が実行するもう 1 つのアクションは、spoke's .glade で GtkBuilder のインスタンスを初期化し、これを self.builder として保存することです。initialize メソッドはこれを使用して、キックスタートファイルの %addon セクションにあるテキストを表示し、変更するために使用される GtkTextEntry を取得します。

__init__ および initialize メソッドは両方とも、スポークの作成時に重要となります。ただし、スポークの主なロールは、スポークの値の表示と設定を変更または確認したいユーザーがアクセスすることです。これを有効にするには、その他の 3 つの方法を使用できます。

これらの関数は、以下のように Hello World アドオンのサンプルに実装されます。

def refresh(self):
    """
    The refresh method that is called every time the spoke is displayed.
    It should update the UI elements according to the contents of
    internal data structures.
    :see: pyanaconda.ui.common.UIObject.refresh
    """
    lines = self._hello_world_module.Lines
    self._entry.get_buffer().set_text("".join(lines))
    reverse = self._hello_world_module.Reverse
    self._reverse.set_active(reverse)

def apply(self):
    """
    The apply method that is called when user leaves the spoke. It should
    update the D-Bus service with values set in the GUI elements.
    """
    buf = self._entry.get_buffer()
    text = buf.get_text(buf.get_start_iter(),
                        buf.get_end_iter(),
                        True)
    lines = text.splitlines(True)
    self._hello_world_module.SetLines(lines)

    self._hello_world_module.SetReverse(self._reverse.get_active())

def execute(self):
  """
  The execute method that is called when the spoke is exited. It is
  supposed to do all changes to the runtime environment according to
  the values set in the GUI elements.

  """

  # nothing to do here
  pass

複数の追加のメソッドを使用して、スポークの状態を制御できます。

これらの属性はすべて、インストールプロセスの現在の状態に基づいて動的に決定する必要があります。

以下は、Hello World アドオンでのこれらのメソッドの実装例です。これには、HelloWorldData クラスの text 属性に特定の値を設定する必要があります。

@property
def ready(self):
    """
    The ready property reports whether the spoke is ready, that is, can be visited
    or not. The spoke is made (in)sensitive based on the returned value of the ready
    property.

    :rtype: bool

    """

    # this spoke is always ready
    return True


@property
def mandatory(self):
    """
    The mandatory property that tells whether the spoke is mandatory to be
    completed to continue in the installation process.

    :rtype: bool

    """

    # this is an optional spoke that is not mandatory to be completed
    return False

これらのプロパティーが定義された後、スポークはそのアクセス可能性と完全性を制御できますが、内部で設定された値のサマリーを提供することはできません。スポークにアクセスして、スポークがどのように設定されているかを確認する必要がありますが、これは望ましくない場合があります。このため、status という追加のプロパティーが存在します。このプロパティーには、設定された値の短いサマリーを含む 1 行のテキストが含まれ、スポークタイトルの下のハブに表示することができます。

status プロパティーは、以下のように Hello World の例のアドオンで定義されます。

@property
def status(self):
    """
    The status property that is a brief string describing the state of the
    spoke. It should describe whether all values are set and if possible
    also the values themselves. The returned value will appear on the hub
    below the spoke's title.
    :rtype: str
    """
    lines = self._hello_world_module.Lines
    if not lines:
        return _("No text added")
    elif self._hello_world_module.Reverse:
        return _("Text set with {} lines to reverse").format(len(lines))
    else:
        return _("Text set with {} lines").format(len(lines))

例で説明しているプロパティーをすべて定義した後に、アドオンには、グラフィカルユーザーインターフェイス (GUI) とキックスタートを示す完全なサポートがあります。

主な制限の 1 つとして、それぞれのスポークに独自のメインウィンドウ (SpokeWindow ウィジェットのインスタンス) が必要である点が挙げられます。このウィジェットは、Anaconda 固有の他のウィジェットとともに、anaconda-widgets パッケージにあります。Glade など、GUI サポートでアドオンの開発に必要な他のファイルは、anaconda-widgets-devel パッケージで見つけることができます。

グラフィカルインターフェイスのサポートモジュールに、必要な方法をすべて含むと、以下のセクションへ進んでテキストベースのユーザーインターフェイスのサポートを追加するか、Anaconda アドオンのデプロイおよびテスト へ進んでアドオンをテストすることができます。

pyanaconda パッケージには、ヘルパー関数やユーティリティー関数が複数含まれ、ハブやスポークで使用されるコンストラクトも含まれます。そのほとんどは、pyanaconda.ui.gui.utils パッケージにあります。

Hello World アドオンの例は、Anaconda も使用する englightbox コンテンツマネージャーの使用方法を示しています。このコンテンツマネージャーはウィンドウをライトボックスに入れ、可視性を高め、ユーザーの基礎となるウィンドウとの対話を防ぐことに重点を置くことができます。この機能を示すために、サンプルアドオンには新しいダイアログウィンドウを開くボタンが含まれています。ダイアログ自体は、pyanaconda.ui.gui.init で定義される GUIObject クラスから継承される特別な HelloWorldDialog です。

ダイアログクラスは、self.window 属性を介してアクセス可能な内部 Gtk ダイアログを実行および破棄する run メソッドを定義します。この属性は、同じ意味の mainWidgetName クラス属性を使用して設定されます。そのため、以下の例のようにダイアログを定義するコードは非常にシンプルです。

        # every GUIObject gets ksdata in init
        dialog = HelloWorldDialog(self.data)

        # show dialog above the lightbox
        with self.main_window.enlightbox(dialog.window):
            dialog.run()

Defining an englightbox Dialog のサンプルコードは、ダイアログのインスタンスを作成してから、enlightbox コンテキストマネージャーを使用してライトボックス内でダイアログを実行します。コンテキストマネージャーにはスポークのウィンドウへの参照があり、ダイアログのライトボックスをインスタンス化するためにダイアログのウィンドウだけを必要とします。

Anaconda が提供するもう 1 つの便利な機能は、インストール時および最初の再起動後に表示されるスポークを定義する機能です。Initial Setup ユーティリティーは、アドオングラフィカルユーザーインターフェイス (GUI) のサポートの追加 で説明されています。Anaconda と初期セットアップの両方でスポークを使用できるようにするには、pyanaconda.ui.common モジュールで定義される最初の継承クラスとして、特別な FirstbootSpokeMixIn クラス (別称 mixin) を継承する必要があります。

スポークを Anaconda および初期セットアップの再設定モードで使用できるようにするには、pyanaconda.ui.common モジュールで定義された最初の継承クラスとして、mixin とも呼ばれる特別な FirstbootSpokeMixIn クラスを継承する必要があります。

初期セットアップでのみ特定のスポークを利用可能にする場合は、このスポークは代わりに FirstbootOnlySpokeMixIn クラスを継承する必要があります。

次の例に示すように、スポークを Anaconda と初期設定の両方で常に使用できるようにするには、スポークで should_run メソッドを再定義する必要があります。

@classmethod
    def should_run(cls, environment, data):
    """Run this spoke for Anaconda and Initial Setup"""
    return True

pyanaconda パッケージは、@gtk_action_wait および @gtk_action_nowait デコレーターなど、より高度な機能を提供しますが、これらは本書の対象外となっています。その他の例については、インストーラーのソースを参照してください。

Anaconda は、テキストベースのインターフェイス (TUI) にも対応しています。このインターフェイスは機能がさらに制限されていますが、一部のシステムでは、インタラクティブインストールの唯一の選択肢となる場合があります。テキストベースのインターフェイスとグラフィカルインターフェイスの違い、および TUI の制限に関する詳細は、Introduction to Anaconda and add-ons を参照してください。

インストーラーのテキストモードサポートは simpleline ライブラリーに基づいており、非常にシンプルなユーザーの対話のみを許可します。テキストモードインターフェイスは、

内部的には、simpleline ツールキットには、App、UIScreen、および Widget の 3 つの主要クラスがあります。ウィジェットは、画面に出力される情報が含まれるユニットです。これらは、App クラスの単一のインスタンスによって切り替えられる UIScreens に配置されます。基本的な要素に加え、hubs、spoke`s and `dialogs はすべて、グラフィカルインターフェイスと同じような方法でさまざまなウィジェットを含んでいます。

アドオンで最も重要なクラスは、NormalTUISpoke および pyanaconda.ui.tui.spokes パッケージで定義される他のさまざまなクラスです。これらのクラスはすべて TUIObject クラスをベースとしています。このクラス自体は、Add-on GUI advanced features で説明されている GUIObject クラスと同じものになります。各 TUI スポークは、NormalTUISpoke クラスを継承する Python クラスであり、API で定義される特別な引数とメソッドをオーバーライドします。テキストインターフェイスは GUI よりも簡単なため、引数は以下の 2 つのみになります。

各スポークは、複数のメソッドをオーバーライドすることも想定されています。複数のメソッドとは init、initialize、refresh、refresh、apply、execute、input、prompt、および properties (ready、completed、mandatory、および status) になります。

以下の例は、Hello World サンプルアドオンのシンプルな Text User Interface (TUI) スポークの実装を示しています。

def __init__(self, *args, **kwargs):
    """
    Create the representation of the spoke.

    :see: simpleline.render.screen.UIScreen
    """
    super().__init__(*args, **kwargs)
    self.title = N_("Hello World")
    self._hello_world_module = HELLO_WORLD.get_proxy()
    self._container = None
    self._reverse = False
    self._lines = ""

def initialize(self):
    """
    The initialize method that is called after the instance is created.
    The difference between __init__ and this method is that this may take
    a long time and thus could be called in a separated thread.

    :see: pyanaconda.ui.common.UIObject.initialize
    """
    # nothing to do here
    super().initialize()

def setup(self, args=None):
    """
    The setup method that is called right before the spoke is entered.
    It should update its state according to the contents of DBus modules.

    :see: simpleline.render.screen.UIScreen.setup
    """
    super().setup(args)

    self._reverse = self._hello_world_module.Reverse
    self._lines = self._hello_world_module.Lines

    return True

def refresh(self, args=None):
    """
    The refresh method that is called every time the spoke is displayed.
    It should generate the UI elements according to its state.

    :see: pyanaconda.ui.common.UIObject.refresh
    :see: simpleline.render.screen.UIScreen.refresh
    """
    super().refresh(args)

    self._container = ListColumnContainer(
        columns=1
    )
    self._container.add(
        CheckboxWidget(
            title="Reverse",
            completed=self._reverse
        ),
        callback=self._change_reverse
    )
    self._container.add(
        EntryWidget(
            title="Hello world text",
            value="".join(self._lines)
        ),
        callback=self._change_lines
    )

    self.window.add_with_separator(self._container)

def _change_reverse(self, data):
    """
    Callback when user wants to switch checkbox.
    Flip state of the "reverse" parameter which is boolean.
    """
    self._reverse = not self._reverse

def _change_lines(self, data):
    """
    Callback when user wants to input new lines.
    Show a dialog and save the provided lines.
    """
    dialog = Dialog("Lines")
    result = dialog.run()
    self._lines = result.splitlines(True)

def input(self, args, key):
    """
    The input method that is called by the main loop on user's input.

    * If the input should not be handled here, return it.
    * If the input is invalid, return InputState.DISCARDED.
    * If the input is handled and the current screen should be refreshed,
      return InputState.PROCESSED_AND_REDRAW.
    * If the input is handled and the current screen should be closed,
      return InputState.PROCESSED_AND_CLOSE.

    :see: simpleline.render.screen.UIScreen.input
    """
    if self._container.process_user_input(key):
        return InputState.PROCESSED_AND_REDRAW

    if key.lower() == Prompt.CONTINUE:
        self.apply()
        self.execute()
        return InputState.PROCESSED_AND_CLOSE

    return super().input(args, key)

def apply(self):
    """
    The apply method is not called automatically for TUI. It should be called
    in input() if required. It should update the contents of internal data
    structures with values set in the spoke.
    """
    self._hello_world_module.SetReverse(self._reverse)
    self._hello_world_module.SetLines(self._lines)

def execute(self):
    """
    The execute method is not called automatically for TUI. It should be called
    in input() if required. It is supposed to do all changes to the runtime
    environment according to the values set in the spoke.
    """
    # nothing to do here
    pass

上の例では、以下のようになります。

別のスポークで入力した追加情報が必要な場合など、別の画面を表示するには、別の TUIObject をインスタンス化し、ScreenHandler.push_screen_modal() を使用してそれを表示します。

テキストベースのインターフェイスの制限により、TUI スポークは非常によく似た構造を持つ傾向があり、ユーザーがチェックまたはチェックを外して入力する必要があるチェックボックスまたはエントリーのリストで設定されます。

Defining a Simple TUI Spoke の例では、メソッドが利用可能かつ提供されるデータの出力と処理に対処する TUI スポークを実装する方法が示されました。しかし、pyanaconda.ui.tui.spokes パッケージから Normal EditTUISpoke クラスを使用し、これを実行する別の方法があります。このクラスを継承することで、設定する必要のあるフィールドと属性を指定するだけで、一般的な TUI スポークを実装できます。以下の例で説明します。

class HelloWorldEditSpoke(NormalTUISpoke):
    """Example class demonstrating usage of editing in TUI"""

    category = HelloWorldCategory

    def init(self, data, storage, payload):
        """
        :see: simpleline.render.screen.UIScreen
        :param data: data object passed to every spoke to load/store data
                     from/to it
        :type data: pykickstart.base.BaseHandler
        :param storage: object storing storage-related information
                        (disks, partitioning, bootloader, etc.)
        :type storage: blivet.Blivet
        :param payload: object storing packaging-related information
        :type payload: pyanaconda.packaging.Payload
        """
        NormalTUISpoke.init(self, data, storage, payload)

        self.title = N_("Hello World Edit")
        self._container = None
        # values for user to set
        self._checked = False
        self._unconditional_input = ""
        self._conditional_input = ""

    def refresh(self, args=None):
        """
        The refresh method that is called every time the spoke is displayed.
        It should update the UI elements according to the contents of
        self.data.
        :see: pyanaconda.ui.common.UIObject.refresh
        :see: simpleline.render.screen.UIScreen.refresh
        :param args: optional argument that may be used when the screen is
                     scheduled
        :type args: anything
        """
        super().refresh(args)
        self._container = ListColumnContainer(columns=1)

        # add ListColumnContainer to window (main window container)
        # this will automatically add numbering and will call callbacks when required
        self.window.add(self._container)

        self._container.add(CheckboxWidget(title="Simple checkbox", completed=self._checked),
                            callback=self._checkbox_called)
        self._container.add(EntryWidget(title="Unconditional text input",
                                        value=self._unconditional_input),
                            callback=self._get_unconditional_input)

        # show conditional input only if the checkbox is checked
        if self._checked:
            self._container.add(EntryWidget(title="Conditional password input",
                                            value="Password set" if self._conditional_input
                                            else ""),
                                callback=self._get_conditional_input)

        self._window.add_separator()


    @property
    def completed(self):
        # completed if user entered something non-empty to the Conditioned input
        return bool(self._conditional_input)
    @property
    def status(self):
        return "Hidden input %s" % ("entered" if self._conditional_input
                                    else "not entered")

    def apply(self):
        # nothing needed here, values are set in the self.args tree
        pass

独自の Anaconda アドオンをインストール環境にデプロイしてテストできます。テストを行う方法については、以下の手順に従います。

既存のブートイメージをデプロイメントし、product.img ファイルを作成してイメージを再パッケージ化する方法は、Extracting Red Hat Enterprise Linux boot images を参照してください。

product.img イメージファイルは、実行時に既存のインストーラーファイルを置き換える新しいインストーラーファイルを含むアーカイブです。

システムの起動時に、Anaconda は起動用メディア上の images/ ディレクトリーから product.img ファイルを読み込みます。その後、このディレクトリーにあるファイルを使用して、インストーラーのファイルシステムで同じ名前が付けられたファイルを置き換えます。置き換えると、インストーラーをカスタマイズします (例: デフォルトのイメージをカスタムイメージに置き換えるためなど)。

備考:インストーラーのカスタマイズにはこれが必要になります (例えば、デフォルトのイメージをカスタムのもので置き換える場合)。product.img イメージに含まれるディレクトリーは、インストーラーと同じディレクトリー構造である必要があります。インストーラーのディレクトリー構造の詳細については、以下の表を参照してください。

以下の手順では、product.img ファイルの作成方法を説明します。

これで product.img ファイルが作成され、作成するカスタマイズがそれぞれのディレクトリーに配置されるようになりました。

ブートイメージと GUI レイアウトをカスタマイズしたら、変更を含む新しいイメージを作成します。

カスタムブートイメージを作成するには、以下の手順に従います。