mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-29 14:38:50 +00:00
Remove unsupported front matter fields
This commit is contained in:
@@ -1,15 +1,7 @@
|
||||
---
|
||||
title: Backup
|
||||
weight: 50
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/after-installation/
|
||||
- /rancher/v2.0-v2.4/en/backups/
|
||||
- /rancher/v2.0-v2.4/en/backups/backups
|
||||
- /rancher/v2.0-v2.4/en/backups/legacy/backup
|
||||
- /rancher/v2.0-v2.4/en/backups/v2.0.x-v2.4.x/backup/
|
||||
- /rancher/v2.x/en/backups/v2.0.x-v2.4.x/
|
||||
- /rancher/v2.x/en/backups/v2.0.x-v2.4.x/backup/
|
||||
---
|
||||
|
||||
This section contains information about how to create backups of your Rancher data and how to restore them in a disaster scenario.
|
||||
|
||||
- Rancher server backups:
|
||||
|
||||
@@ -1,12 +1,7 @@
|
||||
---
|
||||
title: Restore
|
||||
weight: 1010
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/backups/restorations
|
||||
- /rancher/v2.0-v2.4/en/backups/legacy/restore
|
||||
- /rancher/v2.0-v2.4/en/backups/v2.0.x-v2.4.x/restore
|
||||
- /rancher/v2.x/en/backups/v2.0.x-v2.4.x/restore/
|
||||
---
|
||||
|
||||
If you lose the data on your Rancher Server, you can restore it if you have backups stored in a safe location.
|
||||
|
||||
- [Restoring backups for Rancher installed with Docker](../../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-docker-installed-rancher.md)
|
||||
|
||||
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: Contributing to Rancher
|
||||
weight: 27
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/faq/contributing/
|
||||
---
|
||||
|
||||
This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue.
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Skipped and Not Applicable Tests
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/cis-scans/legacy/skipped-tests
|
||||
- /rancher/v2.0-v2.4/en/cis-scans/v2.4/skipped-tests
|
||||
- /rancher/v2.0-v2.4/en/cis-scans/skipped-tests
|
||||
- /rancher/v2.x/en/cis-scans/v2.4/skipped-tests/
|
||||
---
|
||||
|
||||
This section lists the tests that are skipped in the permissive test profile for RKE.
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Default Alerts for Cluster Monitoring
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/alerts/default-alerts
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/alerts/cluster-alerts/default-alerts
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-alerts/default-alerts
|
||||
---
|
||||
|
||||
When you create a cluster, some alert rules are predefined. These alerts notify you about signs that the cluster could be unhealthy. You can receive these alerts if you configure a [notifier](../notifiers.md) for them.
|
||||
|
||||
+1
-8
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Elasticsearch
|
||||
weight: 200
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/tools/logging/elasticsearch/
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/logging/elasticsearch
|
||||
- /rancher/v2.0-v2.4/en/logging/legacy/cluster-logging/elasticsearch
|
||||
- /rancher/v2.0-v2.4/en/logging/v2.0.x-v2.4.x/cluster-logging/elasticsearch
|
||||
- /rancher/v2.x/en/logging/v2.0.x-v2.4.x/cluster-logging/elasticsearch/
|
||||
---
|
||||
|
||||
If your organization uses [Elasticsearch](https://www.elastic.co/), either on premise or in the cloud, you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Elasticsearch deployment to view logs.
|
||||
@@ -43,5 +36,5 @@ If your instance of Elasticsearch uses SSL, your **Endpoint** will need to begin
|
||||
|
||||
1. Select whether or not you want to verify your SSL.
|
||||
|
||||
* If you are using a self-signed certificate, select **Enabled - Input trusted server certificate**, provide the **CA Certificate PEM**. You can copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
* If you are using a self-signed certificate, select **Enabled - Input trusted server certificate**, provide the **CA Certificate PEM**. You can copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
* If you are using a certificate from a certificate authority, select **Enabled - Input trusted server certificate**. You do not need to provide a **CA Certificate PEM**.
|
||||
|
||||
+1
-7
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Fluentd
|
||||
weight: 600
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/logging/fluentd
|
||||
- /rancher/v2.0-v2.4/en/logging/legacy/cluster-logging/fluentd
|
||||
- /rancher/v2.0-v2.4/en/logging/v2.0.x-v2.4.x/cluster-logging/fluentd
|
||||
- /rancher/v2.x/en/logging/v2.0.x-v2.4.x/cluster-logging/fluentd/
|
||||
---
|
||||
|
||||
If your organization uses [Fluentd](https://www.fluentd.org/), you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Fluentd server to view logs.
|
||||
@@ -36,4 +30,4 @@ After adding all the Fluentd servers, you have the option to select **Enable Gzi
|
||||
|
||||
If your Fluentd servers are using TLS, you need to select **Use TLS**. If you are using a self-signed certificate, provide the **CA Certificate PEM**. You can copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
|
||||
>**Note:** Fluentd does not support self-signed certificates when client authentication is enabled.
|
||||
>**Note:** Fluentd does not support self-signed certificates when client authentication is enabled.
|
||||
|
||||
+1
-8
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Kafka
|
||||
weight: 400
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/tools/logging/kafka/
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/logging/kafka
|
||||
- /rancher/v2.0-v2.4/en/logging/legacy/cluster-logging/kafka
|
||||
- /rancher/v2.0-v2.4/en/logging/v2.0.x-v2.4.x/cluster-logging/kafka
|
||||
- /rancher/v2.x/en/logging/v2.0.x-v2.4.x/cluster-logging/kafka/
|
||||
---
|
||||
|
||||
If your organization uses [Kafka](https://kafka.apache.org/), you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Kafka server to view logs.
|
||||
@@ -32,7 +25,7 @@ If your Kafka cluster is using SSL for the **Broker**, you need to complete the
|
||||
|
||||
1. Provide the **CA Certificate PEM**. You can either copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
|
||||
>**Note:** Kafka does not support self-signed certificates when client authentication is enabled.
|
||||
>**Note:** Kafka does not support self-signed certificates when client authentication is enabled.
|
||||
|
||||
### SASL configuration
|
||||
|
||||
|
||||
+1
-10
@@ -1,14 +1,5 @@
|
||||
---
|
||||
title: Splunk
|
||||
weight: 300
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/tasks/logging/splunk/
|
||||
- /rancher/v2.0-v2.4/en/tools/logging/splunk/
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/logging/splunk
|
||||
- /rancher/v2.0-v2.4/en/logging/legacy/cluster-logging/splunk
|
||||
- /rancher/v2.0-v2.4/en/logging/v2.0.x-v2.4.x/cluster-logging/splunk
|
||||
- /rancher/v2.x/en/logging/v2.0.x-v2.4.x/cluster-logging/splunk/
|
||||
- /rancher/v2.x/en/cluster-admin/tools/logging/splunk
|
||||
---
|
||||
|
||||
If your organization uses [Splunk](https://www.splunk.com/), you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Splunk server to view logs.
|
||||
@@ -50,7 +41,7 @@ If your instance of Splunk uses SSL, your **Endpoint** will need to begin with `
|
||||
|
||||
1. Select whether or not you want to verify your SSL.
|
||||
|
||||
* If you are using a self-signed certificate, select **Enabled - Input trusted server certificate**, provide the **CA Certificate PEM**. You can copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
* If you are using a self-signed certificate, select **Enabled - Input trusted server certificate**, provide the **CA Certificate PEM**. You can copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
* If you are using a certificate from a certificate authority, select **Enabled - Input trusted server certificate**. You do not need to provide a **CA Certificate PEM**.
|
||||
|
||||
## Viewing Logs
|
||||
|
||||
+1
-8
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Syslog
|
||||
weight: 500
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/tools/logging/syslog/
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/logging/syslog
|
||||
- /rancher/v2.0-v2.4/en/logging/legacy/cluster-logging/syslog
|
||||
- /rancher/v2.0-v2.4/en/logging/v2.0.x-v2.4.x/cluster-logging/syslog
|
||||
- /rancher/v2.x/en/logging/v2.0.x-v2.4.x/cluster-logging/syslog/
|
||||
---
|
||||
|
||||
If your organization uses [Syslog](https://tools.ietf.org/html/rfc5424), you can configure Rancher to send it Kubernetes logs. Afterwards, you can log into your Syslog server to view logs.
|
||||
@@ -43,5 +36,5 @@ If your Syslog server is using **TCP** protocol and uses TLS, you need to select
|
||||
|
||||
1. Select whether or not you want to verify your SSL.
|
||||
|
||||
* If you are using a self-signed certificate, select **Enabled - Input trusted server certificate**, provide the **CA Certificate PEM**. You can copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
* If you are using a self-signed certificate, select **Enabled - Input trusted server certificate**, provide the **CA Certificate PEM**. You can copy and paste the certificate or upload it using the **Read from a file** button.
|
||||
* If you are using a certificate from a certificate authority, select **Enabled - Input trusted server certificate**. You do not need to provide a **CA Certificate PEM**.
|
||||
|
||||
-7
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Cluster Metrics
|
||||
weight: 3
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/tools/monitoring/cluster-metrics
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/monitoring/cluster-metrics
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/cluster-metrics
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/cluster-metrics
|
||||
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/cluster-metrics/
|
||||
---
|
||||
|
||||
_Available as of v2.2.0_
|
||||
|
||||
-7
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Prometheus Custom Metrics Adapter
|
||||
weight: 5
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/tools/monitoring/custom-metrics
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/custom-metrics
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/monitoring/custom-metrics/
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/custom-metrics
|
||||
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/custom-metrics/
|
||||
---
|
||||
|
||||
After you've enabled [cluster level monitoring](../../../pages-for-subheaders/cluster-monitoring.md), You can view the metrics data from Rancher. You can also deploy the Prometheus custom metrics adapter then you can use the HPA with metrics stored in cluster monitoring.
|
||||
|
||||
-7
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Prometheus Expressions
|
||||
weight: 4
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/tools/monitoring/expression
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/monitoring/expression
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/expression
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/expression
|
||||
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/expression/
|
||||
---
|
||||
|
||||
The PromQL expressions in this doc can be used to configure [alerts.](../../../pages-for-subheaders/cluster-alerts.md)
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Project Monitoring
|
||||
weight: 2
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/tools/monitoring
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/monitoring/project-monitoring
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/project-monitoring
|
||||
---
|
||||
|
||||
_Available as of v2.2.4_
|
||||
|
||||
-7
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Prometheus Configuration
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/tools/monitoring/prometheus
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/monitoring/prometheus/
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/prometheus
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/prometheus
|
||||
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/prometheus/
|
||||
---
|
||||
|
||||
_Available as of v2.2.0_
|
||||
|
||||
-7
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Viewing Metrics
|
||||
weight: 2
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/tools/monitoring/viewing-metrics
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/monitoring/viewing-metrics
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/monitoring/cluster-monitoring/viewing-metrics
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/viewing-metrics
|
||||
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/viewing-metrics/
|
||||
---
|
||||
|
||||
_Available as of v2.2.0_
|
||||
|
||||
+9
-16
@@ -1,14 +1,7 @@
|
||||
---
|
||||
title: CPU and Memory Allocations
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/istio/configuring-resource-allocations/
|
||||
- /rancher/v2.0-v2.4/en/project-admin/istio/config/
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/istio/resources
|
||||
- /rancher/v2.0-v2.4/en/istio/legacy/resources
|
||||
- /rancher/v2.0-v2.4/en/istio/v2.3.x-v2.4.x/resources
|
||||
- /rancher/v2.x/en/istio/v2.3.x-v2.4.x/resources/
|
||||
---
|
||||
|
||||
_Available as of v2.3.0_
|
||||
|
||||
This section describes the minimum recommended computing resources for the Istio components in a cluster.
|
||||
@@ -26,13 +19,13 @@ In Kubernetes, the resource request indicates that the workload will not deploye
|
||||
Workload | Container | CPU - Request | Mem - Request | CPU - Limit | Mem - Limit | Configurable
|
||||
---------|-----------|---------------|---------------|-------------|-------------|-------------
|
||||
istio-pilot |discovery| 500m | 2048Mi | 1000m | 4096Mi | Y
|
||||
istio-telemetry |mixer| 1000m | 1024Mi | 4800m | 4096Mi | Y
|
||||
istio-policy | mixer | 1000m | 1024Mi | 4800m | 4096Mi | Y
|
||||
istio-tracing | jaeger | 100m | 100Mi | 500m | 1024Mi | Y
|
||||
prometheus | prometheus | 750m | 750Mi | 1000m | 1024Mi | Y
|
||||
grafana | grafana | 100m | 100Mi | 200m | 512Mi | Y
|
||||
Others | - | 500m | 500Mi | - | - | N
|
||||
**Total** | **-** | **3950m** | **5546Mi** | **>12300m** | **>14848Mi** | **-**
|
||||
istio-telemetry |mixer| 1000m | 1024Mi | 4800m | 4096Mi | Y
|
||||
istio-policy | mixer | 1000m | 1024Mi | 4800m | 4096Mi | Y
|
||||
istio-tracing | jaeger | 100m | 100Mi | 500m | 1024Mi | Y
|
||||
prometheus | prometheus | 750m | 750Mi | 1000m | 1024Mi | Y
|
||||
grafana | grafana | 100m | 100Mi | 200m | 512Mi | Y
|
||||
Others | - | 500m | 500Mi | - | - | N
|
||||
**Total** | **-** | **3950m** | **5546Mi** | **>12300m** | **>14848Mi** | **-**
|
||||
|
||||
|
||||
## Configuring Resource Allocations
|
||||
@@ -43,7 +36,7 @@ To make it easier to schedule the workloads to a node, a cluster administrator c
|
||||
|
||||
You can find more information about Istio configuration in the [official Istio documentation](https://istio.io/docs/concepts/what-is-istio).
|
||||
|
||||
To configure the resources allocated to an Istio component,
|
||||
To configure the resources allocated to an Istio component,
|
||||
|
||||
1. In Rancher, go to the cluster where you have Istio installed.
|
||||
1. Click **Tools > Istio.** This opens the Istio configuration page.
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Disabling Istio
|
||||
weight: 4
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/istio/disabling-istio
|
||||
- /rancher/v2.0-v2.4/en/istio/legacy/disabling-istio
|
||||
- /rancher/v2.0-v2.4/en/istio/v2.3.x-v2.4.x/disabling-istio
|
||||
- /rancher/v2.x/en/istio/v2.3.x-v2.4.x/disabling-istio/
|
||||
---
|
||||
|
||||
This section describes how to disable Istio in a cluster, namespace, or workload.
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Role-based Access Control
|
||||
weight: 3
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/istio/rbac
|
||||
- /rancher/v2.0-v2.4/en/istio/legacy/rbac
|
||||
- /rancher/v2.0-v2.4/en/istio/v2.3.x-v2.4.x/rbac
|
||||
- /rancher/v2.x/en/istio/v2.3.x-v2.4.x/rbac/
|
||||
---
|
||||
|
||||
This section describes the permissions required to access Istio features and how to configure access to the Kiali and Jaeger visualizations.
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Release Notes
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/istio/release-notes
|
||||
- /rancher/v2.0-v2.4/en/istio/legacy/release-notes
|
||||
- /rancher/v2.0-v2.4/en/istio/v2.3.x-v2.4.x/release-notes
|
||||
- /rancher/v2.x/en/istio/v2.3.x-v2.4.x/release-notes/
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -1,13 +1,5 @@
|
||||
---
|
||||
title: Notifiers
|
||||
weight: 4
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/project-admin/tools/notifiers
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/notifiers
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/notifiers
|
||||
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/notifiers
|
||||
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/notifiers/
|
||||
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-alerts/default-alerts/
|
||||
---
|
||||
|
||||
Notifiers are services that inform you of alert events. You can configure notifiers to send alert notifications to staff best suited to take corrective action.
|
||||
|
||||
+1
-5
@@ -1,11 +1,7 @@
|
||||
---
|
||||
title: OPA Gatekeeper
|
||||
weight: 17
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/cluster-admin/tools/opa-gatekeeper
|
||||
- /rancher/v2.0-v2.4/en/opa-gatekeper/Open%20Policy%20Agent
|
||||
- /rancher/v2.0-v2.4/en/opa-gatekeper
|
||||
---
|
||||
|
||||
_Available as of v2.4.0_
|
||||
|
||||
To ensure consistency and compliance, every organization needs the ability to define and enforce policies in its environment in an automated way. [OPA (Open Policy Agent)](https://www.openpolicyagent.org/) is a policy engine that facilitates policy-based control for cloud native environments. Rancher provides the ability to enable OPA Gatekeeper in Kubernetes clusters, and also installs a couple of built-in policy definitions, which are also called constraint templates.
|
||||
|
||||
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: FAQ
|
||||
weight: 25
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/about/
|
||||
---
|
||||
|
||||
This FAQ is a work in progress designed to answers the questions our users most frequently ask about Rancher v2.x.
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Container Network Interface (CNI) Providers
|
||||
description: Learn about Container Network Interface (CNI), the CNI providers Rancher provides, the features they offer, and how to choose a provider for you
|
||||
weight: 2300
|
||||
---
|
||||
|
||||
## What is CNI?
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Installing and Configuring kubectl
|
||||
weight: 100
|
||||
---
|
||||
|
||||
`kubectl` is a CLI utility for running commands against Kubernetes clusters. It's required for many maintenance and administrative tasks in Rancher 2.x.
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Networking
|
||||
weight: 8005
|
||||
---
|
||||
|
||||
Networking FAQ's
|
||||
|
||||
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Rancher is No Longer Needed
|
||||
weight: 8010
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/removing-rancher/cleaning-cluster-nodes/
|
||||
- /rancher/v2.0-v2.4/en/installation/removing-rancher/
|
||||
- /rancher/v2.0-v2.4/en/admin-settings/removing-rancher/
|
||||
- /rancher/v2.0-v2.4/en/admin-settings/removing-rancher/rancher-cluster-nodes/
|
||||
---
|
||||
|
||||
This page is intended to answer questions about what happens if you don't want Rancher anymore, if you don't want a cluster to be managed by Rancher anymore, or if the Rancher server is deleted.
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
---
|
||||
title: Security
|
||||
weight: 8007
|
||||
|
||||
---
|
||||
|
||||
**Is there a Hardening Guide?**
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Technical
|
||||
weight: 8006
|
||||
---
|
||||
|
||||
### How can I reset the administrator password?
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Telemetry
|
||||
weight: 8008
|
||||
---
|
||||
|
||||
### What is Telemetry?
|
||||
|
||||
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: Questions about Upgrading to Rancher v2.x
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.x/en/faq/upgrades-to-2x/
|
||||
---
|
||||
|
||||
This page contains frequently asked questions about the changes between Rancher v1.x and v2.x, and how to upgrade from Rancher v1.x to v2.x.
|
||||
|
||||
-9
@@ -1,14 +1,5 @@
|
||||
---
|
||||
title: 4. Install Rancher
|
||||
weight: 400
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-installation/install-rancher/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-system-charts/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-for-private-reg/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/install-rancher
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap/install-rancher
|
||||
- /rancher/v2.0-v2.4/en/installation/options/air-gap-helm2/install-rancher
|
||||
- /rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/install-rancher/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: '3. Install Kubernetes with RKE (Kubernetes Installs Only)'
|
||||
weight: 300
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/install-kube
|
||||
- /rancher/v2.0-v2.4/en/installation/options/air-gap-helm2/launch-kubernetes
|
||||
- /rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/launch-kubernetes/
|
||||
---
|
||||
|
||||
This section is about how to prepare to launch a Kubernetes cluster which is used to deploy Rancher server for your air gapped environment.
|
||||
|
||||
-9
@@ -1,14 +1,5 @@
|
||||
---
|
||||
title: '2. Collect and Publish Images to your Private Registry'
|
||||
weight: 200
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-installation/prepare-private-reg/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/prepare-private-registry/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/prepare-private-registry/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/config-rancher-for-private-reg/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-for-private-reg/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/air-gap-helm2/populate-private-registry
|
||||
- /rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/populate-private-registry/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: '1. Prepare your Node(s)'
|
||||
weight: 100
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/provision-hosts
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/provision-host
|
||||
- /rancher/v2.0-v2.4/en/installation/options/air-gap-helm2/prepare-nodes
|
||||
- /rancher/v2.x/en/installation/resources/advanced/air-gap-helm2/prepare-nodes/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Template for an RKE Cluster with a Certificate Signed by Recognized CA and a Layer 4 Load Balancer
|
||||
weight: 3
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/cluster-yml-templates/3-node-certificate-recognizedca
|
||||
- /rancher/v2.x/en/installation/resources/advanced/cluster-yml-templates/3-node-certificate-recognizedca/
|
||||
---
|
||||
|
||||
RKE uses a cluster.yml file to install and configure your Kubernetes cluster.
|
||||
|
||||
+1
-4
@@ -1,10 +1,7 @@
|
||||
---
|
||||
title: Template for an RKE Cluster with a Self-signed Certificate and Layer 4 Load Balancer
|
||||
weight: 2
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/cluster-yml-templates/3-node-certificate
|
||||
- /rancher/v2.x/en/installation/resources/advanced/cluster-yml-templates/3-node-certificate/
|
||||
---
|
||||
|
||||
RKE uses a cluster.yml file to install and configure your Kubernetes cluster.
|
||||
|
||||
This template is intended to be used for RKE add-on installs, which are only supported up to Rancher v2.0.8. Please use the Rancher Helm chart if you are installing a newer Rancher version.
|
||||
|
||||
+1
-5
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Template for an RKE Cluster with a Self-signed Certificate and SSL Termination on Layer 7 Load Balancer
|
||||
weight: 3
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/cluster-yml-templates/3-node-externalssl-certificate
|
||||
- /rancher/v2.x/en/installation/resources/advanced/cluster-yml-templates/3-node-externalssl-certificate/
|
||||
---
|
||||
|
||||
RKE uses a cluster.yml file to install and configure your Kubernetes cluster.
|
||||
@@ -13,7 +9,7 @@ This template is intended to be used for RKE add-on installs, which are only sup
|
||||
The following template can be used for the cluster.yml if you have a setup with:
|
||||
|
||||
- Layer 7 load balancer with self-signed SSL termination (HTTPS)
|
||||
- [NGINX Ingress controller](https://kubernetes.github.io/ingress-nginx/)
|
||||
- [NGINX Ingress controller](https://kubernetes.github.io/ingress-nginx/)
|
||||
|
||||
> For more options, refer to [RKE Documentation: Config Options](https://rancher.com/docs/rke/latest/en/config-options/).
|
||||
|
||||
|
||||
+1
-5
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Template for an RKE Cluster with a Recognized CA Certificate and SSL Termination on Layer 7 Load Balancer
|
||||
weight: 4
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/cluster-yml-templates/3-node-externalssl-recognizedca
|
||||
- /rancher/v2.x/en/installation/resources/advanced/cluster-yml-templates/3-node-externalssl-recognizedca/
|
||||
---
|
||||
|
||||
RKE uses a cluster.yml file to install and configure your Kubernetes cluster.
|
||||
@@ -13,7 +9,7 @@ This template is intended to be used for RKE add-on installs, which are only sup
|
||||
The following template can be used for the cluster.yml if you have a setup with:
|
||||
|
||||
- Layer 7 load balancer with SSL termination (HTTPS)
|
||||
- [NGINX Ingress controller](https://kubernetes.github.io/ingress-nginx/)
|
||||
- [NGINX Ingress controller](https://kubernetes.github.io/ingress-nginx/)
|
||||
|
||||
> For more options, refer to [RKE Documentation: Config Options](https://rancher.com/docs/rke/latest/en/config-options/).
|
||||
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Docker Install with TLS Termination at Layer-7 NGINX Load Balancer
|
||||
weight: 252
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/single-node/single-node-install-external-lb/
|
||||
- /rancher/v2.0-v2.4/en/installation/other-installation-methods/single-node-docker/single-node-install-external-lb
|
||||
- /rancher/v2.0-v2.4/en/installation/options/single-node-install-external-lb
|
||||
- /rancher/v2.0-v2.4/en/installation/single-node-install-external-lb
|
||||
---
|
||||
|
||||
For development and testing environments that have a special requirement to terminate TLS/SSL at a load balancer instead of your Rancher Server container, deploy Rancher and configure a load balancer to work with it conjunction.
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Enabling the API Audit Log to Record System Events
|
||||
weight: 4
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/api-audit-log/
|
||||
- /rancher/v2.0-v2.4/en/installation/api-auditing
|
||||
---
|
||||
|
||||
You can enable the API audit log to record the sequence of system events initiated by individual users. You can know what happened, when it happened, who initiated it, and what cluster it affected. When you enable this feature, all requests to the Rancher API and all responses from it are written to a log.
|
||||
|
||||
+2
-5
@@ -1,10 +1,7 @@
|
||||
---
|
||||
title: NGINX
|
||||
weight: 270
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/create-nodes-lb/nginx
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/create-nodes-lb/nginx/
|
||||
---
|
||||
|
||||
NGINX will be configured as Layer 4 load balancer (TCP) that forwards connections to one of your Rancher nodes.
|
||||
|
||||
>**Note:**
|
||||
@@ -29,7 +26,7 @@ After installing NGINX, you need to update the NGINX configuration file, `nginx.
|
||||
>**Note:** See [NGINX Documentation: TCP and UDP Load Balancing](https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/) for all configuration options.
|
||||
|
||||
<figcaption>Example NGINX config</figcaption>
|
||||
|
||||
|
||||
```
|
||||
worker_processes 4;
|
||||
worker_rlimit_nofile 40000;
|
||||
|
||||
+1
-4
@@ -1,10 +1,7 @@
|
||||
---
|
||||
title: Amazon NLB
|
||||
weight: 277
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/create-nodes-lb/nlb
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/create-nodes-lb/nlb/
|
||||
---
|
||||
|
||||
## Objectives
|
||||
|
||||
Configuring an Amazon NLB is a multistage process. We've broken it down into multiple tasks so that it's easy to follow.
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
weight: 276
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/helm-init/troubleshooting
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/helm-init/troubleshooting/
|
||||
---
|
||||
|
||||
### Helm commands show forbidden
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Chart Options
|
||||
weight: 276
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/helm-rancher/chart-options
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/helm-rancher/chart-options/
|
||||
---
|
||||
|
||||
### Common Options
|
||||
|
||||
+1
-5
@@ -1,10 +1,6 @@
|
||||
---
|
||||
title: Adding Kubernetes TLS Secrets
|
||||
description: Read about how to populate the Kubernetes TLS secret for a Rancher installation
|
||||
weight: 276
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/helm-rancher/tls-secrets
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/helm-rancher/tls-secrets/
|
||||
description: Read about how to populate the Kubernetes TLS secret for a Rancher installation
|
||||
---
|
||||
|
||||
Kubernetes will create all the objects and services for Rancher, but it will not become available until we populate the `tls-rancher-ingress` secret in the `cattle-system` namespace with the certificate and key.
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
weight: 276
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/helm-rancher/troubleshooting
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/helm-rancher/troubleshooting/
|
||||
---
|
||||
|
||||
### Where is everything
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
weight: 276
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/kubernetes-rke/troubleshooting
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/kubernetes-rke/troubleshooting/
|
||||
---
|
||||
|
||||
### canal Pods show READY 2/3
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Enable API Auditing
|
||||
weight: 300
|
||||
aliases:
|
||||
- /rke/latest/en/config-options/add-ons/api-auditing/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/api-auditing
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/api-auditing/
|
||||
---
|
||||
|
||||
>**Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Amazon NLB Configuration
|
||||
weight: 277
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/ha-server-install/nlb/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/layer-4-lb/nlb
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/layer-4-lb/nlb/
|
||||
---
|
||||
|
||||
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Amazon ALB Configuration
|
||||
weight: 277
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/ha-server-install-external-lb/alb/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/layer-7-lb/alb
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/alb/
|
||||
---
|
||||
|
||||
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: NGINX Configuration
|
||||
weight: 277
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/ha-server-install-external-lb/nginx/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/layer-7-lb/nginx
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/layer-7-lb/nginx/
|
||||
---
|
||||
|
||||
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: HTTP Proxy Configuration
|
||||
weight: 277
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/proxy
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/proxy/
|
||||
---
|
||||
|
||||
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: 404 - default backend
|
||||
weight: 30
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/troubleshooting-ha/404-default-backend/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/troubleshooting/404-default-backend
|
||||
- /404-default-backend/
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/404-default-backend/
|
||||
---
|
||||
|
||||
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Generic troubleshooting
|
||||
weight: 5
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/troubleshooting-ha/generic-troubleshooting/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/troubleshooting/generic-troubleshooting
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/generic-troubleshooting/
|
||||
---
|
||||
|
||||
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Failed to get job complete status
|
||||
weight: 20
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/troubleshooting-ha/job-complete-status/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/troubleshooting/job-complete-status
|
||||
- /rancher/v2.x/en/installation/resources/advanced/helm2/rke-add-on/troubleshooting/job-complete-status/
|
||||
---
|
||||
|
||||
> #### **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Opening Ports with firewalld
|
||||
weight: 1
|
||||
---
|
||||
|
||||
> We recommend disabling firewalld. For Kubernetes 1.19.x and higher, firewalld must be turned off.
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Kubernetes Install with External Load Balancer (TCP/Layer 4)
|
||||
weight: 275
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/ha/rke-add-on/layer-4-lb
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/rke-add-on/layer-4-lb
|
||||
- /rancher/v2.0-v2.4/en/installation/options/rke-add-on/layer-4-lb
|
||||
- /rancher/v2.x/en/installation/resources/advanced/rke-add-on/layer-4-lb/
|
||||
---
|
||||
import SSlFaqHa from '@site/src/components/SslFaqHa'
|
||||
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Kubernetes Install with External Load Balancer (HTTPS/Layer 7)
|
||||
weight: 276
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/ha/rke-add-on/layer-7-lb
|
||||
- /rancher/v2.0-v2.4/en/installation/options/rke-add-on/layer-7-lb/
|
||||
- /rancher/v2.0-v2.4/en/installation/options/rke-add-on/layer-7-lb
|
||||
- /rancher/v2.x/en/installation/resources/advanced/rke-add-on/layer-7-lb/
|
||||
---
|
||||
import SslFaqHa from '@site/src/components/SslFaqHa'
|
||||
|
||||
|
||||
-3
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: Tuning etcd for Large Installations
|
||||
weight: 2
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/etcd
|
||||
---
|
||||
|
||||
When running larger Rancher installations with 15 or more clusters it is recommended to increase the default keyspace for etcd from the default 2GB. The maximum setting is 8GB and the host should have enough RAM to keep the entire dataset in memory. When increasing this value you should also increase the size of the host. The keyspace size can also be adjusted in smaller installations if you anticipate a high rate of change of pods during the garbage collection interval.
|
||||
|
||||
-3
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: UI for Istio Virtual Services and Destination Rules
|
||||
weight: 2
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/feature-flags/istio-virtual-service-ui
|
||||
---
|
||||
|
||||
This feature enables a UI that lets you create, read, update and delete virtual services and destination rules, which are traffic management features of Istio.
|
||||
|
||||
+5
-8
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: "Running on ARM64 (Experimental)"
|
||||
weight: 3
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/arm64-platform
|
||||
---
|
||||
|
||||
> **Important:**
|
||||
@@ -15,18 +12,18 @@ The following options are available when using an ARM64 platform:
|
||||
- Only for Docker Install. Please note that the following installation command replaces the examples found in the [Docker Install](../../../../pages-for-subheaders/rancher-on-a-single-node-with-docker.md) link:
|
||||
|
||||
```
|
||||
# In the last line `rancher/rancher:vX.Y.Z`, be certain to replace "X.Y.Z" with a released version in which ARM64 builds exist. For example, if your matching version is v2.5.8, you would fill in this line with `rancher/rancher:v2.5.8`.
|
||||
# In the last line `rancher/rancher:vX.Y.Z`, be certain to replace "X.Y.Z" with a released version in which ARM64 builds exist. For example, if your matching version is v2.5.8, you would fill in this line with `rancher/rancher:v2.5.8`.
|
||||
docker run -d --restart=unless-stopped \
|
||||
-p 80:80 -p 443:443 \
|
||||
--privileged \
|
||||
rancher/rancher:vX.Y.Z
|
||||
rancher/rancher:vX.Y.Z
|
||||
```
|
||||
> **Note:** To check if your specific released version is compatible with the ARM64 architecture, you may navigate to your
|
||||
> **Note:** To check if your specific released version is compatible with the ARM64 architecture, you may navigate to your
|
||||
> version's release notes in the following two ways:
|
||||
>
|
||||
> - Manually find your version using https://github.com/rancher/rancher/releases.
|
||||
> - Go directly to your version using the tag and the specific version number. If you plan to use v2.5.8, for example, you may
|
||||
> navigate to https://github.com/rancher/rancher/releases/tag/v2.5.8.
|
||||
> - Go directly to your version using the tag and the specific version number. If you plan to use v2.5.8, for example, you may
|
||||
> navigate to https://github.com/rancher/rancher/releases/tag/v2.5.8.
|
||||
|
||||
- Create custom cluster and adding ARM64 based node(s)
|
||||
- Kubernetes cluster version must be 1.12 or higher
|
||||
|
||||
-3
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: Allow Unsupported Storage Drivers
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/feature-flags/enable-not-default-storage-drivers/
|
||||
---
|
||||
|
||||
This feature allows you to use types for storage providers and provisioners that are not enabled by default.
|
||||
|
||||
-8
@@ -1,13 +1,5 @@
|
||||
---
|
||||
title: Rollbacks
|
||||
weight: 3
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/upgrades/rollbacks
|
||||
- /rancher/v2.0-v2.4/en/installation/upgrades-rollbacks/rollbacks
|
||||
- /rancher/v2.0-v2.4/en/upgrades/ha-server-rollbacks
|
||||
- /rancher/v2.0-v2.4/en/upgrades/rollbacks/ha-server-rollbacks
|
||||
- /rancher/v2.0-v2.4/en/installation/upgrades-rollbacks/rollbacks/ha-server-rollbacks
|
||||
- /rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades-rollbacks/rollbacks
|
||||
---
|
||||
|
||||
### Rolling Back to Rancher v2.2-v2.4
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Troubleshooting the Rancher Server Kubernetes Cluster
|
||||
weight: 276
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/k8s-install/helm-rancher/troubleshooting
|
||||
- /rancher/v2.0-v2.4/en/installation/ha/kubernetes-rke/troubleshooting
|
||||
- /rancher/v2.0-v2.4/en/installation/k8s-install/kubernetes-rke/troubleshooting
|
||||
- /rancher/v2.0-v2.4/en/installation/options/troubleshooting
|
||||
---
|
||||
|
||||
This section describes how to troubleshoot an installation of Rancher on a Kubernetes cluster.
|
||||
|
||||
-8
@@ -1,13 +1,5 @@
|
||||
---
|
||||
title: Upgrading Rancher Installed on Kubernetes with Helm 2
|
||||
weight: 1050
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/upgrades/upgrades/ha/helm2
|
||||
- /rancher/v2.0-v2.4/en/upgrades/helm2
|
||||
- /rancher/v2.0-v2.4/en/installation/upgrades-rollbacks/upgrades/ha/helm2
|
||||
- /rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades/ha/helm2
|
||||
- /rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades/helm2
|
||||
- /rancher/v2.x/en/installation/install-rancher-on-k8s/upgrades/helm2/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-8
@@ -1,13 +1,5 @@
|
||||
---
|
||||
title: Migrating from a Kubernetes Install with an RKE Add-on
|
||||
weight: 1030
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/upgrades/ha-server-upgrade/
|
||||
- /rancher/v2.0-v2.4/en/upgrades/upgrades/ha-server-upgrade/
|
||||
- /rancher/v2.0-v2.4/en/upgrades/upgrades/migrating-from-rke-add-on
|
||||
- /rancher/v2.0-v2.4/en/installation/upgrades-rollbacks/upgrades/migrating-from-rke-add-on
|
||||
- /rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades/migrating-from-rke-add-on
|
||||
- /rancher/v2.x/en/installation/install-rancher-on-k8s/upgrades/migrating-from-rke-add-on/
|
||||
---
|
||||
|
||||
> **Important: RKE add-on install is only supported up to Rancher v2.0.8**
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Upgrading to v2.0.7+ — Namespace Migration
|
||||
weight: 1040
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/upgrades/upgrades/namespace-migration
|
||||
- /rancher/v2.0-v2.4/en/installation/upgrades-rollbacks/upgrades/namespace-migration
|
||||
- /rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades-rollbacks/upgrades/namespace-migration
|
||||
- /rancher/v2.x/en/installation/install-rancher-on-k8s/upgrades/namespace-migration/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Installing Docker
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Docker is required to be installed on nodes where the Rancher server will be installed with Helm or Docker.
|
||||
|
||||
-1
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Port Requirements
|
||||
description: Read about port requirements needed in order for Rancher to operate properly, both for Rancher nodes and downstream Kubernetes cluster nodes
|
||||
weight: 300
|
||||
---
|
||||
|
||||
import PortsIaasNodes from '@site/src/components/PortsIaasNodes'
|
||||
|
||||
-3
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: '1. Set up Infrastructure and Private Registry'
|
||||
weight: 100
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/provision-host
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-3
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: '3. Install Kubernetes (Skip for Docker Installs)'
|
||||
weight: 300
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/install-kube
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-7
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: 4. Install Rancher
|
||||
weight: 400
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-system-charts/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-for-private-reg/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/install-rancher
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap/install-rancher
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/install-rancher/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: '2. Collect and Publish Images to your Private Registry'
|
||||
weight: 200
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/prepare-private-registry/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/prepare-private-registry/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/config-rancher-for-private-reg/
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-for-private-reg/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: '2. Install Kubernetes'
|
||||
weight: 200
|
||||
---
|
||||
|
||||
Once the infrastructure is ready, you can continue with setting up an RKE cluster to install Rancher in.
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: 3. Install Rancher
|
||||
weight: 300
|
||||
---
|
||||
|
||||
Now that you have a running RKE cluster, you can install Rancher in it. For security reasons all traffic to Rancher must be encrypted with TLS. For this tutorial you are going to automatically issue a self-signed certificate through [cert-manager](https://cert-manager.io/). In a real-world use-case you will likely use Let's Encrypt or provide your own certificate.
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: '1. Set up Infrastructure'
|
||||
weight: 100
|
||||
---
|
||||
|
||||
In this section, you will provision the underlying infrastructure for your Rancher management server with internete access through a HTTP proxy.
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Certificate Troubleshooting
|
||||
weight: 4
|
||||
---
|
||||
### How Do I Know if My Certificates are in PEM Format?
|
||||
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: Rolling Back Rancher Installed with Docker
|
||||
weight: 1015
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/upgrades/single-node-rollbacks
|
||||
- /rancher/v2.0-v2.4/en/upgrades/rollbacks/single-node-rollbacks
|
||||
---
|
||||
|
||||
If a Rancher upgrade does not complete successfully, you'll have to roll back to your Rancher setup that you were using before [Docker Upgrade](./upgrade-docker-installed-rancher.md). Rolling back restores:
|
||||
|
||||
-7
@@ -1,12 +1,5 @@
|
||||
---
|
||||
title: Upgrading Rancher Installed with Docker
|
||||
weight: 1010
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/upgrades/single-node-upgrade/
|
||||
- /rancher/v2.0-v2.4/en/upgrades/upgrades/single-node-air-gap-upgrade
|
||||
- /rancher/v2.0-v2.4/en/upgrades/upgrades/single-node
|
||||
- /rancher/v2.0-v2.4/en/upgrades/upgrades/single-node-upgrade/
|
||||
- /rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/upgrades/upgrades/single-node/
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
+1
-2
@@ -1,13 +1,12 @@
|
||||
---
|
||||
title: Adding TLS Secrets
|
||||
weight: 2
|
||||
---
|
||||
|
||||
Kubernetes will create all the objects and services for Rancher, but it will not become available until we populate the `tls-rancher-ingress` secret in the `cattle-system` namespace with the certificate and key.
|
||||
|
||||
Combine the server certificate followed by any intermediate certificate(s) needed into a file named `tls.crt`. Copy your certificate key into a file named `tls.key`.
|
||||
|
||||
For example, [acme.sh](https://acme.sh) provides server certificate and CA chains in `fullchain.cer` file.
|
||||
For example, [acme.sh](https://acme.sh) provides server certificate and CA chains in `fullchain.cer` file.
|
||||
This `fullchain.cer` should be renamed to `tls.crt` & certificate key file as `tls.key`.
|
||||
|
||||
Use `kubectl` with the `tls` secret type to create the secrets.
|
||||
|
||||
-3
@@ -1,8 +1,5 @@
|
||||
---
|
||||
title: Choosing a Rancher Version
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/server-tags
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-4
@@ -1,9 +1,5 @@
|
||||
---
|
||||
title: About Custom CA Root Certificates
|
||||
weight: 1
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/custom-ca-root-certificate/
|
||||
- /rancher/v2.0-v2.4/en/installation/resources/choosing-version/encryption/custom-ca-root-certificate
|
||||
---
|
||||
|
||||
If you're using Rancher in an internal production environment where you aren't exposing apps publicly, use a certificate from a private certificate authority (CA).
|
||||
|
||||
-6
@@ -1,11 +1,5 @@
|
||||
---
|
||||
title: Helm Version Requirements
|
||||
weight: 3
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm-version
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/helm-init
|
||||
- /rancher/v2.0-v2.4/en/installation/options/helm2/helm-rancher
|
||||
---
|
||||
|
||||
This section contains the requirements for Helm, which is the tool used to install Rancher on a high-availability Kubernetes cluster.
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Setting up Local System Charts for Air Gapped Installations
|
||||
weight: 120
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-single-node/config-rancher-system-charts/_index.md
|
||||
- /rancher/v2.0-v2.4/en/installation/air-gap-high-availability/config-rancher-system-charts/_index.md
|
||||
- /rancher/v2.0-v2.4/en/installation/options/local-system-charts
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
+4
-5
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Updating the Rancher Certificate
|
||||
weight: 10
|
||||
---
|
||||
|
||||
# Updating a Private CA Certificate
|
||||
@@ -76,7 +75,7 @@ Also get the version string of the currently deployed Rancher chart:
|
||||
$ helm ls -A
|
||||
```
|
||||
|
||||
Upgrade the Helm application instance using the original configuration values and making sure to specify `ingress.tls.source=secret` as well as the current chart version to prevent an application upgrade.
|
||||
Upgrade the Helm application instance using the original configuration values and making sure to specify `ingress.tls.source=secret` as well as the current chart version to prevent an application upgrade.
|
||||
|
||||
If the certificate was signed by a private CA, add the `set privateCA=true` argument as well. Also make sure to read the documentation describing the initial installation using custom certificates.
|
||||
|
||||
@@ -207,7 +206,7 @@ Also get the version string of the currently deployed Rancher chart:
|
||||
$ helm ls -A
|
||||
```
|
||||
|
||||
Upgrade the Helm application instance using the original configuration values and making sure to specify the current chart version to prevent an application upgrade.
|
||||
Upgrade the Helm application instance using the original configuration values and making sure to specify the current chart version to prevent an application upgrade.
|
||||
|
||||
Also make sure to read the documentation describing the initial installation using custom certificates.
|
||||
|
||||
@@ -219,9 +218,9 @@ helm upgrade rancher rancher-stable/rancher \
|
||||
--set ...
|
||||
```
|
||||
|
||||
On upgrade, you can either
|
||||
On upgrade, you can either
|
||||
|
||||
- remove `--set ingress.tls.source=secret \` from the Helm upgrade command, as shown above, or
|
||||
- remove `--set ingress.tls.source=secret \` from the Helm upgrade command, as shown above, or
|
||||
|
||||
- remove the `privateCA` parameter or set it to `false` because the CA is valid:
|
||||
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Upgrading Cert-Manager with Helm 2
|
||||
weight: 2040
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/upgrading-cert-manager/helm-2-instructions
|
||||
- /rancher/v2.0-v2.4/en/installation/resources/choosing-version/encryption/upgrading-cert-manager/helm-2-instructions
|
||||
- /rancher/v2.x/en/installation/resources/upgrading-cert-manager/helm-2-instructions/
|
||||
---
|
||||
|
||||
Rancher uses cert-manager to automatically generate and renew TLS certificates for HA deployments of Rancher. As of Fall 2019, three important changes to cert-manager are set to occur that you need to take action on if you have an HA deployment of Rancher:
|
||||
|
||||
-5
@@ -1,10 +1,5 @@
|
||||
---
|
||||
title: Upgrading Cert-Manager
|
||||
weight: 4
|
||||
aliases:
|
||||
- /rancher/v2.0-v2.4/en/installation/options/upgrading-cert-manager
|
||||
- /rancher/v2.0-v2.4/en/installation/options/upgrading-cert-manager/helm-2-instructions
|
||||
- /rancher/v2.0-v2.4/en/installation/resources/encryption/upgrading-cert-manager
|
||||
---
|
||||
|
||||
Rancher uses cert-manager to automatically generate and renew TLS certificates for HA deployments of Rancher. As of Fall 2019, three important changes to cert-manager are set to occur that you need to take action on if you have an HA deployment of Rancher:
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Upgrading and Rolling Back Kubernetes
|
||||
weight: 70
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Upgrading Kubernetes without Upgrading Rancher
|
||||
weight: 1120
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Overview
|
||||
weight: 1
|
||||
---
|
||||
|
||||
Rancher is a container management platform built for organizations that deploy containers in production. Rancher makes it easy to run Kubernetes everywhere, meet IT requirements, and empower DevOps teams.
|
||||
|
||||
# Run Kubernetes Everywhere
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: CLI with Rancher
|
||||
weight: 100
|
||||
---
|
||||
|
||||
Interact with Rancher using command line interface (CLI) tools from your workstation.
|
||||
|
||||
-1
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Rancher AWS Quick Start Guide
|
||||
description: Read this step by step Rancher AWS guide to quickly deploy a Rancher Server with a single node cluster attached.
|
||||
weight: 100
|
||||
---
|
||||
The following steps will quickly deploy a Rancher Server on AWS with a single node cluster attached.
|
||||
|
||||
|
||||
-1
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Rancher Azure Quick Start Guide
|
||||
description: Read this step by step Rancher Azure guide to quickly deploy a Rancher Server with a single node cluster attached.
|
||||
weight: 100
|
||||
---
|
||||
|
||||
The following steps will quickly deploy a Rancher server on Azure in a single-node RKE Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.
|
||||
|
||||
-1
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Rancher DigitalOcean Quick Start Guide
|
||||
description: Read this step by step Rancher DigitalOcean guide to quickly deploy a Rancher Server with a single node cluster attached.
|
||||
weight: 100
|
||||
---
|
||||
The following steps will quickly deploy a Rancher Server on DigitalOcean with a single node cluster attached.
|
||||
|
||||
|
||||
-1
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Rancher GCP Quick Start Guide
|
||||
description: Read this step by step Rancher GCP guide to quickly deploy a Rancher Server with a single node cluster attached.
|
||||
weight: 100
|
||||
---
|
||||
The following steps will quickly deploy a Rancher server on GCP in a single-node RKE Kubernetes cluster, with a single-node downstream Kubernetes cluster attached.
|
||||
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Manual Quick Start
|
||||
weight: 300
|
||||
---
|
||||
|
||||
Howdy Partner! This tutorial walks you through:
|
||||
|
||||
- Installation of Rancher 2.x
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Vagrant Quick Start
|
||||
weight: 200
|
||||
---
|
||||
|
||||
The following steps quickly deploy a Rancher Server with a single node cluster attached.
|
||||
|
||||
>**Note:** The intent of these guides is to quickly launch a sandbox that you can use to evaluate Rancher. These guides are not intended for production environments. For comprehensive setup instructions, see [Installation](../../../pages-for-subheaders/installation-and-upgrade.md).
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Workload with NodePort Quick Start
|
||||
weight: 200
|
||||
---
|
||||
|
||||
### Prerequisite
|
||||
|
||||
-1
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: Workload with Ingress Quick Start
|
||||
weight: 100
|
||||
---
|
||||
|
||||
### Prerequisite
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user