mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 20:48:11 +00:00
Add in OS Docs
This commit is contained in:
Denise Schannon
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Built-in System Services in RancherOS
|
||||
|
||||
redirect_from:
|
||||
- os/v1.0/en/system-services/built-in-system-services/
|
||||
- os/v1.1/en/system-services/built-in-system-services/
|
||||
|
||||
---
|
||||
|
||||
## Built-in System Services
|
||||
|
||||
To launch RancherOS, we have built-in system services. They are defined in the [Docker Compose](https://docs.docker.com/compose/compose-file/) format, and can be found in the default system config file, `/usr/share/ros/os-config.yml`. You can [add your own system services]({{page.osbaseurl}}/system-services/) or override services in the cloud-config.
|
||||
|
||||
### preload-user-images
|
||||
|
||||
Read more about [image preloading]({{page.osbaseurl}}/boot-process/image-preloading/).
|
||||
|
||||
### network
|
||||
|
||||
During this service, networking is set up, e.g. hostname, interfaces, and DNS.
|
||||
|
||||
It is configured by `hostname` and `rancher.network`[settings]({{page.osbaseurl}}/networking/) in [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
### ntp
|
||||
|
||||
Runs `ntpd` in a System Docker container.
|
||||
|
||||
### console
|
||||
|
||||
This service provides the RancherOS user interface by running `sshd` and `getty`. It completes the RancherOS configuration on start up:
|
||||
|
||||
1. If the `rancher.password=<password>` kernel parameter exists, it sets `<password>` as the password for the `rancher` user.
|
||||
|
||||
2. If there are no host SSH keys, it generates host SSH keys and saves them under `rancher.ssh.keys` in [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
3. Runs `cloud-init -execute`, which does the following:
|
||||
|
||||
* Updates `.ssh/authorized_keys` in `/home/rancher` and `/home/docker` from [cloud-config]({{page.osbaseurl}}/configuration/ssh-keys/) and metadata.
|
||||
* Writes files specified by the `write_files` [cloud-config]({{page.osbaseurl}}/configuration/write-files/) setting.
|
||||
* Resizes the device specified by the `rancher.resize_device` [cloud-config]({{page.osbaseurl}}/configuration/resizing-device-partition/) setting.
|
||||
* Mount devices specified in the `mounts` [cloud-config]({{page.osbaseurl}}/configuration/additional-mounts/) setting.
|
||||
* Set sysctl parameters specified in the`rancher.sysctl` [cloud-config]({{page.osbaseurl}}/configuration/sysctl/) setting.
|
||||
|
||||
4. If user-data contained a file that started with `#!`, then a file would be saved at `/var/lib/rancher/conf/cloud-config-script` during cloud-init and then executed. Any errors are ignored.
|
||||
|
||||
5. Runs `/opt/rancher/bin/start.sh` if it exists and is executable. Any errors are ignored.
|
||||
|
||||
6. Runs `/etc/rc.local` if it exists and is executable. Any errors are ignored.
|
||||
|
||||
### docker
|
||||
|
||||
This system service runs the user docker daemon. Normally it runs inside the console system container by running `docker-init` script which, in turn, looks for docker binaries in `/opt/bin`, `/usr/local/bin` and `/usr/bin`, adds the first found directory with docker binaries to PATH and runs `dockerlaunch docker daemon` appending the passed arguments.
|
||||
|
||||
Docker daemon args are read from `rancher.docker.args` cloud-config property (followed by `rancher.docker.extra_args`).
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
tag: ["rancheros", "os", "cloud-init"]
|
||||
category: "os"
|
||||
layout: list-docs
|
||||
title: Cloud-Init
|
||||
weight: 151
|
||||
---
|
||||
|
||||
## Cloud-init
|
||||
|
||||
Userdata and metadata can be fetched from a cloud provider, VM runtime, or management service during the RancherOS boot process. Since v0.8.0, this process occurs while RancherOS is still running from memory and before System Docker starts. It is configured by the `rancher.cloud_init.datasources` configuration parameter. For cloud-provider specific images, such as AWS and GCE, the datasource is pre-configured.
|
||||
|
||||
### Userdata
|
||||
|
||||
Userdata is a file given by users when launching RancherOS hosts. It is stored in different locations depending on its format. If the userdata is a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file, indicated by beginning with `#cloud-config` and being in YAML format, it is stored in `/var/lib/rancher/conf/cloud-config.d/boot.yml`. If the userdata is a script, indicated by beginning with `#!`, it is stored in `/var/lib/rancher/conf/cloud-config-script`.
|
||||
|
||||
### Metadata
|
||||
|
||||
Although the specifics vary based on provider, a metadata file will typically contain information about the RancherOS host and contain additional configuration. Its primary purpose within RancherOS is to provide an alternate source for SSH keys and hostname configuration. For example, AWS launches hosts with a set of authorized keys and RancherOS obtains these via metadata. Metadata is stored in `/var/lib/rancher/conf/metadata`.
|
||||
|
||||
## Configuration Load Order
|
||||
|
||||
[Cloud-config]({{page.osbaseurl}}/configuration/#cloud-config/) is read by system services when they need to get configuration. Each additional file overwrites and extends the previous configuration file.
|
||||
|
||||
1. `/usr/share/ros/os-config.yml` - This is the system default configuration, which should **not** be modified by users.
|
||||
2. `/usr/share/ros/oem/oem-config.yml` - This will typically exist by OEM, which should **not** be modified by users.
|
||||
3. Files in `/var/lib/rancher/conf/cloud-config.d/` ordered by filename. If a file is passed in through user-data, it is written by cloud-init and saved as `/var/lib/rancher/conf/cloud-config.d/boot.yml`.
|
||||
4. `/var/lib/rancher/conf/cloud-config.yml` - If you set anything with `ros config set`, the changes are saved in this file.
|
||||
5. Kernel parameters with names starting with `rancher`.
|
||||
6. `/var/lib/rancher/conf/metadata` - Metadata added by cloud-init.
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
tag: ["rancheros", "os"]
|
||||
category: "os"
|
||||
layout: list-docs
|
||||
title: Image Preloading
|
||||
weight: 152
|
||||
---
|
||||
|
||||
## Image Preloading
|
||||
---
|
||||
|
||||
On boot, RancherOS scans `/var/lib/rancher/preload/docker` and `/var/lib/rancher/preload/system-docker` directories and tries to load container image archives it finds there, with `docker load` and `system-docker load`.
|
||||
|
||||
The archives are `.tar` files, optionally compressed with `xz` or `gzip`. These can be produced by `docker save` command, e.g.:
|
||||
|
||||
```
|
||||
$ docker save my-image1 my-image2 some-other/image3 | xz > my-images.tar.xz
|
||||
```
|
||||
|
||||
The resulting files should be placed into `/var/lib/rancher/preload/docker` or `/var/lib/rancher/preload/system-docker` (depending on whether you want it preloaded into Docker or System Docker).
|
||||
|
||||
Pre-loading process only reads each new archive once, so it won't take time on subsequent boots (`<archive>.done` files are created to mark the read archives). If you update the archive (place a newer archive with the same name) it'll get read on the next boot as well.
|
||||
|
||||
Pre-packing docker images is handy when you're customizing your RancherOS distribution (perhaps, building cloud VM images for your infrastructure).
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
tag: ["rancheros", "os", "logging"]
|
||||
category: "os"
|
||||
layout: list-docs
|
||||
title: System Logging
|
||||
weight: 153
|
||||
---
|
||||
|
||||
## RancherOS System Logging
|
||||
|
||||
### System services
|
||||
|
||||
RancherOS uses containers for its system services. This means the logs for `syslog`, `acipd`, `system-cron`, `udev`, `network`, `ntp`, `console` and the user Docker are available using `sudo ros service logs <service-name>`.
|
||||
|
||||
### Boot logging
|
||||
|
||||
Since v1.1.0, the init process's logs are copied to `/var/log/boot` after the user-space filesystem is made available. These can be used to diagnose initialisation, network, and cloud-init issues.
|
||||
|
||||
### Remote Syslog logging
|
||||
|
||||
The Linux kernel has a `netconsole` logging facility that allows it to send the Kernel level logs to a remote Syslog server.
|
||||
When you set this kernel boot parameter in RancherOS v1.1.0 and later, the RancherOS debug logs will also be sent to it.
|
||||
|
||||
To set up Linux kernel and RancherOS remote Syslog logging, you need to set both a local, and remote host IP address - even if this address isn't the final IP address of your system. The kernel setting looks like:
|
||||
|
||||
```
|
||||
netconsole=[+][src-port]@[src-ip]/[<dev>],[tgt-port]@<tgt-ip>/[tgt-macaddr]
|
||||
|
||||
where
|
||||
+ if present, enable extended console support
|
||||
src-port source for UDP packets (defaults to 6665)
|
||||
src-ip source IP to use (interface address)
|
||||
dev network interface (eth0)
|
||||
tgt-port port for logging agent (6666)
|
||||
tgt-ip IP address for logging agent
|
||||
tgt-macaddr ethernet MAC address for logging agent (broadcast)
|
||||
```
|
||||
|
||||
For example, on my current test system, I have set the kernel boot line to:
|
||||
|
||||
|
||||
```
|
||||
printk.devkmsg=on console=tty1 rancher.autologin=tty1 console=ttyS0 rancher.autologin=ttyS0 rancher.state.dev=LABEL=RANCHER_STATE rancher.state.autoformat=[/dev/sda,/dev/vda] rancher.rm_usr loglevel=8 netconsole=+9999@10.0.2.14/,514@192.168.42.223/
|
||||
```
|
||||
|
||||
The kernel boot parameters can be set during installation using `sudo ros install --append "...."`, or on an installed RancherOS system, by running `sudo ros config syslinx` (which will start vi in a container, editing the `global.cfg` boot config file.
|
||||
Reference in New Issue
Block a user