diff --git a/articles/agama-automated-installation.asm.xml b/articles/agama-automated-installation.asm.xml index 8b752cd53..5079efb4a 100644 --- a/articles/agama-automated-installation.asm.xml +++ b/articles/agama-automated-installation.asm.xml @@ -76,7 +76,7 @@ - Automated installation of &productname; using &agama; + Automated Installation of &productname; Using &agama; &productname; - Automated installation of &productname; using &agama; + Automated Installation of &productname; Using &agama; How to automate &productname; installations for unattended bulk deployments using &agama;, ensuring efficient and consistent server provisioning Automatically install &productnameshort;; using &agama; @@ -160,7 +160,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. @@ -181,7 +181,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). @@ -202,7 +202,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..936c69b73 100644 --- a/concepts/introduction-automated-installation-using-agama.xml +++ b/concepts/introduction-automated-installation-using-agama.xml @@ -27,7 +27,7 @@ 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 + of the 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 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 + like &yast; and Auto&yast;, and offers a high level of backward compatibility for unattended installations, it is not a 100% compatible drop-in replacement for all Auto&yast; 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 Auto&yast; 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. @@ -124,7 +128,7 @@ 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. + 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..046ef2ee3 100644 --- a/concepts/understanding-agama-installation-profiles.xml +++ b/concepts/understanding-agama-installation-profiles.xml @@ -42,8 +42,7 @@ the Auto&yast; 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 . @@ -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. @@ -137,7 +136,7 @@ - legacyAutoyastStorage: Support for legacy AutoYaST JSON-style storage. + legacyAutoyastStorage: Support for the 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 083b9294f..8cf7347d6 100644 --- a/glues/more-info-automated-installation-agama.xml +++ b/glues/more-info-automated-installation-agama.xml @@ -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 317f2ac74..9c6d07ff2 100644 --- a/references/agama-advanced-storage-configuration.xml +++ b/references/agama-advanced-storage-configuration.xml @@ -28,17 +28,17 @@ Storage configuration in &agama; is one of the most powerful and flexible components of the automated installation process. It allows you to declaratively define everything from simple partition layouts to sophisticated combinations of LUKS encryption, Logical Volume - Management (LVM), software RAID, and Btrfs subvolumes — all before the system is booted for + Management (LVM), software RAID, and Btrfs subvolumes—all before the system is booted for the first time. - This topic primarily describes the &agama; storage schema as described in + This topic primarily describes the &agama; storage schema defined in . Each section in this topic focuses on a specific capability or concept: basic partitions, encrypted volumes, nested logical volumes, RAID configurations, Btrfs setups, and advanced directives like preservation flags or formatting instructions. Together, they enable - reproducible, secure, and scalable disk layout management suitable. + reproducible, secure, and scalable disk layout management. @@ -60,7 +60,7 @@ Minimal top-level storage The following example illustrates only the bare minimum needed to define a disk object. It - does not reflect the full capabilities of the &agama; storage model such as partitioning, + does not reflect the full capabilities of the &agama; storage model, such as partitioning, encryption, volume management, or reuse behavior. These topics are covered in later sections. @@ -80,19 +80,19 @@
- Filesystems partitions + File system partitions - Standard partitions are used to create filesystems directly on a disk. These are the most + Standard partitions are used to create file systems directly on a disk. These are the most common storage entities and are defined under the partitions array inside - a disk object. Each partition can specify properties like mount points, filesystems type, + a disk object. Each partition can specify properties like mount points, file system type, format behavior, and reuse preferences. - The example below demonstrates a configuration that sets up two partitions: one EFI system - partition and one root partition formatted with XFS. + The example below demonstrates a configuration that sets up two partitions: an EFI system + partition and a root partition formatted with XFS. - Partitioned disk with EFI and root filesystems + Partitioned disk with EFI and root file systems [ { @@ -145,7 +145,7 @@ mountPoint - Mount point inside the target filesystems. Must be specified unless the partition is + Mount point inside the target file system. Must be specified unless the partition is unmounted. @@ -154,7 +154,7 @@ fsType - Filesystems type, such as xfs, ext4, or + File system type, such as xfs, ext4, or btrfs. Required unless format is false. @@ -183,7 +183,7 @@ LUKS encryption &agama; supports encrypting block devices using LUKS. Encrypted devices can be used as - mountable filesystems or as physical volumes in LVM setups. Each encrypted block must define + mountable file systems or as physical volumes in LVM setups. Each encrypted block must define its own passphrase or refer to a key file. @@ -191,7 +191,7 @@ mounted as the system root. - Root filesystem encrypted with LUKS + Root file system encrypted with LUKS [ { @@ -258,7 +258,7 @@ keySize - Key size in bits. Common values are 256 or 512. + Key size in bits. Common values are 256 and 512. @@ -408,7 +408,7 @@ level - The RAID level to use (e.g., 0, 1, + The RAID level to use (for example, 0, 1, 5, 6, or 10). @@ -426,7 +426,7 @@ The volume definition describing what should be created on top of the RAID array. It - may be a regular filesystem partition, a LUKS container, or an LVM setup. + may be a regular file system partition, a LUKS container, or an LVM setup. @@ -436,7 +436,7 @@ Btrfs layout &agama; supports configuring Btrfs subvolumes and mount points, allowing granular control - over snapshot-aware filesystems. You can define a top-level Btrfs partition or volume, then + over snapshot-aware file systems. You can define a top-level Btrfs partition or volume, then define subvolumes under it, each optionally with its own mount point. @@ -484,7 +484,7 @@ mountPoint - The mount point for the root of the Btrfs volume (e.g., /). + The mount point for the root of the Btrfs volume (for example, /). @@ -493,7 +493,7 @@ Whether to format the Btrfs partition. Must be set to true to create - new filesystems. + a new file system. @@ -507,13 +507,13 @@ - name: The name of the Btrfs subvolume (e.g., + name: Name of the Btrfs subvolume (for example, @home). - mountPoint: Mount point for this subvolume (e.g., + mountPoint: Mount point for this subvolume (for example, /home). @@ -559,7 +559,7 @@ grow - If set to true, this partition or volume will take up any leftover + If set to true, this partition or volume takes up any leftover space after allocating other defined volumes. @@ -587,7 +587,7 @@ Unique identifier used to reference this partition in other sections or mount - relationships. Optional, but useful for referencing volumes in complex setups. + relationships. Optional but useful for referencing volumes in complex setups. @@ -627,10 +627,10 @@ preserve - If true, the existing content of the volume will not be deleted or + If set to true, the existing content of the volume will not be deleted or reformatted. This is useful when retaining data directories like - /home or reuse across installations. The target must already be - formatted with a valid filesystem. + /home across installations. The target must already be + formatted with a valid file system. @@ -715,7 +715,7 @@ - Encrypted LUKS root filesystem + Encrypted LUKS root file system [ { @@ -767,7 +767,7 @@ partition - Represents a filesystem partition on a disk. Most commonly used for mount points like + Represents a file system partition on a disk. Most commonly used for mount points like /boot, /home, or /. @@ -785,8 +785,9 @@ luks_open - Refers to an encrypted volume defined via luks. It allows specifying - filesystem and mount point on the decrypted device. + Refers to the command to unlock an encrypted volume defined via + luks. It creates a decrypted block device, allowing the user + to specify a file system type and mount point on the new device. @@ -804,7 +805,7 @@ Defines a volume group that aggregates one or more PVs. Contains logical volumes with - their own mount points and filesystems. + their own mount points and file system types. @@ -812,7 +813,7 @@ mdraid - Used to define software RAID arrays (e.g., RAID1, RAID5) over multiple disks or + Defines software RAID arrays (for example, RAID1, RAID5) over multiple disks or partitions. @@ -822,7 +823,7 @@ Defines a Btrfs subvolume and mount point within a Btrfs-formatted volume. Requires a - parent Btrfs filesystem to exist. + parent Btrfs file system to exist. @@ -860,7 +861,7 @@ Overlapping device references: Using the same partition or device in - more than one storage object (e.g., as both LUKS and plain partition) can result in + more than one storage object (for example, as both LUKS and plain partition) can result in failed setups. diff --git a/references/agama-installation-profile-details.xml b/references/agama-installation-profile-details.xml index 3c69d3ee2..d82f4cb7c 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. @@ -426,9 +426,9 @@ 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 . + An exhaustive description of all possible storage configurations using &agama; is beyond the + scope of this section, as it will need careful consideration of the + storage model schema. For information on advanced storage configuration, refer to . @@ -485,7 +485,7 @@ - fsType: Filesystem type, such as ext4 or + fsType: File system type, such as ext4 or swap. @@ -502,7 +502,7 @@
- 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 @@ -626,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. @@ -699,7 +699,7 @@ autoconnect - Boolean. Whether the connection is brought up automatically. + Boolean. Specifies whether the connection is brought up automatically. @@ -738,7 +738,7 @@ - stp: Boolean. Enables Spanning Tree Protocol. + stp: Boolean. Enables the Spanning Tree Protocol. @@ -1181,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..8d269002f 100644 --- a/references/autoyast-agama-compatibility-reference.xml +++ b/references/autoyast-agama-compatibility-reference.xml @@ -27,7 +27,7 @@ Auto&yast; 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. @@ -108,7 +108,7 @@ 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 + keyboard layout, time zone, and the installed product identity. These are foundational parameters during the installation and are typically mapped one-to-one between Auto&yast; and &agama;. @@ -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 @@ -317,7 +317,7 @@ 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 + covers traditional partitions, logical volumes, file systems, encryption, RAID, and other storage-specific aspects of system setup. @@ -342,7 +342,7 @@ filesystemsstorage.devices[].partitions[].filesystemFully 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. @@ -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 @@ -680,7 +680,7 @@ kdump — Not supported - &agama; does not currently support configuring kdump crash kernels. + &agama; does not currently support configuring &kdump; crash kernels. udev diff --git a/tasks/initiating-agama-automated-installation.xml b/tasks/initiating-agama-automated-installation.xml index 2ac91e730..b734ad932 100644 --- a/tasks/initiating-agama-automated-installation.xml +++ b/tasks/initiating-agama-automated-installation.xml @@ -71,7 +71,7 @@ &prompt.sudo;agama profile import profile.json - If importing a dynamic profile using a Jsonnnet file, &agama; handles dynamic + If importing a dynamic profile using a Jsonnet file, &agama; handles dynamic features such as rules, classes, and embedded Ruby (ERB) templates. 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..97190ac02 100644 --- a/tasks/using-autoyast-profiles-with-agama.xml +++ b/tasks/using-autoyast-profiles-with-agama.xml @@ -218,7 +218,7 @@ - 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 @@ -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