diff --git a/docs/os/boot-process/image-preloading/index.md b/docs/os/boot-process/image-preloading/index.md index fc2ab41e..631dd860 100644 --- a/docs/os/boot-process/image-preloading/index.md +++ b/docs/os/boot-process/image-preloading/index.md @@ -20,5 +20,5 @@ $ docker save my-image1 my-image2 some-other/image3 | xz > my-images.tar.xz The resulting files should be placed into `/var/lib/rancher/preload/docker` or `/var/lib/rancher/preload/system-docker` (depending on whether you want it preloaded into Docker or System Docker). Pre-loading process only reads each new archive once, so it won't take time on subsequent boots (`.done` files are created to mark the read archives). If you update the archive (place a newer archive with the same name) it'll get read on the next boot as well. - + Pre-packing docker images is handy when you're customizing your RancherOS distribution (perhaps, building cloud VM images for your infrastructure). diff --git a/docs/os/configuration/custom-console/index.md b/docs/os/configuration/custom-console/index.md index e79fb929..0102eec9 100644 --- a/docs/os/configuration/custom-console/index.md +++ b/docs/os/configuration/custom-console/index.md @@ -86,7 +86,7 @@ After logging back, you'll be in the Ubuntu console. ``` $ sudo system-docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -6bf33541b2dc rancher/os-ubuntuconsole:v0.5.0-rc3 "/usr/sbin/entry.sh /" About a minute ago Up About a minute +6bf33541b2dc rancher/os-ubuntuconsole:v0.5.0-rc3 "/usr/sbin/entry.sh /" About a minute ago Up About a minute ```
diff --git a/docs/os/configuration/index.md b/docs/os/configuration/index.md index 488102ad..61c7980b 100644 --- a/docs/os/configuration/index.md +++ b/docs/os/configuration/index.md @@ -25,7 +25,7 @@ When you create a RancherOS instance on AWS, for example, you can optionally pro A cloud-config file uses the YAML format. YAML is easy to understand and easy to parse. For more information on YAML, please read more at the [YAML site](http://www.yaml.org/start.html). The most important formatting principle is indentation or whitespace. This indentation indicates relationships of the items to one another. If something is indented more than the previous line, it is a sub-item of the top item that is less indented. -Example: Notice how both are indented underneath `ssh-authorized-keys`. +Example: Notice how both are indented underneath `ssh_authorized_keys`. ```yaml #cloud-config @@ -50,7 +50,7 @@ $ sudo ros config get rancher.network.dns.nameservers - 8.8.4.4 ``` -#### Setting Values +#### Setting Values You can set values in the `/var/lib/rancher/conf/cloud-config.yml` file. diff --git a/docs/os/configuration/kernel-modules-kernel-headers/index.md b/docs/os/configuration/kernel-modules-kernel-headers/index.md index 27c11917..bd87c6d1 100644 --- a/docs/os/configuration/kernel-modules-kernel-headers/index.md +++ b/docs/os/configuration/kernel-modules-kernel-headers/index.md @@ -7,7 +7,6 @@ layout: os-default ## 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/docs/os/configuration/loading-kernel-modules/index.md b/docs/os/configuration/loading-kernel-modules/index.md index 7f29b3c1..84790c38 100644 --- a/docs/os/configuration/loading-kernel-modules/index.md +++ b/docs/os/configuration/loading-kernel-modules/index.md @@ -11,11 +11,11 @@ To compile any Kernel Modules, you first need to [deploy the Kernel Headers]({{s ### DKMS DKMS is supported by running the DKMS scripts inside a *privileged* container. - + > To deploy containers that compiles DKMS modules, you will need to ensure that you bind-mount `/usr/src` and `/lib/modules`. > 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]({{site.baseurl}}/os/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). @@ -88,7 +88,7 @@ This functionality is also available via a kernel parameter. For example, the bt ### Ubuntu-based Kernel Manipulation For images that are or derive from Ubuntu, you will need some small packages for `depmod`(`kmod`) and `modprobe`(`module-init-tools`): - + ```bash sudo apt-get install kmod module-init-tools ``` @@ -101,11 +101,11 @@ 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]({{site.baseurl}}/os/configuration/kernel-modules-kernel-headers/). +Simply put, the Kernel Headers (or Source) cannot be found; enable them via the [Kernel Headers System Service]({{site.baseurl}}/os/configuration/kernel-modules-kernel-headers/). #### Operation not Permitted -When inside a container, you might see similar to the following: +When inside a container, you might see similar to the following: ``` modprobe: ERROR: could not insert 'videodev': Operation not permitted ``` diff --git a/docs/os/configuration/prepacking-docker-images/index.md b/docs/os/configuration/prepacking-docker-images/index.md index 534da2ee..91285061 100644 --- a/docs/os/configuration/prepacking-docker-images/index.md +++ b/docs/os/configuration/prepacking-docker-images/index.md @@ -18,5 +18,5 @@ $ docker save my-image1 my-image2 some-other/image3 | xz > my-images.tar.xz The resulting files should be placed into `/var/lib/rancher/preload/docker` or `/var/lib/rancher/preload/system-docker` (depending on whether you want it preloaded into Docker or System Docker). Pre-loading process only reads each new archive once, so it won't take time on subsequent boots (`.done` files are created to mark the read archives). If you update the archive (place a newer archive with the same name) it'll get read on the next boot as well. - + Pre-packing docker images is handy when you're customizing your RancherOS distribution (perhaps, building cloud VM images for your infrastructure). diff --git a/docs/os/configuration/ssh-keys/index.md b/docs/os/configuration/ssh-keys/index.md index 1b35f5c0..a6b7b269 100644 --- a/docs/os/configuration/ssh-keys/index.md +++ b/docs/os/configuration/ssh-keys/index.md @@ -4,10 +4,10 @@ layout: os-default --- -## SSH Keys +## SSH Keys --- -RancherOS supports adding SSH keys through the [cloud-config]({{site.baseurl}}/os/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]({{site.baseurl}}/os/configuration/#cloud-config) file. Within the cloud-config file, you simply add the ssh keys within the `ssh_authorized_keys` key. ```yaml #cloud-config @@ -21,4 +21,3 @@ When we pass the cloud-config file during the `ros install` command, it will all ``` $ ssh -i /path/to/private/key rancher@ ``` - diff --git a/docs/os/configuration/switching-consoles/index.md b/docs/os/configuration/switching-consoles/index.md index 9d45f76f..e17773aa 100644 --- a/docs/os/configuration/switching-consoles/index.md +++ b/docs/os/configuration/switching-consoles/index.md @@ -88,7 +88,7 @@ After logging back, you'll be in the Ubuntu console. ``` $ sudo system-docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -6bf33541b2dc rancher/os-ubuntuconsole:v0.5.0-rc3 "/usr/sbin/entry.sh /" About a minute ago Up About a minute +6bf33541b2dc rancher/os-ubuntuconsole:v0.5.0-rc3 "/usr/sbin/entry.sh /" About a minute ago Up About a minute ```
diff --git a/docs/os/configuration/switching-docker-versions/index.md b/docs/os/configuration/switching-docker-versions/index.md index e1b932d3..0fdcde34 100644 --- a/docs/os/configuration/switching-docker-versions/index.md +++ b/docs/os/configuration/switching-docker-versions/index.md @@ -40,15 +40,15 @@ If you've already started RancherOS and want to switch Docker engines, you can c ``` $ sudo ros engine switch docker-1.11.2 -INFO[0000] Project [os]: Starting project -INFO[0000] [0/19] [docker]: Starting +INFO[0000] Project [os]: Starting project +INFO[0000] [0/19] [docker]: Starting Pulling docker (rancher/os-docker:1.11.2)... 1.11.2: Pulling from rancher/os-docker 2a6bbb293656: Pull complete Digest: sha256:ec57fb24f6d4856d737e14c81a20f303afbeef11fc896d31b4e498829f5d18b2 Status: Downloaded newer image for rancher/os-docker:1.11.2 -INFO[0007] Recreating docker -INFO[0007] [1/19] [docker]: Started +INFO[0007] Recreating docker +INFO[0007] [1/19] [docker]: Started INFO[0007] Project [os]: Project started $ docker version Client: diff --git a/docs/os/configuration/users/index.md b/docs/os/configuration/users/index.md index 34abaec9..03f66b4c 100644 --- a/docs/os/configuration/users/index.md +++ b/docs/os/configuration/users/index.md @@ -7,9 +7,9 @@ layout: os-default ## Configuring RancherOS Users --- -Currently, we don't support adding other users besides `rancher`. +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]({{site.baseurl}}/os/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]({{site.baseurl}}/os/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. diff --git a/docs/os/custom-builds/custom-kernels/index.md b/docs/os/custom-builds/custom-kernels/index.md index 7dc6f255..9aba40cf 100644 --- a/docs/os/custom-builds/custom-kernels/index.md +++ b/docs/os/custom-builds/custom-kernels/index.md @@ -13,12 +13,12 @@ We build the kernel for RancherOS at the [os-kernel repository](https://github.c 1. Create a clone of the [os-kernel](https://github.com/rancher/os-kernel) repository to your local machine using `git clone`. - + ``` $ git clone https://github.com/rancher/os-kernel.git ``` -2. In the `./Dockerfile.dapper` file, update the `KERNEL_TAG`, `KERNEL_VERSION`, `KERNEL_URL` and `KERNEL_SHA1`. `KERNEL_URL` points to Linux kernel sources archive, packaged as `.tar.gz` or `.tar.xz`. `KERNEL_SHA1` is the `SHA1` sum of the kernel sources archive. +2. In the `./Dockerfile.dapper` file, update the `KERNEL_TAG`, `KERNEL_VERSION`, `KERNEL_URL` and `KERNEL_SHA1`. `KERNEL_URL` points to Linux kernel sources archive, packaged as `.tar.gz` or `.tar.xz`. `KERNEL_SHA1` is the `SHA1` sum of the kernel sources archive. `./Dockerfile.dapper` file @@ -30,8 +30,8 @@ We build the kernel for RancherOS at the [os-kernel repository](https://github.c ENV KERNEL_URL=https://github.com/rancher/linux/archive/${KERNEL_TAG}.tar.gz ``` -3. After you've replaced the `KERNEL_*` values, run `make` in the root `os-kernel` directory. After the build is completed, a `./dist/kernel` directory will be created with the freshly built kernel tarball and headers. - +3. After you've replaced the `KERNEL_*` values, run `make` in the root `os-kernel` directory. After the build is completed, a `./dist/kernel` directory will be created with the freshly built kernel tarball and headers. + ``` $ make ...snip... @@ -40,7 +40,7 @@ We build the kernel for RancherOS at the [os-kernel repository](https://github.c ./dist/kernel/build-linux-4.8.7-rancher-x86.tar.gz ./dist/kernel/linux-4.8.7-rancher-x86.tar.gz ./dist/kernel/config - + Images ready to push: rancher/os-extras:4.8.7-rancher rancher/os-headers:4.8.7-rancher @@ -55,7 +55,7 @@ The `build-.tar.gz` and `extra-.tar.gz` files are used to build the 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]({{site.baseurl}}/os/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`. + 1. Create a clone of the main [RancherOS repository](https://github.com/rancher/os) to your local machine with a `git clone`. ``` $ git clone https://github.com/rancher/os.git @@ -102,5 +102,5 @@ By default, RancherOS ships with the kernel provided by the [os-kernel repositor firmware/ ... ``` - + 3. After you've replaced the URL with your custom kernel, you can follow the steps in [building your own custom RancherOS ISO]({{site.baseurl}}/os/configuration/custom-rancheros-iso/). diff --git a/docs/os/custom-builds/custom-rancheros-iso/index.md b/docs/os/custom-builds/custom-rancheros-iso/index.md index e790c120..5636cef3 100644 --- a/docs/os/custom-builds/custom-rancheros-iso/index.md +++ b/docs/os/custom-builds/custom-rancheros-iso/index.md @@ -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]({{site.baseurl}}/os/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{site.baseurl}}/os/running-rancheros/workstation/docker-machine). +The `rancheros.iso` is ready to be used to [boot RancherOS from ISO]({{site.baseurl}}/os/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{site.baseurl}}/os/running-rancheros/workstation/docker-machine). ### Creating a GCE Image Archive diff --git a/docs/os/index.md b/docs/os/index.md index 1061bd4d..196294b6 100644 --- a/docs/os/index.md +++ b/docs/os/index.md @@ -14,7 +14,6 @@ Like other minimalist Linux distributions, RancherOS boots incredibly quickly, g Docker is an open-source platform designed for developers, system admins, and DevOps, it is used to build, ship, and run containers, using simple yet powerful CLI (Command Line Interface), you can get started with Docker from [Docker user guide](https://docs.docker.com/userguide/). ### Hardware Requirements ---- * x86_64 server with at least 512MB of RAM. @@ -22,7 +21,6 @@ Docker is an open-source platform designed for developers, system admins, and De ### 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]({{site.baseurl}}/os/system-services/adding-system-services/). @@ -34,11 +32,11 @@ System Docker runs a special container called **Docker**, which is another Docke ![How it works]({{site.baseurl}}/img/os/rancheroshowitworks.png "How it works") ### Running RancherOS ---- + To find out more about installing RancherOS, jump to our [Quick Start Guide]({{site.baseurl}}/os/quick-start-guide/). ### Latest Release ---- + Please check our repository for the latest release in our [README](https://github.com/rancher/os/blob/master/README.md).
diff --git a/docs/os/networking/dns/index.md b/docs/os/networking/dns/index.md index e4351035..b903872e 100644 --- a/docs/os/networking/dns/index.md +++ b/docs/os/networking/dns/index.md @@ -6,6 +6,7 @@ redirect_from: --- ## DNS +--- If you wanted to configure the DNS through the cloud config file, you'll need to place DNS configurations within the `rancher` key. diff --git a/docs/os/networking/proxy-settings/index.md b/docs/os/networking/proxy-settings/index.md index d57fb7ab..6c7cef94 100644 --- a/docs/os/networking/proxy-settings/index.md +++ b/docs/os/networking/proxy-settings/index.md @@ -5,6 +5,7 @@ layout: os-default --- ## 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. diff --git a/docs/os/quick-start-guide/index.md b/docs/os/quick-start-guide/index.md index a72002db..528a2592 100644 --- a/docs/os/quick-start-guide/index.md +++ b/docs/os/quick-start-guide/index.md @@ -50,7 +50,6 @@ dc2cafca3c69 rancher/os-syslog:v0.5.0 "/usr/sbin/entry.sh /" 18 seco Some containers are run at boot time, and others, such as the `console`, `docker`, etc. containers are always running. ## Using RancherOS ---- ### Deploying a Docker Container @@ -116,7 +115,7 @@ ros version 0.0.1 RancherOS state is controlled by a cloud config file. `ros` is used to edit the configuration of the system, to see for example the dns configuration of the system: ``` -$ sudo ros config get rancher.dns +$ sudo ros config get rancher.network.dns.nameservers - 8.8.8.8 - 8.8.4.4 ``` @@ -131,4 +130,3 @@ $ sudo ros console switch ubuntu ### Conclusion RancherOS is a simple Linux distribution ideal for running Docker. By embracing containerization of system services and leveraging Docker for management, RancherOS hopes to provide a very reliable, and easy to manage OS for running containers. - diff --git a/docs/os/running-rancher-on-rancheros/index.md b/docs/os/running-rancher-on-rancheros/index.md index e5fa90c3..04808b99 100644 --- a/docs/os/running-rancher-on-rancheros/index.md +++ b/docs/os/running-rancher-on-rancheros/index.md @@ -11,9 +11,9 @@ 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]({{site.baseurl}}/os/configuration/#cloud-config) to launch the rancher/agent container. +You can easily add hosts into Rancher by using [cloud-config]({{site.baseurl}}/os/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. +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. ```bash $ sudo docker run --d --privileged -v /var/run/docker.sock:/var/run/docker.sock \ @@ -41,13 +41,13 @@ rancher: ```
-> **Note:** You can not name the service `rancher-agent` as this will not allow the rancher/agent container to be launched correctly. Please read more about why [you can't name your container as `rancher-agent`]({{site.baseurl}}/rancher/faqs/agents/#adding-in-name-rancher-agent). +> **Note:** You can not name the service `rancher-agent` as this will not allow the rancher/agent container to be launched correctly. Please read more about why [you can't name your container as `rancher-agent`]({{site.baseurl}}/rancher/faqs/agents/#adding-in-name-rancher-agent). ### Adding in Host Labels With each host, you have the ability to add labels to help you organize your hosts. The labels are added as an environment variable when launching the rancher/agent container. The host label in the UI will be a key/value pair and the keys must be unique identifiers. If you added two keys with different values, we'll take the last inputted value to use as the key/value pair. -By adding labels to hosts, you can use these labels when [schedule services/load balancers/services]({{site.baseurl}}/rancher/rancher-ui/scheduling/) and create a whitelist or blacklist of hosts for your [services]({{site.baseurl}}/rancher/rancher-ui/applications/stacks/adding-services/) to run on. +By adding labels to hosts, you can use these labels when [schedule services/load balancers/services]({{site.baseurl}}/rancher/rancher-ui/scheduling/) and create a whitelist or blacklist of hosts for your [services]({{site.baseurl}}/rancher/rancher-ui/applications/stacks/adding-services/) to run on. When adding a custom host, you can add the labels using the UI and it will automatically add the environment variable (`CATTLE_HOST_LABELS`) with the key/value pair into the command on the UI screen. diff --git a/docs/os/running-rancheros/cloud/aws/index.md b/docs/os/running-rancheros/cloud/aws/index.md index a7810806..24006da3 100644 --- a/docs/os/running-rancheros/cloud/aws/index.md +++ b/docs/os/running-rancheros/cloud/aws/index.md @@ -3,8 +3,10 @@ title: Getting Started on Amazon EC2 layout: os-default --- + ## 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 @@ -35,7 +37,7 @@ Let’s walk through how to import and create a RancherOS on EC2 machine using t ![RancherOS on AWS 2]({{site.baseurl}}/img/os/Rancher_aws2.png) 3. Go through the steps of creating the instance type through the AWS console. If you want to pass in a [cloud-config]({{site.baseurl}}/os/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. - + ![RancherOS on AWS 6]({{site.baseurl}}/img/os/Rancher_aws6.png) After going through all the steps, you finally click on **Launch**, and either create a new key pair or choose an existing key pair to be used with the EC2 instance. If you have created a new key pair, download the key pair. If you have chosen an existing key pair, make sure you have the key pair accessible. Click on **Launch Instances**. @@ -45,13 +47,12 @@ Let’s walk through how to import and create a RancherOS on EC2 machine using t 4. Your instance will be launching and you can click on **View Instances** to see it's status. ![RancherOS on AWS 4]({{site.baseurl}}/img/os/Rancher_aws4.png) - + Your instance is now running! - + ![RancherOS on AWS 5]({{site.baseurl}}/img/os/Rancher_aws5.png) ## Logging into RancherOS ----- From a command line, log into the EC2 Instance. If you added ssh keys using a cloud-config, both those keys, and the one you selected in the AWS UI will be installed. @@ -67,10 +68,5 @@ $ ssh -v -i /Directory/of/MySSHKeyName.pem rancher@ ``` ## Latest AMI Releases ----- Please check the [README](https://github.com/rancher/os/blob/master/README.md) in our RancherOS repository for our latest AMIs. - - - - diff --git a/docs/os/running-rancheros/cloud/azure/index.md b/docs/os/running-rancheros/cloud/azure/index.md index 4e08576e..2b851c68 100644 --- a/docs/os/running-rancheros/cloud/azure/index.md +++ b/docs/os/running-rancheros/cloud/azure/index.md @@ -7,9 +7,9 @@ layout: os-default ## 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. +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. +> **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. ### Launching Rancheros through the Azure Portal @@ -19,7 +19,7 @@ Follow the steps to create a virtual machine. In the _Basics_ step, provide a **name** for the VM, use _rancher_ as the **user name** and select the **SSH public key** option of authenticating. Add your ssh public key into the appropriate field. Select the **Resource group** that you want to add the VM to or create a new one. Select the **location** for your VM. -In the _Size_ step, select a virtual machine that has at least **1GB** of memory. +In the _Size_ step, select a virtual machine that has at least **1GB** of memory. In the _Settings_ step, you can use all the default settings to get RancherOS running. diff --git a/docs/os/running-rancheros/cloud/openstack/index.md b/docs/os/running-rancheros/cloud/openstack/index.md index 854ad008..8df605b2 100644 --- a/docs/os/running-rancheros/cloud/openstack/index.md +++ b/docs/os/running-rancheros/cloud/openstack/index.md @@ -3,9 +3,9 @@ title: Rancher RancherOS in Openstack layout: os-default --- -## Openstack +## 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. +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]({{site.baseurl}}/os/configuration/#cloud-config) file. diff --git a/docs/os/running-rancheros/index.md b/docs/os/running-rancheros/index.md index 89771c34..5c6e8472 100644 --- a/docs/os/running-rancheros/index.md +++ b/docs/os/running-rancheros/index.md @@ -9,20 +9,20 @@ layout: os-default 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]({{site.baseurl}}/os/quick-start-guide/). -### Platforms +### Platforms #### Workstation -[Docker Machine]({{site.baseurl}}/os/running-rancheros/workstation/docker-machine) +[Docker Machine]({{site.baseurl}}/os/running-rancheros/workstation/docker-machine) -[Boot from ISO]({{site.baseurl}}/os/running-rancheros/workstation/boot-from-iso) +[Boot from ISO]({{site.baseurl}}/os/running-rancheros/workstation/boot-from-iso) #### Cloud -[Amazon EC2]({{site.baseurl}}/os/running-rancheros/cloud/aws) +[Amazon EC2]({{site.baseurl}}/os/running-rancheros/cloud/aws) -[Google Compute Engine]({{site.baseurl}}/os/running-rancheros/cloud/gce) +[Google Compute Engine]({{site.baseurl}}/os/running-rancheros/cloud/gce) [DigitalOcean]({{site.baseurl}}/os/running-rancheros/cloud/do) diff --git a/docs/os/running-rancheros/server/pxe/index.md b/docs/os/running-rancheros/server/pxe/index.md index ae8753d6..d5670e9f 100644 --- a/docs/os/running-rancheros/server/pxe/index.md +++ b/docs/os/running-rancheros/server/pxe/index.md @@ -50,9 +50,9 @@ When this service is run, the `EXTRA_CMDLINE` will be set. Valid [datasources](https://github.com/rancher/os/blob/3338c4ac63597940bcde7e6005f1cc09287062a2/cmd/cloudinit/cloudinit.go#L378) for RancherOS. -| type | default | +| type | default | |---|---| -| ec2 | DefaultAddress | +| ec2 | DefaultAddress | | file | path | | url | url | | cmdline | | @@ -61,5 +61,5 @@ Valid [datasources](https://github.com/rancher/os/blob/3338c4ac63597940bcde7e600 | gce | | ### Cloud-Config - + When booting via iPXE, RancherOS can be configured using a [cloud-config file]({{site.baseurl}}/os/configuration/#cloud-config). diff --git a/docs/os/running-rancheros/server/raspberry-pi/index.md b/docs/os/running-rancheros/server/raspberry-pi/index.md index dbc10517..12935775 100644 --- a/docs/os/running-rancheros/server/raspberry-pi/index.md +++ b/docs/os/running-rancheros/server/raspberry-pi/index.md @@ -8,7 +8,7 @@ layout: os-default 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]({{site.baseurl}}/os/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]({{site.baseurl}}/os/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. diff --git a/docs/os/running-rancheros/workstation/boot-from-iso/index.md b/docs/os/running-rancheros/workstation/boot-from-iso/index.md index ce2f3276..d1726716 100644 --- a/docs/os/running-rancheros/workstation/boot-from-iso/index.md +++ b/docs/os/running-rancheros/workstation/boot-from-iso/index.md @@ -12,11 +12,11 @@ You must boot with at least **512MB** of memory. If you boot with the ISO, you w > **Note:** If you are planning on [installing to disk]({{site.baseurl}}/os/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]({{site.baseurl}}/os/running-rancheros/server/install-to-disk/) to install RancherOS to a hard disk. ### Persisting State ---- + If you are running from the ISO, RancherOS will be running from memory. All downloaded Docker images, for example, will be stored in a ramdisk and will be lost after the server is rebooted. You can create a file system with the label `RANCHER_STATE` to instruct RancherOS to use that partition to store state. Suppose you have a disk partition on the server called `/dev/sda`, the following command formats that partition and labels it `RANCHER_STATE` @@ -29,58 +29,3 @@ $ sudo reboot After you reboot, the server RancherOS will use `/dev/sda` as the state partition. > **Note:** If you are installing RancherOS to disk, you do not need to run this command. - - - diff --git a/docs/os/running-rancheros/workstation/docker-machine/index.md b/docs/os/running-rancheros/workstation/docker-machine/index.md index 0c3df330..d0bc4515 100644 --- a/docs/os/running-rancheros/workstation/docker-machine/index.md +++ b/docs/os/running-rancheros/workstation/docker-machine/index.md @@ -7,7 +7,7 @@ layout: os-default ## 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). +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. @@ -15,7 +15,7 @@ Before we get started, you'll need to make sure that you have docker machine ins Get the latest `rancheros.iso` artifact from the RancherOS [releases](https://github.com/rancher/os/releases). -### Using Docker Machine +### Using Docker Machine You can use Docker Machine to launch VMs for various providers. Currently only VirtualBox and AWS are supported. diff --git a/docs/os/security/index.md.bak b/docs/os/security/index.md.bak deleted file mode 100644 index c0784151..00000000 --- a/docs/os/security/index.md.bak +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: RancherOS security -layout: os-default - ---- - -## RancherOS security ---- - - - - - - - - -
-

Security policy

-

Rancher Labs supports responsible disclosure, and endeavours to resolve all issues in a reasonable time frame. RancherOS is a minimal Linux distribution, built with entirely using open source components.

-		 -

Reporting process

-

Please submit possible security issues by emailing security@rancher.com

-		 -

Announcments

-

Subscribe to the Rancher announcements forum for release updates.

-
- -### RancherOS Vulnerabilities - -| ID | Description | Date | Resolution | -|----|-------------|------|------------| -| [CVE-2017-6074](http://seclists.org/oss-sec/2017/q1/471) | Local privilege-escalation using a user after free issue in [Datagram Congestion Control Protocol (DCCP)](https://wiki.linuxfoundation.org/networking/dccp). DCCP is built into the RancherOS kernel as a dynamically loaded module, and isn't loaded by default. | 17 Feb 2017 | [RancherOS v0.8.1](https://github.com/rancher/os/releases/tag/v0.8.1) using a [patched 4.9.12 Linux kernel](https://github.com/rancher/os-kernel/releases/tag/v4.9.12-rancher) | - - diff --git a/docs/os/storage/additional-mounts/index.md b/docs/os/storage/additional-mounts/index.md index 369a25e2..c2cb14b9 100644 --- a/docs/os/storage/additional-mounts/index.md +++ b/docs/os/storage/additional-mounts/index.md @@ -6,6 +6,7 @@ redirect_from: --- ## Additional Mounts +--- Additional mounts can be specified as part of your [cloud-config]({{site.baseurl}}/os/configuration/#cloud-config). These mounts are applied within the console container. Here's a simple example that mounts `/dev/vdb` to `/mnt/s`. diff --git a/docs/os/system-services/system-docker-volumes/index.md b/docs/os/system-services/system-docker-volumes/index.md index a2b9dc31..107b061b 100644 --- a/docs/os/system-services/system-docker-volumes/index.md +++ b/docs/os/system-services/system-docker-volumes/index.md @@ -18,7 +18,7 @@ Provides user accessible persistent storage directories, used by console service /opt ``` -### container-data-volumes +### container-data-volumes Provides docker storage directory, used by console service (and, indirectly, by docker) @@ -26,7 +26,7 @@ Provides docker storage directory, used by console service (and, indirectly, by /var/lib/docker ``` -### command-volumes +### command-volumes Provides necessary command binaries (read-only), used by system services: diff --git a/docs/os/under-the-hood/zombie-process-management/index.md b/docs/os/under-the-hood/zombie-process-management/index.md index 63dc02c5..c15662f3 100644 --- a/docs/os/under-the-hood/zombie-process-management/index.md +++ b/docs/os/under-the-hood/zombie-process-management/index.md @@ -1,5 +1,5 @@ --- -title: Zombie process management +title: Zombie process management layout: os-default ---