Skip to content

Latest commit

 

History

History
130 lines (86 loc) · 2.23 KB

os.md

File metadata and controls

130 lines (86 loc) · 2.23 KB
parent
Configuration

os type

Contains the configuration options for the OS.

hostname [string]

Specifies the hostname for the OS.

Implemented by writing to the /etc/hostname file.

Example:

os:
  hostname: example-image

kernelCommandLine [kernelCommandLine]

Specifies extra kernel command line options.

packages [packages]

Remove, update, and install packages on the system.

additionalFiles [additionalFile[]]

Copy files into the OS image.

os:
  additionalFiles:
  - source: files/a.txt
    destination: /a.txt

  - content: |
      abc
    destination: /b.txt
    permissions: "664"

additionalDirs [dirConfig[]]

Copy directories into the OS image.

This property is a list of dirConfig objects.

Example:

os:
  additionalDirs:
    # Copying directory with default permission options.
    - source: "path/to/local/directory/"
      destination: "/path/to/destination/directory/"
    # Copying directory with specific permission options.
    - source: "path/to/local/directory/"
      destination: "/path/to/destination/directory/"
      newDirPermissions: 0644
      mergedDirPermissions: 0777
      childFilePermissions: 0644

users [user]

Used to add and/or update user accounts.

Example:

os:
  users:
  - name: test

modules [module[]]

Used to configure kernel modules.

overlays [overlay[]]

Used to add filesystem overlays.

bootloader [bootloader]

Defines the configuration for the boot-loader.

uki [uki]

Used to create UKI PE images and enable UKI as boot entries.

selinux [selinux]

Options for configuring SELinux.

Example:

os:
  selinux:
    mode: permissive

services [services]

Options for configuring systemd services.

os:
  services:
    enable:
    - sshd

imageHistory [string]

Options for configuring image history.

Set value to none to disable.

To learn more about image history, refer to the Image History Concept documentation.

os:
  imageHistory: none