rancher/os
1
0
Fork 1
mirror of https://github.com/rancher/os.git synced 2025-08-13 12:27:11 +00:00
Code Issues Releases Wiki Activity

What's live atm

Browse Source 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit 2017-04-27 11:51:13 -07:00
parent b573e0f378
commit bc12860e7e
29 changed files with 63 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/os/configuration/index.md
View File

@ -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

1
docs/os/configuration/kernel-modules-kernel-headers/index.md
View File

@ -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

3
docs/os/configuration/ssh-keys/index.md
View File

@ -7,7 +7,7 @@ layout: os-default
## 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@<ip-address>
```

6
docs/os/index.md
View File

@ -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).
<br>

1
docs/os/networking/dns/index.md
View File

@ -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.

1
docs/os/networking/proxy-settings/index.md
View File

@ -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.

4
docs/os/quick-start-guide/index.md
View File

@ -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.

8
docs/os/running-rancheros/cloud/aws/index.md
View File

@ -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
@ -51,7 +53,6 @@ Let’s walk through how to import and create a RancherOS on EC2 machine using t
![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@<ip-of-ec2-instance>
```
## Latest AMI Releases
----
Please check the [README](https://github.com/rancher/os/blob/master/README.md) in our RancherOS repository for our latest AMIs.

59
docs/os/running-rancheros/workstation/boot-from-iso/index.md
View File

@ -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.
<!----
### Example using VirtualBox
1. Download the RancherOS ISO.
2. Start up a VM from VirtualBox.
a. Open up VirtualBox. If you don't have VirtualBox, download it [here](https://www.virtualbox.org/wiki/Downloads).
![RancherOS on ISO 1]({{site.baseurl}}/img/os/Rancher_iso1.png)
b. Provide a **name**, select the **type** to be _Linux_, and select the **version** to be _Other Linux (64-bit)_. Click **Continue**.
![RancherOS on ISO 2]({{site.baseurl}}/img/os/Rancher_iso2.png)
c. Select at least **1GB** of RAM.
![RancherOS on ISO 3]({{site.baseurl}}/img/os/Rancher_iso3.png)
d. Select **Create a virtual hard drive now** and click **Create**.
![RancherOS on ISO 4]({{site.baseurl}}/img/os/Rancher_iso4.png)
e. Select the **VDI (VirtualBox Disk Image)** setting and click **Continue**.
![RancherOS on ISO 5]({{site.baseurl}}/img/os/Rancher_iso5.png)
f. Select **Dynamically allocated** and click **Continue**.
![RancherOS on ISO 6]({{site.baseurl}}/img/os/Rancher_iso6.png)
g. Click **Create**.
![RancherOS on ISO 7]({{site.baseurl}}/img/os/Rancher_iso7.png)
Your new VM should be created, but in a _Powered Off_ state.
3. Start the VM from VirtualBox by clicking on the VM and clicking **Start** or right-click on the box and select **Start**. You will be immediately prompted to select an ISO. Find the RancherOS ISO that you have downloaded. Click **Start**.
![RancherOS on ISO 7]({{site.baseurl}}/img/os/Rancher_iso7.png)
4. When RancherOS launches, you will be prompted for a rancher login and password. The login and password is 'rancher' (all lowercase).
```
RancherOS rancher /dev/ttyl
rancher login: rancher
Password:
```
Next, read about how to [install to disk]({{site.baseurl}}/os/running-rancheros/server/install-to-disk/) in order to have any changes to RancherOS to be saved.
---->

34
docs/os/security/index.md.bak
View File

@ -1,34 +0,0 @@
---
title: RancherOS security
layout: os-default
---
## RancherOS security
---
<table width="100%">
<tr style="vertical-align: top;">
<td width="30%" style="border: none;">
<h4>Security policy</h4>
<p style="padding: 8px">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.</p>
</td>
<td width="30%" style="border: none;">
<h4>Reporting process</h4>
<p style="padding: 8px">Please submit possible security issues by emailing <a href="security@rancher.com">security@rancher.com</a></p>
</td>
<td width="30%" style="border: none;">
<h4>Announcments</h4>
<p style="padding: 8px">Subscribe to the <a href="https://forums.rancher.com/c/announcements">Rancher announcements forum</a> for release updates.</p>
</td>
</tr>
</table>
### 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) |

1
docs/os/storage/additional-mounts/index.md
View File

@ -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`.