diff --git a/docs/devel/live_iso.md b/docs/devel/live_iso.md index cbd51af..79b497c 100644 --- a/docs/devel/live_iso.md +++ b/docs/devel/live_iso.md @@ -65,7 +65,7 @@ This feature is experimental and untested! The Agama packages on the Live ISO can be automatically updated from the [OBS Devel project](https://build.opensuse.org/project/show/systemsmanagement:Agama:Devel). -- Use the `agama.self_update` boot parameter to run the self-update +- Use the `inst.self_update` boot parameter to run the self-update automatically during boot. - Or run the `agama-self-update` script anytime later in a running Live system. diff --git a/docs/devel/startup.md b/docs/devel/startup.md index cc6f7d2..f4ad902 100644 --- a/docs/devel/startup.md +++ b/docs/devel/startup.md @@ -32,7 +32,7 @@ is responsible for starting up Agama's web server using the `agama-web-server` c ## Auto-installation -If the `agama.auto` option is specified in the kernel command-line, the +If the `inst.auto` option is specified in the kernel command-line, the [agama-auto.service](https://github.com/openSUSE/agama/blob/master/autoinstallation/systemd/agama-auto.service) comes into play. It runs after the `agama-web-server.service` so the web server and the D-Bus daemon are ready. diff --git a/docs/user/autoyast/profiles.md b/docs/user/autoyast/profiles.md index e0a1110..0fb3a24 100644 --- a/docs/user/autoyast/profiles.md +++ b/docs/user/autoyast/profiles.md @@ -1,11 +1,11 @@ # Loading an AutoYaST profile The typical way of starting an unattended installation in Agama is by passing the URL of an AutoYaST -profile through the [`agama.auto`](../boot_options.md#boot-options) argument in the kernel's +profile through the [`inst.auto`](../boot_options.md#boot-options) argument in the kernel's command-line[^agama-profile-import]. For example: ```text -agama.auto=http://example.net/agama/tumbleweed.xml +inst.auto=http://example.net/agama/tumbleweed.xml ``` Agama takes care of pre-processing and converting the profile to an Agama equivalent. As part of diff --git a/docs/user/boot_options.md b/docs/user/boot_options.md index 00665f4..e57d006 100644 --- a/docs/user/boot_options.md +++ b/docs/user/boot_options.md @@ -14,56 +14,62 @@ on [dracut](https://manpages.opensuse.org/Tumbleweed/dracut/dracut.8.en.html) no to extend. ::: -- `agama.auto`: +:::warning +Originally `agama.` prefix used to be used for Agama related kernel boot options. This is obsolete now +as we started to use more generic `inst.` prefix now. For now both prefixes can be used but support for the +first one can be removed anytime. +::: + +- `inst.auto`: Tells the installer to use the profile in the given URL to start an unattended installation. ```text - agama.auto=http://mydomain.org/tumbleweed.jsonnet + inst.auto=http://mydomain.org/tumbleweed.jsonnet ``` -- `agama.config_url`: it uses the file at the given URL as the new Agama configuration. Please, do +- `inst.config_url`: it uses the file at the given URL as the new Agama configuration. Please, do not confuse this file with an unattended installation profile. See [URL handling in the installer](https://github.com/yast/yast-installation/blob/master/doc/url.md) to find more details about the supported URLs. ```text - agama.config_url=http://192.168.122.1/my-agama.yaml - agama.config_url=usb:///agama.yaml + inst.config_url=http://192.168.122.1/my-agama.yaml + inst.config_url=usb:///agama.yaml ``` -- `agama.register_url`: sets the URL of the RMT or SCC proxy server to register the product with. +- `inst.register_url`: sets the URL of the RMT or SCC proxy server to register the product with. ```text - agama.register_url=http://rmt.example.net + inst.register_url=http://rmt.example.net ``` :::note HTTPS is not supported yet. ::: -- `agama.install_url` +- `inst.install_url` Override the default `installation_url` set in the product files - [here](https://github.com/openSUSE/agama/tree/master/products.d) by passing the `agama.install_url` + [here](https://github.com/openSUSE/agama/tree/master/products.d) by passing the `inst.install_url` parameter as a boot option in the bootloader. This is particularly useful for any pre-production testing in openQA. ```text - agama.install_url=https://myrepo,https://myrepo2 + inst.install_url=https://myrepo,https://myrepo2 ``` :::warning Setting this variable will impact all products. ::: -- `agama.finish` +- `inst.finish` During an unattended installation, if the installation is completed successfully then the installer will reboot into the target system by default (`reboot`). This behavior can be modified allowing to `stop`, `halt` or `poweroff` the machine at the end of the installation. An interactive installation is not affected by this parameter. ```text - agama.finish=poweroff + inst.finish=poweroff ``` - `live.password` and `live.password_hash` Set the `root` password of the live system. diff --git a/docs/user/unattended/index.md b/docs/user/unattended/index.md index 2df52f8..7c34d97 100644 --- a/docs/user/unattended/index.md +++ b/docs/user/unattended/index.md @@ -108,5 +108,5 @@ sudo agama config show > profile.json ## Starting the installation To start an unattended installation process, you need to tell Agama where to find the profile. When -using the Live ISO, you must use the `agama.auto` boot option. Please, check the [boot +using the Live ISO, you must use the `inst.auto` boot option. Please, check the [boot options](../boot_options.md) for further information.