Copy edits for RancherOS predefined image docs

This commit is contained in:
Catherine Luse
2019-06-26 16:42:17 -07:00
committed by Denise
parent 2a389c567c
commit 7c3b7e1f2c
@@ -31,7 +31,7 @@ $ make release
The `rancheros.iso` is ready to be used to [boot RancherOS from ISO]({{< baseurl >}}/os/v1.x/en/installation/running-rancheros/workstation/boot-from-iso/) or [launch RancherOS using Docker Machine]({{< baseurl >}}/os/v1.x/en/installation/running-rancheros/workstation/docker-machine).
### Creating a GCE Image Archive
## Creating a GCE Image Archive
Create a clone of the main [RancherOS repository](https://github.com/rancher/os) to your local machine with a `git clone`.
@@ -46,48 +46,50 @@ If you want to build GCE image based on RancherOS v1.4.0, you can run this comma
RANCHEROS_VERSION=v1.4.0 make build-gce
```
### Custom build cases
## Custom Build Cases
#### Reduce memory requirements
#### Reduce Memory Requirements
With the changes of the kernel and built docker, RancherOS booting requires more memory, please refer to [Memory Requirements]({{< baseurl >}}/os/v1.x/en/#hardware-requirements).
With changes to the kernel and built Docker, RancherOS booting requires more memory. For details, please refer to the [memory requirements]({{< baseurl >}}/os/v1.x/en/#hardware-requirements).
By customizing the ISO, you can reduce the memory usage on boot. The easiest way is to downgrade the built-in docker version, because docker takes up a lot of space.
This can effectively reduce the memory required to decompress the initrd on boot, using docker 17.03 is a good choice:
By customizing the ISO, you can reduce the memory usage on boot. The easiest way is to downgrade the built-in Docker version, because Docker takes up a lot of space.
This can effectively reduce the memory required to decompress the `initrd` on boot. Using docker 17.03 is a good choice:
```
# run make
$ USER_DOCKER_VERSION=17.03.2 make release
```
#### Building with a different console
#### Building with a Different Console
_Available as of v1.5.0_
When building RancherOS, you have the ability to automatically start in a supported [console]({{< baseurl >}}/os/v1.x/en/installation/switching-consoles/) instead of booting into the default console and switching to your desired one.
Here is an example of building RanchreOS and having the alpine console enabled:
Here is an example of building RancherOS and having the `alpine` console enabled:
```
$ OS_CONSOLE=alpine make release
```
#### Building with predefined docker images
#### Building with Predefined Docker Images
If you want to custom an ISO file to address your offline scenario, you can predefined images for system-docker and user-docker.
If you want to use a custom ISO file to address an offline scenario, you can use predefined images for `system-docker` and `user-docker`.
RancherOS supports `APPEND_SYSTEM_IMAGES`, it can save images to the initrd file, and loaded with system-docker when booting.
You can build ISO like this:
RancherOS supports `APPEND_SYSTEM_IMAGES`. It can save images to the `initrd` file, and is loaded with `system-docker` when booting.
You can build the ISO like this:
```
APPEND_SYSTEM_IMAGES="rancher/os-openvmtools:10.3.10-1" make release
```
RancherOS also supports APPEND_USER_IMAGES, it can save images to the initrd file, and loaded with user-docker when booting.
You can build ISO like this:
RancherOS also supports `APPEND_USER_IMAGES`. It can save images to the `initrd` file, and is loaded with `user-docker` when booting.
You can build the ISO like this:
```
APPEND_USER_IMAGES="alpine:3.9 ubuntu:bionic" make release
```
Please note that these will be packaged into the initrd, and the predefined images will take up the resource footprint at startup.
Please note that these will be packaged into the `initrd`, and the predefined images will affect the resource footprint at startup.