Clear Linux OS Profile
Intended to be used with Retail Node Installer, this Clear Linux OS profile contains a few files that ultimately will install Clear Linux OS to disk.
Software Stack in this profile
- Clear Linux
Target Device Prerequisites
- x86 Bare Metal or x86 Virtual Machine
- At Least 5 GB of Disk Space
- Supports the following drive types:
- Supports the following drive types:
- 4 GB of RAM
A necessary prerequisite to using this profile is having an Retail Node Installer deployed. Please refer to Retail Node Installer project documentation for installation in order to deploy it.
Out of the box, the Clear Linux profile should just work. Therefore, no specific steps are required in order to use this profile that have not already been described in the Retail Node Installer documentation. Simply boot a client device using legacy BIOS PXE boot and the Clear Linux profile should automatically launch after a brief waiting period.
If you do encounter issues PXE booting, please review the steps outlined in the Retail Node Installer documentation and ensure you've followed them correctly. See the Known Issues section for possible solutions.
After installing Clear Linux, the default login username is
sys-admin and the default password is
P@ssw0rd!. This password is defined in the
bootstrap.sh script and in the
conf/config.yml as a kernel argument.
Kernel Paramaters used at build time
The following kernel parameters can be added to
bootstrap- RESERVED, do not change
clearlinuxversion- Use the release number from here https://cdn.download.clearlinux.org/releases/ Defaults to latest release
debug- [TRUE | FALSE] Enables a more verbose output
httppath- RESERVED, do not change
kernparam- Used to pass additional kernel parameters to the targeted system. Example format: kernparam=splash:quiet#enable_gvt:1
parttype- RESERVED, do not change
password- Initial user password. Defaults to 'password'
proxy- Add proxy settings if behind proxy during installation. Example: http://proxy-us.intel.com:912
proxysocks- Add socks proxy settings if behind proxy during installation. Example: http://proxy-us.intel.com:1080
release- [prod | dev] If set to prod the system will shutdown after it is provisioned. Altnerativily it will reboot.
token- GitHub token for private repositories, if this profile is in a private respository this token should have access to this repo
username- Initial user name. Defaults to 'sys-admin'
- Currently does not support full disk encryption
- Currently does not install Secure Boot features
If you want to customize your Retail Node Installer profile, follow these steps:
- Duplicate this repository locally and push it to a separate/new git repository
- Make changes after reading the information below
- Update your Retail Node Installer configuration to point to the git repository and branch (such as master).
The flexibility of Retail Node Installer comes to fruition with the following profile-side file structures:
conf/config.yml- This file contains the arguments that are passed to the Linux kernel upon PXE boot. Alter these arguments according to the needs of your scripts. The following kernel arguments are always prepended to the arguments specified in
conf/files.yml- This file contains a few definitions that tell Retail Node Installer to download specific files that you can customize. Please check if there are any Known Limitations before changing this file from the default. See
conf/files.sample.ymlfor a full example.
bootstrap.sh- A profile is required to have a
bootstrap.shas an entry point. This is an arbitrary script that you can control. If you plan to create profiles for other operating systems such as Ubuntu or Debian, it is recommended to use preseed to launch
bootstrap.shas the last step. Currently the following variables are processed:
A profile must have all of the following:
bootstrap.shfile at the root of the repository
vmlinuz, as shown in the