diff --git a/content/os/v1.x/en/_index.md b/content/os/v1.x/en/_index.md index ce1231253b6..44f95a0cb65 100644 --- a/content/os/v1.x/en/_index.md +++ b/content/os/v1.x/en/_index.md @@ -1,12 +1,10 @@ --- -title: RancherOS Documentation +title: Overview of RancherOS shortTitle: RancherOS description: RancherOS is a simplified Linux distribution built from containers, for containers. These documents describe how to install and use RancherOS. weight: 1 --- -## Overview of RancherOS ---- RancherOS is the smallest, easiest way to run Docker in production. Everything in RancherOS is a container managed by Docker. This includes system services such as `udev` and `syslog`. Because it only includes the services necessary to run Docker, RancherOS is dramatically smaller than most traditional operating systems. By removing unnecessary libraries and services, requirements for security patches and other maintenance are dramatically reduced. This is possible because, with Docker, users typically package all necessary libraries into their containers. Another way in which RancherOS is designed specifically for running Docker is that it always runs the latest version of Docker. This allows users to take advantage of the latest Docker capabilities and bug fixes. diff --git a/content/os/v1.x/en/about/_index.md b/content/os/v1.x/en/about/_index.md index 4defefb7006..89a3c6b52af 100644 --- a/content/os/v1.x/en/about/_index.md +++ b/content/os/v1.x/en/about/_index.md @@ -1,11 +1,8 @@ --- -title: About +title: Contributing to RancherOS weight: 4 --- -## Contributing to RancherOS ---- - ## Developing Development is easiest done with QEMU on Linux. OS X works too, although QEMU doesn't have KVM support. If you are running Linux in a virtual machine, then we recommend you run VMWare Fusion/Workstation and enable VT-x support. Then, QEMU will have KVM support and run sufficiently fast inside your Linux VM. diff --git a/content/os/v1.x/en/about/faqs/_index.md b/content/os/v1.x/en/about/faqs/_index.md index 464cb407166..baa1182cce8 100644 --- a/content/os/v1.x/en/about/faqs/_index.md +++ b/content/os/v1.x/en/about/faqs/_index.md @@ -1,11 +1,8 @@ --- -title: FAQs +title: Frequently Asked Questions weight: 301 --- -## Frequently Asked Questions ---- - ### What is required to run RancherOS? RancherOS runs on any laptop, physical, or virtual servers. diff --git a/content/os/v1.x/en/about/running-rancher-on-rancherOS/_index.md b/content/os/v1.x/en/about/running-rancher-on-rancherOS/_index.md index a9da0a13610..225eed12892 100644 --- a/content/os/v1.x/en/about/running-rancher-on-rancherOS/_index.md +++ b/content/os/v1.x/en/about/running-rancher-on-rancherOS/_index.md @@ -1,12 +1,8 @@ --- -title: Running Rancher on RancherOS +title: Tips on using Rancher v1.x with RancherOS weight: 302 --- - -## Tips on using Rancher v1.x with RancherOS ---- - RancherOS can be used to launch [Rancher](/rancher/) and be used as the OS to add nodes to Rancher. ### Launching Agents using Cloud-Config diff --git a/content/os/v1.x/en/about/security/_index.md b/content/os/v1.x/en/about/security/_index.md index 29715d2f7a2..1311d84a9ec 100644 --- a/content/os/v1.x/en/about/security/_index.md +++ b/content/os/v1.x/en/about/security/_index.md @@ -3,10 +3,6 @@ title: RancherOS Security weight: 303 --- -## RancherOS Security ---- - -
diff --git a/content/os/v1.x/en/installation/amazon-ecs/_index.md b/content/os/v1.x/en/installation/amazon-ecs/_index.md index daed6efd134..27e730fd4fa 100644 --- a/content/os/v1.x/en/installation/amazon-ecs/_index.md +++ b/content/os/v1.x/en/installation/amazon-ecs/_index.md @@ -3,9 +3,6 @@ title: Amazon ECS (EC2 Container Service) weight: 190 --- -## Amazon ECS (EC2 Container Service) ---- - [Amazon ECS](https://aws.amazon.com/ecs/) is supported, which allows RancherOS EC2 instances to join your cluster. ### Pre-Requisites diff --git a/content/os/v1.x/en/installation/boot-process/built-in-system-services/_index.md b/content/os/v1.x/en/installation/boot-process/built-in-system-services/_index.md index d9ae91cf360..32e0f7ce61f 100644 --- a/content/os/v1.x/en/installation/boot-process/built-in-system-services/_index.md +++ b/content/os/v1.x/en/installation/boot-process/built-in-system-services/_index.md @@ -3,8 +3,6 @@ title: Built-in System Services weight: 150 --- -## 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]({{< baseurl >}}/os/v1.x/en/installation/system-services/adding-system-services/) or override services in the cloud-config. ### preload-user-images diff --git a/content/os/v1.x/en/installation/boot-process/cloud-init/_index.md b/content/os/v1.x/en/installation/boot-process/cloud-init/_index.md index 1ade81a7cbe..85ab3695cea 100644 --- a/content/os/v1.x/en/installation/boot-process/cloud-init/_index.md +++ b/content/os/v1.x/en/installation/boot-process/cloud-init/_index.md @@ -3,8 +3,6 @@ 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 diff --git a/content/os/v1.x/en/installation/boot-process/image-preloading/_index.md b/content/os/v1.x/en/installation/boot-process/image-preloading/_index.md index 52196ea0605..279e38beaeb 100644 --- a/content/os/v1.x/en/installation/boot-process/image-preloading/_index.md +++ b/content/os/v1.x/en/installation/boot-process/image-preloading/_index.md @@ -3,9 +3,6 @@ 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.: diff --git a/content/os/v1.x/en/installation/boot-process/logging/_index.md b/content/os/v1.x/en/installation/boot-process/logging/_index.md index 8ea2ce6214a..9a4e8966b92 100644 --- a/content/os/v1.x/en/installation/boot-process/logging/_index.md +++ b/content/os/v1.x/en/installation/boot-process/logging/_index.md @@ -3,8 +3,6 @@ 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 `. diff --git a/content/os/v1.x/en/installation/configuration/_index.md b/content/os/v1.x/en/installation/configuration/_index.md index d34aa38924c..628115f1816 100644 --- a/content/os/v1.x/en/installation/configuration/_index.md +++ b/content/os/v1.x/en/installation/configuration/_index.md @@ -3,8 +3,6 @@ title: Configuration weight: 120 --- -## Configuring RancherOS ---- There are two ways that RancherOS can be configured. 1. A cloud-config file can be used to provide configuration when first booting RancherOS. diff --git a/content/os/v1.x/en/installation/configuration/adding-kernel-parameters/_index.md b/content/os/v1.x/en/installation/configuration/adding-kernel-parameters/_index.md index 2bfb6af2146..64061536246 100644 --- a/content/os/v1.x/en/installation/configuration/adding-kernel-parameters/_index.md +++ b/content/os/v1.x/en/installation/configuration/adding-kernel-parameters/_index.md @@ -1,10 +1,8 @@ --- -title: Adding Kernel Parameters +title: Kernel boot parameters weight: 133 --- -## Kernel boot parameters - RancherOS parses the Linux kernel boot cmdline to add any keys it understands to its configuration. This allows you to modify what cloud-init sources it will use on boot, to enable `rancher.debug` logging, or to almost any other configuration setting. There are two ways to set or modify persistent kernel parameters, in-place (editing the file and reboot) or during installation to disk. diff --git a/content/os/v1.x/en/installation/configuration/docker/_index.md b/content/os/v1.x/en/installation/configuration/docker/_index.md index f84905d920f..050560b15f6 100644 --- a/content/os/v1.x/en/installation/configuration/docker/_index.md +++ b/content/os/v1.x/en/installation/configuration/docker/_index.md @@ -3,9 +3,6 @@ title: Configuring Docker or System Docker weight: 126 --- -## Configuring Docker or System Docker ---- - In RancherOS, you can configure System Docker and Docker daemons by using [cloud-config]({{< baseurl >}}/os/v1.x/en/installation/configuration/#cloud-config). ### Configuring Docker diff --git a/content/os/v1.x/en/installation/configuration/hostname/_index.md b/content/os/v1.x/en/installation/configuration/hostname/_index.md index dfeb629ced0..0b05fa53e45 100644 --- a/content/os/v1.x/en/installation/configuration/hostname/_index.md +++ b/content/os/v1.x/en/installation/configuration/hostname/_index.md @@ -3,9 +3,6 @@ title: Setting the Hostname weight: 124 --- -## Setting the Hostname ---- - You can set the hostname of the host using [cloud-config]({{< baseurl >}}/os/v1.x/en/installation/configuration/#cloud-config). The example below shows how to configure it. ```yaml diff --git a/content/os/v1.x/en/installation/configuration/kernel-modules-kernel-headers/_index.md b/content/os/v1.x/en/installation/configuration/kernel-modules-kernel-headers/_index.md index 9bdb547cc99..630594495ce 100644 --- a/content/os/v1.x/en/installation/configuration/kernel-modules-kernel-headers/_index.md +++ b/content/os/v1.x/en/installation/configuration/kernel-modules-kernel-headers/_index.md @@ -1,11 +1,8 @@ --- -title: Installing Kernel Modules with Kernel Headers +title: Installing Kernel Modules that require Kernel Headers weight: 135 --- -## Installing Kernel Modules that require Kernel Headers ---- - To compile any kernel modules, you will need to download the kernel headers. The kernel headers are available in the form of a system service. Since the kernel headers are a system service, they need to be enabled using the `ros service` command. ### Installing Kernel Headers diff --git a/content/os/v1.x/en/installation/configuration/loading-kernel-modules/_index.md b/content/os/v1.x/en/installation/configuration/loading-kernel-modules/_index.md index 03934c82a90..17e5a464fba 100644 --- a/content/os/v1.x/en/installation/configuration/loading-kernel-modules/_index.md +++ b/content/os/v1.x/en/installation/configuration/loading-kernel-modules/_index.md @@ -3,8 +3,6 @@ title: Loading Extra Kernel Modules weight: 134 --- -## Loading Extra Kernel Modules - Since RancherOS v0.8, we build our own kernels using an unmodified kernel.org LTS kernel. We also build almost all optional extras as modules - so most in-tree modules are available in the `kernel-extras` service. diff --git a/content/os/v1.x/en/installation/configuration/private-registries/_index.md b/content/os/v1.x/en/installation/configuration/private-registries/_index.md index fa89b9beb60..65ebd182839 100644 --- a/content/os/v1.x/en/installation/configuration/private-registries/_index.md +++ b/content/os/v1.x/en/installation/configuration/private-registries/_index.md @@ -3,9 +3,6 @@ title: Private Registries weight: 128 --- -## Private Registries ---- - When launching services through a [cloud-config]({{< baseurl >}}/os/v1.x/en/installation/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: diff --git a/content/os/v1.x/en/installation/configuration/resizing-device-partition/_index.md b/content/os/v1.x/en/installation/configuration/resizing-device-partition/_index.md index f88c2d71a21..c7aa605f430 100644 --- a/content/os/v1.x/en/installation/configuration/resizing-device-partition/_index.md +++ b/content/os/v1.x/en/installation/configuration/resizing-device-partition/_index.md @@ -3,9 +3,6 @@ title: Resizing a Device Partition weight: 131 --- -## Resizing a Device Partition ---- - The `resize_device` cloud config option can be used to automatically extend the first partition (assuming its `ext4`) to fill the size of it's device. Once the partition has been resized to fill the device, a `/var/lib/rancher/resizefs.done` file will be written to prevent the resize tools from being run again. If you need it to run again, delete that file and reboot. diff --git a/content/os/v1.x/en/installation/configuration/running-commands/_index.md b/content/os/v1.x/en/installation/configuration/running-commands/_index.md index d6606e9a4ef..5c90d2ecc3e 100644 --- a/content/os/v1.x/en/installation/configuration/running-commands/_index.md +++ b/content/os/v1.x/en/installation/configuration/running-commands/_index.md @@ -3,9 +3,6 @@ title: Running Commands weight: 123 --- -## Running Commands ---- - You can automate running commands on boot using the `runcmd` cloud-config directive. Commands can be specified as either a list or a string. In the latter case, the command is executed with `sh`. ```yaml diff --git a/content/os/v1.x/en/installation/configuration/setting-up-docker-tls/_index.md b/content/os/v1.x/en/installation/configuration/setting-up-docker-tls/_index.md index cbde124cb0e..cf98801bbc8 100644 --- a/content/os/v1.x/en/installation/configuration/setting-up-docker-tls/_index.md +++ b/content/os/v1.x/en/installation/configuration/setting-up-docker-tls/_index.md @@ -3,8 +3,6 @@ title: Setting up Docker TLS weight: 127 --- -## Setting up Docker TLS - `ros tls generate` is used to generate both the client and server TLS certificates for Docker. Remember, all `ros` commands need to be used with `sudo` or as a `root` user. diff --git a/content/os/v1.x/en/installation/configuration/ssh-keys/_index.md b/content/os/v1.x/en/installation/configuration/ssh-keys/_index.md index 5965325d144..e4a3b81e84c 100644 --- a/content/os/v1.x/en/installation/configuration/ssh-keys/_index.md +++ b/content/os/v1.x/en/installation/configuration/ssh-keys/_index.md @@ -3,9 +3,6 @@ title: SSH Keys weight: 121 --- -## SSH Keys ---- - RancherOS supports adding SSH keys through the [cloud-config]({{< baseurl >}}/os/v1.x/en/installation/configuration/#cloud-config) file. Within the cloud-config file, you simply add the ssh keys within the `ssh_authorized_keys` key. ```yaml diff --git a/content/os/v1.x/en/installation/configuration/switching-consoles/_index.md b/content/os/v1.x/en/installation/configuration/switching-consoles/_index.md index 17c761e5b6d..e351cac5b65 100644 --- a/content/os/v1.x/en/installation/configuration/switching-consoles/_index.md +++ b/content/os/v1.x/en/installation/configuration/switching-consoles/_index.md @@ -3,9 +3,6 @@ title: Switching Consoles weight: 125 --- -## Switching Consoles ---- - When [booting from the ISO]({{< baseurl >}}/os/v1.x/en/installation/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]({{< baseurl >}}/os/v1.x/en/installation/configuration/#cloud-config). diff --git a/content/os/v1.x/en/installation/configuration/switching-docker-versions/_index.md b/content/os/v1.x/en/installation/configuration/switching-docker-versions/_index.md index 1ce768dce83..65fe0ad175a 100644 --- a/content/os/v1.x/en/installation/configuration/switching-docker-versions/_index.md +++ b/content/os/v1.x/en/installation/configuration/switching-docker-versions/_index.md @@ -3,8 +3,6 @@ title: Switching Docker Versions weight: 129 --- -## Changing Docker Versions - The version of User Docker used in RancherOS can be configured using a [cloud-config]({{< baseurl >}}/os/v1.x/en/installation/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). diff --git a/content/os/v1.x/en/installation/configuration/sysctl/_index.md b/content/os/v1.x/en/installation/configuration/sysctl/_index.md index d0b6ac87e42..488028a059d 100644 --- a/content/os/v1.x/en/installation/configuration/sysctl/_index.md +++ b/content/os/v1.x/en/installation/configuration/sysctl/_index.md @@ -3,9 +3,6 @@ title: sysctl Settings weight: 132 --- -## sysctl Settings ---- - The `rancher.sysctl` cloud-config key can be used to control sysctl parameters. This works in a manner similar to `/etc/sysctl.conf` for other Linux distros. ``` diff --git a/content/os/v1.x/en/installation/configuration/users/_index.md b/content/os/v1.x/en/installation/configuration/users/_index.md index 92b6c9cbb79..529281eef07 100644 --- a/content/os/v1.x/en/installation/configuration/users/_index.md +++ b/content/os/v1.x/en/installation/configuration/users/_index.md @@ -3,9 +3,6 @@ title: Users weight: 130 --- -## Configuring RancherOS Users ---- - 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]({{< baseurl >}}/os/v1.x/en/installation/custom-builds/custom-console/#console-persistence). diff --git a/content/os/v1.x/en/installation/configuration/write-files/_index.md b/content/os/v1.x/en/installation/configuration/write-files/_index.md index 949b454369f..bc86e0a21ab 100644 --- a/content/os/v1.x/en/installation/configuration/write-files/_index.md +++ b/content/os/v1.x/en/installation/configuration/write-files/_index.md @@ -3,9 +3,6 @@ title: Writing Files weight: 122 --- -## Writing Files ---- - You can automate writing files to disk using the `write_files` cloud-config directive. ```yaml diff --git a/content/os/v1.x/en/installation/custom-builds/custom-console/_index.md b/content/os/v1.x/en/installation/custom-builds/custom-console/_index.md index e904b35118c..c24ca816aeb 100644 --- a/content/os/v1.x/en/installation/custom-builds/custom-console/_index.md +++ b/content/os/v1.x/en/installation/custom-builds/custom-console/_index.md @@ -3,9 +3,6 @@ title: Custom Console weight: 180 --- -## Custom Console ---- - When [booting from the ISO]({{< baseurl >}}/os/v1.x/en/installation/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]({{< baseurl >}}/os/v1.x/en/installation/configuration/#cloud-config). diff --git a/content/os/v1.x/en/installation/custom-builds/custom-kernels/_index.md b/content/os/v1.x/en/installation/custom-builds/custom-kernels/_index.md index b1e03f5a427..cf6a71c13fd 100644 --- a/content/os/v1.x/en/installation/custom-builds/custom-kernels/_index.md +++ b/content/os/v1.x/en/installation/custom-builds/custom-kernels/_index.md @@ -3,8 +3,6 @@ title: Custom Kernels weight: 181 --- -## Custom Kernels - ### Building and Packaging a Kernel to be used in RancherOS We build the kernel for RancherOS at the [os-kernel repository](https://github.com/rancher/os-kernel). You can use this repository to help package your own custom kernel to be used in RancherOS. diff --git a/content/os/v1.x/en/installation/custom-builds/custom-rancheros-iso/_index.md b/content/os/v1.x/en/installation/custom-builds/custom-rancheros-iso/_index.md index 02f8f027c1d..f5fb5c07359 100644 --- a/content/os/v1.x/en/installation/custom-builds/custom-rancheros-iso/_index.md +++ b/content/os/v1.x/en/installation/custom-builds/custom-rancheros-iso/_index.md @@ -3,8 +3,6 @@ title: Custom RancherOS ISO weight: 182 --- -## Custom RancherOS ISO - It's easy to build your own RancherOS ISO. 1. Create a clone of the main [RancherOS repository](https://github.com/rancher/os) to your local machine with a `git clone`. diff --git a/content/os/v1.x/en/installation/networking/dns/_index.md b/content/os/v1.x/en/installation/networking/dns/_index.md index 69be9e3ae03..efbf740fa29 100644 --- a/content/os/v1.x/en/installation/networking/dns/_index.md +++ b/content/os/v1.x/en/installation/networking/dns/_index.md @@ -3,9 +3,6 @@ title: Configuring DNS weight: 171 --- -## DNS ---- - If you wanted to configure the DNS through the cloud config file, you'll need to place DNS configurations within the `rancher` key. ```yaml diff --git a/content/os/v1.x/en/installation/networking/interfaces/_index.md b/content/os/v1.x/en/installation/networking/interfaces/_index.md index 1d677c24685..d6963e7510f 100644 --- a/content/os/v1.x/en/installation/networking/interfaces/_index.md +++ b/content/os/v1.x/en/installation/networking/interfaces/_index.md @@ -3,9 +3,6 @@ title: Configuring Network Interfaces weight: 170 --- -## Interfaces ---- - Using `ros config`, you can configure specific interfaces. Wildcard globbing is supported so `eth*` will match `eth1` and `eth2`. The available options you can configure are `address`, `gateway`, `mtu`, and `dhcp`. ``` diff --git a/content/os/v1.x/en/installation/networking/proxy-settings/_index.md b/content/os/v1.x/en/installation/networking/proxy-settings/_index.md index 36363515913..fccd1c14d01 100644 --- a/content/os/v1.x/en/installation/networking/proxy-settings/_index.md +++ b/content/os/v1.x/en/installation/networking/proxy-settings/_index.md @@ -3,9 +3,6 @@ title: Configuring Proxy Settings weight: 172 --- -## Proxy settings ---- - HTTP proxy settings can be set directly under the `network` key. This will automatically configure proxy settings for both Docker and System Docker. ```yaml diff --git a/content/os/v1.x/en/installation/running-rancheros/_index.md b/content/os/v1.x/en/installation/running-rancheros/_index.md index 8d9278d347f..4c8b2845a1f 100644 --- a/content/os/v1.x/en/installation/running-rancheros/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/_index.md @@ -3,9 +3,6 @@ title: Running RancherOS weight: 100 --- -## 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]({{< baseurl >}}/os/v1.x/en/quick-start-guide/). ### Platforms diff --git a/content/os/v1.x/en/installation/running-rancheros/cloud/aws/_index.md b/content/os/v1.x/en/installation/running-rancheros/cloud/aws/_index.md index b032fe61d11..69e691183ac 100644 --- a/content/os/v1.x/en/installation/running-rancheros/cloud/aws/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/cloud/aws/_index.md @@ -3,9 +3,6 @@ title: Amazon EC2 weight: 105 --- -## Running RancherOS on AWS ----- - RancherOS is available as an Amazon Web Services AMI, and can be easily run on EC2. You can launch RancherOS either using the AWS Command Line Interface (CLI) or using the AWS console. ### Launching RancherOS through the AWS CLI diff --git a/content/os/v1.x/en/installation/running-rancheros/cloud/azure/_index.md b/content/os/v1.x/en/installation/running-rancheros/cloud/azure/_index.md index f8e02eceb35..13578649862 100644 --- a/content/os/v1.x/en/installation/running-rancheros/cloud/azure/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/cloud/azure/_index.md @@ -3,9 +3,6 @@ title: Azure weight: 110 --- -## Running RancherOS on Azure ---- - RancherOS is available as an image with Azure Resource Management. Please note that RancherOS is only offered in Azure Resource Management and not available in the Azure Service Management. > **Note:** Currently, we only have v0.3.1 available as an image in Azure and it does not support passing in cloud config files. We are working on adding a new version that has cloud config enabled. Also, only certain regions are supported with RancherOS on Azure. diff --git a/content/os/v1.x/en/installation/running-rancheros/cloud/do/_index.md b/content/os/v1.x/en/installation/running-rancheros/cloud/do/_index.md index 8157d41df50..dc18cd01c11 100644 --- a/content/os/v1.x/en/installation/running-rancheros/cloud/do/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/cloud/do/_index.md @@ -3,9 +3,6 @@ title: Digital Ocean weight: 107 --- -## Running RancherOS in DigitalOcean ---- - Running RancherOS on DigitalOcean is not yet supported, but there is a `rancheros` image now available from the commandline tools, so you can run: ``` diff --git a/content/os/v1.x/en/installation/running-rancheros/cloud/gce/_index.md b/content/os/v1.x/en/installation/running-rancheros/cloud/gce/_index.md index d4bfe22c906..6545a2a3477 100644 --- a/content/os/v1.x/en/installation/running-rancheros/cloud/gce/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/cloud/gce/_index.md @@ -3,9 +3,6 @@ title: Google Compute Engine (GCE) weight: 106 --- -## Running RancherOS on Google Compute Engine (GCE) ----- - > **Note:** Due to the maximum transmission unit (MTU) of [1460 bytes on GCE](https://cloud.google.com/compute/docs/troubleshooting#packetfragmentation), you will need to configure your [network interfaces]({{< baseurl >}}/os/v1.x/en/installation/networking/interfaces/) and both the [Docker and System Docker]({{< baseurl >}}/os/v1.x/en/installation/configuration/docker/) to use a MTU of 1460 bytes or you will encounter weird networking related errors. ### Adding the RancherOS Image into GCE diff --git a/content/os/v1.x/en/installation/running-rancheros/cloud/openstack/_index.md b/content/os/v1.x/en/installation/running-rancheros/cloud/openstack/_index.md index 8b182c8d4c2..300dcc34b20 100644 --- a/content/os/v1.x/en/installation/running-rancheros/cloud/openstack/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/cloud/openstack/_index.md @@ -1,10 +1,6 @@ --- title: OpenStack weight: 109 - ---- - -## 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. diff --git a/content/os/v1.x/en/installation/running-rancheros/cloud/vmware-esxi/_index.md b/content/os/v1.x/en/installation/running-rancheros/cloud/vmware-esxi/_index.md index 3801f08148b..8daae41533b 100644 --- a/content/os/v1.x/en/installation/running-rancheros/cloud/vmware-esxi/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/cloud/vmware-esxi/_index.md @@ -3,9 +3,6 @@ title: VMware ESXi weight: 108 --- -## VMware ESXi ---- - As of v1.1.0, RancherOS automatically detects that it is running on VMware ESXi, and automatically adds the `open-vm-tools` service to be downloaded and started, and uses `guestinfo` keys to set the cloud-init data. ### VMware guestinfo diff --git a/content/os/v1.x/en/installation/running-rancheros/server/install-to-disk/_index.md b/content/os/v1.x/en/installation/running-rancheros/server/install-to-disk/_index.md index 8cc49c74381..86c83c842d5 100644 --- a/content/os/v1.x/en/installation/running-rancheros/server/install-to-disk/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/server/install-to-disk/_index.md @@ -3,8 +3,6 @@ title: Installing to Disk weight: 111 --- -## 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]({{< baseurl >}}/os/v1.x/en/installation/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 diff --git a/content/os/v1.x/en/installation/running-rancheros/server/pxe/_index.md b/content/os/v1.x/en/installation/running-rancheros/server/pxe/_index.md index 1df7dd7295f..0cb9e6513ea 100644 --- a/content/os/v1.x/en/installation/running-rancheros/server/pxe/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/server/pxe/_index.md @@ -3,9 +3,6 @@ title: iPXE weight: 112 --- -## Booting RancherOS via iPXE ----- - ``` #!ipxe # Boot a persistent RancherOS to RAM diff --git a/content/os/v1.x/en/installation/running-rancheros/server/raspberry-pi/_index.md b/content/os/v1.x/en/installation/running-rancheros/server/raspberry-pi/_index.md index cc85da84240..4b638b09317 100644 --- a/content/os/v1.x/en/installation/running-rancheros/server/raspberry-pi/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/server/raspberry-pi/_index.md @@ -3,9 +3,6 @@ title: Raspberry Pi weight: 113 --- -## 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]({{< baseurl >}}/os/v1.x/en/installation/configuration/#cloud-config). You will need to boot up, change the configuration and then reboot to apply those changes. diff --git a/content/os/v1.x/en/installation/running-rancheros/workstation/boot-from-iso/_index.md b/content/os/v1.x/en/installation/running-rancheros/workstation/boot-from-iso/_index.md index 73479d23feb..9e119390fbc 100644 --- a/content/os/v1.x/en/installation/running-rancheros/workstation/boot-from-iso/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/workstation/boot-from-iso/_index.md @@ -3,8 +3,6 @@ title: Booting from ISO weight: 102 --- -## Boot from ISO ---- The RancherOS ISO file can be used to create a fresh RancherOS install on KVM, VMware, VirtualBox, or bare metal servers. You can download the `rancheros.iso` file from our [releases page](https://github.com/rancher/os/releases/). 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. diff --git a/content/os/v1.x/en/installation/running-rancheros/workstation/docker-machine/_index.md b/content/os/v1.x/en/installation/running-rancheros/workstation/docker-machine/_index.md index dbcf85776a0..118a323ea02 100644 --- a/content/os/v1.x/en/installation/running-rancheros/workstation/docker-machine/_index.md +++ b/content/os/v1.x/en/installation/running-rancheros/workstation/docker-machine/_index.md @@ -3,9 +3,6 @@ title: Using Docker Machine weight: 101 --- -## Docker Machine ---- - Before we get started, you'll need to make sure that you have docker machine installed. Download it directly from the docker machine [releases](https://github.com/docker/machine/releases). > **Note:** If you create a RancherOS instance using Docker Machine, you will not be able to upgrade your version of RancherOS. diff --git a/content/os/v1.x/en/installation/storage/additional-mounts/_index.md b/content/os/v1.x/en/installation/storage/additional-mounts/_index.md index b09c8320a0b..a5bade4f73f 100644 --- a/content/os/v1.x/en/installation/storage/additional-mounts/_index.md +++ b/content/os/v1.x/en/installation/storage/additional-mounts/_index.md @@ -3,9 +3,6 @@ title: Additional Mounts weight: 161 --- -## Additional Mounts ---- - Additional mounts can be specified as part of your [cloud-config]({{< baseurl >}}/os/v1.x/en/installation/configuration/#cloud-config). These mounts are applied within the console container. Here's a simple example that mounts `/dev/vdb` to `/mnt/s`. ```yaml diff --git a/content/os/v1.x/en/installation/storage/state-partition/_index.md b/content/os/v1.x/en/installation/storage/state-partition/_index.md index ffa1d3ffb9c..1250f8255a1 100644 --- a/content/os/v1.x/en/installation/storage/state-partition/_index.md +++ b/content/os/v1.x/en/installation/storage/state-partition/_index.md @@ -3,9 +3,6 @@ title: Persistent State Partition weight: 160 --- -## Persistent State Partition ---- - RancherOS will store its state in a single partition specified by the `dev` field. The field can be a device such as `/dev/sda1` or a logical name such `LABEL=state` or `UUID=123124`. The default value is `LABEL=RANCHER_STATE`. The file system type of that partition can be set to `auto` or a specific file system type such as `ext4`. ```yaml diff --git a/content/os/v1.x/en/installation/storage/using-zfs/_index.md b/content/os/v1.x/en/installation/storage/using-zfs/_index.md index 56090b7cc0c..e835dff1ad8 100644 --- a/content/os/v1.x/en/installation/storage/using-zfs/_index.md +++ b/content/os/v1.x/en/installation/storage/using-zfs/_index.md @@ -3,9 +3,6 @@ title: Using ZFS weight: 162 --- -## Using ZFS ---- - #### Installing the ZFS service The `zfs` service will install the kernel-headers for your kernel (if you build your own kernel, you'll need to replicate this service), and then download the [ZFS on Linux]() source, and build and install it. Then it will build a `zfs-tools` image that will be used to give you access to the zfs tools. diff --git a/content/os/v1.x/en/installation/system-services/adding-system-services/_index.md b/content/os/v1.x/en/installation/system-services/adding-system-services/_index.md index d4a2dc751c7..bbfc6c4470e 100644 --- a/content/os/v1.x/en/installation/system-services/adding-system-services/_index.md +++ b/content/os/v1.x/en/installation/system-services/adding-system-services/_index.md @@ -3,9 +3,6 @@ title: System Services weight: 140 --- -## System Services ---- - A system service is a container that can be run in either System Docker or Docker. Rancher provides services that are already available in RancherOS by adding them to the [os-services repo](https://github.com/rancher/os-services). Anything in the `index.yml` file from the repository for the tagged release will be an available system service when using the `ros service list` command. ### Enabling and Starting System Services diff --git a/content/os/v1.x/en/installation/system-services/custom-system-services/_index.md b/content/os/v1.x/en/installation/system-services/custom-system-services/_index.md index a931e740037..da9145dae25 100644 --- a/content/os/v1.x/en/installation/system-services/custom-system-services/_index.md +++ b/content/os/v1.x/en/installation/system-services/custom-system-services/_index.md @@ -3,8 +3,6 @@ title: Custom System Services weight: 141 --- -## 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]({{< baseurl >}}/os/v1.x/en/installation/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 diff --git a/content/os/v1.x/en/installation/system-services/environment/_index.md b/content/os/v1.x/en/installation/system-services/environment/_index.md index 7d8a40d0edf..a0d9746613c 100644 --- a/content/os/v1.x/en/installation/system-services/environment/_index.md +++ b/content/os/v1.x/en/installation/system-services/environment/_index.md @@ -3,9 +3,6 @@ title: Environment weight: 143 --- -## Environment ---- - The [environment key](https://docs.docker.com/compose/yml/#environment) can be used to customize system services. When a value is not assigned, RancherOS looks up the value from the `rancher.environment` key. In the example below, `ETCD_DISCOVERY` will be set to `https://discovery.etcd.io/d1cd18f5ee1c1e2223aed6a1734719f7` for the `etcd` service. diff --git a/content/os/v1.x/en/installation/system-services/system-docker-volumes/_index.md b/content/os/v1.x/en/installation/system-services/system-docker-volumes/_index.md index a4bf35c47d7..8430640c436 100644 --- a/content/os/v1.x/en/installation/system-services/system-docker-volumes/_index.md +++ b/content/os/v1.x/en/installation/system-services/system-docker-volumes/_index.md @@ -3,9 +3,6 @@ title: System Docker Volumes weight: 142 --- -## System Docker Volumes ---- - A few services are containers in `created` state. Their purpose is to provide volumes for other services. ### user-volumes diff --git a/content/os/v1.x/en/overview/_index.md b/content/os/v1.x/en/overview/_index.md index 2d5d48ae41b..3bf8cb70426 100644 --- a/content/os/v1.x/en/overview/_index.md +++ b/content/os/v1.x/en/overview/_index.md @@ -1,12 +1,10 @@ --- -title: Overview +title: Overview of RancherOS shortTitle: RancherOS description: RancherOS is a simplified Linux distribution built from containers, for containers. These documents describe how to install and use RancherOS. weight: 1 --- -## Overview of RancherOS ---- RancherOS is the smallest, easiest way to run Docker in production. Everything in RancherOS is a container managed by Docker. This includes system services such as `udev` and `syslog`. Because it only includes the services necessary to run Docker, RancherOS is dramatically smaller than most traditional operating systems. By removing unnecessary libraries and services, requirements for security patches and other maintenance are dramatically reduced. This is possible because, with Docker, users typically package all necessary libraries into their containers. Another way in which RancherOS is designed specifically for running Docker is that it always runs the latest version of Docker. This allows users to take advantage of the latest Docker capabilities and bug fixes. diff --git a/content/os/v1.x/en/quick-start-guide/_index.md b/content/os/v1.x/en/quick-start-guide/_index.md index 9a7f3903273..53dd5000972 100644 --- a/content/os/v1.x/en/quick-start-guide/_index.md +++ b/content/os/v1.x/en/quick-start-guide/_index.md @@ -3,10 +3,6 @@ title: Quick Start Guide weight: 1 --- - -## Quick Start Guide ---- - If you have a specific RanchersOS machine requirements, please check out our [guides on running RancherOS]({{< baseurl >}}/os/v1.x/en/installation/running-rancheros/). With the rest of this guide, we'll start up a RancherOS using [Docker machine]({{< baseurl >}}/os/v1.x/en/installation/running-rancheros/workstation/docker-machine/) and show you some of what RancherOS can do. ### Launching RancherOS using Docker Machine diff --git a/content/os/v1.x/en/upgrading/_index.md b/content/os/v1.x/en/upgrading/_index.md index e686f87bd53..05658c050f8 100644 --- a/content/os/v1.x/en/upgrading/_index.md +++ b/content/os/v1.x/en/upgrading/_index.md @@ -3,9 +3,6 @@ title: Upgrading weight: 3 --- -## Upgrading ---- - If RancherOS has released a new version and you want to learn how to upgrade your OS, we make it easy using the `ros os` command. Since RancherOS is a kernel and initrd, the upgrade process is downloading a new kernel and initrd, and updating the boot loader to point to it. The old kernel and initrd are not removed. If there is a problem with your upgrade, you can select the old kernel from the Syslinux bootloader.