Rancher OS Profile
Intended to be used with Retail Node Installer, this Rancher OS profile contains a few files that ultimately will install Rancher OS v1.5.1 to disk.
A necessary prerequisite to using this profile is having an Retail Node Installer deployed. Please refer to its documentation in order to deploy it.
Out of the box, the Rancher 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 Rancher profile should automatically launch after a brief waiting period. Note that RancherOS itself does not support UEFI installation.
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 Rancher, the default login username is
rancher 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.
This RancherOS profile sets this kernel argument in
The Rancher initrd uses cloud init to process the file called
dyn-ks.yml, which is a kickstart file that contains a few bash script definitions. The last step of this kickstart is to run
wget to download
bootstrap.sh from the Retail Node Installer, which is then executed in a shell. Inside the
bootstrap.sh file is a minimal script that installs Rancher to disk using
bootstrap.sh file does not properly tell the Rancher installer to use
dyn-ks.yml. In future releases this will be fixed.
This profile is not intended to provide a completely functional operating system. Please use this profile as reference code to build out your own operating systems to your own needs.
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 Issues 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.
*.rnitemplate- Any file under any directory (for example
dyn-ks.yml.rnitemplate) will be processed into its intended file (becoming
dyn-ks.yml). 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
To update rancher, you will need to connect to the rancher system and run the
ros os upgrade command.
You will also need to provide the
-i command line argument with the rancher version you would like to upgrade to. Rancher versions are stored in the official rancher git repository found here: https://github.com/rancher/os/releases
ros os upgrade -i rancher/os:<UPDATE_VERSION>
Follow the user prompts to complete the process
If you would like to automate the update and skip the user prompts run yes as the default answer. You can do this by using the example below.
yes Y | ros os upgrade -i rancher/os:<UPDATE_VERSION>