Edit RancherD docs

This commit is contained in:
cluse
2020-11-08 17:29:37 -07:00
parent 595eacabc1
commit 4073023474
2 changed files with 17 additions and 9 deletions
@@ -15,6 +15,7 @@ RancherD is a single binary that first launches an RKE2 Kubernetes cluster, then
- [Part II: High Availability](#part-ii-high-availability)
- [Upgrades](#upgrades)
- [Configuration](#configuration)
- [Uninstall](#uninstall)
- [RKE2 Documentation](#rke2-documentation)
# About RancherD Installs
@@ -74,12 +75,12 @@ To avoid certificate errors with the fixed registration address, you should laun
This option adds an additional hostname or IP as a Subject Alternative Name in the server's TLS cert, and it can be specified as a list if you would like to access the Kubernetes cluster via both the IP and the hostname.
Create the RancherD config file at `/etc/rancher/rancherd/config.yaml`:
Create the RancherD config file at `/etc/rancher/rke2/config.yaml`:
```yaml
token: my-shared-secret
tls-san:
- my-fixed-registration-address.com
- https://my-fixed-registration-address.com
- another-kubernetes-domain.com
```
@@ -133,11 +134,10 @@ Now, you can start issuing `kubectl` commands. Use the following commands to ver
```
kubectl get daemonset rancher -n cattle-system
kubectl get pod -n cattle-system
```
### 6. Set the initial Rancher password
### 5. Set the initial Rancher password
Once the `rancher` pod is up and running, run the following:
@@ -161,7 +161,7 @@ When following these steps, you should still be logged in as root.
Additional server nodes are launched much like the first, except that you must specify the `server` and `token` parameters so that they can successfully connect to the initial server node.
Here is an example of what the RancherD config file would look like for additional server nodes. By default, this config file is expected to be located at `/etc/rancher/rancherd/config.yaml`.
Here is an example of what the RancherD config file would look like for additional server nodes. By default, this config file is expected to be located at `/etc/rancher/rke2/config.yaml`.
```yaml
server: https://my-fixed-registration-address.com:9345
@@ -203,6 +203,14 @@ For information on upgrades and rollbacks, refer to [this page.](./upgrades)
For information on how to configure certificates, node taints, Rancher Helm chart options, or RancherD CLI options, refer to the [configuration reference.](./rancherd-configuration)
# Uninstall
To uninstall RancherD from your system, run the command below. This will shut down the process, remove the RancherD binary, and clean up files used by RancherD.
```
rancherd-uninstall.sh
```
# RKE2 Documentation
For more information on RKE2, the Kubernetes distribution used to provision the underlying cluster, refer to the documentation [here.](https://docs.rke2.io/)
@@ -96,7 +96,7 @@ It can be run with the following options:
| Option | Description |
|--------|-------------|
| `--config FILE, -c FILE` | Load configuration from FILE (default: "/etc/rancher/rancherd/config.yaml") |
| `--config FILE, -c FILE` | Load configuration from FILE (default: "/etc/rancher/rke2/config.yaml") |
### Logging
@@ -200,7 +200,7 @@ It can be run with the following options:
|--------|-------------|
| `--container-runtime-endpoint value` | Disable embedded containerd and use alternative CRI implementation |
| `--snapshotter value` | Override default containerd snapshotter (default: "overlayfs") |
| `--private-registry value` | Private registry configuration file (default: "/etc/rancher/rancherd/registries.yaml") |
| `--private-registry value` | Private registry configuration file (default: "/etc/rancher/rke2/registries.yaml") |
### Agent Networking
@@ -242,7 +242,7 @@ The following options are available.
| Option | Description |
|--------|-------------|
| `--config FILE, -c FILE` | Load configuration from FILE (default: "/etc/rancher/rancherd/config.yaml") |
| `--config FILE, -c FILE` | Load configuration from FILE (default: "/etc/rancher/rke2/config.yaml") |
### Data
@@ -280,7 +280,7 @@ The following options are available.
|--------|-------------|
| `--container-runtime-endpoint value` | Disable embedded containerd and use alternative CRI implementation |
| `--snapshotter value` | Override default containerd snapshotter (default: "overlayfs") |
| `--private-registry value` | Private registry configuration file (default: "/etc/rancher/rancherd/registries.yaml") |
| `--private-registry value` | Private registry configuration file (default: "/etc/rancher/rke2/registries.yaml") |
### Agent Networking