diff --git a/content/os/_index.md b/content/os/_index.md index 9998f393af1..02d6687464f 100644 --- a/content/os/_index.md +++ b/content/os/_index.md @@ -21,23 +21,23 @@ 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.osbaseurl}}/running-rancheros/server/install-to-disk/), you will need at least 1024MB of RAM. +> **Note:** If you are planning on [installing to disk]({{< baseurl >}}/os/installation/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.osbaseurl}}/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]({{< baseurl >}}/os/installation/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. We created this separation because it seemed logical and also it would really be bad if somebody did `docker rm -f $(docker ps -qa)` and deleted the entire OS. -![How it works]({{site.baseurl}}/img/os/rancheroshowitworks.png "How it works") +![How it works]({{< baseurl >}}/img/os/rancheroshowitworks.png) ### Running RancherOS -To find out more about installing RancherOS, jump to our [Quick Start Guide]({{page.osbaseurl}}/quick-start-guide/). +To find out more about installing RancherOS, jump to our [Quick Start Guide]({{< baseurl >}}/os/quick-start-guide/). ### Latest Release diff --git a/content/os/about/_index.md b/content/os/about/_index.md index abc83e2a9b2..ae7a69a5810 100644 --- a/content/os/about/_index.md +++ b/content/os/about/_index.md @@ -65,7 +65,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.osbaseurl}}/system-services/) can be contributed. +[RancherOS Services Repo](https://github.com/rancher/os-services): This repo is where any [system-services]({{< baseurl >}}/os/installation/system-services/adding-system-services/) can be contributed. [RancherOS Images Repo](https://github.com/rancher/os-images): This repo is for the corresponding service images. @@ -74,7 +74,7 @@ All of repositories are located within our main GitHub [page](https://github.com If you find any bugs or are having any trouble, please contact us by filing an [issue](https://github.com/rancher/os/issues/new). -If you have any updates to our documentation, please make any PRs to our [docs repo](https://github.com/rancher/rancher.github.io). +If you have any updates to our documentation, please make any PRs to our [docs repo](https://github.com/rancher/docs).

diff --git a/content/os/about/running-rancher-on-rancherOS/_index.md b/content/os/about/running-rancher-on-rancherOS/_index.md index efdb455eeb0..06c57034613 100644 --- a/content/os/about/running-rancher-on-rancherOS/_index.md +++ b/content/os/about/running-rancher-on-rancherOS/_index.md @@ -7,16 +7,16 @@ weight: 302 --- -## Tips on using Rancher with RancherOS +## Tips on using Rancher v1.x with RancherOS --- -RancherOS can be used to launch [Rancher]({{site.baseurl}}/rancher/latest/en/) and be used as the OS to [add hosts]({{site.baseurl}}/rancher/latest/en/hosts/custom) to Rancher. +RancherOS can be used to launch [Rancher](/rancher/) and be used as the OS to add nodes to Rancher. ### Launching Agents using Cloud-Config -You can easily add hosts into Rancher by using [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) to launch the rancher/agent container. +You can easily add hosts into Rancher by using [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config) to launch the rancher/agent container. -After Rancher is launched and [host registration]({{site.baseurl}}/rancher/latest/en/configuration/settings/#host-registration) has been saved, you will be able to find the [custom command]({{site.baseurl}}/rancher/latest/en/hosts/custom) in the **Infrastructure** -> **Hosts** -> **Custom** page. +After Rancher is launched and host registration has been saved, you will be able to find use the custom option to add Rancher OS nodes. ```bash $ sudo docker run --d --privileged -v /var/run/docker.sock:/var/run/docker.sock \ @@ -44,13 +44,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/latest/en/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`](https://rancher.com/docs/rancher/v1.6/en/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/latest/en/cattle/scheduling/) and create a whitelist or blacklist of hosts for your [services]({{site.baseurl}}/rancher/latest/en/cattle/adding-services/) to run on. +By adding labels to hosts, you can use these labels when to schedule services/load balancers/services and create a whitelist or blacklist of hosts for your 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/content/os/installation/amazon-ecs/_index.md b/content/os/installation/amazon-ecs/_index.md index 314f92c9dba..9c207016cd2 100644 --- a/content/os/installation/amazon-ecs/_index.md +++ b/content/os/installation/amazon-ecs/_index.md @@ -17,13 +17,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.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. +RancherOS makes it easy to join your ECS cluster. The ECS agent is a [system service]({{< baseurl >}}/os/installation/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.osbaseurl}}/configuration/#cloud-config) file. +For the **User Data**, you'll need to pass in the [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config) file. ```yaml #cloud-config @@ -43,7 +43,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.osbaseurl}}/configuration/#cloud-config) file. +To select the version, you can update your [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config) file. ```yaml #cloud-config diff --git a/content/os/installation/boot-process/built-in-system-services/_index.md b/content/os/installation/boot-process/built-in-system-services/_index.md index d6ff2b5f03c..ae533e9f05d 100644 --- a/content/os/installation/boot-process/built-in-system-services/_index.md +++ b/content/os/installation/boot-process/built-in-system-services/_index.md @@ -1,25 +1,24 @@ --- -title: Built-in System Services in RancherOS - -redirect_from: - - os/v1.0/en/system-services/built-in-system-services/ - - os/v1.1/en/system-services/built-in-system-services/ - +tag: ["rancheros", "os", "system services"] +category: "os" +layout: list-docs +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]({{page.osbaseurl}}/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]({{< baseurl >}}/os/installation/system-services/adding-system-services/) or override services in the cloud-config. ### preload-user-images -Read more about [image preloading]({{page.osbaseurl}}/boot-process/image-preloading/). +Read more about [image preloading]({{< baseurl >}}/os/installation/boot-process/image-preloading/). ### network During this service, networking is set up, e.g. hostname, interfaces, and DNS. -It is configured by `hostname` and `rancher.network`[settings]({{page.osbaseurl}}/networking/) in [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config). +It is configured by `hostname` and `rancher.network`settings in [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config). ### ntp @@ -31,15 +30,15 @@ This service provides the RancherOS user interface by running `sshd` and `getty` 1. If the `rancher.password=` kernel parameter exists, it sets `` as the password for the `rancher` user. -2. If there are no host SSH keys, it generates host SSH keys and saves them under `rancher.ssh.keys` in [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config). +2. If there are no host SSH keys, it generates host SSH keys and saves them under `rancher.ssh.keys` in [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config). 3. Runs `cloud-init -execute`, which does the following: - * Updates `.ssh/authorized_keys` in `/home/rancher` and `/home/docker` from [cloud-config]({{page.osbaseurl}}/configuration/ssh-keys/) and metadata. - * Writes files specified by the `write_files` [cloud-config]({{page.osbaseurl}}/configuration/write-files/) setting. - * Resizes the device specified by the `rancher.resize_device` [cloud-config]({{page.osbaseurl}}/configuration/resizing-device-partition/) setting. - * Mount devices specified in the `mounts` [cloud-config]({{page.osbaseurl}}/configuration/additional-mounts/) setting. - * Set sysctl parameters specified in the`rancher.sysctl` [cloud-config]({{page.osbaseurl}}/configuration/sysctl/) setting. + * Updates `.ssh/authorized_keys` in `/home/rancher` and `/home/docker` from [cloud-config]({{< baseurl >}}/os/installation/configuration/ssh-keys/) and metadata. + * Writes files specified by the `write_files` [cloud-config]({{< baseurl >}}/os/installation/configuration/write-files/) setting. + * Resizes the device specified by the `rancher.resize_device` [cloud-config]({{< baseurl >}}/os/installation/configuration/resizing-device-partition/) setting. + * Mount devices specified in the `mounts` [cloud-config]({{< baseurl >}}/os/installation/storage/additional-mounts/) setting. + * Set sysctl parameters specified in the`rancher.sysctl` [cloud-config]({{< baseurl >}}/os/installation/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. diff --git a/content/os/installation/boot-process/cloud-init/_index.md b/content/os/installation/boot-process/cloud-init/_index.md index b2070ec71ca..17a108b17f2 100644 --- a/content/os/installation/boot-process/cloud-init/_index.md +++ b/content/os/installation/boot-process/cloud-init/_index.md @@ -12,7 +12,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.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`. +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]({{< baseurl >}}/os/installation/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 @@ -20,7 +20,7 @@ Although the specifics vary based on provider, a metadata file will typically co ## Configuration Load Order -[Cloud-config]({{page.osbaseurl}}/configuration/#cloud-config/) is read by system services when they need to get configuration. Each additional file overwrites and extends the previous configuration file. +[Cloud-config]({{< baseurl >}}/os/installation/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. diff --git a/content/os/installation/configuration/_index.md b/content/os/installation/configuration/_index.md index 64717d9b584..d91db60cfec 100644 --- a/content/os/installation/configuration/_index.md +++ b/content/os/installation/configuration/_index.md @@ -1,9 +1,9 @@ --- - tag: ["rancheros", "os", "configuration", "custom"] - category: "os" - layout: list-docs - title: Configuration - weight: 120 +tag: ["rancheros", "os", "configuration", "custom"] +category: "os" +layout: list-docs +title: Configuration +weight: 120 --- ## Configuring RancherOS @@ -40,7 +40,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 ` command can be used. -For more complicated settings, like the [sysctl settings]({{page.osbaseurl}}/sysctl/), you can also create a small YAML file and then run `sudo ros config merge -i `. +For more complicated settings, like the [sysctl settings]({{< baseurl >}}/os/installation/configuration/sysctl/), you can also create a small YAML file and then run `sudo ros config merge -i `. #### Getting Values diff --git a/content/os/installation/configuration/adding-kernel-parameters/_index.md b/content/os/installation/configuration/adding-kernel-parameters/_index.md index 2d0885f3a32..efb79789003 100644 --- a/content/os/installation/configuration/adding-kernel-parameters/_index.md +++ b/content/os/installation/configuration/adding-kernel-parameters/_index.md @@ -31,7 +31,7 @@ $ sudo system-docker run --rm -it -v /:/host alpine vi /host/boot/global.cfg ### During installation -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. +If you want to set the extra kernel parameters when you are [Installing RancherOS to Disk]({{< baseurl >}}/os/installation/running-rancheros/server/install-to-disk/) please use the `--append` parameter. ```bash $ sudo ros install -d /dev/sda --append "rancheros.autologin=tty1" diff --git a/content/os/installation/configuration/docker/_index.md b/content/os/installation/configuration/docker/_index.md index 7c5e87831b9..9fee51d9971 100644 --- a/content/os/installation/configuration/docker/_index.md +++ b/content/os/installation/configuration/docker/_index.md @@ -9,7 +9,7 @@ weight: 126 ## Configuring Docker or System Docker --- -In RancherOS, you can configure System Docker and Docker daemons by using [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config). +In RancherOS, you can configure System Docker and Docker daemons by using [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config). ### Configuring Docker @@ -61,7 +61,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.osbaseurl}}/configuration/setting-up-docker-tls/), this key needs to be set to true. +`tls` | Boolean | `false` | When [setting up TLS]({{< baseurl >}}/os/installation/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. diff --git a/content/os/installation/configuration/hostname/_index.md b/content/os/installation/configuration/hostname/_index.md index 2fe00f409df..696399aa0b2 100644 --- a/content/os/installation/configuration/hostname/_index.md +++ b/content/os/installation/configuration/hostname/_index.md @@ -9,7 +9,7 @@ weight: 124 ## Setting the Hostname --- -You can set the hostname of the host using [cloud-config]({baseurl}}/configuration/#cloud-config). The example below shows how to configure it. +You can set the hostname of the host using [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config). The example below shows how to configure it. ```yaml #cloud-config diff --git a/content/os/installation/configuration/loading-kernel-modules/_index.md b/content/os/installation/configuration/loading-kernel-modules/_index.md index b97052b4df5..209751bdaad 100644 --- a/content/os/installation/configuration/loading-kernel-modules/_index.md +++ b/content/os/installation/configuration/loading-kernel-modules/_index.md @@ -6,6 +6,8 @@ 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/installation/configuration/private-registries/_index.md b/content/os/installation/configuration/private-registries/_index.md index ae9019b9935..9d640d09b0d 100644 --- a/content/os/installation/configuration/private-registries/_index.md +++ b/content/os/installation/configuration/private-registries/_index.md @@ -9,7 +9,7 @@ weight: 128 ## Private Registries --- -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. +When launching services through a [cloud-config]({{< baseurl >}}/os/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: @@ -67,7 +67,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/configuration/#cloud-config), the certificates can be written directly into `/etc/docker/certs.d`. ```yaml #cloud-config diff --git a/content/os/installation/configuration/running-commands/_index.md b/content/os/installation/configuration/running-commands/_index.md index 4d5dbdc2d9b..15022a45c95 100644 --- a/content/os/installation/configuration/running-commands/_index.md +++ b/content/os/installation/configuration/running-commands/_index.md @@ -18,7 +18,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/boot-process/built-in-system-services/#console). ### Running Docker commands @@ -37,7 +37,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/system-services/adding-system-services/) is recommended. ## Running Commands Early in the Boot Process --- diff --git a/content/os/installation/configuration/ssh-keys/_index.md b/content/os/installation/configuration/ssh-keys/_index.md index 900759d0bcb..8311e9c3422 100644 --- a/content/os/installation/configuration/ssh-keys/_index.md +++ b/content/os/installation/configuration/ssh-keys/_index.md @@ -9,7 +9,7 @@ weight: 121 ## SSH Keys --- -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. +RancherOS supports adding SSH keys through the [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config) file. Within the cloud-config file, you simply add the ssh keys within the `ssh_authorized_keys` key. ```yaml #cloud-config diff --git a/content/os/installation/configuration/switching-consoles/_index.md b/content/os/installation/configuration/switching-consoles/_index.md index 0e3aafe78fc..1e725c84f3f 100644 --- a/content/os/installation/configuration/switching-consoles/_index.md +++ b/content/os/installation/configuration/switching-consoles/_index.md @@ -9,13 +9,13 @@ weight: 125 ## Switching Consoles --- -When [booting from the ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso/), RancherOS starts with the default console, which is based on busybox. +When [booting from the ISO]({{< baseurl >}}/os/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]({{page.osbaseurl}}/configuration/#cloud-config). +You can select which console you want RancherOS to start with using the [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config). ### Enabling Consoles using Cloud-Config -When launching RancherOS with a [cloud-config]({{page.osbaseurl}}/configuration/#cloud-config) file, you can select which console you want to use. +When launching RancherOS with a [cloud-config]({{< baseurl >}}/os/installation/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
-> **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. +> **Note:** When using a persistent console and in the current version's console, [rolling back]({{< baseurl >}}/os/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 diff --git a/content/os/installation/configuration/switching-docker-versions/_index.md b/content/os/installation/configuration/switching-docker-versions/_index.md index d2b47ba324b..c026dd07e72 100644 --- a/content/os/installation/configuration/switching-docker-versions/_index.md +++ b/content/os/installation/configuration/switching-docker-versions/_index.md @@ -8,7 +8,7 @@ weight: 129 ## Changing Docker Versions -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. +The version of User Docker used in RancherOS can be configured using a [cloud-config]({{< baseurl >}}/os/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). @@ -88,7 +88,7 @@ FROM scratch COPY engine /engine ``` -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. +Once the image is built a [system service]({{< baseurl >}}/os/installation/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. diff --git a/content/os/installation/configuration/users/_index.md b/content/os/installation/configuration/users/_index.md index 286dab38d63..516d866cd5a 100644 --- a/content/os/installation/configuration/users/_index.md +++ b/content/os/installation/configuration/users/_index.md @@ -11,7 +11,7 @@ weight: 130 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.osbaseurl}}/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]({{< baseurl >}}/os/installation/custom-builds/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/content/os/installation/custom-builds/custom-console/_index.md b/content/os/installation/custom-builds/custom-console/_index.md index e8a4c61b177..c5360ecf451 100644 --- a/content/os/installation/custom-builds/custom-console/_index.md +++ b/content/os/installation/custom-builds/custom-console/_index.md @@ -9,13 +9,13 @@ weight: 180 ## Custom Console --- -When [booting from the ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso/), RancherOS starts with the default console, which is based on busybox. +When [booting from the ISO]({{< baseurl >}}/os/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]({{page.osbaseurl}}/configuration/#cloud-config). +You can select which console you want RancherOS to start with using the [cloud-config]({{< baseurl >}}/os/installation/configuration/#cloud-config). ### Enabling Consoles using Cloud-Config -When launching RancherOS with a [cloud-config]({baseurl}}/configuration/#cloud-config) file, you can select which console you want to use. +When launching RancherOS with a [cloud-config]({{< baseurl >}}/os/installation/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
-> **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. +> **Note:** When using a persistent console and in the current version's console, [rolling back]({{< baseurl >}}/os/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 diff --git a/content/os/installation/custom-builds/custom-kernels/_index.md b/content/os/installation/custom-builds/custom-kernels/_index.md index 9bfefc594d7..b9a0d85732c 100644 --- a/content/os/installation/custom-builds/custom-kernels/_index.md +++ b/content/os/installation/custom-builds/custom-kernels/_index.md @@ -54,7 +54,7 @@ The `build-.tar.gz` and `extra-.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.osbaseurl}}/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]({{< baseurl >}}/os/installation/custom-builds/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`. @@ -104,4 +104,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/custom-builds/custom-rancheros-iso/). diff --git a/content/os/installation/custom-builds/custom-rancheros-iso/_index.md b/content/os/installation/custom-builds/custom-rancheros-iso/_index.md index 769d441e64d..3e46657575a 100644 --- a/content/os/installation/custom-builds/custom-rancheros-iso/_index.md +++ b/content/os/installation/custom-builds/custom-rancheros-iso/_index.md @@ -16,7 +16,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.osbaseurl}}/configuration/custom-kernels), or [custom Docker]({{page.osbaseurl}}/configuration/custom-docker). +2. In the root of the repository, the "General Configuration" section of `Dockerfile.dapper` can be updated to use [custom kernels]({{< baseurl >}}/os/installation/custom-builds/custom-kernels). 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. @@ -30,7 +30,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.osbaseurl}}/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{page.osbaseurl}}/running-rancheros/workstation/docker-machine). +The `rancheros.iso` is ready to be used to [boot RancherOS from ISO]({{< baseurl >}}/os/installation/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{< baseurl >}}/os/installation/running-rancheros/workstation/docker-machine). ### Creating a GCE Image Archive diff --git a/content/os/installation/running-rancheros/_index.md b/content/os/installation/running-rancheros/_index.md index c5ef74be657..025da8d73d9 100644 --- a/content/os/installation/running-rancheros/_index.md +++ b/content/os/installation/running-rancheros/_index.md @@ -9,31 +9,31 @@ 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]({{page.osbaseurl}}/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]({{< baseurl >}}/os/quick-start-guide/). ### Platforms #### Workstation -[Docker Machine]({{page.osbaseurl}}/running-rancheros/workstation/docker-machine) +[Docker Machine]({{< baseurl >}}/os/installation/running-rancheros/workstation/docker-machine) -[Boot from ISO]({{page.osbaseurl}}/running-rancheros/workstation/boot-from-iso) +[Boot from ISO]({{< baseurl >}}/os/installation/running-rancheros/workstation/boot-from-iso) #### Cloud -[Amazon EC2]({{page.osbaseurl}}/running-rancheros/cloud/aws) +[Amazon EC2]({{< baseurl >}}/os/installation/running-rancheros/cloud/aws) -[Google Compute Engine]({{page.osbaseurl}}/running-rancheros/cloud/gce) +[Google Compute Engine]({{< baseurl >}}/os/installation/running-rancheros/cloud/gce) -[DigitalOcean]({{page.osbaseurl}}/running-rancheros/cloud/do) +[DigitalOcean]({{< baseurl >}}/os/installation/running-rancheros/cloud/do) -[Azure]({{page.osbaseurl}}/running-rancheros/cloud/azure) +[Azure]({{< baseurl >}}/os/installation/running-rancheros/cloud/azure) #### Bare Metal & Virtual Servers -[iPXE]({{page.osbaseurl}}/running-rancheros/server/ipxe) +[PXE]({{< baseurl >}}/os/installation/running-rancheros/server/pxe) -[PXE]({{page.osbaseurl}}/running-rancheros/server/pxe) +[Install to Hard Disk]({{< baseurl >}}/os/installation/running-rancheros/server/install-to-disk) -[Install to Hard Disk]({{page.osbaseurl}}/running-rancheros/server/install-to-disk) +[Raspberry Pi]({{< baseurl >}}/os/installation/running-rancheros/server/raspberry-pi) diff --git a/content/os/installation/running-rancheros/cloud/aws/_index.md b/content/os/installation/running-rancheros/cloud/aws/_index.md index 0850ba02fe4..df58c05c078 100644 --- a/content/os/installation/running-rancheros/cloud/aws/_index.md +++ b/content/os/installation/running-rancheros/cloud/aws/_index.md @@ -32,27 +32,27 @@ Let’s walk through how to import and create a RancherOS on EC2 machine using t 1. First login to your AWS console, and go to the EC2 dashboard, click on **Launch Instance**: - ![RancherOS on AWS 1]({{site.baseurl}}/img/os/Rancher_aws1.png) + ![RancherOS on AWS 1]({{< baseurl >}}/img/os/Rancher_aws1.png) 2. Select the **Community AMIs** on the sidebar and search for **RancherOS**. Pick the latest version and click **Select**. - ![RancherOS on AWS 2]({{site.baseurl}}/img/os/Rancher_aws2.png) + ![RancherOS on AWS 2]({{< 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]({{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. +3. Go through the steps of creating the instance type through the AWS console. If you want to pass in a [cloud-config]({{< baseurl >}}/os/installation/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) + ![RancherOS on AWS 6]({{< 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**. - ![RancherOS on AWS 3]({{site.baseurl}}/img/os/Rancher_aws3.png) + ![RancherOS on AWS 3]({{< baseurl >}}/img/os/Rancher_aws3.png) 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) + ![RancherOS on AWS 4]({{< baseurl >}}/img/os/Rancher_aws4.png) Your instance is now running! - ![RancherOS on AWS 5]({{site.baseurl}}/img/os/Rancher_aws5.png) + ![RancherOS on AWS 5]({{< baseurl >}}/img/os/Rancher_aws5.png) ## Logging into RancherOS diff --git a/content/os/installation/running-rancheros/cloud/do/_index.md b/content/os/installation/running-rancheros/cloud/do/_index.md index f1f4a94a0d3..b21ba71f5c1 100644 --- a/content/os/installation/running-rancheros/cloud/do/_index.md +++ b/content/os/installation/running-rancheros/cloud/do/_index.md @@ -4,6 +4,7 @@ category: "os" layout: list-docs title: Digital Ocean weight: 107 +--- ## Running RancherOS in DigitalOcean --- diff --git a/content/os/installation/running-rancheros/cloud/gce/_index.md b/content/os/installation/running-rancheros/cloud/gce/_index.md index a8fc903d298..8e6d20a30dc 100644 --- a/content/os/installation/running-rancheros/cloud/gce/_index.md +++ b/content/os/installation/running-rancheros/cloud/gce/_index.md @@ -9,7 +9,7 @@ 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]({{site.baseurl}}/os/networking/interfaces/) and both the [Docker and System Docker]({{site.baseurl}}/os/configuration/docker/) to use a MTU of 1460 bytes or you will encounter weird networking related errors. +> **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/installation/networking/interfaces/) and both the [Docker and System Docker]({{< baseurl >}}/os/installation/configuration/docker/) to use a MTU of 1460 bytes or you will encounter weird networking related errors. ### Adding the RancherOS Image into GCE @@ -35,7 +35,7 @@ $ gcloud compute instances create --project --zone }}/os/installation/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 --zone --image --metadata-from-file user-data=/Directory/of/Cloud_Config.yml @@ -84,15 +84,15 @@ After the image is uploaded, it's easy to use the console to create new instance 1. Make sure you are in the project that the image was created in. - ![RancherOS on GCE 4]({{site.baseurl}}/img/os/Rancher_gce4.png) + ![RancherOS on GCE 4]({{< baseurl >}}/img/os/Rancher_gce4.png) 2. In the navigation bar, click on the **VM instances**, which is located at Compute -> Compute Engine -> Metadata. Click on **Create instance**. - ![RancherOS on GCE 5]({{site.baseurl}}/img/os/Rancher_gce5.png) + ![RancherOS on GCE 5]({{< baseurl >}}/img/os/Rancher_gce5.png) 2. Fill out the information for your instance. In the **Image** dropdown, your private image will be listed among the public images provided by Google. Select the private image for RancherOS. Click **Create**. - ![RancherOS on GCE 6]({{site.baseurl}}/img/os/Rancher_gce6.png) + ![RancherOS on GCE 6]({{< baseurl >}}/img/os/Rancher_gce6.png) 3. Your instance is being created and will be up and running shortly! @@ -104,7 +104,7 @@ In order to SSH into the GCE instance, you will need to have SSH keys set up in In your project, click on **Metadata**, which is located within Compute -> Compute Engine -> Metadata. Click on **SSH Keys**. -![RancherOS on GCE 7]({{site.baseurl}}/img/os/Rancher_gce7.png) +![RancherOS on GCE 7]({{< baseurl >}}/img/os/Rancher_gce7.png) Add the SSH keys that you want to have access to any instances within your project. @@ -114,11 +114,11 @@ Note: If you do this after any RancherOS instance is created, you will need to r After your instance is created, click on the instance name. Scroll down to the **SSH Keys** section and click on **Add SSH key**. This key will only be applicable to the instance. -![RancherOS on GCE 8]({{site.baseurl}}/img/os/Rancher_gce8.png) +![RancherOS on GCE 8]({{< baseurl >}}/img/os/Rancher_gce8.png) After the SSH keys have been added, you'll need to reset the machine, by clicking **Reset**. -![RancherOS on GCE 9]({{site.baseurl}}/img/os/Rancher_gce9.png) +![RancherOS on GCE 9]({{< baseurl >}}/img/os/Rancher_gce9.png) After a little bit, you will be able to SSH into the box using the **rancher** user. diff --git a/content/os/installation/running-rancheros/cloud/openstack/_index.md b/content/os/installation/running-rancheros/cloud/openstack/_index.md index f5061193d5c..95c64583970 100644 --- a/content/os/installation/running-rancheros/cloud/openstack/_index.md +++ b/content/os/installation/running-rancheros/cloud/openstack/_index.md @@ -12,4 +12,4 @@ weight: 109 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.osbaseurl}}/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]({{< baseurl >}}/os/installation/configuration/#cloud-config) file. diff --git a/content/os/installation/running-rancheros/server/install-to-disk/_index.md b/content/os/installation/running-rancheros/server/install-to-disk/_index.md index d1befe39415..ef54b8edc40 100644 --- a/content/os/installation/running-rancheros/server/install-to-disk/_index.md +++ b/content/os/installation/running-rancheros/server/install-to-disk/_index.md @@ -8,7 +8,7 @@ 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]({{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). +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/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 @@ -16,7 +16,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/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. @@ -66,7 +66,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/configuration/#cloud-config). #### Installing a Different Version diff --git a/content/os/installation/running-rancheros/server/pxe/_index.md b/content/os/installation/running-rancheros/server/pxe/_index.md index 28a204b50b4..f8942e50279 100644 --- a/content/os/installation/running-rancheros/server/pxe/_index.md +++ b/content/os/installation/running-rancheros/server/pxe/_index.md @@ -65,11 +65,11 @@ Valid cloud-init datasources for RancherOS. | gce | | | | packet | DefaultAddress | | | url | url | | -| vmware** | | set `guestinfo` cloud-init or interface data as per [VMware ESXi]({{page.osbaseurl}}/cloud/vmware-esxi) | +| vmware** | | set `guestinfo` cloud-init or interface data as per [VMware ESXi]({{< baseurl >}}/os/installation/running-rancheros/cloud/vmware-esxi) | | * | This will add ["configdrive", "vmware", "ec2", "digitalocean", "packet", "gce"] into the list of datasources to try | | ** vmware was added as of v1.1. ### Cloud-Config -When booting via iPXE, RancherOS can be configured using a [cloud-config file]({{page.osbaseurl}}/configuration/#cloud-config). +When booting via iPXE, RancherOS can be configured using a [cloud-config file]({{< baseurl >}}/os/installation/configuration/#cloud-config). diff --git a/content/os/installation/running-rancheros/server/raspberry-pi/_index.md b/content/os/installation/running-rancheros/server/raspberry-pi/_index.md index 96231cdb41d..86cf01f6d1a 100644 --- a/content/os/installation/running-rancheros/server/raspberry-pi/_index.md +++ b/content/os/installation/running-rancheros/server/raspberry-pi/_index.md @@ -11,7 +11,7 @@ weight: 113 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.osbaseurl}}/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]({{< baseurl >}}/os/installation/configuration/#cloud-config). You will need to boot up, change the configuration and then reboot to apply those changes. Currently, only Raspberry Pi 3 is tested and known to work. diff --git a/content/os/installation/running-rancheros/workstation/boot-from-iso/_index.md b/content/os/installation/running-rancheros/workstation/boot-from-iso/_index.md index 0b70a979887..ba66b2993a0 100644 --- a/content/os/installation/running-rancheros/workstation/boot-from-iso/_index.md +++ b/content/os/installation/running-rancheros/workstation/boot-from-iso/_index.md @@ -12,11 +12,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.osbaseurl}}/running-rancheros/server/install-to-disk/), you will need at least 1.5GB of RAM. +> **Note:** If you are planning on [installing to disk]({{< baseurl >}}/os/installation/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.osbaseurl}}/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]({{< baseurl >}}/os/installation/running-rancheros/server/install-to-disk/) to install RancherOS to a hard disk. ### Persisting State diff --git a/content/os/installation/running-rancheros/workstation/docker-machine/_index.md b/content/os/installation/running-rancheros/workstation/docker-machine/_index.md index d01c9368061..5df90b6166b 100644 --- a/content/os/installation/running-rancheros/workstation/docker-machine/_index.md +++ b/content/os/installation/running-rancheros/workstation/docker-machine/_index.md @@ -2,7 +2,7 @@ tag: ["rancheros", "os", "docker machine"] category: "os" layout: list-docs -title: Using Docker Machine +title: Using Docker Machine weight: 101 --- @@ -57,7 +57,7 @@ Logging into RancherOS follows the standard Docker Machine commands. To login in $ docker-machine ssh ``` -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. +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]({{< baseurl >}}/os/installation/system-services/adding-system-services/), [customizing the configuration]({{< baseurl >}}/os/installation/configuration/), and launching containers. If you want to exit out of RancherOS, you can exit by pressing `Ctrl+D`. diff --git a/content/os/installation/storage/additional-mounts/_index.md b/content/os/installation/storage/additional-mounts/_index.md index 514857b2096..b5fe3d13319 100644 --- a/content/os/installation/storage/additional-mounts/_index.md +++ b/content/os/installation/storage/additional-mounts/_index.md @@ -9,7 +9,7 @@ weight: 161 ## Additional Mounts --- -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`. +Additional mounts can be specified as part of your [cloud-config]({{< baseurl >}}/os/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 #cloud-config diff --git a/content/os/installation/system-services/custom-system-services/_index.md b/content/os/installation/system-services/custom-system-services/_index.md index e3c0c259bb6..4005099c761 100644 --- a/content/os/installation/system-services/custom-system-services/_index.md +++ b/content/os/installation/system-services/custom-system-services/_index.md @@ -8,7 +8,7 @@ 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]({{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. +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/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/quick-start-guide/_index.md b/content/os/quick-start-guide/_index.md index bae784dfcab..e00d49fd1f0 100644 --- a/content/os/quick-start-guide/_index.md +++ b/content/os/quick-start-guide/_index.md @@ -10,7 +10,7 @@ weight: 2 ## Quick Start Guide --- -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. +If you have a specific RanchersOS machine requirements, please check out our [guides on running RancherOS]({{< baseurl >}}/os/installation/running-rancheros/). With the rest of this guide, we'll start up a RancherOS using [Docker machine]({{< baseurl >}}/os/installation/running-rancheros/workstation/docker-machine/) and show you some of what RancherOS can do. ### Launching RancherOS using Docker Machine @@ -96,7 +96,7 @@ $ sudo system-docker run -d --net=host --name busydash husseingalal/busydash ``` In the commad, we used `--net=host` to tell System Docker not to containerize the container's networking, and use the host’s networking instead. After running the container, you can see the monitoring server by accessing `http://`. -![System Docker Container]({{site.baseurl}}/img/os/Rancher_busydash.png) +![System Docker Container]({{< baseurl >}}/img/os/Rancher_busydash.png) To make the container survive during the reboots, you can create the `/opt/rancher/bin/start.sh` script, and add the Docker start line to launch the Docker at each startup. @@ -124,7 +124,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/custom-builds/custom-console/#console-persistence) and replace the native Busybox console. For example, to switch to the Ubuntu console: ``` $ sudo ros console switch ubuntu diff --git a/content/os/upgrading/_index.md b/content/os/upgrading/_index.md index b38fc512be9..42eda9afd5a 100644 --- a/content/os/upgrading/_index.md +++ b/content/os/upgrading/_index.md @@ -15,7 +15,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.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. +> **Note:** If you are using [`docker-machine`]({{< baseurl >}}/os/installation/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 @@ -70,7 +70,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.osbaseurl}}/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]({{< baseurl >}}/os/installation/running-rancheros/server/install-to-disk/). #### Upgrading to a Specific Version @@ -120,7 +120,7 @@ ros version 0.4.4
-> **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. +> **Note:** If you are using a [persistent console]({{< baseurl >}}/os/installation/custom-builds/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 diff --git a/src/img/os/.DS_Store b/src/img/os/.DS_Store new file mode 100644 index 00000000000..5008ddfcf53 Binary files /dev/null and b/src/img/os/.DS_Store differ diff --git a/src/img/os/Rancher_aws1.png b/src/img/os/Rancher_aws1.png new file mode 100644 index 00000000000..51714242e41 Binary files /dev/null and b/src/img/os/Rancher_aws1.png differ diff --git a/src/img/os/Rancher_aws2.png b/src/img/os/Rancher_aws2.png new file mode 100644 index 00000000000..44c1e73478c Binary files /dev/null and b/src/img/os/Rancher_aws2.png differ diff --git a/src/img/os/Rancher_aws3.png b/src/img/os/Rancher_aws3.png new file mode 100644 index 00000000000..866bb3cb18f Binary files /dev/null and b/src/img/os/Rancher_aws3.png differ diff --git a/src/img/os/Rancher_aws4.png b/src/img/os/Rancher_aws4.png new file mode 100644 index 00000000000..a55c4c93f0c Binary files /dev/null and b/src/img/os/Rancher_aws4.png differ diff --git a/src/img/os/Rancher_aws5.png b/src/img/os/Rancher_aws5.png new file mode 100644 index 00000000000..6184541bc10 Binary files /dev/null and b/src/img/os/Rancher_aws5.png differ diff --git a/src/img/os/Rancher_aws6.png b/src/img/os/Rancher_aws6.png new file mode 100644 index 00000000000..6f83bdd4335 Binary files /dev/null and b/src/img/os/Rancher_aws6.png differ diff --git a/src/img/os/Rancher_aws7.png b/src/img/os/Rancher_aws7.png new file mode 100644 index 00000000000..1c5f5ae7a58 Binary files /dev/null and b/src/img/os/Rancher_aws7.png differ diff --git a/src/img/os/Rancher_aws8.png b/src/img/os/Rancher_aws8.png new file mode 100644 index 00000000000..71ea1a079e6 Binary files /dev/null and b/src/img/os/Rancher_aws8.png differ diff --git a/src/img/os/Rancher_aws9.png b/src/img/os/Rancher_aws9.png new file mode 100644 index 00000000000..83c6c49a15b Binary files /dev/null and b/src/img/os/Rancher_aws9.png differ diff --git a/src/img/os/Rancher_busydash.png b/src/img/os/Rancher_busydash.png new file mode 100644 index 00000000000..999e9b3aad7 Binary files /dev/null and b/src/img/os/Rancher_busydash.png differ diff --git a/src/img/os/Rancher_disk1.png b/src/img/os/Rancher_disk1.png new file mode 100644 index 00000000000..4d7af226a5d Binary files /dev/null and b/src/img/os/Rancher_disk1.png differ diff --git a/src/img/os/Rancher_disk2.png b/src/img/os/Rancher_disk2.png new file mode 100644 index 00000000000..c0c4fbc9e99 Binary files /dev/null and b/src/img/os/Rancher_disk2.png differ diff --git a/src/img/os/Rancher_disk3.png b/src/img/os/Rancher_disk3.png new file mode 100644 index 00000000000..fca549b883d Binary files /dev/null and b/src/img/os/Rancher_disk3.png differ diff --git a/src/img/os/Rancher_gce1.png b/src/img/os/Rancher_gce1.png new file mode 100644 index 00000000000..8b0da400333 Binary files /dev/null and b/src/img/os/Rancher_gce1.png differ diff --git a/src/img/os/Rancher_gce4.png b/src/img/os/Rancher_gce4.png new file mode 100644 index 00000000000..c480c118f6d Binary files /dev/null and b/src/img/os/Rancher_gce4.png differ diff --git a/src/img/os/Rancher_gce5.png b/src/img/os/Rancher_gce5.png new file mode 100644 index 00000000000..553cda6047c Binary files /dev/null and b/src/img/os/Rancher_gce5.png differ diff --git a/src/img/os/Rancher_gce6.png b/src/img/os/Rancher_gce6.png new file mode 100644 index 00000000000..7d810106456 Binary files /dev/null and b/src/img/os/Rancher_gce6.png differ diff --git a/src/img/os/Rancher_gce7.png b/src/img/os/Rancher_gce7.png new file mode 100644 index 00000000000..bb69e8314ca Binary files /dev/null and b/src/img/os/Rancher_gce7.png differ diff --git a/src/img/os/Rancher_gce8.png b/src/img/os/Rancher_gce8.png new file mode 100644 index 00000000000..16e6a1c06e0 Binary files /dev/null and b/src/img/os/Rancher_gce8.png differ diff --git a/src/img/os/Rancher_gce9.png b/src/img/os/Rancher_gce9.png new file mode 100644 index 00000000000..edb382d77fe Binary files /dev/null and b/src/img/os/Rancher_gce9.png differ diff --git a/src/img/os/Rancher_iso1.png b/src/img/os/Rancher_iso1.png new file mode 100644 index 00000000000..f4a546e3621 Binary files /dev/null and b/src/img/os/Rancher_iso1.png differ diff --git a/src/img/os/Rancher_iso2.png b/src/img/os/Rancher_iso2.png new file mode 100644 index 00000000000..c0a1a051044 Binary files /dev/null and b/src/img/os/Rancher_iso2.png differ diff --git a/src/img/os/Rancher_iso3.png b/src/img/os/Rancher_iso3.png new file mode 100644 index 00000000000..988d750b4ff Binary files /dev/null and b/src/img/os/Rancher_iso3.png differ diff --git a/src/img/os/Rancher_iso4.png b/src/img/os/Rancher_iso4.png new file mode 100644 index 00000000000..817f41195b9 Binary files /dev/null and b/src/img/os/Rancher_iso4.png differ diff --git a/src/img/os/Rancher_iso5.png b/src/img/os/Rancher_iso5.png new file mode 100644 index 00000000000..ac2e73ae9ba Binary files /dev/null and b/src/img/os/Rancher_iso5.png differ diff --git a/src/img/os/Rancher_iso6.png b/src/img/os/Rancher_iso6.png new file mode 100644 index 00000000000..aa02e98ba74 Binary files /dev/null and b/src/img/os/Rancher_iso6.png differ diff --git a/src/img/os/Rancher_iso7.png b/src/img/os/Rancher_iso7.png new file mode 100644 index 00000000000..7372ecc38be Binary files /dev/null and b/src/img/os/Rancher_iso7.png differ diff --git a/src/img/os/Rancher_iso8.png b/src/img/os/Rancher_iso8.png new file mode 100644 index 00000000000..cbbcd27b00c Binary files /dev/null and b/src/img/os/Rancher_iso8.png differ diff --git a/src/img/os/Rancher_platform1.png b/src/img/os/Rancher_platform1.png new file mode 100644 index 00000000000..7791f2fe2f6 Binary files /dev/null and b/src/img/os/Rancher_platform1.png differ diff --git a/src/img/os/Rancher_platform2.png b/src/img/os/Rancher_platform2.png new file mode 100644 index 00000000000..eb1d085f7d2 Binary files /dev/null and b/src/img/os/Rancher_platform2.png differ diff --git a/src/img/os/cloud-config.png b/src/img/os/cloud-config.png new file mode 100644 index 00000000000..98f7db897de Binary files /dev/null and b/src/img/os/cloud-config.png differ diff --git a/src/img/os/rancheroshowitworks.png b/src/img/os/rancheroshowitworks.png new file mode 100644 index 00000000000..c29a4779ac9 Binary files /dev/null and b/src/img/os/rancheroshowitworks.png differ