From 4640626a25618d33b6531d9bb127c7050f3cc910 Mon Sep 17 00:00:00 2001 From: Souvik Sarkar Date: Thu, 6 Nov 2025 19:53:06 +0530 Subject: [PATCH] PR#527 and other editorial review corrections for Agama auto installation docs --- articles/agama-automated-installation.asm.xml | 12 +- ...ion-automated-installation-using-agama.xml | 58 ++++----- ...erstanding-agama-installation-profiles.xml | 38 +++--- ...more-info-automated-installation-agama.xml | 12 +- .../agama-advanced-storage-configuration.xml | 6 +- .../agama-installation-profile-details.xml | 59 +++++---- ...autoyast-agama-compatibility-reference.xml | 112 +++++++++--------- ...eshooting-agama-automated-installation.xml | 2 +- tasks/using-autoyast-profiles-with-agama.xml | 66 +++++------ 9 files changed, 183 insertions(+), 182 deletions(-) diff --git a/articles/agama-automated-installation.asm.xml b/articles/agama-automated-installation.asm.xml index d2d559033..4731e834a 100644 --- a/articles/agama-automated-installation.asm.xml +++ b/articles/agama-automated-installation.asm.xml @@ -41,7 +41,7 @@ - Using Auto&yast; profiles with &agama; + Using &ay; profiles with &agama; Initiating automated installation using Agama @@ -65,7 +65,7 @@ - Compatibility between Auto&yast; and &agama; profiles + Compatibility between &ay; and &agama; profiles @@ -116,7 +116,7 @@ How to automate &productname; installations for unattended bulk deployments using &agama;, ensuring efficient and consistent server provisioning Automatically install &productnameshort; using &agama; - + @@ -164,7 +164,7 @@ EFFORT - You may need 30 minutes to read and understand the most important sections of this + You need about 30 minutes to read and understand the most important sections of this article. The time required for customization of Agama profiles and storage configuration depends on deployment requirements. @@ -185,7 +185,7 @@ - A bare metal server or a virtual machine. For server installations without any + A bare-metal server or a virtual machine. For server installations without any desktop environment, &suse; recommends a minimum of 1 CPU, 2 GB memory and 32 GB storage (which includes storage for Btrfs snapshots in the root partition, swap space, and storage for software packages). @@ -206,7 +206,7 @@ Optional registration Certain images that are signed with the developer's key may allow you to skip - registration before or while installation. Besides, certain images may + registration before or during installation. Besides, certain images may contain all installable packages for your operating system that you can use as an offline package repository. In such cases, you may not need an active registration code before installation. However, if you use software packages diff --git a/concepts/introduction-automated-installation-using-agama.xml b/concepts/introduction-automated-installation-using-agama.xml index b952dc20b..d9729af81 100644 --- a/concepts/introduction-automated-installation-using-agama.xml +++ b/concepts/introduction-automated-installation-using-agama.xml @@ -27,8 +27,8 @@ This article describes how to use &agama; for automated and unattended installation of &productname;. You can use JSON profiles describing different aspects - of intended system, and &agama; installs accordingly. While not a fully backward compatible - replacement for Auto&yast;, it simplifies the task of automated installation and provides + of the intended system, and &agama; installs accordingly. While not a fully backward compatible + replacement for &ay;, it simplifies the task of automated installation and provides multiple clients for interactive and automated installation. @@ -36,23 +36,23 @@
What is &agama; - Agama as a service-based Linux installer capable of performing both interactive and - unattended installations. You can provide &agama; a JSON profile file detailing the initial + Agama is a service-based Linux installer capable of performing both interactive and + unattended installations. You can provide &agama; with a JSON profile file detailing the initial system state, such as user authentication, partitioning, networking and software selection. - On receiving the profile and instruction for installation from one of its supported clients, + On receiving the profile and instructions for installation from one of its supported clients, &agama; installs your target system accordingly. Users can interact with and control the - installation process using &agama;'s web-based user interface, command-line interface and + installation process using &agama;'s Web-based user interface, command-line interface and HTTP API, facilitating automation and integration into existing workflows. While &agama; reuses many principles and internal components from previous SUSE installers - like &yast; and Auto&yast;, and offers a high level of backwards compatibility for unattended - installations, it is not a 100% compatible drop-in replacement for all Auto&yast; features. + like &yast; and &ay;, and offers a high level of backward compatibility for unattended + installations, it is not a 100% compatible drop-in replacement for all &ay; features. &agama; focuses only on the installation process rather than being a general configuration tool.
- &agama; server client architecture + &agama; client-server architecture @@ -60,15 +60,19 @@ + + Diagram of &agama;'s client-server architecture showing three clients—CLI, + Web UI and others—connecting to the &agama; core via an HTTP API +
- Why use &agama; for automated installation + Why use &agama; for automated installation? - &agama;offers its installation service by exposing an HTTP API, which you can use - interactively from a web-based interface and a command-line interface (CLI), or provide a - JSON profile to &agama; for automated installation of a target system. Using the HTTP API you + &agama;offers its installation service through an HTTP API, which you can use + interactively from a Web-based interface and a command-line interface (CLI), or provide a + JSON profile to &agama; for automated installation of a target system. Using the HTTP API, you can also integrate with custom scripts and deployment tools. The benefits of using Agama for automated installation are as follows: @@ -79,16 +83,16 @@ &agama; focuses on core installation tasks such as user authentication, network configuration, storage setup and software installation, delegating further - configuration to other tools such as &ansible; &salt;, &cockpit; or &openscap;. + configuration to other tools such as &ansible;, &salt;, &cockpit; or &openscap;. - Profile based installation + Profile-based installation You can define installation parameters for the target system in an easily readable and - editable JSON or Jsonnet profile. Existing XML based Auto&yast; are also supported with + editable JSON or Jsonnet profile. Existing XML-based &ay; profiles are also supported with some exceptions. @@ -100,8 +104,8 @@ The profile allows detailed setup including user authentication, product registration, network connections, storage (drives, partitions, LVM, RAID, encryption, resizing, deleting), software selection by patterns and packages, localization (language, - keyboard, timezone) and many other aspects of the target system that are not exposed in - the graphical or web-based interface. This helps in a more granular control over the + keyboard, time zone) and many other aspects of the target system that are not exposed in + the graphical or Web-based interface. This provides a more granular level of control over the installation parameters. @@ -111,20 +115,20 @@ &agama; supports dynamic profiles using Jsonnet, injecting hardware information that - can be processed at runtime. This avoids reliance on Auto&yast;'s rules or ERB for + can be processed at runtime. This avoids reliance on &ay;'s rules or ERB for dynamic configurations. - Auto&yast; compatibility + &ay; compatibility - &agama; offers a mechanism to reuse existing AutoYaST profiles to a great extent. It + &agama; offers a mechanism to reuse existing &ay; profiles to a great extent. It supports some dynamic features such as pre-scripts, rules/classes, and Embedded Ruby - (ERB) when using Auto&yast; profiles. A legacyAutoyastStorage - section allows direct use of the Auto&yast; profile's partitioning - section for backwards compatibility. + (ERB) when using &ay; profiles. A legacyAutoyastStorage + section allows direct use of the &ay; profile's partitioning + section for backward compatibility. @@ -143,11 +147,11 @@ The typical way to start an unattended installation from an ISO image is using the - inst.auto kernel boot option, pointing to the profile URL or it's + inst.auto kernel boot option, pointing to the profile URL or its location in the hard drive. You can also use the agama profile import command from the &agama; CLI to load a profile, followed by the - agama install command. The CLI also allows inspection, modification, - validation of the profile, and subsequent monitoring of the installation process. + agama install command. The CLI also allows inspection, modification + and validation of the profile, and subsequent monitoring of the installation process. diff --git a/concepts/understanding-agama-installation-profiles.xml b/concepts/understanding-agama-installation-profiles.xml index 47d267578..2a4c59d45 100644 --- a/concepts/understanding-agama-installation-profiles.xml +++ b/concepts/understanding-agama-installation-profiles.xml @@ -29,21 +29,20 @@ configuration file that specifies how the system should be set up. This profile describes various aspects of the installation, including partitioning, networking, software selection, and other options. The concept of using a profile for automated installation is - similar to Auto&yast;. &agama; focuses specifically on the installation process itself and + similar to &ay;. &agama; focuses specifically on the installation process itself and delegates further system configuration to other tools. &agama; aims for a high level of - backward compatibility with Auto&yast; profiles for automated installations. + backward compatibility with &ay; profiles for automated installations. - Difference between &agama; and Auto&yast; profiles + Difference between &agama; and &ay; profiles - &agama; and Auto&yast; profiles are largely compatible for all common use cases. However, - &agama; profiles are not fully compatible with Auto&yast; profiles, and cannot be used as + &agama; and &ay; profiles are largely compatible for all common use cases. However, + &agama; profiles are not fully compatible with &ay; profiles, and cannot be used as a drop-in replacement without checking the compatibility. There are certain aspects of - the Auto&yast; profiles that are currently supported in &agama; profiles, or may be + the &ay; profiles that are currently supported in &agama; profiles, or may be supported in the future. However, there are certain other aspects that are neither currently supported in &agama; profiles, nor will be supported in the future. For more - information, refer to the section - . + information, refer to the section . @@ -51,7 +50,7 @@
Introduction to the &agama; profile structure - &agama; profile configuration is defined using a JSON document. It contains several sections + The &agama; profile configuration is defined using a JSON document. It contains several sections that are necessary for describing the installation parameters for a customized system. At a high level, the profile consists of the following sections: @@ -92,7 +91,7 @@ - localization: Language, keyboard, and timezone settings. + localization: Language, keyboard, and time zone settings. @@ -112,7 +111,7 @@ - bootloader: Bootloader config and kernel params. + bootloader: Boot loader config and kernel params. @@ -137,7 +136,7 @@ - legacyAutoyastStorage: Support for legacy AutoYaST JSON-style storage. + legacyAutoyastStorage: Support for legacy &ay; JSON-style storage. @@ -158,8 +157,8 @@ For more information on the JSON and Jsonnet profiles, refer to the resources mentioned in - the section. The upstream - resources usually contains most updated information and examples about the profiles. + . The upstream + resources usually contain most updated information and examples about the profiles.
@@ -167,10 +166,9 @@ A minimal &agama; JSON profile must at least include sections for product identification, product registration, and credentials for the root user. &agama; uses the defaults for the - rest of the profile. As a best practice, you should also configure the following as a best - practice: + rest of the profile. As a best practice, you should also configure the following: - A hostname + A host name A non-root user Minimal localization settings @@ -211,7 +209,7 @@ - You can generated a hashed password by running the following command: + You can generate a hashed password by running the following command: &prompt.sudo;openssl passwd -6 @@ -222,8 +220,8 @@ &prompt.sudo;ssh-keygen -t rsa -b 4096 -C "YOUR-EMAIL@EXAMPLE.COM" - Based on your requirements, choose the key type and the key size. However, it's better - to adopt a stronger security. + Based on your requirements, choose the key type and the key size. However, it is better + to adopt stronger security. diff --git a/glues/more-info-automated-installation-agama.xml b/glues/more-info-automated-installation-agama.xml index da39f8ec2..df30d6b94 100644 --- a/glues/more-info-automated-installation-agama.xml +++ b/glues/more-info-automated-installation-agama.xml @@ -38,7 +38,7 @@ &agama; user documentation: Organizes information by user perspective and covers a wide range of - topics, including interactive installation, unattended installation, Auto&yast; support, + topics, including interactive installation, unattended installation, &ay; support, boot options, URLs, command-line reference, and remote access. @@ -64,9 +64,9 @@ &agama; - Auto&yast; compatibility reference: Essential for users migrating from - Auto&yast; or planning to reuse Auto&yast; profiles. It details the support status of - various Auto&yast; profile sections and elements within &agama;. + &ay; compatibility reference: Essential for users migrating from + &ay; or planning to reuse &ay; profiles. It details the support status of + various &ay; profile sections and elements within &agama;. @@ -80,7 +80,7 @@ &agama; project on GitHub: - Contains source code for the &agama; installer, which you can use to deep dive into the + Contains the source code for the &agama; installer, which you can use to deep dive into the installer's internals. @@ -95,7 +95,7 @@ &agama; - profile example in Jsonnet. + profile example in Jsonnet diff --git a/references/agama-advanced-storage-configuration.xml b/references/agama-advanced-storage-configuration.xml index 2c3dbbb3b..1bdc1b1c5 100644 --- a/references/agama-advanced-storage-configuration.xml +++ b/references/agama-advanced-storage-configuration.xml @@ -65,12 +65,12 @@ - Compatibility with legacy Auto&yast; storage + Compatibility with legacy &ay; storage In some cases, storage can be replaced by the legacyAutoyastStorage section. This section supports everything offered - by the partitioning section of the Auto&yast; profile. However, &agama; - does not validate this special section—be careful to provide valid Auto&yast; + by the partitioning section of the &ay; profile. However, &agama; + does not validate this special section—be careful to provide valid &ay; options. diff --git a/references/agama-installation-profile-details.xml b/references/agama-installation-profile-details.xml index d35d1e144..6438bec88 100644 --- a/references/agama-installation-profile-details.xml +++ b/references/agama-installation-profile-details.xml @@ -75,7 +75,7 @@ registrationCode - The registration code for the product obtained from &scc;, and used to activate + The registration code for the product obtained from the &scc; and used to activate repositories and receive updates. @@ -84,7 +84,7 @@ registrationEmail - The email address associated with the registration account used during product + The e-mail address associated with the registration account used during product activation. @@ -93,7 +93,7 @@ registrationUrl - The full URL of the registration server. If you are using &scc;, you can omit this + The full URL of the registration server. If you are using the &scc;, you can omit this field. However, it is useful when registering from a custom server. @@ -130,10 +130,10 @@
- Hostname configuration for an &agama; installation profile + Host name configuration for an &agama; installation profile - The hostname section sets the system's static and transient hostname. The - static hostname is persistent across reboots, while the transient hostname is used + The hostname section sets the system's static and transient host name. The + static host name is persistent across reboots, while the transient host name is used temporarily at runtime and may be overridden by network services like DHCP. @@ -153,9 +153,9 @@ static - The persistent hostname written to /etc/hostname. This name + The persistent host name written to /etc/hostname. This name remains consistent across system reboots and is used by default if no transient - hostname is specified. + host name is specified. @@ -163,7 +163,7 @@ transient - A temporary hostname applied at runtime. This may be used during deployment or + A temporary host name applied at runtime. This may be used during deployment or installation to reflect an ephemeral identity. For example, it can be set via DHCP or by installation tooling like &agama;. @@ -208,12 +208,12 @@ The root user's password. If hashedPassword is - true, this must be a pre-generated hash (For example, using + true, this must be a pre-generated hash (for example, using openssl passwd -6). Otherwise, plain text is accepted and will be hashed during installation. - You can generated a hashed password by running the following command: + You can generate a hashed password by running the following command: &prompt.sudo;openssl passwd -6 @@ -233,8 +233,8 @@ &prompt.sudo;ssh-keygen -t rsa -b 4096 -C "YOUR-EMAIL@EXAMPLE.COM" - Based on your requirements, choose the key type and the key size. However, it's better - to adopt a stronger security. + Based on your requirements, choose the key type and the key size. However, it is better + to adopt stronger security. @@ -295,7 +295,7 @@ password - The user's password, in plain text or pre-hashed depending on the + The user's password, in plain text or pre-hashed, depending on the hashedPassword flag. If plaintext is provided, it will be automatically hashed. @@ -337,7 +337,7 @@ language - The system language and locale, specified as a locale string. For example, + The system language and locale specified as a locale string. For example, en_US.UTF-8 or de_DE. This controls messages, number formats, date formats, and default encoding. @@ -357,7 +357,7 @@ timezone - The system time zone, using a region/location format. For example, + The system time zone using a region/location format. For example, Europe/Berlin. This sets the default system clock and affects date/time display. @@ -462,9 +462,8 @@ Advanced storage configuration An exhaustive description of all possible storage configuration using &agama; is beyond the - scope of this section, as it will need a careful consideration of the storage model schema. - For information on advanced storage configuration, refer to the section - . + scope of this section, as it will need careful consideration of the storage model schema. + For information on advanced storage configuration, refer to . @@ -492,18 +491,18 @@ that kind of devices. - Compatibility with legacy Auto&yast; storage + Compatibility with legacy &ay; storage In some cases, storage can be replaced by the legacyAutoyastStorage section. This section supports everything offered - by the partitioning section of the Auto&yast; profile. However, &agama; - does not validate this special section—be careful to provide valid Auto&yast; + by the partitioning section of the &ay; profile. However, &agama; + does not validate this special section—be careful to provide valid &ay; options.
- Bootloader configuration for an &agama; installation profile + Boot loader configuration for an &agama; installation profile The bootloader section defines boot-time behavior, including whether to pause at the boot menu and what extra kernel parameters to pass. It affects the installed @@ -627,7 +626,7 @@ Support for IEEE 802.1X authentication is intended for advanced enterprise - deployments where authentication is required at the link layer, before IP is + deployments where authentication is required at the link layer, before an IP is assigned. This commonly involves integration with RADIUS and certificate-based trust. Misconfiguration can result in complete network inaccessibility. Refer to systemd-networkd documentation for authoritative guidance. @@ -700,7 +699,7 @@ autoconnect - Boolean. Whether the connection is brought up automatically. + Boolean. Specifies whether the connection is brought up automatically. @@ -739,7 +738,7 @@ - stp: Boolean. Enables Spanning Tree Protocol. + stp: Boolean. Enables the Spanning Tree Protocol. @@ -1086,9 +1085,9 @@
- Legacy AutoYaST storage configuration for an &agama; installation profile + Legacy &ay; storage configuration for an &agama; installation profile - The legacyAutoyastStorage section allows reuse of Auto&yast;-style storage + The legacyAutoyastStorage section allows reuse of &ay;-style storage definitions by expressing them in JSON. It accepts an array of opaque objects directly representing the legacy partitioning structure, allowing migration or backward compatibility for existing storage configurations. @@ -1126,7 +1125,7 @@ legacyAutoyastStorage - An array of JSON objects compatible with the XML structure used in Auto&yast;’s + An array of JSON objects compatible with the XML structure used in &ay;’s partitioning section. This allows experienced administrators to reuse complex partitioning logic without switching to &agama;-native storage syntax. @@ -1182,7 +1181,7 @@ - address: IP address or hostname of the iSCSI target. + address: IP address or host name of the iSCSI target. diff --git a/references/autoyast-agama-compatibility-reference.xml b/references/autoyast-agama-compatibility-reference.xml index 611509978..e5aa938d0 100644 --- a/references/autoyast-agama-compatibility-reference.xml +++ b/references/autoyast-agama-compatibility-reference.xml @@ -18,28 +18,28 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:trans="http://docbook.org/ns/transclusion"> - Compatibility between Auto&yast; and &agama; profiles + Compatibility between &ay; and &agama; profiles - Auto&yast; has long been the standard for unattended and automated installations in + &ay; has long been the standard for unattended and automated installations in &productname; systems. With the advent of the &agama; installer, a new approach to system - configuration and deployment has emerged—designed to be modular, declarative, and + configuration and deployment has emerged—designed to be modular, declarative and extensible using modern formats and APIs. - This section provides a detailed comparative view of the configuration models in Auto&yast; + This section provides a detailed comparative view of the configuration models in &ay; and &agama;, highlighting conceptual differences and offering practical guidance for - transitioning to the &agama; profile format. The goal is to equip experienced Auto&yast; + transitioning to the &agama; profile format. The goal is to equip experienced &ay; users with a clear roadmap for migrating existing profiles to the new &agama; schema. - Where applicable, compatibility matrices are provided to indicate which Auto&yast; modules + Where applicable, compatibility matrices are provided to indicate which &ay; modules and fields are currently supported, planned, undecided, or explicitly unsupported in &agama;. These mappings are based on the upstream reference maintained by the &agama; project. @@ -50,14 +50,14 @@ Conceptual differences This table highlights the fundamental differences in design philosophy and approach between - Auto&yast; and &agama;. + &ay; and &agama;. - Auto&yast; vs &agama; design comparison + &ay; vs &agama; design comparison - Auto&yast; + &ay; &agama; @@ -87,18 +87,18 @@
- Mapping Auto&yast; sections to &agama; schema + Mapping &ay; sections to &agama; schema This section provides a detailed comparison and translation map between the major sections - and modules of Auto&yast; and their equivalents (or lack thereof) in the &agama; profile + and modules of &ay; and their equivalents (or lack thereof) in the &agama; profile schema. Each subsection addresses a particular functional area, indicating how configuration responsibilities are split or restructured in &agama;, and clearly states where support is partial, planned, or unavailable. - Granular support status for Auto&yast; elements + Granular support status for &ay; elements - For a more granular information on the compatibility and support status for Auto&yast; + For a more granular information on the compatibility and support status for &ay; elements in &agama; profiles as compared to what is presented here, refer to the upstream documentation . @@ -107,9 +107,9 @@
System identity and localization - This section covers the basic configuration for setting the system's hostname, language, - keyboard layout, timezone, and the installed product identity. These are foundational - parameters during the installation and are typically mapped one-to-one between Auto&yast; + This section covers the basic configuration for setting the system's host name, language, + keyboard layout, time zone, and the installed product identity. These are foundational + parameters during the installation and are typically mapped one-to-one between &ay; and &agama;. @@ -117,7 +117,7 @@ - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -128,7 +128,7 @@ hostname hostname.static / hostname.transient Fully supported - &agama; distinguishes static and transient hostnames. + &agama; distinguishes static and transient host names. language @@ -146,7 +146,7 @@ timezone localization.timezone Fully supported - Timezone IDs follow the standard timezone database names (for example, Europe/Berlin). + Time zone IDs follow the standard time zone database names (for example, Europe/Berlin). product / base @@ -171,7 +171,7 @@ - Auto&yast; element + &ay; element Support status &agama; field Comment @@ -245,7 +245,7 @@
Network configuration - This section details how network settings are defined in Auto&yast; and &agama;, covering + This section details how network settings are defined in &ay; and &agama;, covering interface setup, DHCP/static addressing, bonding, bridging, and other advanced networking configurations. @@ -254,7 +254,7 @@
- Auto&yast; element + &ay; element &agama; field Support status Comment @@ -283,7 +283,7 @@ network/hostname hostname Fully supported - System hostname can be set independently of network block. + System host name can be set independently of network block. network/bridge @@ -316,8 +316,8 @@
Storage and partitioning - This section compares the storage configuration capabilities of Auto&yast; and &agama;. It - covers traditional partitions, logical volumes, filesystems, encryption, RAID, and other + This section compares the storage configuration capabilities of &ay; and &agama;. It + covers traditional partitions, logical volumes, file systems, encryption, RAID, and other storage-specific aspects of system setup.
@@ -325,7 +325,7 @@ - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -342,7 +342,7 @@ filesystems storage.devices[].partitions[].filesystem Fully supported - Common filesystems such as ext4, xfs, and btrfs are supported with mount and format options. + Common file systems such as ext4, XFS, and Btrfs are supported with mount and format options. lvm @@ -354,13 +354,13 @@ raid storage.devices[].partitions[].raid Fully supported - Software RAID levels (0, 1, 5, etc.) are supported including metadata and spare settings. + Software RAID levels (0, 1, 5, etc.) are supported, including metadata and spare settings. btrfs storage.devices[].partitions[].btrfs Fully supported - Subvolumes, compression, and btrfs-specific mount options are available. + Subvolumes, compression, and Btrfs-specific mount options are available. encryption @@ -393,7 +393,7 @@ Supports marking partitions as bootable, ESP, hidden, etc. - complex criteria (e.g., by-id) + complex criteria (for example, by-id) storage.devices[].match Fully supported Devices can be selected using labels, device paths, UUIDs, or custom match rules. @@ -405,15 +405,15 @@
Software selection and patterns - This section maps how software selection is handled in Auto&yast; and &agama;, including + This section maps how software selection is handled in &ay; and &agama;, including individual package installation and pattern-based selections.
- Software and pattern mapping between Auto&yast; and &agama; + Software and pattern mapping between &ay; and &agama; - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -449,16 +449,16 @@
- Bootloader settings + Boot loader settings - This section maps bootloader configuration options between Auto&yast; and &agama; profiles. + This section maps bootloader configuration options between &ay; and &agama; profiles. - Bootloader configuration mapping + Boot loader configuration mapping - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -475,13 +475,13 @@ bootloader—kernel_parameters bootloader.extraKernelParams Fully supported - Additional kernel command line parameters. + Additional kernel command-line parameters. bootloader—flag (for example, no_timeout) bootloader.stopOnBootMenu Fully supported - Controls whether the bootloader stops on the boot menu. + Controls whether the bootloader stops at the boot menu. bootloader—location @@ -502,7 +502,7 @@
Security, certificates, and registration - This section compares how Auto&yast; and &agama; handle security settings, certificate + This section compares how &ay; and &agama; handle security settings, certificate deployment, and system registration during installation.
@@ -510,7 +510,7 @@ - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -554,14 +554,14 @@
Pre-install, post-install, and init scripts - This section maps the script execution phases between Auto&yast; and &agama; profiles. + This section maps the script execution phases between &ay; and &agama; profiles.
- Script phases in Auto&yast; vs. &agama; + Script phases in &ay; vs. &agama; - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -599,7 +599,7 @@
File deployment and customization - This section compares how custom files can be deployed during installation using Auto&yast; + This section compares how custom files can be deployed during installation using &ay; and &agama; profiles.
@@ -607,7 +607,7 @@ - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -643,7 +643,7 @@
Miscellaneous hardware-specific sections - This section covers specialized hardware-related configuration elements from Auto&yast; and + This section covers specialized hardware-related configuration elements from &ay; and their equivalents (or lack thereof) in &agama;.
@@ -651,7 +651,7 @@ - Auto&yast; element + &ay; element &agama; field Support status Comment @@ -674,13 +674,13 @@ zipl — Not supported - Bootloader configuration on s390x is partially handled by other fields like bootloader but no direct equivalent for zipl. + Boot loader configuration on s390x is partially handled by other fields like bootloader but no direct equivalent for zipl. kdump — Not supported - &agama; does not currently support configuring kdump crash kernels. + &agama; does not currently support configuring &kdump; crash kernels. udev @@ -694,19 +694,19 @@
- Unsupported Auto&yast; profile elements in &agama; + Unsupported &ay; profile elements in &agama; - The following table lists Auto&yast; profile sections that are currently not supported by + The following table lists &ay; profile sections that are currently not supported by &agama;. These modules either have no equivalent functionality in &agama;, are considered legacy or niche, or are planned for future implementation. This list is essential for users - migrating from Auto&yast; to avoid misconfiguration or unmet expectations. + migrating from &ay; to avoid misconfiguration or unmet expectations.
- Unsupported Auto&yast; modules in &agama; + Unsupported &ay; modules in &agama; - Auto&yast; element + &ay; element Support status Comment @@ -785,7 +785,7 @@ host Not supported - Deprecated; handled through hostname and networking. + Deprecated; handled through host name and networking. http-server diff --git a/tasks/post-installation-troubleshooting-agama-automated-installation.xml b/tasks/post-installation-troubleshooting-agama-automated-installation.xml index 58b2e1100..a071385bf 100644 --- a/tasks/post-installation-troubleshooting-agama-automated-installation.xml +++ b/tasks/post-installation-troubleshooting-agama-automated-installation.xml @@ -18,7 +18,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:trans="http://docbook.org/ns/transclusion"> - Post installation troubleshooting of automated installation using &agama; diff --git a/tasks/using-autoyast-profiles-with-agama.xml b/tasks/using-autoyast-profiles-with-agama.xml index 872e4d190..bb1cae6c2 100644 --- a/tasks/using-autoyast-profiles-with-agama.xml +++ b/tasks/using-autoyast-profiles-with-agama.xml @@ -18,7 +18,7 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:trans="http://docbook.org/ns/transclusion"> - Using Auto&yast; profiles with &agama; + Using &ay; profiles with &agama; @@ -26,26 +26,26 @@ &agama; introduces a modern, declarative installation framework that diverges significantly - from the legacy Auto&yast; system, even though both aim to automate &productname; - deployments. While partial reuse of existing Auto&yast; profiles is possible, direct + from the legacy &ay; system, even though both aim to automate &productname; + deployments. While partial reuse of existing &ay; profiles is possible, direct compatibility is limited due to schema differences, semantic mismatches, and architectural - shifts. This topic outlines how to load Auto&yast; profiles in &agama;, identifies + shifts. This topic outlines how to load &ay; profiles in &agama;, identifies supported modules, and offers practical guidance for converting legacy profiles using recommended tools and conventions.
- Benefits of using Auto&yast; profiles in &agama; + Benefits of using &ay; profiles in &agama; - Reusing existing Auto&yast; profiles in &agama; provides a pragmatic starting point for teams + Reusing existing &ay; profiles in &agama; provides a pragmatic starting point for teams migrating to the new installer without discarding prior investments. Although direct - compatibility is limited, leveraging Auto&yast; profiles accelerates transition efforts by + compatibility is limited, leveraging &ay; profiles accelerates transition efforts by retaining core configuration logic, organizational conventions, and validated deployment workflows. - Using Auto&yast; profiles in &agama; has the following benefits: + Using &ay; profiles in &agama; has the following benefits: @@ -61,7 +61,7 @@ Faster onboarding - Administrators familiar with Auto&yast; can map known modules to &agama; fields + Administrators familiar with &ay; can map known modules to &agama; fields incrementally. @@ -70,7 +70,7 @@ Incremental migration - Supported Auto&yast; elements can be reused while unsupported ones are refactored or + Supported &ay; elements can be reused while unsupported ones are refactored or omitted over time. @@ -87,22 +87,22 @@
- Limitations of using Auto&yast; profiles in &agama; + Limitations of using &ay; profiles in &agama; - While reusing Auto&yast; profiles in &agama; may provide a head start during migration, it + While reusing &ay; profiles in &agama; may provide a head start during migration, it also introduces significant limitations. The fundamental differences in schema structure, - execution model, and configuration philosophy mean that Auto&yast;-based profiles can + execution model, and configuration philosophy mean that &ay;-based profiles can constrain the effectiveness and clarity of &agama; workflows if carried over directly. - Using Auto&yast; profiles in &agama; has the following limitations: + Using &ay; profiles in &agama; has the following limitations: Procedural bias - Auto&yast; profiles often rely on execution order, embedded scripts, and imperative + &ay; profiles often rely on execution order, embedded scripts, and imperative constructs, which have no counterpart in &agama;’s declarative design. @@ -111,7 +111,7 @@ Semantic mismatch - Many Auto&yast; modules encapsulate behavior or assumptions not explicitly modeled in + Many &ay; modules encapsulate behavior or assumptions not explicitly modeled in &agama;, leading to subtle incompatibilities or misconfigurations during reuse. @@ -120,7 +120,7 @@ Reduced transparency - Profiles imported from Auto&yast; tend to obscure the declarative simplicity of + Profiles imported from &ay; tend to obscure the declarative simplicity of &agama;, making troubleshooting and peer review harder. @@ -137,28 +137,28 @@
- Loading Auto&yast; profiles with &agama; + Loading &ay; profiles with &agama; - &agama; supports loading Auto&yast; profiles as part of its transitional support for legacy + &agama; supports loading &ay; profiles as part of its transitional support for legacy automation systems. This allows administrators to reuse existing configuration assets while gradually migrating to the native &agama; profile format. Several loading mechanisms are available depending on the deployment context and profile structure. - Loading an Auto&yast; profile using &agama; + Loading an &ay; profile using &agama; - Use the following steps to load an Auto&yast; profile in &agama;. Profiles can be supplied + Use the following steps to load an &ay; profile in &agama;. Profiles can be supplied either through kernel boot parameters or imported using the &agama; CLI. - Select a method for providing the Auto&yast; profile to &agama;: + Select a method for providing the &ay; profile to &agama;: Load the profile using a kernel boot parameter. Add the inst.auto - parameter to the kernel command line and specify the URL of the Auto&yast; profile: + parameter to the kernel command line and specify the URL of the &ay; profile: &prompt.sudo;linux inst.auto=http://EXAMPLE.NET/AGAMA/SLES.xml @@ -168,7 +168,7 @@ Import the profile using the &agama; CLI. Run the following command to fetch and - preprocess the Auto&yast; profile: + preprocess the &ay; profile: &prompt.sudo;agama profile import URL @@ -183,7 +183,7 @@ - Auto&yast; profiles: .xml, .erb, and + &ay; profiles: .xml, .erb, and directories such as rules/ or classes/ @@ -193,7 +193,7 @@ . - When importing Auto&yast; content, the CLI automatically evaluates dynamic features + When importing &ay; content, the CLI automatically evaluates dynamic features such as: @@ -218,29 +218,29 @@ - Display the loaded or imported profile, or pip[e it to a JSON file: + Display the loaded or imported profile, or pipe it to a JSON file: &prompt.sudo;agama config show > profile.json
- Best practices for converting Auto&yast; profiles to &agama; profiles + Best practices for converting &ay; profiles to &agama; profiles - Converting Auto&yast; profiles to &agama; profiles involves transforming the original XML + Converting &ay; profiles to &agama; profiles involves transforming the original XML into &agama;'s JSON or Jsonnet format. This procedure outlines the recommended steps using the &agama; CLI. - Best practices for converting Auto&yast; profiles to &agama; profiles + Best practices for converting &ay; profiles to &agama; profiles - Convert the Auto&yast; profile to a JSON file by piping the CLI output to a destination + Convert the &ay; profile to a JSON file by piping the CLI output to a destination file: &prompt.sudo;agama profile autoyast http://EXAMPLE.NET/AUTOYAST.xml > profile.json - This command fetches and processes the Auto&yast; profile, then writes the resulting + This command fetches and processes the &ay; profile, then writes the resulting &agama;-compatible JSON to the specified file. @@ -262,7 +262,7 @@ If you require dynamic behavior, convert the profile to Jsonnet. You can then evaluate it - into JSON: + to JSON: &prompt.sudo;agama profile evaluate profile.jsonnet > profile.json