Running scripts

Agama allows execute scripts at the following points of the installation process:

• Previous to any installation work (pre-installation scripts).
• After the system is installed (post-installation scripts).
• During the first boot of the installed system (init scripts).

This section describes how to specify a script and goes through some use-cases.

note

You can compare Agama scripts to the AutoYaST ones in the Scripts section of the backward compatibility documentation.

Scripts definition

User scripts are defined in the scripts section of the Agama profile. There is a key for each of the three scripts types, and each key can contain a list of scripts.

{
  scripts: {
    pre: [
      {
        name: "activate-multipath",
        body: |||
          #!/usr/bin/bash
          systemctl start multipathd.socket multipathd.service
        |||
      }
    ],
    post: [
      {
        name: "enable-sshd",
        chroot: true,
        body: |||
          #!/usr/bin/bash
          systemctl enable sshd.service
        |||
      }
    ],
    init: [
      {
        name: "run-ansible",
        url: "https://192.168.1.1/provisioning.sh"
      }
    ]
}

note

JSON does not allow multiline strings, so it might be better to use Jsonnet instead. However, you need to pay attention to the indentation, because it matters.

If you prefer JSON, you can write the \n to separate lines.

{
  "name": "enable-sshd",
  "chroot": true,
  "body": "#!/usr/bin/bash\nsystemctl enable sshd.service"
}

The common parts

All scripts share the same elements:

• name: a name to identify the script. It makes it easier to find the script logs.
• body: the content of the script. It is important to include the shebang as the first line of the script.
• url: alternatively to the body, you can define a URL to download the script. The scripts are downloaded and written to the disk after the profile is imported.

Check the following sections to find out the differences between the script types.

Pre-installation scripts

The pre-installation scripts are executed before the system is analyzed. They are useful for enabling hardware, tweaking the installation media, etc.

warning

Unlike AutoYaST, the pre-installation scripts cannot modify the current profile. We recommend using Jsonnet to build a dynamic profile. If you need something that behaves exactly like AutoYaST, you can still use an AutoYaST profile with its own pre-scripts section.

Post-installation scripts

The post-installation scripts are executed after the system is installed. They are helpful for enabling services, adjusting system configuration, installing or removing software, etc. These scripts have an additional option, chroot, that determines where to run:

• On the installation media (chroot is set to false), which is the behavior by default. You can find the installed system mounted at /mnt.
• On the installed system (chroot is set to true). Beware that systemd is not running on the installed system. For that reason, some commands might not work. If that's a problem, check the init scripts.

Init scripts

The init scripts run during the first boot of the installed system. They are special because Agama is not present at that point. However, if they are included in a profile, Agama will install a special agama-scripts service which takes care of running them. Once the scripts run, the service is disabled.

They are a good alternative for those cases where a post-script falls short. The system is fully operational in this case, so there are no limitations.

Troubleshooting

You can find the scripts and their logs at /var/log/agama-installation/scripts after the installation has finished. There is a directory for each kind of script (pre, post and init). Each folder contains the scripts (named according to the name element) and their corresponding standard output ([name].log), standard error ([name].err) and exit status ([name].out).

If you need to debug a problem during installation, you can find those files at /run/agama/scripts.