Rancher Manager

https://ranchermanager.docs.rancher.com
Admin
Rancher Manager is an enterprise container management platform designed to deploy, operate, and...
Tokens:570,582
Snippets:4,464
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and start firewalld

Source: https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/open-ports-with-firewalld

Install firewalld v7.x or later and start it. This is a prerequisite for the port configuration commands.

```shell
yum install firewalld
systemctl start firewalld
systemctl enable firewalld
```

--------------------------------

### Install and start RKE2 server

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher

Commands to install RKE2 and enable/start the server service.

```shell
curl -sfL https://get.rke2.io | sh -
systemctl enable rke2-server.service
systemctl start rke2-server.service
```

--------------------------------

### Example Output of Load Balancer Service

Source: https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks

Example output from the kubectl get service command, showing the EXTERNAL-IP (40.31.180.83) that should be saved for DNS setup.

```shell
NAME                       TYPE           CLUSTER-IP     EXTERNAL-IP    PORT(S)
 AGE
traefik  LoadBalancer   10.0.116.18    40.31.180.83   80:31229/TCP,443:31050/TCP 67s
```

--------------------------------

### Example output of kubectl get nodes

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher

Expected output showing two nodes with the master role after successful K3s setup.

```shell
ubuntu@ip-172-31-60-194:~$ sudo k3s kubectl get nodes
NAME               STATUS   ROLES    AGE    VERSION
ip-172-31-60-194   Ready    master   44m    v1.17.2+k3s1
ip-172-31-63-88    Ready    master   6m8s   v1.17.2+k3s1

```

--------------------------------

### Install K3s server with external datastore

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher

Run this command on the first Linux node to start the K3s server and connect it to the external datastore. Replace <VERSION> and <DATASTORE_ENDPOINT> with your values. The datastore endpoint can also be set via the environment variable $K3S_DATASTORE_ENDPOINT.

```shell
 curl -sfL https://get.k3s.io |  INSTALL_K3S_VERSION=<VERSION> sh -s - server \
   --datastore-endpoint="<DATASTORE_ENDPOINT>"

```

--------------------------------

### Provision RKE2 Server

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver

Installs and starts the RKE2 server, configures the bash environment, and displays the node token. The token is required for agent nodes to join. The output shows a redacted token.

```shell
sudo su
curl -sfL https://get.rke2.io | sh -
systemctl enable --now rke2-server

cat > /root/.bashrc << EOF
export PATH=$PATH:/var/lib/rancher/rke2/bin/
export KUBECONFIG=/etc/rancher/rke2/rke2.yaml
EOF

cat /var/lib/rancher/rke2/server/node-token
token: K10ca0c38d4ff90d8b80319ab34092e315a8b732622e6adf97bc9eb0536REDACTED::server:ec0308000b8a6b595da000efREDACTED
```

--------------------------------

### Deploy Hello World Manifest with kubectl create

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/test-hpas-with-kubectl

Command to deploy the hello-world manifest to the cluster. Replace <HELLO_WORLD_MANIFEST> with the path to the manifest file.

```shell
 # kubectl create -f <HELLO_WORLD_MANIFEST>
```

--------------------------------

### Get current Rancher Helm values

Source: https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades

Retrieves the current values from the installed Rancher Helm chart. The output shows an example value; there will be more values listed. Use this as the first step before upgrading.

```shell
helm get values rancher -n cattle-system

hostname: rancher.my.org

```

--------------------------------

### Install RKE2 using install.sh with artifact path

Source: https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes

Run the install script with the INSTALL_RKE2_ARTIFACT_PATH environment variable pointing to the directory containing the downloaded artifacts. Execute this on each server to install RKE2.

```shell
INSTALL_RKE2_ARTIFACT_PATH=/tmp/rke2-artifacts sh install.sh

```

--------------------------------

### Example output of kubectl get service traefik

Source: https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke

Example output from the kubectl get service command. The EXTERNAL-IP column (40.31.180.83) is the load balancer address to save for accessing Rancher.

```shell
NAME                       TYPE           CLUSTER-IP     EXTERNAL-IP                                                              PORT(S)
 AGE
traefik  LoadBalancer   10.0.116.18    40.31.180.83   80:31229/TCP,443:31050/TCP 27m
```

--------------------------------

### Basic kubectl commands for managing HPAs

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-resources-setup/horizontal-pod-autoscaler/manage-hpas-with-kubectl

Commands to create, view, and delete HPAs. Creating with a manifest uses 'kubectl create -f <HPA_MANIFEST>'. Creating without a manifest (only CPU) uses 'kubectl autoscale deployment hello-world --min=2 --max=5 --cpu-percent=50'. Viewing basic info uses 'kubectl get hpa hello-world', detailed info uses 'kubectl describe hpa hello-world', and deleting uses 'kubectl delete hpa hello-world'.

```bash
kubectl create -f <HPA_MANIFEST>
```

```bash
kubectl autoscale deployment hello-world --min=2 --max=5 --cpu-percent=50
```

```bash
kubectl get hpa hello-world
```

```bash
kubectl describe hpa hello-world
```

```bash
kubectl delete hpa hello-world
```

--------------------------------

### Example Output of Ingress Check

Source: https://ranchermanager.docs.rancher.com/troubleshooting/other-troubleshooting-tips/rancher-ha

Example output showing the ingress with the configured FQDN and addresses.

```shell
NAME      HOSTS                    ADDRESS                   PORTS     AGE
rancher   rancher.yourdomain.com   x.x.x.x,x.x.x.x,x.x.x.x   80, 443   2m
```

--------------------------------

### Install rancher-csp-adapter with values.yaml

Source: https://ranchermanager.docs.rancher.com/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter

Installs the adapter using a values.yaml file. Requires the values.yaml from the previous example.

```bash
  helm install rancher-csp-adapter rancher-charts/rancher-csp-adapter -f values.yaml --version $CSP_ADAPTER_VERSION
```

--------------------------------

### Example output for cattle-controllers lease

Source: https://ranchermanager.docs.rancher.com/troubleshooting/other-troubleshooting-tips/rancher-ha

Example output from the `kubectl -n kube-system get lease cattle-controllers` command. It shows the lease name, the current leader (holderIdentity), and the age of the lease.

```shell
NAME                 HOLDER                    AGE
cattle-controllers   rancher-dbc7ff869-gvg6k   6h10m
```

--------------------------------

### machineGlobalConfig Example

Source: https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration

Shows how to specify RKE2 configurations that apply to every node. Options available in standalone RKE2 can be applied here.

```yaml
machineGlobalConfig:
    etcd-arg:
        - key1=value1
        - key2=value2

```

--------------------------------

### Get Load Balancer IP with kubectl

Source: https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks

Run this command to get the address of the load balancer for the traefik service in the traefik namespace. The output shows the EXTERNAL-IP which should be saved for DNS setup.

```shell
kubectl get service traefik --namespace=traefik
```

--------------------------------

### values.yaml for rancher-csp-adapter

Source: https://ranchermanager.docs.rancher.com/integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/install-adapter

Example values.yaml for the CSP adapter. The account number must be a string (quoted) or installation fails.

```yaml
  aws:
    enabled: true
    accountNumber: "$MY_ACC_NUM"
    roleName: $MY_ROLE_NAME
  additionalTrustedCAs: true
```

--------------------------------

### Get Ceph monitor details with ceph mon dump

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/manage-clusters/create-kubernetes-persistent-storage/manage-persistent-storage/use-external-ceph-driver

Run this command on your SES cluster to get details about the Ceph monitor configuration. The output includes the fsid and mon addresses needed later for the ceph-csi driver installation.

```shell
ceph mon dump

```

--------------------------------

### Install rancher-backup charts from local files

Source: https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster

Installs the rancher-backup charts from local .tgz files on an air-gapped host, using private registry image settings.

```bash
helm install rancher-backup-crd ./rancher-backup-crd-<chart-version>.tgz -n cattle-resources-system --create-namespace
helm install rancher-backup ./rancher-backup-<chart-version>.tgz -n cattle-resources-system --set image.repository=<registry>/rancher/backup-restore-operator --set global.kubectl.repository=<registry>/rancher/kubectl
```

--------------------------------

### Install Rancher with Docker

Source: https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager/equinix-metal

Run this command from a shell connected to the Equinix Metal host to install Rancher. The container is started in detached mode with restart policy unless-stopped, exposes ports 80 and 443, and runs with privileged privileges.

```shell
sudo docker run -d --restart=unless-stopped -p 80:80 -p 443:443 --privileged rancher/rancher
```

--------------------------------

### Example output for kube-dns

Source: https://ranchermanager.docs.rancher.com/troubleshooting/other-troubleshooting-tips/dns

Example output when using kube-dns, showing a running kube-dns pod.

```shell
NAME                        READY   STATUS    RESTARTS   AGE
kube-dns-5fd74c7488-h6f7n   3/3     Running   0          4m13s
```

--------------------------------

### Expected kubectl Output

Source: https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway

Example output from the kubectl get gateway -A command, showing the bookinfo-gateway with an age of 64 minutes.

```shell
NAME               AGE
bookinfo-gateway   64m
```

--------------------------------

### Example Output of Pod Check

Source: https://ranchermanager.docs.rancher.com/troubleshooting/other-troubleshooting-tips/rancher-ha

Example output showing three Rancher pods running with 1/1 readiness.

```shell
NAME                       READY   STATUS    RESTARTS   AGE   IP          NODE
rancher-7dbd7875f7-n6t5t   1/1     Running   0          8m    x.x.x.x     x.x.x.x
rancher-7dbd7875f7-qbj5k   1/1     Running   0          8m    x.x.x.x     x.x.x.x
rancher-7dbd7875f7-qw7wb   1/1     Running   0          8m    x.x.x.x     x.x.x.x
```

--------------------------------

### Add new Helm chart repository for Rancher

Source: https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/resources/choose-a-rancher-version

Adds the Helm chart repository that you want to start installing Rancher from, replacing the removed one.

```shell
helm repo add rancher-<CHART_REPO> https://releases.rancher.com/server-charts/<CHART_REPO>
```

--------------------------------

### Install Rancher with Helm

Source: https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli

Installs Rancher using Helm into the cattle-system namespace. Requires a domain name that forwards traffic to the Linux machine; a fake domain like <IP_OF_LINUX_NODE>.sslip.io is used for this tutorial. Use the --version flag to install a specific Rancher version; otherwise the latest is installed. Includes both Linux/macOS and Windows PowerShell variants.

```shell
helm install rancher rancher-latest/rancher \
  --namespace cattle-system \
  --set hostname=<IP_OF_LINUX_NODE>.sslip.io \
  --set replicas=1 \
  --set bootstrapPassword=<PASSWORD_FOR_RANCHER_ADMIN>

# Windows Powershell
helm install rancher rancher-latest/rancher `
  --namespace cattle-system `
  --set hostname=<IP_OF_LINUX_NODE>.sslip.io `
  --set replicas=1 `
  --set bootstrapPassword=<PASSWORD_FOR_RANCHER_ADMIN>
```

--------------------------------

### Start and enable rke2-server service

Source: https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes

Start and enable the rke2-server service after creating the RKE2 configuration file on every node. Follow the RKE2 High Availability documentation for the configuration file.

```shell
systemctl enable rke2-server.service
systemctl start rke2-server.service

```

--------------------------------

### chartValues Example

Source: https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration

Shows how to specify values for system charts installed by RKE2. Use this field instead of HelmChartConfig via additionalManifest to avoid unexpected behavior.

```yaml
chartValues:
    chart-name:
        key: value

```
Tokens:
Raw