mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-27 13:38:07 +00:00
Merge pull request #2947 from catherineluse/rancherd
Address feedback on RancherD docs #2935
This commit is contained in:
@@ -36,7 +36,7 @@ Part II explains how to convert the single-node Rancher installation into a high
|
|||||||
|
|
||||||
RancherD must be launched on a Linux OS. At this time, only OSes that leverage systemd are supported.
|
RancherD must be launched on a Linux OS. At this time, only OSes that leverage systemd are supported.
|
||||||
|
|
||||||
The Linux node needs to fulfill the [installation requirements]({{<baseurl>}}/rancher/v2.x/en/installation/requirements) for hardware and networking.
|
The Linux node needs to fulfill the [installation requirements]({{<baseurl>}}/rancher/v2.x/en/installation/requirements) for hardware and networking. Docker is not required for RancherD installs.
|
||||||
|
|
||||||
To install RancherD on SELinux Enforcing CentOS 8 nodes or RHEL 8 nodes, some [additional steps]({{<baseurl>}}/rancher/v2.x/en/installation/requirements/#rancherd-on-selinux-enforcing-centos-8-or-rhel-8-nodes) are required.
|
To install RancherD on SELinux Enforcing CentOS 8 nodes or RHEL 8 nodes, some [additional steps]({{<baseurl>}}/rancher/v2.x/en/installation/requirements/#rancherd-on-selinux-enforcing-centos-8-or-rhel-8-nodes) are required.
|
||||||
### Root Access
|
### Root Access
|
||||||
@@ -66,11 +66,15 @@ This endpoint can be set up using any number of approaches, such as:
|
|||||||
* Round-robin DNS
|
* Round-robin DNS
|
||||||
* Virtual or elastic IP addresses
|
* Virtual or elastic IP addresses
|
||||||
|
|
||||||
Note that the RancherD server process listens on port 9345 for new nodes to register. The Kubernetes API is served on port 6443, as normal. Configure your load balancer accordingly.
|
The following should be taken into consideration when configuring the load balancer or other endpoint:
|
||||||
|
|
||||||
|
- The RancherD server process listens on port 9345 for new nodes to register.
|
||||||
|
- The Kubernetes API is served on port 6443, as normal.
|
||||||
|
- In RancherD installs, the Rancher UI is served on port 8443 by default. (This is different from Helm chart installs, where port 443 is used by default.)
|
||||||
|
|
||||||
# Part I: Installing Rancher
|
# Part I: Installing Rancher
|
||||||
|
|
||||||
### 1. Set up the config.yaml
|
### 1. Set up Configurations
|
||||||
|
|
||||||
To avoid certificate errors with the fixed registration address, you should launch the server with the `tls-san` parameter set. This parameter should refer to your fixed registration address.
|
To avoid certificate errors with the fixed registration address, you should launch the server with the `tls-san` parameter set. This parameter should refer to your fixed registration address.
|
||||||
|
|
||||||
@@ -87,10 +91,14 @@ tls-san:
|
|||||||
|
|
||||||
The first server node establishes the secret token that other nodes would register with if they are added to the cluster.
|
The first server node establishes the secret token that other nodes would register with if they are added to the cluster.
|
||||||
|
|
||||||
If you do not specify a pre-shared secret, RancherD will generate one and place it at `/var/lib/rancher/rancherd/server/node-token`.
|
If you do not specify a pre-shared secret, RancherD will generate one and place it at `/var/lib/rancher/rke2/server/node-token`.
|
||||||
|
|
||||||
To specify your own pre-shared secret as the token, set the `token` argument on startup.
|
To specify your own pre-shared secret as the token, set the `token` argument on startup.
|
||||||
|
|
||||||
|
Installing Rancher this way will use Rancher-generated certificates. To use your own self-signed or trusted certificates, refer to the [configuration guide.]({{<baseurl>}}/rancher/v2.x/en/installation/install-rancher-on-linux/rancherd-configuration/#certificates-for-the-rancher-server)
|
||||||
|
|
||||||
|
For information on customizing the RancherD Helm chart values.yaml, refer to [this section.]({{<baseurl>}}/rancher/v2.x/en/installation/install-rancher-on-linux/rancherd-configuration/#customizing-the-rancherd-helm-chart)
|
||||||
|
|
||||||
### 2. Launch the first server node
|
### 2. Launch the first server node
|
||||||
|
|
||||||
Run the RancherD installer:
|
Run the RancherD installer:
|
||||||
@@ -99,6 +107,12 @@ Run the RancherD installer:
|
|||||||
curl -sfL https://get.rancher.io | sh -
|
curl -sfL https://get.rancher.io | sh -
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The RancherD version can be specified using the `INSTALL_RANCHERD_VERSION` environment variable:
|
||||||
|
|
||||||
|
```
|
||||||
|
curl -sfL https://get.rancher.io | INSTALL_RANCHERD_VERSION=v2.5.4-rc6 sh -
|
||||||
|
```
|
||||||
|
|
||||||
Once installed, the `rancherd` binary will be on your PATH. You can check out its help text like this:
|
Once installed, the `rancherd` binary will be on your PATH. You can check out its help text like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -138,6 +152,12 @@ kubectl get daemonset rancher -n cattle-system
|
|||||||
kubectl get pod -n cattle-system
|
kubectl get pod -n cattle-system
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you watch the pods, you will see the following pods installed:
|
||||||
|
|
||||||
|
- `helm-operation` pods in the `cattle-system` namespace
|
||||||
|
- a `rancher` pod and `rancher-webhook` pod in the `cattle-system` namespace
|
||||||
|
- a `fleet-agent`, `fleet-controller`, and `gitjob` pod in the `fleet-system` namespace
|
||||||
|
- a `rancher-operator` pod in the `rancher-operator-system` namespace
|
||||||
### 5. Set the initial Rancher password
|
### 5. Set the initial Rancher password
|
||||||
|
|
||||||
Once the `rancher` pod is up and running, run the following:
|
Once the `rancher` pod is up and running, run the following:
|
||||||
|
|||||||
+1
-1
@@ -56,7 +56,7 @@ spec:
|
|||||||
publicCA: true
|
publicCA: true
|
||||||
```
|
```
|
||||||
|
|
||||||
Put this manifest on your host in `/var/lib/rancher/rancherd/server/manifests` before running RancherD.
|
Put this manifest on your host in `/var/lib/rancher/rke2/server/manifests` before running RancherD.
|
||||||
|
|
||||||
### Common Options
|
### Common Options
|
||||||
|
|
||||||
|
|||||||
@@ -33,6 +33,8 @@ At this time, only Linux OSes that leverage systemd are supported.
|
|||||||
|
|
||||||
To install RancherD on SELinux Enforcing CentOS 8 or RHEL 8 nodes, some [additional steps](#rancherd-on-selinux-enforcing-centos-8-or-rhel-8-nodes) are required.
|
To install RancherD on SELinux Enforcing CentOS 8 or RHEL 8 nodes, some [additional steps](#rancherd-on-selinux-enforcing-centos-8-or-rhel-8-nodes) are required.
|
||||||
|
|
||||||
|
Docker is not required for RancherD installs.
|
||||||
|
|
||||||
### Requirements for Installing Rancher on an RKE Kubernetes Cluster
|
### Requirements for Installing Rancher on an RKE Kubernetes Cluster
|
||||||
|
|
||||||
For the container runtime, RKE should work with any modern Docker version, while K3s should work with any modern version of Docker or containerd.
|
For the container runtime, RKE should work with any modern Docker version, while K3s should work with any modern version of Docker or containerd.
|
||||||
@@ -65,8 +67,9 @@ If you plan to run Rancher on ARM64, see [Running on ARM64 (Experimental).]({{<b
|
|||||||
|
|
||||||
### Installing Docker
|
### Installing Docker
|
||||||
|
|
||||||
Docker can be installed by following the steps in the official [Docker documentation.](https://docs.docker.com/) Rancher also provides [scripts]({{<baseurl>}}/rancher/v2.x/en/installation/requirements/installing-docker) to install Docker with one command.
|
Docker is required for Helm chart installs, and it can be installed by following the steps in the official [Docker documentation.](https://docs.docker.com/) Rancher also provides [scripts]({{<baseurl>}}/rancher/v2.x/en/installation/requirements/installing-docker) to install Docker with one command.
|
||||||
|
|
||||||
|
Docker is not required for RancherD installs.
|
||||||
# Hardware Requirements
|
# Hardware Requirements
|
||||||
|
|
||||||
This section describes the CPU, memory, and disk requirements for the nodes where the Rancher server is installed.
|
This section describes the CPU, memory, and disk requirements for the nodes where the Rancher server is installed.
|
||||||
|
|||||||
Reference in New Issue
Block a user