Skip to content

Added documentation for agama.finish boot option and CLI #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
teclator merged 3 commits into from
Feb 19, 2025
Merged

Added documentation for agama.finish boot option and CLI #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f85d5d
Added documentation for agama.finish boot option and CLI
teclator Feb 19, 2025
46764a4
Little change to show reboot is the default
teclator Feb 19, 2025
cd9322c
Clarify that interactive installation is not affected
teclator Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/user/boot_options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,16 @@ to extend.
Setting this variable will impact all products.
:::

- `agama.finish`
During an unattended installation, if the installation is completed successfully then the
Copy link
Contributor

@jreidinger jreidinger Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so it does not have any effect if user do not specify agama.auto, right?

Copy link
Contributor Author

@teclator teclator Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, not by now.

Copy link
Contributor

@mchf mchf Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So may be mention that explicitly ... taking into account what bugs we sometimes get ;-)

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
```

- `live.password` and `live.password_hash` Set the `root` password of the live system.
`live.password` accepts a plain text password, while `live.password_hash` is expected to receive a
hashed password, which is more secure. The disadvantage of a hashed password is that it is quite
Expand Down
22 changes: 22 additions & 0 deletions docs/user/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ This document contains the help content for the `agama` command-line program.
- [`agama auth logout`↴](#agama-auth-logout)
- [`agama auth show`↴](#agama-auth-show)
- [`agama download`↴](#agama-download)
- [`agama finish`↴](#agama-finish)

## `agama`

Expand Down Expand Up @@ -314,3 +315,24 @@ The purpose of this command is to download files using AutoYaST supported schema
###### **Arguments:**

- `<URL>` — URL pointing to file for download

## `agama finish`

Finish the installation rebooting the system by default

**Usage:** `agama finish [METHOD]`

###### **Arguments:**

- `<METHOD>` — Action to be done at the end of the installation

Possible values:

- `stop`:
Stop at the end of the installation
- `reboot`:
Reboot into the installed system
- `halt`:
Halt the installed machine
- `poweroff`:
Poweroff the installed machine
Loading