Kickstart Support in Photon OS

Set the target host name as string. You can also specify the name in print format.

The hostname must not start with a number or "-" and must be less than 64 characters.

Default value: "photon-"

Examples: { "photon-$((RANDOM%4096))" }, { "photon-machine" }

crypted: true/false

text: password text

crypted: false: This indicates that the "text" field is plain text. It is then encrypted and used to create the root user's password.

text: Plain text or encrypted password.

Example: /dev/sda

To create GPT partitions

Example:

[

{"mountpoint": "/", "size": 0, "filesystem": "ext4"},

{"mountpoint": "/boot", "size": 128, "filesystem": "ext4"},

{"mountpoint": "/root", "size": 128, "filesystem": "ext4"},

{"size": 128, "filesystem": "swap"}

]

To create LVM partitions

Example:

[

{"mountpoint": "/", "size": 0, "filesystem": "ext4", "lvm":{"vg_name":"vg1", "lv_name":"rootfs"}},

{"mountpoint": "/boot", "size": 128, "filesystem": "ext4"},

            <p>{"mountpoint": "/root", "size": 128, "filesystem": "ext4","lvm":{"vg_name":"vg1", "lv_name":"root"}},

            <p>{"size": 128, "filesystem": "swap","lvm":{"vg_name":"vg2", "lv_name":"swap"}}

]

Note: Mounting '/boot' partition as lvm is not supported.

Example: { "packagelist_file": "packages_minimal.json" }

See the example for partitions.

Example: { "postinstall": [ "#!/bin/sh", "echo \"Hello World\" > /etc/postinstall" ] }

The public key that you require to install for password-less logins.

This key is created in authorized_keys in the .ssh directory.

Contains a list of pairs {source file (or directory), destination file (or directory)} to copy to the target system. Source file (directory) will be looked up in "search_path" list.

Example: { "additional_files": [ {"resizefs.sh": "/usr/local/bin/resizefs.sh"}, {"resizefs.service": "/lib/systemd/system/resizefs.service"}]}

Provide a path containing additional RPMS that are to be bundled into the image.

Target system architecture. Should be set if target architecture is different from the host, for instance x86_64 machine building RPi image. Acceptable values are: "x86_64", "aarch64" Default value: autodetected host architecture

Example: { "arch": "aarch64" }

Sets the boot type to support: EFI, BIOS or both.

Acceptable values are: bios, efi, dualboot

bios

Adds special partition (very first) for first stage grub.

efi

Adds ESP (Efi Special Partition), format is as FAT and copy there EFI binaries including grub.efi

dualboot

Adds two extra partitions for "bios" and "efi" modes. This target will support both modes that can be switched in bios settings without extra actions in the OS.

Default value: "dualboot" for x86_64 and "efi" for aarch64

Example: { "bootmode": "bios" }

Ejects cdrom after installation completed if set to true.

Boolean: true or false

Default value: true

Example: { "eject_cdrom": false }

Should be set to false if target system is not being run on host machine. When it set to false, installer will not add EFI boot entries, and will not generate unique machine-id.

Default value: false if "disk" is /dev/loop and true otherwise.

Example: { "live": false }

Set installer logging level.

Acceptable values are: error, warning, info, debug

Default value: info

Example: { "log_level": "debug" }

Atomic flavour of Photon OS.

default_repo

(required)

Define the type of repo data used for installing the OS There are two type:

1. Default Repo(comes with ISO)

2. Custom Repo (Remote server)

Boolean: true or false

where true : Default Repo is selected

false: Custom Repo is selected

Default value: true Example: { "ostree": {"default_repo": true}}

repo_url

(Required, Only If Custom Repo is selected) Supported Value: Valid "repo" URL of remote server where repo data exists

repo_ref

(Required, Only If Custom Repo is selected) Supported Value: Valid "ref" path which was mentioned for creation of Base Tree on remote server

Example: { "ostree": { "default_repo": false, "repo_url": "http://:/repo", "repo_ref": "photon/3.0/x86_64/minimal" } }

Contains list of packages to install.

Example: { "packages": ["minimal", "linux", "initramfs"] }

Set partition table type. Supported values are: gpt, msdos.

Default value: gpt

Example: { "partition_type": "msdos" }

Used to configure network on a live/installed system.

type

required

String; must be one of dhcp/static/vlan. Indicates how the network is being configured.

hostname

optional; when type == dhcp

String; DHCP client hostname

ip_addr

required; when type == static

IP String; IP address to be configured

netmask

required; when type == static

IP String; Netmask to be configured

gateway

required; when type == static

IP String; Gateway IP address to be configured

nameserver

required; when type == static

IP String; Name server IP address to be configured

vlan_id

required; when type == vlan

ID String. (1-4094); VLAN ID number expressed as string

Contains list of scripts to run on the target after installation. Scripts will be looked up in "search_path" list.

Example: { "postinstallscripts": ["rpi3-custom-patch.sh"] }

List of directories to search for additional files and scripts.

Example: { "search_path": ["/home/user", "/tmp"] }

Contains encrypted root password. Short form of: { "password": { "crypted": true, "text": "encrypted password here"} }

Installer will show progress status in the UI, if it set to true. Or logging output will be printed to console - default behavior.

Boolean: true or false

Default value: false

Example: { "ui": true }

Contains the flavor of Linux to install if multiple Linux flavors are present in "packages" or "packagelist_file"

Acceptable values: "linux", "linux-esx", "linux-rt", "linux-aws", and "linux-secure"

Example: { "linux_flavor": "linux-esx" }

Contains the docker image present in "packages" or "packagelist_file"

Acceptable values: "photon:1.0", "photon:2.0", "photon:3.0", "photon" and so on.

Default value: "photon:latest"

Example: { "photon_docker_image": "photon:3.0" }

Contains the photon release version.

Acceptable values: "3.0", "4.0"

Example: {"release_version": "3.0"}

For reference, look at "sample_ks.cfg" file.