Skip to content

Commit

Permalink
Replace incorrect "burmilla"s back to "rancher"s (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
benok authored Oct 7, 2024
1 parent c42fa2c commit 251a0a7
Show file tree
Hide file tree
Showing 30 changed files with 87 additions and 87 deletions.
2 changes: 1 addition & 1 deletion content/docs/additional-resources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ On OS X, `brew` is recommended to install those. On Linux, use your distro packa

To launch BurmillaOS in QEMU from your dev version, you can either use `make run`, or customise the vm using `./scripts/run` and its options. You can use `--append your.kernel=params here` and `--cloud-config your-cloud-config.yml` to configure the BurmillaOS instance you're launching.

You can SSH in using `./scripts/ssh`. Your SSH keys should have been populated (if you didn't provide your own cloud-config) so you won't need a password. If you don't have SSH keys, or something is wrong with your cloud-config, then the password is "`burmilla`".
You can SSH in using `./scripts/ssh`. Your SSH keys should have been populated (if you didn't provide your own cloud-config) so you won't need a password. If you don't have SSH keys, or something is wrong with your cloud-config, then the password is "`rancher`".

If you're on OS X, you can run BurmillaOS using [_xhyve_](https://github.com/mist64/xhyve) instead of QEMU: just pass `--xhyve` to `./scripts/run` and `./scripts/ssh`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You should use a private Docker registry so that `user-docker` and `system-docke
2. Set the private registry certificates for `user-docker`. For details, refer to [Certificates for Private Registries](/docs/configuration/docker/private-registries#certificates-for-private-registries)
3. Set the private registry certificates for `system-docker`. There are two ways to set the certificates:
- To set the private registry certificates before BurmillaOS starts, you can run a script included with BurmillaOS. For details, refer to [Set Custom Certs in ISO](/docs/configuration/advanced/airgap-configuration#set-custom-certs-in-iso).
- To set the private registry certificates after BurmillaOS starts, append your private registry certs to the `/etc/ssl/certs/ca-certificates.crt.burmilla` file. Then reboot to make the certs fully take effect.
- To set the private registry certificates after BurmillaOS starts, append your private registry certs to the `/etc/ssl/certs/ca-certificates.crt.rancher` file. Then reboot to make the certs fully take effect.
4. The images used by BurmillaOS should be pushed to your private registry.

## Set Custom Certs in ISO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ bookToc: false

The `resize_device` cloud config option can be used to automatically extend the first partition (assuming its `ext4`) to fill the size of it's device.

Once the partition has been resized to fill the device, a `/var/lib/burmilla/resizefs.done` file will be written to prevent the resize tools from being run again. If you need it to run again, delete that file and reboot.
Once the partition has been resized to fill the device, a `/var/lib/rancher/resizefs.done` file will be written to prevent the resize tools from being run again. If you need it to run again, delete that file and reboot.

```yaml
#cloud-config
Expand Down
4 changes: 2 additions & 2 deletions content/docs/configuration/advanced/running-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ You can automate running commands on boot using the `runcmd` cloud-config direct
```yaml
#cloud-config
runcmd:
- [ touch, /home/burmilla/test1 ]
- echo "test" > /home/burmilla/test2
- [ touch, /home/rancher/test1 ]
- echo "test" > /home/rancher/test2
```
Commands specified using `runcmd` will be executed within the context of the `console` container.
Expand Down
8 changes: 4 additions & 4 deletions content/docs/configuration/base/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ For more complicated settings, like the [sysctl settings](/docs/configuration/ad

### Getting Values

You can easily get any value that's been set in the `/var/lib/burmilla/conf/cloud-config.yml` file. Let's see how easy it is to get the DNS configuration of the system.
You can easily get any value that's been set in the `/var/lib/rancher/conf/cloud-config.yml` file. Let's see how easy it is to get the DNS configuration of the system.

```shell
$ sudo ros config get rancher.network.dns.nameservers
Expand All @@ -49,15 +49,15 @@ $ sudo ros config get rancher.network.dns.nameservers

### Setting Values

You can set values in the `/var/lib/burmilla/conf/cloud-config.yml` file.
You can set values in the `/var/lib/rancher/conf/cloud-config.yml` file.

Setting a simple value in the `/var/lib/burmilla/conf/cloud-config.yml`
Setting a simple value in the `/var/lib/rancher/conf/cloud-config.yml`

```shell
$ sudo ros config set rancher.docker.tls true
```

Setting a list in the `/var/lib/burmilla/conf/cloud-config.yml`
Setting a list in the `/var/lib/rancher/conf/cloud-config.yml`

```shell
$ sudo ros config set rancher.network.dns.nameservers "['8.8.8.8','8.8.4.4']"
Expand Down
4 changes: 2 additions & 2 deletions content/docs/configuration/base/ssh-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ ssh_authorized_keys:
- ssh-rsa BBB...ZZZ example2@burmilla
```
When we pass the cloud-config file during the `ros install` command, it will allow these ssh keys to be associated with the **burmilla** user. You can ssh into BurmillaOS using the key.
When we pass the cloud-config file during the `ros install` command, it will allow these ssh keys to be associated with the **rancher** user. You can ssh into BurmillaOS using the key.

```shell
$ ssh -i /path/to/private/key burmilla@<ip-address>
$ ssh -i /path/to/private/key rancher@<ip-address>
```

Please note that OpenSSH 7.0 and greater similarly disable the ssh-dss (DSA) public key algorithm. It too is weak and we recommend against its use.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/configuration/base/switching-consoles.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The default console is persistent. Persistent console means that the console con
/home
/opt
/var/lib/docker
/var/lib/burmilla
/var/lib/rancher
```
<br>
Expand Down
2 changes: 1 addition & 1 deletion content/docs/configuration/docker/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ OPTIONS:
When using `--authorized-keys`, you will need to put the key file in one of the following directories:

```
/var/lib/burmilla/
/var/lib/rancher/
/opt/
/home/
```
Expand Down
2 changes: 1 addition & 1 deletion content/docs/configuration/docker/private-registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Configuring authentication for the Docker client is not handled by the `registry
```yaml
#cloud-config
write_files:
- path: /home/burmilla/.docker/config.json
- path: /home/rancher/.docker/config.json
permissions: "0755"
owner: burmilla
content: |
Expand Down
4 changes: 2 additions & 2 deletions content/docs/configuration/docker/setting-up-docker-tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You also need client cert and key to access Docker via a TCP socket now:

```
$ sudo ros tls gen
INFO[0000] Out directory (-d, --dir) not specified, using default: /home/burmilla/.docker
INFO[0000] Out directory (-d, --dir) not specified, using default: /home/rancher/.docker
```

All the docker client TLS files are in `~/.docker` dir now.
Expand All @@ -46,7 +46,7 @@ $ docker --tlsverify version

Because all the necessary files are in the `~/.docker` dir, you don't need to specify them using `--tlscacert` `--tlscert` and `--tlskey` options. You also don't need `-H` to access Docker on localhost.

Copy the files from `/home/burmilla/.docker` to `$HOME/.docker` on your client machine if you need to access Docker on your BurmillaOS host from there.
Copy the files from `/home/rancher/.docker` to `$HOME/.docker` on your client machine if you need to access Docker on your BurmillaOS host from there.

On your client machine, set the Docker host and test out if Docker commands work.

Expand Down
8 changes: 4 additions & 4 deletions content/docs/installation/boot-process/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ Runs `ntpd` in a System Docker container.

This service provides the BurmillaOS user interface by running `sshd` and `getty`. It completes the BurmillaOS configuration on start up:

1. If the `rancher.password=<password>` kernel parameter exists, it sets `<password>` as the password for the `burmilla` user.
1. If the `rancher.password=<password>` kernel parameter exists, it sets `<password>` 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](/docs/configuration/base/#cloud-config).
3. Runs `cloud-init -execute`, which does the following:
* Updates `.ssh/authorized_keys` in `/home/burmilla` and `/home/docker` in the [cloud-config](/docs/configuration/base/ssh-keys) and metadata.
* Updates `.ssh/authorized_keys` in `/home/rancher` and `/home/docker` in the [cloud-config](/docs/configuration/base/ssh-keys) and metadata.
* Writes files specified by setting `write_files` in the [cloud-config](/docs/configuration/advanced/write-files).
* Resizes the device specified by setting `rancher.resize_device` in the [cloud-config](/docs/configuration/advanced/resizing-device-partition).
* Mount devices specified in the `mounts` in the [cloud-config](/docs/storage/additional-mounts).
* Set sysctl parameters specified in the`rancher.sysctl` [cloud-config](/docs/configuration/advanced/sysctl).
4. If user-data contained a file that started with `#!`, then a file would be saved at `/var/lib/burmilla/conf/cloud-config-script` during cloud-init and then executed. Any errors are ignored.
5. Runs `/opt/burmilla/bin/start.sh` if it exists and is executable. Any errors are ignored.
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.
5. Runs `/opt/rancher/bin/start.sh` if it exists and is executable. Any errors are ignored.
6. Runs `/etc/rc.local` if it exists and is executable. Any errors are ignored.

## Docker
Expand Down
12 changes: 6 additions & 6 deletions content/docs/installation/boot-process/cloud-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Userdata and metadata can be fetched from a cloud provider, VM runtime, or manag

## Userdata

Userdata is a file given by users when launching BurmillaOS hosts. It is stored in different locations depending on its format. If the userdata is a [cloud-config](/docs/configuration/base/#cloud-config) file, indicated by beginning with `#cloud-config` and being in YAML format, it is stored in `/var/lib/burmilla/conf/cloud-config.d/boot.yml`. If the userdata is a script, indicated by beginning with `#!`, it is stored in `/var/lib/burmilla/conf/cloud-config-script`.
Userdata is a file given by users when launching BurmillaOS hosts. It is stored in different locations depending on its format. If the userdata is a [cloud-config](/docs/configuration/base/#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

Although the specifics vary based on provider, a metadata file will typically contain information about the BurmillaOS host and contain additional configuration. Its primary purpose within BurmillaOS is to provide an alternate source for SSH keys and hostname configuration. For example, AWS launches hosts with a set of authorized keys and BurmillaOS obtains these via metadata. Metadata is stored in `/var/lib/burmilla/conf/metadata`.
Although the specifics vary based on provider, a metadata file will typically contain information about the BurmillaOS host and contain additional configuration. Its primary purpose within BurmillaOS is to provide an alternate source for SSH keys and hostname configuration. For example, AWS launches hosts with a set of authorized keys and BurmillaOS obtains these via metadata. Metadata is stored in `/var/lib/rancher/conf/metadata`.

## Configuration Load Order

[Cloud-config](/docs/configuration/base/#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.
3. Files in `/var/lib/burmilla/conf/cloud-config.d/` ordered by filename. If a file is passed in through user-data, it is written by cloud-init and saved as `/var/lib/burmilla/conf/cloud-config.d/boot.yml`.
4. `/var/lib/burmilla/conf/cloud-config.yml` - If you set anything with `ros config set`, the changes are saved in this file.
5. Kernel parameters with names starting with `burmilla`.
6. `/var/lib/burmilla/conf/metadata` - Metadata added by cloud-init.
3. Files in `/var/lib/rancher/conf/cloud-config.d/` ordered by filename. If a file is passed in through user-data, it is written by cloud-init and saved as `/var/lib/rancher/conf/cloud-config.d/boot.yml`.
4. `/var/lib/rancher/conf/cloud-config.yml` - If you set anything with `ros config set`, the changes are saved in this file.
5. Kernel parameters with names starting with `rancher`.
6. `/var/lib/rancher/conf/metadata` - Metadata added by cloud-init.
4 changes: 2 additions & 2 deletions content/docs/installation/boot-process/image-preloading.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ bookToc: false
---
# Image Preloading

On boot, BurmillaOS scans `/var/lib/burmilla/preload/docker` and `/var/lib/burmilla/preload/system-docker` directories and tries to load container image archives it finds there, with `docker load` and `system-docker load`.
On boot, BurmillaOS scans `/var/lib/rancher/preload/docker` and `/var/lib/rancher/preload/system-docker` directories and tries to load container image archives it finds there, with `docker load` and `system-docker load`.

The archives are `.tar` files, optionally compressed with `xz` or `gzip`. These can be produced by `docker save` command, e.g.:

```bash
$ docker save my-image1 my-image2 some-other/image3 | xz > my-images.tar.xz
```

The resulting files should be placed into `/var/lib/burmilla/preload/docker` or `/var/lib/burmilla/preload/system-docker` (depending on whether you want it preloaded into Docker or System Docker).
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 (`<archive>.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.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/installation/boot-process/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For example, on my current test system, I have set the kernel boot line to:
```shell
printk.devkmsg=on console=tty1 rancher.autologin=tty1 console=ttyS0 rancher.autologin=ttyS0 rancher.state.dev=LABEL=BURMILLA_STATE rancher.state.autoformat=[/dev/sda,/dev/vda] rancher.rm_usr loglevel=8 netconsole=+9999@10.0.2.14/,514@192.168.42.223/
printk.devkmsg=on console=tty1 rancher.autologin=tty1 console=ttyS0 rancher.autologin=ttyS0 rancher.state.dev=LABEL=RANCHER_STATE rancher.state.autoformat=[/dev/sda,/dev/vda] rancher.rm_usr loglevel=8 netconsole=+9999@10.0.2.14/,514@192.168.42.223/
```
The kernel boot parameters can be set during installation using `sudo ros install --append "...."`, or on an installed BurmillaOS system, by running `sudo ros config syslinux` (which will start vi in a container, editing the `global.cfg` boot config file.
2 changes: 1 addition & 1 deletion content/docs/installation/cloud/aliyun.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Since the image is private, we need to use the `Custom Images`.

![BurmillaOS on Aliyun 2](/images/BurmillaOS_aliyun2.jpg)

After the instance is successfully started, we can login with the `burmilla` user via SSH.
After the instance is successfully started, we can login with the `rancher` user via SSH.
4 changes: 2 additions & 2 deletions content/docs/installation/cloud/aws-ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ From a command line, log into the EC2 Instance. If you added ssh keys using a cl
both those keys, and the one you selected in the AWS UI will be installed.

```
$ ssh -i /Directory/of/MySSHKeyName.pem burmilla@<ip-of-ec2-instance>
$ ssh -i /Directory/of/MySSHKeyName.pem rancher@<ip-of-ec2-instance>
```

If you have issues logging into BurmillaOS, try using this command to help debug the issue.

```
$ ssh -v -i /Directory/of/MySSHKeyName.pem burmilla@<ip-of-ec2-instance>
$ ssh -v -i /Directory/of/MySSHKeyName.pem rancher@<ip-of-ec2-instance>
```

## Latest AMI Releases
Expand Down
4 changes: 2 additions & 2 deletions content/docs/installation/cloud/digital-ocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To start a BurmillaOS Droplet on Digital Ocean:
1. Click **Create.**


You can access the host via SSH after the Droplet is booted. The default user is `burmilla`.
You can access the host via SSH after the Droplet is booted. The default user is `rancher`.

Below is an example `cloud-config` file that you can use to initialize the Droplet with user data, such as deploying Rancher:

Expand All @@ -49,5 +49,5 @@ write_files:
done
done
docker run -d --restart=unless-stopped -p 80:80 -p 443:443 -v /opt/burmilla:/var/lib/burmilla burmilla/burmilla:${burmilla_version}
docker run -d --restart=unless-stopped -p 80:80 -p 443:443 -v /opt/rancher:/var/lib/rancher burmilla/burmilla:${burmilla_version}
```
Loading

0 comments on commit 251a0a7

Please sign in to comment.