mirror of
https://github.com/rancher/os.git
synced 2025-07-01 01:01:48 +00:00
use page.osbaseurl to make it a little more distinct from site.baseurl
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit
parent
e35449ba91
commit
3a7cde6d76
@ -42,12 +42,12 @@ defaults:
|
||||
values:
|
||||
layout: "os-default-v1.0"
|
||||
version: v1.0
|
||||
baseurl: "/docs/os/v1.0/en"
|
||||
osbaseurl: "/docs/os/v1.0/en"
|
||||
-
|
||||
scope:
|
||||
path: "os/v1.1"
|
||||
values:
|
||||
layout: "os-default-v1.1"
|
||||
version: v1.1
|
||||
baseurl: "/docs/os/v1.1/en"
|
||||
osbaseurl: "/docs/os/v1.1/en"
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<ul id="menu">
|
||||
<li><a href="{{page.baseurl}}/">Overview</a></li>
|
||||
<li><a href="{{page.baseurl}}/quick-start-guide/">Quick Start Guide</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/">Overview</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/quick-start-guide/">Quick Start Guide</a></li>
|
||||
<li>
|
||||
<a href="#">
|
||||
Running RancherOS <i class="pull-right fa fa-angle-down"></i></a>
|
||||
@ -8,27 +8,27 @@
|
||||
<li>
|
||||
<a href="#">Workstation <i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/workstation/docker-machine/">Docker Machine</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/workstation/boot-from-iso/">Boot from ISO</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/workstation/docker-machine/">Docker Machine</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso/">Boot from ISO</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#">Cloud <i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/cloud/aws/">AWS</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/cloud/gce/">GCE</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/cloud/do/">DigitalOcean</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/cloud/openstack/">Openstack</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/cloud/vmware-esxi/">VMware ESXi</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/server/pxe/">PXE</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/cloud/aws/">AWS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/cloud/gce/">GCE</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/cloud/do/">DigitalOcean</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/cloud/openstack/">Openstack</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/cloud/vmware-esxi/">VMware ESXi</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/server/pxe/">PXE</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#">Bare metal and Virtual Server <i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/server/install-to-disk/">Install to Disk</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/server/pxe/">PXE</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancheros/server/raspberry-pi/">Raspberry Pi</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/server/install-to-disk/">Install to Disk</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/server/pxe/">PXE</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancheros/server/raspberry-pi/">Raspberry Pi</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -36,67 +36,67 @@
|
||||
<li>
|
||||
<a href="#">Configuration <i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/configuration/">Configuring RancherOS</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/ssh-keys/">SSH Keys</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/write-files/">Writing Files</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/running-commands/">Running Commands</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/hostname/">Setting the Hostname</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/switching-consoles/">Switching Consoles</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/docker/">Configuring Docker or System Docker</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/setting-up-docker-tls/">Setting up Docker TLS</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/private-registries/">Private Registries</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/switching-docker-versions/">Switching Docker Versions</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/users/">Users</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/resizing-device-partition/">Resizing a Device Partition</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/sysctl/">sysctl Settings</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/adding-kernel-parameters/">Adding kernel parameters</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/loading-kernel-modules/">Loading kernel modules</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/kernel-modules-kernel-headers/">Install kernel modules that require kernel headers</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/">Configuring RancherOS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/ssh-keys/">SSH Keys</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/write-files/">Writing Files</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/running-commands/">Running Commands</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/hostname/">Setting the Hostname</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/switching-consoles/">Switching Consoles</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/docker/">Configuring Docker or System Docker</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/setting-up-docker-tls/">Setting up Docker TLS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/private-registries/">Private Registries</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/switching-docker-versions/">Switching Docker Versions</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/users/">Users</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/resizing-device-partition/">Resizing a Device Partition</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/sysctl/">sysctl Settings</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/adding-kernel-parameters/">Adding kernel parameters</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/loading-kernel-modules/">Loading kernel modules</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/kernel-modules-kernel-headers/">Install kernel modules that require kernel headers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#">System Services<i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/system-services/adding-system-services/">System Services</a></li>
|
||||
<li><a href="{{page.baseurl}}/system-services/custom-system-services/">Custom Services</a></li>
|
||||
<li><a href="{{page.baseurl}}/system-services/system-docker-volumes/">System Docker Volumes</a></li>
|
||||
<li><a href="{{page.baseurl}}/system-services/environment/">Environment</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/system-services/adding-system-services/">System Services</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/system-services/custom-system-services/">Custom Services</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/system-services/system-docker-volumes/">System Docker Volumes</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/system-services/environment/">Environment</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#">Boot Process<i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/boot-process/built-in-system-services/">Built-in System Services</a></li>
|
||||
<li><a href="{{page.baseurl}}/boot-process/cloud-init/">Cloud-init</a></li>
|
||||
<li><a href="{{page.baseurl}}/boot-process/image-preloading/">Image Preloading</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/boot-process/built-in-system-services/">Built-in System Services</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/boot-process/cloud-init/">Cloud-init</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/boot-process/image-preloading/">Image Preloading</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#">Storage<i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/storage/state-partition/">State Partition</a></li>
|
||||
<li><a href="{{page.baseurl}}/storage/additional-mounts/">Additional Mounts</a></li>
|
||||
<li><a href="{{page.baseurl}}/storage/using-zfs/">Using ZFS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/storage/state-partition/">State Partition</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/storage/additional-mounts/">Additional Mounts</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/storage/using-zfs/">Using ZFS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#">Networking<i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/networking/interfaces/">Interfaces</a></li>
|
||||
<li><a href="{{page.baseurl}}/networking/dns/">DNS</a></li>
|
||||
<li><a href="{{page.baseurl}}/networking/proxy-settings/">Proxy Settings</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/networking/interfaces/">Interfaces</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/networking/dns/">DNS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/networking/proxy-settings/">Proxy Settings</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#">Custom Builds<i class="pull-right fa fa-angle-down"></i></a>
|
||||
<ul>
|
||||
<li><a href="{{page.baseurl}}/configuration/custom-kernels/">Custom Kernels</a></li>
|
||||
<li><a href="{{page.baseurl}}/configuration/custom-rancheros-iso/">Building custom RancherOS ISO</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/custom-kernels/">Custom Kernels</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/configuration/custom-rancheros-iso/">Building custom RancherOS ISO</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="{{page.baseurl}}/upgrading/">Upgrading</a></li>
|
||||
<li><a href="{{page.baseurl}}/amazon-ecs/">Amazon ECS</a></li>
|
||||
<li><a href="{{page.baseurl}}/contributing/">Contributing to RancherOS</a></li>
|
||||
<li><a href="{{page.baseurl}}/running-rancher-on-rancheros/">Tips on using Rancher with RancherOS</a></li>
|
||||
<li><a href="{{page.baseurl}}/security/">RancherOS security</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/upgrading/">Upgrading</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/amazon-ecs/">Amazon ECS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/contributing/">Contributing to RancherOS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/running-rancher-on-rancheros/">Tips on using Rancher with RancherOS</a></li>
|
||||
<li><a href="{{page.osbaseurl}}/security/">RancherOS security</a></li>
|
||||
</ul>
|
||||
|
||||
@ -15,13 +15,13 @@ Prior to launching RancherOS EC2 instances, the [ECS Container Instance IAM Role
|
||||
|
||||
### Launching an instance with ECS
|
||||
|
||||
RancherOS makes it easy to join your ECS cluster. The ECS agent is a [system service]({{page.baseurl}}/system-services/adding-system-services/) that is enabled in the ECS enabled AMI. There may be other RancherOS AMIs that don't have the ECS agent enabled by default, but it can easily be added in the user data on any RancherOS AMI.
|
||||
RancherOS makes it easy to join your ECS cluster. The ECS agent is a [system service]({{page.osbaseurl}}/system-services/adding-system-services/) that is enabled in the ECS enabled AMI. There may be other RancherOS AMIs that don't have the ECS agent enabled by default, but it can easily be added in the user data on any RancherOS AMI.
|
||||
|
||||
When launching the RancherOS AMI, you'll need to specify the **IAM Role** and **Advanced Details** -> **User Data** in the **Configure Instance Details** step.
|
||||
|
||||
For the **IAM Role**, you'll need to be sure to select the ECS Container Instance IAM role.
|
||||
|
||||
For the **User Data**, you'll need to pass in the [cloud-config]({{page.baseurl}}/configuration/#cloud-config) file.
|
||||
For the **User Data**, you'll need to pass in the [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file.
|
||||
|
||||
```yaml
|
||||
#cloud-config
|
||||
@ -41,7 +41,7 @@ rancher:
|
||||
|
||||
By default, the ECS agent will be using the `latest` tag for the `amazon-ecs-agent` image. In v0.5.0, we introduced the ability to select which version of the `amazon-ecs-agent`.
|
||||
|
||||
To select the version, you can update your [cloud-config]({{page.baseurl}}/configuration/#cloud-config) file.
|
||||
To select the version, you can update your [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file.
|
||||
|
||||
```yaml
|
||||
#cloud-config
|
||||
|
||||
@ -7,17 +7,17 @@ redirect_from:
|
||||
|
||||
## 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.baseurl}}/system-services/) or override services in the cloud-config.
|
||||
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.baseurl}}/boot-process/image-preloading/).
|
||||
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.baseurl}}/networking/) in [cloud-config]({{page.baseurl}}/configuration/#cloud-config).
|
||||
It is configured by `hostname` and `rancher.network`[settings]({{page.osbaseurl}}/networking/) in [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
### ntp
|
||||
|
||||
@ -29,15 +29,15 @@ This service provides the RancherOS user interface by running `sshd` and `getty`
|
||||
|
||||
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.baseurl}}/configuration/#cloud-config).
|
||||
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.baseurl}}/configuration/ssh-keys/) and metadata.
|
||||
* Writes files specified by the `write_files` [cloud-config]({{page.baseurl}}/configuration/write-files/) setting.
|
||||
* Resizes the device specified by the `rancher.resize_device` [cloud-config]({{page.baseurl}}/configuration/resizing-device-partition/) setting.
|
||||
* Mount devices specified in the `mounts` [cloud-config]({{page.baseurl}}/configuration/additional-mounts/) setting.
|
||||
* Set sysctl parameters specified in the`rancher.sysctl` [cloud-config]({{page.baseurl}}/configuration/sysctl/) setting.
|
||||
* 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.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ Userdata and metadata can be fetched from a cloud provider, VM runtime, or manag
|
||||
|
||||
### 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.baseurl}}/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`.
|
||||
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
|
||||
|
||||
@ -18,7 +18,7 @@ Although the specifics vary based on provider, a metadata file will typically co
|
||||
|
||||
## Configuration Load Order
|
||||
|
||||
[Cloud-config]({{page.baseurl}}/configuration/#cloud-config/) is read by system services when they need to get configuration. Each additional file overwrites and extends the previous configuration file.
|
||||
[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.
|
||||
|
||||
@ -18,7 +18,7 @@ To edit the kernel boot parameters of an already installed RancherOS system, use
|
||||
|
||||
### During installation
|
||||
|
||||
If you want to set the extra kernel parameters when you are [Installing RancherOS to Disk]({{page.baseurl}}/running-rancheros/server/install-to-disk/) please use the `--append` parameter.
|
||||
If you want to set the extra kernel parameters when you are [Installing RancherOS to Disk]({{page.osbaseurl}}/running-rancheros/server/install-to-disk/) please use the `--append` parameter.
|
||||
|
||||
```bash
|
||||
$ sudo ros install -d /dev/sda --append "rancheros.autologin=tty1"
|
||||
|
||||
@ -7,9 +7,9 @@ title: Custom Console on RancherOS
|
||||
## Custom Console
|
||||
---
|
||||
|
||||
When [booting from the ISO]({{page.baseurl}}/running-rancheros/workstation/boot-from-iso/), RancherOS starts with the default console, which is based on busybox.
|
||||
When [booting from the ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso/), RancherOS starts with the default console, which is based on busybox.
|
||||
|
||||
You can select which console you want RancherOS to start with using the [cloud-config]({{page.baseurl}}/configuration/#cloud-config).
|
||||
You can select which console you want RancherOS to start with using the [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
### Enabling Consoles using Cloud-Config
|
||||
|
||||
@ -106,7 +106,7 @@ All consoles except the default (busybox) console are persistent. Persistent con
|
||||
|
||||
<br>
|
||||
|
||||
> **Note:** When using a persistent console and in the current version's console, [rolling back]({{page.baseurl}}/upgrading/#rolling-back-an-upgrade) is not supported. For example, rolling back to v0.4.5 when using a v0.5.0 persistent console is not supported.
|
||||
> **Note:** When using a persistent console and in the current version's console, [rolling back]({{page.osbaseurl}}/upgrading/#rolling-back-an-upgrade) is not supported. For example, rolling back to v0.4.5 when using a v0.5.0 persistent console is not supported.
|
||||
|
||||
### Enabling Consoles
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ title: Custom Kernels in RancherOS
|
||||
|
||||
### Changing the Kernel in RancherOS
|
||||
|
||||
By default, RancherOS ships with the kernel provided by the [os-kernel repository](https://github.com/rancher/os-kernel). Swapping out the default kernel can by done by [building your own custom RancherOS ISO]({{page.baseurl}}/configuration/custom-rancheros-iso/).
|
||||
By default, RancherOS ships with the kernel provided by the [os-kernel repository](https://github.com/rancher/os-kernel). Swapping out the default kernel can by done by [building your own custom RancherOS ISO]({{page.osbaseurl}}/configuration/custom-rancheros-iso/).
|
||||
|
||||
1. Create a clone of the main [RancherOS repository](https://github.com/rancher/os) to your local machine with a `git clone`.
|
||||
|
||||
@ -59,7 +59,7 @@ By default, RancherOS ships with the kernel provided by the [os-kernel repositor
|
||||
...
|
||||
```
|
||||
|
||||
3. After you've replaced the URL with your custom kernel, you can follow the steps in [building your own custom RancherOS ISO]({{page.baseurl}}/configuration/custom-rancheros-iso/).
|
||||
3. After you've replaced the URL with your custom kernel, you can follow the steps in [building your own custom RancherOS ISO]({{page.osbaseurl}}/configuration/custom-rancheros-iso/).
|
||||
|
||||
### Packaging a Kernel to be used in RancherOS
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ It's easy to build your own RancherOS ISO.
|
||||
$ git clone https://github.com/rancher/os.git
|
||||
```
|
||||
|
||||
2. In the root of the repository, the "General Configuration" section of `Dockerfile.dapper` can be updated to use [custom kernels]({{page.baseurl}}/configuration/custom-kernels), or [custom Docker]({{page.baseurl}}/configuration/custom-docker).
|
||||
2. In the root of the repository, the "General Configuration" section of `Dockerfile.dapper` can be updated to use [custom kernels]({{page.osbaseurl}}/configuration/custom-kernels), or [custom Docker]({{page.osbaseurl}}/configuration/custom-docker).
|
||||
|
||||
3. After you've saved your edits, run `make` in the root directory. After the build has completed, a `./dist/artifacts` directory will be created with the custom built RancherOS release files.
|
||||
|
||||
@ -29,7 +29,7 @@ It's easy to build your own RancherOS ISO.
|
||||
iso-checksums.txt vmlinuz
|
||||
```
|
||||
|
||||
The `rancheros.iso` is ready to be used to [boot RancherOS from ISO]({{page.baseurl}}/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{page.baseurl}}/running-rancheros/workstation/docker-machine).
|
||||
The `rancheros.iso` is ready to be used to [boot RancherOS from ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{page.osbaseurl}}/running-rancheros/workstation/docker-machine).
|
||||
|
||||
|
||||
### Creating a GCE Image Archive
|
||||
|
||||
@ -7,7 +7,7 @@ title: Configuring Docker in RancherOS
|
||||
## Configuring Docker or System Docker
|
||||
---
|
||||
|
||||
In RancherOS, you can configure System Docker and Docker daemons by using [cloud-config]({{page.baseurl}}/configuration/#cloud-config).
|
||||
In RancherOS, you can configure System Docker and Docker daemons by using [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
### Configuring Docker
|
||||
|
||||
@ -59,7 +59,7 @@ Key | Value | Default | Description
|
||||
---|---|---| ---
|
||||
`extra_args` | List of Strings | `[]` | Arbitrary daemon arguments, appended to the generated command
|
||||
`environment` | List of Strings | `[]` |
|
||||
`tls` | Boolean | `false` | When [setting up TLS]({{page.baseurl}}/configuration/setting-up-docker-tls/), this key needs to be set to true.
|
||||
`tls` | Boolean | `false` | When [setting up TLS]({{page.osbaseurl}}/configuration/setting-up-docker-tls/), this key needs to be set to true.
|
||||
`tls_args` | List of Strings (used only if `tls: true`) | `[]` |
|
||||
`server_key` | String (used only if `tls: true`)| `""` | PEM encoded server TLS key.
|
||||
`server_cert` | String (used only if `tls: true`) | `""` | PEM encoded server TLS certificate.
|
||||
|
||||
@ -39,7 +39,7 @@ In our example above, we have our `#cloud-config` line to indicate it's a cloud-
|
||||
### Manually Changing Configuration
|
||||
|
||||
To update RancherOS configuration after booting, the `ros config set <key> <value>` command can be used.
|
||||
For more complicated settings, like the [sysctl settings]({{page.baseurl}}/sysctl/index.md), you can also create a small YAML file and then run `sudo ros config merge -i <your yaml file>`.
|
||||
For more complicated settings, like the [sysctl settings]({{page.osbaseurl}}/sysctl/index.md), you can also create a small YAML file and then run `sudo ros config merge -i <your yaml file>`.
|
||||
|
||||
#### Getting Values
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ title: DKMS / Loadable Kernel Modules in RancherOS
|
||||
|
||||
## Dynamic Kernel Module Support (DKMS) / Loadable Kernel Modules (LKM)
|
||||
|
||||
To compile any Kernel Modules, you first need to [deploy the Kernel Headers]({{page.baseurl}}/configuration/kernel-modules-kernel-headers/).
|
||||
To compile any Kernel Modules, you first need to [deploy the Kernel Headers]({{page.osbaseurl}}/configuration/kernel-modules-kernel-headers/).
|
||||
|
||||
### DKMS
|
||||
|
||||
@ -16,7 +16,7 @@ DKMS is supported by running the DKMS scripts inside a *privileged* container.
|
||||
|
||||
> To deploy containers that run any DKMS operations (i.e., `modprobe`), you will need to ensure that you bind-mount `/lib/modules`.
|
||||
|
||||
By default, the `/lib/modules` folder is already available in the console deployed via [RancherOS System Services]({{page.baseurl}}/system-services/built-in-system-services/), but not `/usr/src`. You will likely need to [deploy your own container](#docker-example) for compilation purposes.
|
||||
By default, the `/lib/modules` folder is already available in the console deployed via [RancherOS System Services]({{page.osbaseurl}}/system-services/built-in-system-services/), but not `/usr/src`. You will likely need to [deploy your own container](#docker-example) for compilation purposes.
|
||||
|
||||
To learn more about Docker's privileged mode, or to limit capabilities, please review the [Docker Runtime privilege and Linux capabilities documentation](https://docs.docker.com/engine/reference/run/#/runtime-privilege-and-linux-capabilities).
|
||||
|
||||
@ -71,7 +71,7 @@ find /lib*/modules/$(uname -r) -name *.ko | less
|
||||
zcat /proc/config.gz | less
|
||||
```
|
||||
|
||||
For more information regarding modifying the Kernel, please review the [Custom Kernels]({{page.baseurl}}/custom-builds/custom-kernels/) documentation.
|
||||
For more information regarding modifying the Kernel, please review the [Custom Kernels]({{page.osbaseurl}}/custom-builds/custom-kernels/) documentation.
|
||||
|
||||
### Auto-Loading Modules
|
||||
|
||||
@ -101,7 +101,7 @@ Messing around with the Kernel can be tricky, so here's some common issues:
|
||||
|
||||
#### kernel source for this kernel does not seem to be installed.
|
||||
|
||||
Simply put, the Kernel Headers (or Source) cannot be found; enable them via the [Kernel Headers System Service]({{page.baseurl}}/configuration/kernel-modules-kernel-headers/).
|
||||
Simply put, the Kernel Headers (or Source) cannot be found; enable them via the [Kernel Headers System Service]({{page.osbaseurl}}/configuration/kernel-modules-kernel-headers/).
|
||||
|
||||
#### Operation not Permitted
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ title: Private Registries in RancherOS
|
||||
## Private Registries
|
||||
---
|
||||
|
||||
When launching services through a [cloud-config]({{page.baseurl}}/configuration/#cloud-config), it is sometimes necessary to pull a private image from DockerHub or from a private registry. Authentication for these can be embedded in your cloud-config.
|
||||
When launching services through a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config), it is sometimes necessary to pull a private image from DockerHub or from a private registry. Authentication for these can be embedded in your cloud-config.
|
||||
|
||||
For example, to add authentication for DockerHub:
|
||||
|
||||
@ -65,7 +65,7 @@ write_files:
|
||||
|
||||
### Certificates for Private Registries
|
||||
|
||||
Certificates can be stored in the standard locations (i.e. `/etc/docker/certs.d`) following the [Docker documentation](https://docs.docker.com/registry/insecure). By using the `write_files` directive of the [cloud-config]({{page.baseurl}}/configuration/#cloud-config), the certificates can be written directly into `/etc/docker/certs.d`.
|
||||
Certificates can be stored in the standard locations (i.e. `/etc/docker/certs.d`) following the [Docker documentation](https://docs.docker.com/registry/insecure). By using the `write_files` directive of the [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config), the certificates can be written directly into `/etc/docker/certs.d`.
|
||||
|
||||
```yaml
|
||||
#cloud-config
|
||||
|
||||
@ -16,7 +16,7 @@ runcmd:
|
||||
- echo "test" > /home/rancher/test2
|
||||
```
|
||||
|
||||
Commands specified using `runcmd` will be executed within the context of the `console` container. More details on the ordering of commands run in the `console` container can be found [here]({{page.baseurl}}/system-services/built-in-system-services/#console).
|
||||
Commands specified using `runcmd` will be executed within the context of the `console` container. More details on the ordering of commands run in the `console` container can be found [here]({{page.osbaseurl}}/system-services/built-in-system-services/#console).
|
||||
|
||||
### Running Docker commands
|
||||
|
||||
@ -35,7 +35,7 @@ write_files:
|
||||
docker run -d nginx
|
||||
```
|
||||
|
||||
Running Docker commands in this manner is useful when pieces of the `docker run` command are dynamically generated. For services whose configuration is static, [adding a system service]({{page.baseurl}}/system-services/adding-system-services/) is recommended.
|
||||
Running Docker commands in this manner is useful when pieces of the `docker run` command are dynamically generated. For services whose configuration is static, [adding a system service]({{page.osbaseurl}}/system-services/adding-system-services/) is recommended.
|
||||
|
||||
## Running Commands Early in the Boot Process
|
||||
---
|
||||
|
||||
@ -7,7 +7,7 @@ title: SSH Keys in RancherOS
|
||||
## SSH Keys
|
||||
---
|
||||
|
||||
RancherOS supports adding SSH keys through the [cloud-config]({{page.baseurl}}/configuration/#cloud-config) file. Within the cloud-config file, you simply add the ssh keys within the `ssh_authorized_keys` key.
|
||||
RancherOS supports adding SSH keys through the [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file. Within the cloud-config file, you simply add the ssh keys within the `ssh_authorized_keys` key.
|
||||
|
||||
```yaml
|
||||
#cloud-config
|
||||
|
||||
@ -9,13 +9,13 @@ redirect_from:
|
||||
## Switching Consoles
|
||||
---
|
||||
|
||||
When [booting from the ISO]({{page.baseurl}}/running-rancheros/workstation/boot-from-iso/), RancherOS starts with the default console, which is based on busybox.
|
||||
When [booting from the ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso/), RancherOS starts with the default console, which is based on busybox.
|
||||
|
||||
You can select which console you want RancherOS to start with using the [cloud-config]({{page.baseurl}}/configuration/#cloud-config).
|
||||
You can select which console you want RancherOS to start with using the [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
### Enabling Consoles using Cloud-Config
|
||||
|
||||
When launching RancherOS with a [cloud-config]({{page.baseurl}}/configuration/#cloud-config) file, you can select which console you want to use.
|
||||
When launching RancherOS with a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file, you can select which console you want to use.
|
||||
|
||||
Currently, the list of available consoles are:
|
||||
|
||||
@ -108,7 +108,7 @@ All consoles except the default (busybox) console are persistent. Persistent con
|
||||
|
||||
<br>
|
||||
|
||||
> **Note:** When using a persistent console and in the current version's console, [rolling back]({{page.baseurl}}/upgrading/#rolling-back-an-upgrade) is not supported. For example, rolling back to v0.4.5 when using a v0.5.0 persistent console is not supported.
|
||||
> **Note:** When using a persistent console and in the current version's console, [rolling back]({{page.osbaseurl}}/upgrading/#rolling-back-an-upgrade) is not supported. For example, rolling back to v0.4.5 when using a v0.5.0 persistent console is not supported.
|
||||
|
||||
### Enabling Consoles
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
|
||||
## Changing Docker Versions
|
||||
|
||||
The version of User Docker used in RancherOS can be configured using a [cloud-config]({{page.baseurl}}/configuration/#cloud-config) file or by using the `ros engine` command.
|
||||
The version of User Docker used in RancherOS can be configured using a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file or by using the `ros engine` command.
|
||||
|
||||
> **Note:** There are known issues in Docker when switching between versions. For production systems, we recommend setting the Docker engine only once [using a cloud-config](#setting-the-docker-engine-using-cloud-config).
|
||||
|
||||
@ -88,7 +88,7 @@ FROM scratch
|
||||
COPY engine /engine
|
||||
```
|
||||
|
||||
Once the image is built a [system service]({{page.baseurl}}/system-services/adding-system-services/) configuration file must be created. An [example file](https://github.com/rancher/os-services/blob/master/d/docker-1.12.3.yml) can be found in the rancher/os-services repo. Change the `image` field to point to the Docker engine image you've built.
|
||||
Once the image is built a [system service]({{page.osbaseurl}}/system-services/adding-system-services/) configuration file must be created. An [example file](https://github.com/rancher/os-services/blob/master/d/docker-1.12.3.yml) can be found in the rancher/os-services repo. Change the `image` field to point to the Docker engine image you've built.
|
||||
|
||||
All of the previously mentioned methods of switching Docker engines are now available. For example, if your service file is located at `https://myservicefile` then the following cloud-config file could be used to use your custom Docker engine.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ title: Users in RancherOS
|
||||
|
||||
Currently, we don't support adding other users besides `rancher`.
|
||||
|
||||
You _can_ add users in the console container, but these users will only exist as long as the console container exists. It only makes sense to add users in a [persistent consoles]({{page.baseurl}}/configuration/custom-console/#console-persistence).
|
||||
You _can_ add users in the console container, but these users will only exist as long as the console container exists. It only makes sense to add users in a [persistent consoles]({{page.osbaseurl}}/configuration/custom-console/#console-persistence).
|
||||
|
||||
If you want the console user to be able to ssh into RancherOS, you need to add them
|
||||
to the `docker` group.
|
||||
|
||||
@ -63,7 +63,7 @@ All of repositories are located within our main GitHub [page](https://github.com
|
||||
|
||||
[RancherOS Repo](https://github.com/rancher/os): This repo contains the bulk of the RancherOS code.
|
||||
|
||||
[RancherOS Services Repo](https://github.com/rancher/os-services): This repo is where any [system-services]({{page.baseurl}}/system-services/) can be contributed.
|
||||
[RancherOS Services Repo](https://github.com/rancher/os-services): This repo is where any [system-services]({{page.osbaseurl}}/system-services/) can be contributed.
|
||||
|
||||
[RancherOS Images Repo](https://github.com/rancher/os-images): This repo is for the corresponding service images.
|
||||
|
||||
|
||||
@ -53,7 +53,7 @@ The `build-<name>.tar.gz` and `extra-<name>.tar.gz` files are used to build the
|
||||
|
||||
### Building a RancherOS release using the Packaged kernel files.
|
||||
|
||||
By default, RancherOS ships with the kernel provided by the [os-kernel repository](https://github.com/rancher/os-kernel). Swapping out the default kernel can by done by [building your own custom RancherOS ISO]({{page.baseurl}}/configuration/custom-rancheros-iso/).
|
||||
By default, RancherOS ships with the kernel provided by the [os-kernel repository](https://github.com/rancher/os-kernel). Swapping out the default kernel can by done by [building your own custom RancherOS ISO]({{page.osbaseurl}}/configuration/custom-rancheros-iso/).
|
||||
|
||||
1. Create a clone of the main [RancherOS repository](https://github.com/rancher/os) to your local machine with a `git clone`.
|
||||
|
||||
@ -103,4 +103,4 @@ By default, RancherOS ships with the kernel provided by the [os-kernel repositor
|
||||
...
|
||||
```
|
||||
|
||||
3. After you've replaced the URL with your custom kernel, you can follow the steps in [building your own custom RancherOS ISO]({{page.baseurl}}/configuration/custom-rancheros-iso/).
|
||||
3. After you've replaced the URL with your custom kernel, you can follow the steps in [building your own custom RancherOS ISO]({{page.osbaseurl}}/configuration/custom-rancheros-iso/).
|
||||
|
||||
@ -15,7 +15,7 @@ It's easy to build your own RancherOS ISO.
|
||||
$ git clone https://github.com/rancher/os.git
|
||||
```
|
||||
|
||||
2. In the root of the repository, the "General Configuration" section of `Dockerfile.dapper` can be updated to use [custom kernels]({{page.baseurl}}/configuration/custom-kernels), or [custom Docker]({{page.baseurl}}/configuration/custom-docker).
|
||||
2. In the root of the repository, the "General Configuration" section of `Dockerfile.dapper` can be updated to use [custom kernels]({{page.osbaseurl}}/configuration/custom-kernels), or [custom Docker]({{page.osbaseurl}}/configuration/custom-docker).
|
||||
|
||||
3. After you've saved your edits, run `make` in the root directory. After the build has completed, a `./dist/artifacts` directory will be created with the custom built RancherOS release files.
|
||||
|
||||
@ -29,7 +29,7 @@ It's easy to build your own RancherOS ISO.
|
||||
iso-checksums.txt vmlinuz
|
||||
```
|
||||
|
||||
The `rancheros.iso` is ready to be used to [boot RancherOS from ISO]({{page.baseurl}}/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{page.baseurl}}/running-rancheros/workstation/docker-machine).
|
||||
The `rancheros.iso` is ready to be used to [boot RancherOS from ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{page.osbaseurl}}/running-rancheros/workstation/docker-machine).
|
||||
|
||||
|
||||
### Creating a GCE Image Archive
|
||||
|
||||
@ -18,12 +18,12 @@ Docker is an open-source platform designed for developers, system admins, and De
|
||||
|
||||
* x86_64 server with at least 512MB of RAM.
|
||||
|
||||
> **Note:** If you are planning on [installing to disk]({{page.baseurl}}/running-rancheros/server/install-to-disk/), you will need at least 1024MB of RAM.
|
||||
> **Note:** If you are planning on [installing to disk]({{page.osbaseurl}}/running-rancheros/server/install-to-disk/), you will need at least 1024MB of RAM.
|
||||
|
||||
|
||||
### How this works
|
||||
|
||||
Everything in RancherOS is a Docker container. We accomplish this by launching two instances of Docker. One is what we call **System Docker**, the first process on the system. All other system services, like `ntpd`, `syslog`, and `console`, are running in Docker containers. System Docker replaces traditional init systems like `systemd`, and can be used to launch [additional system services]({{page.baseurl}}/system-services/adding-system-services/).
|
||||
Everything in RancherOS is a Docker container. We accomplish this by launching two instances of Docker. One is what we call **System Docker**, the first process on the system. All other system services, like `ntpd`, `syslog`, and `console`, are running in Docker containers. System Docker replaces traditional init systems like `systemd`, and can be used to launch [additional system services]({{page.osbaseurl}}/system-services/adding-system-services/).
|
||||
|
||||
System Docker runs a special container called **Docker**, which is another Docker daemon responsible for managing all of the user’s containers. Any containers that you launch as a user from the console will run inside this Docker. This creates isolation from the System Docker containers, and ensures normal user commands don’t impact system services.
|
||||
|
||||
@ -34,7 +34,7 @@ System Docker runs a special container called **Docker**, which is another Docke
|
||||
|
||||
### Running RancherOS
|
||||
|
||||
To find out more about installing RancherOS, jump to our [Quick Start Guide]({{page.baseurl}}/quick-start-guide/).
|
||||
To find out more about installing RancherOS, jump to our [Quick Start Guide]({{page.osbaseurl}}/quick-start-guide/).
|
||||
|
||||
### Latest Release
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ title: Quick Start Guide for RancherOS
|
||||
## Quick Start Guide
|
||||
---
|
||||
|
||||
If you have a specific RanchersOS machine requirements, please check out our [guides on running RancherOS]({{page.baseurl}}/running-rancheros/). With the rest of this guide, we'll start up a RancherOS using [Docker machine]({{page.baseurl}}/running-rancheros/workstation/docker-machine/) and show you some of what RancherOS can do.
|
||||
If you have a specific RanchersOS machine requirements, please check out our [guides on running RancherOS]({{page.osbaseurl}}/running-rancheros/). With the rest of this guide, we'll start up a RancherOS using [Docker machine]({{page.osbaseurl}}/running-rancheros/workstation/docker-machine/) and show you some of what RancherOS can do.
|
||||
|
||||
### Launching RancherOS using Docker Machine
|
||||
|
||||
@ -121,7 +121,7 @@ $ sudo ros config get rancher.network.dns.nameservers
|
||||
```
|
||||
|
||||
|
||||
When using the native Busybox console, any changes to the console will be lost after reboots, only changes to `/home` or `/opt` will be persistent. You can use the `ros console switch` command to switch to a [persistent console]({{page.baseurl}}/configuration/custom-console/#console-persistence) and replace the native Busybox console. For example, to switch to the Ubuntu console:
|
||||
When using the native Busybox console, any changes to the console will be lost after reboots, only changes to `/home` or `/opt` will be persistent. You can use the `ros console switch` command to switch to a [persistent console]({{page.osbaseurl}}/configuration/custom-console/#console-persistence) and replace the native Busybox console. For example, to switch to the Ubuntu console:
|
||||
|
||||
```
|
||||
$ sudo ros console switch ubuntu
|
||||
|
||||
@ -11,7 +11,7 @@ RancherOS can be used to launch [Rancher]({{site.baseurl}}/rancher/) and be used
|
||||
|
||||
### Launching Agents using Cloud-Config
|
||||
|
||||
You can easily add hosts into Rancher by using [cloud-config]({{page.baseurl}}/configuration/#cloud-config) to launch the rancher/agent container.
|
||||
You can easily add hosts into Rancher by using [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) to launch the rancher/agent container.
|
||||
|
||||
After Rancher is launched and [host registration]({{site.baseurl}}/rancher/configuration/settings/#host-registration) has been saved, you will be able to find the [custom command]({{site.baseurl}}/rancher/rancher-ui/infrastructure/hosts/custom) in the **Infrastructure** -> **Hosts** -> **Custom** page.
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ Let’s walk through how to import and create a RancherOS on EC2 machine using t
|
||||
|
||||
|
||||
|
||||
3. Go through the steps of creating the instance type through the AWS console. If you want to pass in a [cloud-config]({{page.baseurl}}/configuration/#cloud-config) file during boot of RancherOS, you'd pass in the file as **User data** by expanding the **Advanced Details** in **Step 3: Configure Instance Details**. You can pass in the data as text or as a file.
|
||||
3. Go through the steps of creating the instance type through the AWS console. If you want to pass in a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file during boot of RancherOS, you'd pass in the file as **User data** by expanding the **Advanced Details** in **Step 3: Configure Instance Details**. You can pass in the data as text or as a file.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ $ gcloud compute instances create --project <PROJECT_ID> --zone <ZONE_TO_CREATE_
|
||||
|
||||
### Using a Cloud Config File with GCE
|
||||
|
||||
If you want to pass in your own cloud config file that will be processed by [cloud init]({{page.baseurl}}/configuration/#cloud-config), you can pass it as metadata upon creation of the instance during the `gcloud compute` command. The file will need to be stored locally before running the command. The key of the metadata will be `user-data` and the value is the location of the file. If any SSH keys are added in the cloud config file, it will also be added to the **rancher** user.
|
||||
If you want to pass in your own cloud config file that will be processed by [cloud init]({{page.osbaseurl}}/configuration/#cloud-config), you can pass it as metadata upon creation of the instance during the `gcloud compute` command. The file will need to be stored locally before running the command. The key of the metadata will be `user-data` and the value is the location of the file. If any SSH keys are added in the cloud config file, it will also be added to the **rancher** user.
|
||||
|
||||
```
|
||||
$ gcloud compute instances create --project <PROJECT_ID> --zone <ZONE_TO_CREATE_INSTANCE> <INSTANCE_NAME> --image <PRIVATE_IMAGE_NAME> --metadata-from-file user-data=/Directory/of/Cloud_Config.yml
|
||||
|
||||
@ -8,4 +8,4 @@ title: Rancher RancherOS in Openstack
|
||||
|
||||
As of v0.5.0, RancherOS releases include an Openstack image that can be found on our [releases page](https://github.com/rancher/os/releases). The image format is QCOW2.
|
||||
|
||||
When launching an instance using the image, you must enable **Advanced Options** -> **Configuration Drive** and in order to use a [cloud-config]({{page.baseurl}}/configuration/#cloud-config) file.
|
||||
When launching an instance using the image, you must enable **Advanced Options** -> **Configuration Drive** and in order to use a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file.
|
||||
|
||||
@ -7,33 +7,33 @@ title: Running RancherOS
|
||||
## Running RancherOS
|
||||
---
|
||||
|
||||
RancherOS runs on virtualization platforms, cloud providers and bare metal servers. We also support running a local VM on your laptop. To start running RancherOS as quickly as possible, follow our [Quick Start Guide]({{page.baseurl}}/quick-start-guide/).
|
||||
RancherOS runs on virtualization platforms, cloud providers and bare metal servers. We also support running a local VM on your laptop. To start running RancherOS as quickly as possible, follow our [Quick Start Guide]({{page.osbaseurl}}/quick-start-guide/).
|
||||
|
||||
### Platforms
|
||||
|
||||
#### Workstation
|
||||
|
||||
[Docker Machine]({{page.baseurl}}/running-rancheros/workstation/docker-machine)
|
||||
[Docker Machine]({{page.osbaseurl}}/running-rancheros/workstation/docker-machine)
|
||||
|
||||
[Boot from ISO]({{page.baseurl}}/running-rancheros/workstation/boot-from-iso)
|
||||
[Boot from ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso)
|
||||
|
||||
|
||||
#### Cloud
|
||||
|
||||
[Amazon EC2]({{page.baseurl}}/running-rancheros/cloud/aws)
|
||||
[Amazon EC2]({{page.osbaseurl}}/running-rancheros/cloud/aws)
|
||||
|
||||
[Google Compute Engine]({{page.baseurl}}/running-rancheros/cloud/gce)
|
||||
[Google Compute Engine]({{page.osbaseurl}}/running-rancheros/cloud/gce)
|
||||
|
||||
[DigitalOcean]({{page.baseurl}}/running-rancheros/cloud/do)
|
||||
[DigitalOcean]({{page.osbaseurl}}/running-rancheros/cloud/do)
|
||||
|
||||
[Azure]({{page.baseurl}}/running-rancheros/cloud/azure)
|
||||
[Azure]({{page.osbaseurl}}/running-rancheros/cloud/azure)
|
||||
|
||||
#### Bare Metal & Virtual Servers
|
||||
|
||||
[iPXE]({{page.baseurl}}/running-rancheros/server/ipxe)
|
||||
[iPXE]({{page.osbaseurl}}/running-rancheros/server/ipxe)
|
||||
|
||||
[PXE]({{page.baseurl}}/running-rancheros/server/pxe)
|
||||
[PXE]({{page.osbaseurl}}/running-rancheros/server/pxe)
|
||||
|
||||
[Install to Hard Disk]({{page.baseurl}}/running-rancheros/server/install-to-disk)
|
||||
[Install to Hard Disk]({{page.osbaseurl}}/running-rancheros/server/install-to-disk)
|
||||
|
||||
<br>
|
||||
|
||||
@ -5,7 +5,7 @@ title: Installing RancherOS to Disk
|
||||
|
||||
## Installing RancherOS to Disk
|
||||
---
|
||||
RancherOS comes with a simple installer that will install RancherOS on a given target disk. To install RancherOS on a new disk, you can use the `ros install` command. Before installing, you'll need to have already [booted RancherOS from ISO]({{page.baseurl}}/running-rancheros/workstation/boot-from-iso). Please be sure to pick the `rancheros.iso` from our release [page](https://github.com/rancher/os/releases).
|
||||
RancherOS comes with a simple installer that will install RancherOS on a given target disk. To install RancherOS on a new disk, you can use the `ros install` command. Before installing, you'll need to have already [booted RancherOS from ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso). Please be sure to pick the `rancheros.iso` from our release [page](https://github.com/rancher/os/releases).
|
||||
|
||||
### Using `ros install` to Install RancherOS
|
||||
|
||||
@ -13,7 +13,7 @@ The `ros install` command orchestrates the installation from the `rancher/os` co
|
||||
|
||||
#### Cloud-Config
|
||||
|
||||
The easiest way to log in is to pass a `cloud-config.yml` file containing your public SSH keys. To learn more about what's supported in our cloud-config, please read our [documentation]({{page.baseurl}}/configuration/#cloud-config).
|
||||
The easiest way to log in is to pass a `cloud-config.yml` file containing your public SSH keys. To learn more about what's supported in our cloud-config, please read our [documentation]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
The `ros install` command will process your `cloud-config.yml` file specified with the `-c` flag. This file will also be placed onto the disk and installed to `/var/lib/rancher/conf/`. It will be evaluated on every boot.
|
||||
|
||||
@ -57,7 +57,7 @@ Status: Downloaded newer image for rancher/os:v0.5.0
|
||||
Continue with reboot [y/N]:
|
||||
```
|
||||
|
||||
After installing RancherOS to disk, you will no longer be automatically logged in as the `rancher` user. You'll need to have added in SSH keys within your [cloud-config file]({{page.baseurl}}/configuration/#cloud-config).
|
||||
After installing RancherOS to disk, you will no longer be automatically logged in as the `rancher` user. You'll need to have added in SSH keys within your [cloud-config file]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
#### Installing a Different Version
|
||||
|
||||
|
||||
@ -62,10 +62,10 @@ Valid cloud-init datasources for RancherOS.
|
||||
| gce | | |
|
||||
| packet | DefaultAddress | |
|
||||
| url | url | |
|
||||
| vmware | | set `guestinfo` cloud-init or interface data as per [VMware ESXi]({{page.baseurl}}/cloud/vmware-esxi) |
|
||||
| vmware | | set `guestinfo` cloud-init or interface data as per [VMware ESXi]({{page.osbaseurl}}/cloud/vmware-esxi) |
|
||||
| * | This will add ["configdrive", "vmware", "ec2", "digitalocean", "packet", "gce"] into the list of datasources to try | |
|
||||
|
||||
### Cloud-Config
|
||||
|
||||
When booting via iPXE, RancherOS can be configured using a [cloud-config file]({{page.baseurl}}/configuration/#cloud-config).
|
||||
When booting via iPXE, RancherOS can be configured using a [cloud-config file]({{page.osbaseurl}}/configuration/#cloud-config).
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ title: Running RancherOS on Raspberry Pi
|
||||
|
||||
As of v0.5.0, RancherOS releases include a Raspberry Pi image that can be found on our [releases page](https://github.com/rancher/os/releases). The official Raspberry Pi documentation contains instructions on how to [install operating system images](https://www.raspberrypi.org/documentation/installation/installing-images/).
|
||||
|
||||
When installing, there is no ability to pass in a [cloud-config]({{page.baseurl}}/configuration/#cloud-config). You will need to boot up, change the configuration and then reboot to apply those changes.
|
||||
When installing, there is no ability to pass in a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config). You will need to boot up, change the configuration and then reboot to apply those changes.
|
||||
|
||||
Currently, only Raspberry Pi 2 and 3 are tested and known to work.
|
||||
|
||||
|
||||
@ -9,11 +9,11 @@ The RancherOS ISO file can be used to create a fresh RancherOS install on KVM, V
|
||||
|
||||
You must boot with at least **512MB** of memory. If you boot with the ISO, you will automatically be logged in as the `rancher` user. Only the ISO is set to use autologin by default. If you run from a cloud or install to disk, SSH keys or a password of your choice is expected to be used.
|
||||
|
||||
> **Note:** If you are planning on [installing to disk]({{page.baseurl}}/running-rancheros/server/install-to-disk/), you will need at least 1.5GB of RAM.
|
||||
> **Note:** If you are planning on [installing to disk]({{page.osbaseurl}}/running-rancheros/server/install-to-disk/), you will need at least 1.5GB of RAM.
|
||||
|
||||
### Install to Disk
|
||||
|
||||
After you boot RancherOS from ISO, you can follow the instructions [here]({{page.baseurl}}/running-rancheros/server/install-to-disk/) to install RancherOS to a hard disk.
|
||||
After you boot RancherOS from ISO, you can follow the instructions [here]({{page.osbaseurl}}/running-rancheros/server/install-to-disk/) to install RancherOS to a hard disk.
|
||||
|
||||
### Persisting State
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ Logging into RancherOS follows the standard Docker Machine commands. To login in
|
||||
$ docker-machine ssh <MACHINE-NAME>
|
||||
```
|
||||
|
||||
You'll be logged into RancherOS and can start exploring the OS, This will log you into the RancherOS VM. You'll then be able to explore the OS by [adding system services]({{page.baseurl}}/system-services/adding-system-services/), [customizing the configuration]({{page.baseurl}}/configuration/), and launching containers.
|
||||
You'll be logged into RancherOS and can start exploring the OS, This will log you into the RancherOS VM. You'll then be able to explore the OS by [adding system services]({{page.osbaseurl}}/system-services/adding-system-services/), [customizing the configuration]({{page.osbaseurl}}/configuration/), and launching containers.
|
||||
|
||||
If you want to exit out of RancherOS, you can exit by pressing `Ctrl+D`.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
## Additional Mounts
|
||||
---
|
||||
|
||||
Additional mounts can be specified as part of your [cloud-config]({{page.baseurl}}/configuration/#cloud-config). These mounts are applied within the console container. Here's a simple example that mounts `/dev/vdb` to `/mnt/s`.
|
||||
Additional mounts can be specified as part of your [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config). These mounts are applied within the console container. Here's a simple example that mounts `/dev/vdb` to `/mnt/s`.
|
||||
|
||||
```yaml
|
||||
#cloud-config
|
||||
|
||||
@ -5,7 +5,7 @@ title: Custom System Services in RancherOS
|
||||
|
||||
## Custom System Services
|
||||
|
||||
You can also create your own system service in [Docker Compose](https://docs.docker.com/compose/) format. After creating your own custom service, you can launch it in RancherOS in a couple of methods. The service could be directly added to the [cloud-config]({{page.baseurl}}/configuration/#cloud-config), or a `docker-compose.yml` file could be saved at a http(s) url location or in a specific directory of RancherOS.
|
||||
You can also create your own system service in [Docker Compose](https://docs.docker.com/compose/) format. After creating your own custom service, you can launch it in RancherOS in a couple of methods. The service could be directly added to the [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config), or a `docker-compose.yml` file could be saved at a http(s) url location or in a specific directory of RancherOS.
|
||||
|
||||
### Launching Services through Cloud-Config
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ title: Directories
|
||||
|
||||
### Persistent Directories Across Reboot
|
||||
|
||||
With v0.4.0, ubuntu and debian consoles are [persistent consoles]({{page.baseurl}}/configuration/custom-console/#console-persistence). Therefore, the only difference is what is persisted inside a containers as opposed to on the host. If a container is deleted/rebuilt, state in the console will be lost except what is in the persisted directories.
|
||||
With v0.4.0, ubuntu and debian consoles are [persistent consoles]({{page.osbaseurl}}/configuration/custom-console/#console-persistence). Therefore, the only difference is what is persisted inside a containers as opposed to on the host. If a container is deleted/rebuilt, state in the console will be lost except what is in the persisted directories.
|
||||
|
||||
```
|
||||
/home
|
||||
|
||||
@ -13,7 +13,7 @@ Since RancherOS is a kernel and initrd, the upgrade process is downloading a new
|
||||
|
||||
To see all of our releases, please visit our [releases page](https://github.com/rancher/os/releases) in GitHub.
|
||||
|
||||
> **Note:** If you are using [`docker-machine`]({{page.baseurl}}/running-rancheros/workstation/docker-machine/) then you will not be able to upgrade your RancherOS version. You need to delete and re-create the machine.
|
||||
> **Note:** If you are using [`docker-machine`]({{page.osbaseurl}}/running-rancheros/workstation/docker-machine/) then you will not be able to upgrade your RancherOS version. You need to delete and re-create the machine.
|
||||
|
||||
|
||||
### Version Control
|
||||
@ -68,7 +68,7 @@ $ sudo ros -v
|
||||
ros version v0.5.0
|
||||
```
|
||||
|
||||
> **Note:** If you are booting from ISO and have not installed to disk, your upgrade will not be saved. You can view our guide to [installing to disk]({{page.baseurl}}/running-rancheros/server/install-to-disk/).
|
||||
> **Note:** If you are booting from ISO and have not installed to disk, your upgrade will not be saved. You can view our guide to [installing to disk]({{page.osbaseurl}}/running-rancheros/server/install-to-disk/).
|
||||
|
||||
#### Upgrading to a Specific Version
|
||||
|
||||
@ -118,7 +118,7 @@ ros version 0.4.4
|
||||
|
||||
<br>
|
||||
|
||||
> **Note:** If you are using a [persistent console]({{page.baseurl}}/configuration/custom-console/#console-persistence) and in the current version's console, rolling back is not supported. For example, rolling back to v0.4.5 when using a v0.5.0 persistent console is not supported.
|
||||
> **Note:** If you are using a [persistent console]({{page.osbaseurl}}/configuration/custom-console/#console-persistence) and in the current version's console, rolling back is not supported. For example, rolling back to v0.4.5 when using a v0.5.0 persistent console is not supported.
|
||||
|
||||
### Staging an Upgrade
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user