public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-26 13:08:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Convert h1 to h2 (2.0-2.4)

Browse Source
This commit is contained in:
Billy Tat
2022-10-28 18:48:50 -07:00
parent bb76e99d20
commit eaa89030f6
89 changed files with 377 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files
versioned_docs/version-2.0-2.4/pages-for-subheaders/air-gap-helm2.md
+1 -1
View File
@@ -28,7 +28,7 @@ The Docker installation is for Rancher users that are wanting to test out Ranche
Instead of running the Docker installation, you have the option to follow the Kubernetes Install guide, but only use one node to install Rancher. Afterwards, you can scale up the etcd nodes in your Kubernetes cluster to make it a Kubernetes Installation.
# Installation Outline
## Installation Outline
- [1. Prepare your Node(s)](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md)
- [2. Collect and Publish Images to your Private Registry](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md)
versioned_docs/version-2.0-2.4/pages-for-subheaders/air-gapped-helm-cli-install.md
+2 -2
View File
@@ -12,14 +12,14 @@ Throughout the installation instructions, there will be _tabs_ for each installa
> **Important:** If you install Rancher following the Docker installation guide, there is no upgrade path to transition your Docker Installation to a Kubernetes Installation.
# Installation Outline
## Installation Outline
1. [Set up infrastructure and private registry](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/infrastructure-private-registry.md)
2. [Collect and publish images to your private registry](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/publish-images.md)
3. [Set up a Kubernetes cluster (Skip this step for Docker installations)](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-kubernetes.md)
4. [Install Rancher](../getting-started/installation-and-upgrade/other-installation-methods/air-gapped-helm-cli-install/install-rancher-ha.md)
# Upgrades
## Upgrades
To upgrade Rancher with Helm CLI in an air gap environment, follow [this procedure.](upgrades.md)
versioned_docs/version-2.0-2.4/pages-for-subheaders/cis-scans.md
+2 -2
View File
@@ -7,7 +7,7 @@ _Available as of v2.4.0_
- [Prerequisites](#prerequisites)
- [How-to Guides](#how-to-guides)
# Prerequisites
## Prerequisites
To run security scans on a cluster and access the generated reports, you must be an [Administrator](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md) or [Cluster Owner.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md)
@@ -17,6 +17,6 @@ The security scan cannot run in a cluster that has Windows nodes.
You will only be able to see the CIS scan reports for clusters that you have access to.
# How-to Guides
## How-to Guides
Please refer [here](../pages-for-subheaders/cis-scan-guides.md) for how-to guides on CIS scans.
versioned_docs/version-2.0-2.4/pages-for-subheaders/cluster-alerts.md
+15 -15
View File
@@ -5,7 +5,7 @@ title: Cluster Alerts
To keep your clusters and applications healthy and driving your organizational productivity forward, you need to stay informed of events occurring in your clusters and projects, both planned and unplanned. When an event occurs, your alert is triggered, and you are sent a notification. You can then, if necessary, follow up with corrective actions.
# About Alerts
## About Alerts
Notifiers and alerts are built on top of the [Prometheus Alertmanager](https://prometheus.io/docs/alerting/alertmanager/). Leveraging these tools, Rancher can notify [cluster owners](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles) and [project owners](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#project-roles) of events they need to address.
@@ -55,7 +55,7 @@ After you set up cluster alerts, you can manage each alert object. To manage ale
- Mute firing alerts
- Unmute muted alerts
# Adding Cluster Alerts
## Adding Cluster Alerts
As a [cluster owner](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles), you can configure Rancher to send you alerts for cluster events.
@@ -74,16 +74,16 @@ As a [cluster owner](../how-to-guides/advanced-user-guides/authentication-permis
**Result:** Your alert is configured. A notification is sent when the alert is triggered.
# Cluster Alert Configuration
## Cluster Alert Configuration
- [System Service Alerts](#system-service-alerts)
- [Resource Event Alerts](#resource-event-alerts)
- [Node Alerts](#node-alerts)
- [Node Selector Alerts](#node-selector-alerts)
- [CIS Scan Alerts](#cis-scan-alerts)
- [Metric Expression Alerts](#metric-expression-alerts)
- [System Service Alerts](#system-service-alerts)
- [Resource Event Alerts](#resource-event-alerts)
- [Node Alerts](#node-alerts)
- [Node Selector Alerts](#node-selector-alerts)
- [CIS Scan Alerts](#cis-scan-alerts)
- [Metric Expression Alerts](#metric-expression-alerts)
# System Service Alerts
## System Service Alerts
This alert type monitor for events that affect one of the Kubernetes master components, regardless of the node it occurs on.
@@ -119,7 +119,7 @@ By default, the below options will apply to all alert rules within the group. Yo
- **Group Interval Time**: How long to wait before sending an alert that has been added to a group which contains already fired alerts, default to 30 seconds.
- **Repeat Wait Time**: How long to wait before re-sending a given alert that has already been sent, default to 1 hour.
# Resource Event Alerts
## Resource Event Alerts
This alert type monitors for specific events that are thrown from a resource type.
@@ -161,7 +161,7 @@ By default, the below options will apply to all alert rules within the group. Yo
- **Group Interval Time**: How long to wait before sending an alert that has been added to a group which contains already fired alerts, default to 30 seconds.
- **Repeat Wait Time**: How long to wait before re-sending a given alert that has already been sent, default to 1 hour.
# Node Alerts
## Node Alerts
This alert type monitors for events that occur on a specific node.
@@ -197,7 +197,7 @@ By default, the below options will apply to all alert rules within the group. Yo
- **Group Interval Time**: How long to wait before sending an alert that has been added to a group which contains already fired alerts, default to 30 seconds.
- **Repeat Wait Time**: How long to wait before re-sending a given alert that has already been sent, default to 1 hour.
# Node Selector Alerts
## Node Selector Alerts
This alert type monitors for events that occur on any node on marked with a label. For more information, see the Kubernetes documentation for [Labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/).
@@ -233,7 +233,7 @@ By default, the below options will apply to all alert rules within the group. Yo
- **Group Interval Time**: How long to wait before sending an alert that has been added to a group which contains already fired alerts, default to 30 seconds.
- **Repeat Wait Time**: How long to wait before re-sending a given alert that has already been sent, default to 1 hour.
# CIS Scan Alerts
## CIS Scan Alerts
_Available as of v2.4.0_
This alert type is triggered based on the results of a CIS scan.
@@ -269,7 +269,7 @@ By default, the below options will apply to all alert rules within the group. Yo
- **Group Interval Time**: How long to wait before sending an alert that has been added to a group which contains already fired alerts, default to 30 seconds.
- **Repeat Wait Time**: How long to wait before re-sending a given alert that has already been sent, default to 1 hour.
# Metric Expression Alerts
## Metric Expression Alerts
This alert type monitors for the overload from Prometheus expression querying, it would be available after you enable monitoring.
versioned_docs/version-2.0-2.4/pages-for-subheaders/cluster-logging.md
+4 -5
View File
@@ -19,8 +19,7 @@ Rancher supports integration with the following services:
- Syslog
- Fluentd
# How Logging Integrations Work
## How Logging Integrations Work
Rancher can integrate with popular external services used for event streams, telemetry, or search. These services can log errors and warnings in your Kubernetes infrastructure to a stream.
@@ -32,7 +31,7 @@ Additionally, you'll have the opportunity to enter key-value pairs to filter the
>**Note:** You can only configure one logging service per cluster or per project.
# Requirements
## Requirements
The Docker daemon on each node in the cluster should be [configured](https://docs.docker.com/config/containers/logging/configure/) with the (default) log-driver: `json-file`. You can check the log-driver by running the following command:
@@ -41,7 +40,7 @@ $ docker info | grep 'Logging Driver'
Logging Driver: json-file
```
# Logging Scope
## Logging Scope
You can configure logging at either cluster level or project level.
@@ -53,7 +52,7 @@ Logs that are sent to your logging service are from the following locations:
- Pod logs stored at `/var/log/containers`.
- Kubernetes system components logs stored at `/var/lib/rancher/rke/log/`.
# Enabling Cluster Logging
## Enabling Cluster Logging
As an [administrator](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md) or [cluster owner](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles), you can configure Rancher to send Kubernetes logs to a logging service.
versioned_docs/version-2.0-2.4/pages-for-subheaders/cluster-monitoring.md
+4 -4
View File
@@ -7,7 +7,7 @@ _Available as of v2.2.0_
Using Rancher, you can monitor the state and processes of your cluster nodes, Kubernetes components, and software deployments through integration with [Prometheus](https://prometheus.io/), a leading open-source monitoring solution.
# About Prometheus
## About Prometheus
Prometheus provides a _time series_ of your data, which is, according to [Prometheus documentation](https://prometheus.io/docs/concepts/data_model/):
@@ -21,7 +21,7 @@ By viewing data that Prometheus scrapes from your cluster control plane, nodes,
Multi-tenancy support in terms of cluster-only and project-only Prometheus instances are also supported.
# Monitoring Scope
## Monitoring Scope
Using Prometheus, you can monitor Rancher at both the cluster level and [project level](../explanations/integrations-in-rancher/cluster-monitoring/project-monitoring.md). For each cluster and project that is enabled for monitoring, Rancher deploys a Prometheus server.
@@ -33,7 +33,7 @@ Using Prometheus, you can monitor Rancher at both the cluster level and [project
- [Project monitoring](../explanations/integrations-in-rancher/cluster-monitoring/project-monitoring.md) allows you to view the state of pods running in a given project. Prometheus collects metrics from the project's deployed HTTP and TCP/UDP workloads.
# Enabling Cluster Monitoring
## Enabling Cluster Monitoring
As an [administrator](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md) or [cluster owner](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles.md#cluster-roles), you can configure Rancher to deploy Prometheus to monitor your Kubernetes cluster.
@@ -62,7 +62,7 @@ As an [administrator](../how-to-guides/advanced-user-guides/authentication-permi
> The default username and password for the Grafana instance will be `admin/admin`. However, Grafana dashboards are served via the Rancher authentication proxy, so only users who are currently authenticated into the Rancher server have access to the Grafana dashboard.
# Resource Consumption
## Resource Consumption
When enabling cluster monitoring, you need to ensure your worker nodes and Prometheus pod have enough resources. The tables below provides a guide of how much resource consumption will be used. In larger deployments, it is strongly advised that the monitoring infrastructure be placed on dedicated nodes in the cluster.
versioned_docs/version-2.0-2.4/pages-for-subheaders/configure-shibboleth-saml.md
+3 -3
View File
@@ -13,7 +13,7 @@ If you also configure OpenLDAP as the back end to Shibboleth, it will return a S
> The instructions in this section assume that you understand how Rancher, Shibboleth, and OpenLDAP work together. For a more detailed explanation of how it works, refer to [this page.](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-authentication/configure-shibboleth-saml/about-group-permissions.md)
# Setting up Shibboleth in Rancher
## Setting up Shibboleth in Rancher
### Shibboleth Prerequisites
>
@@ -71,7 +71,7 @@ If you configure Shibboleth without OpenLDAP, the following caveats apply due to
To enable searching for groups when assigning permissions in Rancher, you will need to configure a back end for the SAML provider that supports groups, such as OpenLDAP.
# Setting up OpenLDAP in Rancher
## Setting up OpenLDAP in Rancher
If you also configure OpenLDAP as the back end to Shibboleth, it will return a SAML assertion to Rancher with user attributes that include groups. Then authenticated users will be able to access resources in Rancher that their groups have permissions for.
@@ -93,6 +93,6 @@ Configure the settings for the OpenLDAP server, groups and users. For help filli
2. From the **Global** view, navigate to **Security** > **Authentication**
3. Select **OpenLDAP**. The **Configure an OpenLDAP server** form will be displayed.
# Troubleshooting
## Troubleshooting
If you are experiencing issues while testing the connection to the OpenLDAP server, first double-check the credentials entered for the service account as well as the search base configuration. You may also inspect the Rancher logs to help pinpointing the problem cause. Debug logs may contain more detailed information about the error. Please refer to [How can I enable debug logging](../faq/technical-items.md#how-can-i-enable-debug-logging) in this documentation.
versioned_docs/version-2.0-2.4/pages-for-subheaders/enable-experimental-features.md
+3 -3
View File
@@ -24,7 +24,7 @@ Because the API sets the actual value and the command line sets the default valu
For example, if you install Rancher, then set a feature flag to true with the Rancher API, then upgrade Rancher with a command that sets the feature flag to false, the default value will still be false, but the feature will still be enabled because it was set with the Rancher API. If you then deleted the set value (true) with the Rancher API, setting it to NULL, the default value (false) would take effect. See the [feature flags page](../reference-guides/installation-references/feature-flags.md) for more information.
# Enabling Features when Starting Rancher
## Enabling Features when Starting Rancher
When you install Rancher, enable the feature you want with a feature flag. The command is different depending on whether you are installing Rancher on a single node or if you are doing a Kubernetes Installation of Rancher.
@@ -97,7 +97,7 @@ docker run -d -p 80:80 -p 443:443 \
</TabItem>
</Tabs>
# Enabling Features with the Rancher UI
## Enabling Features with the Rancher UI
1. Go to the **Global** view and click **Settings.**
1. Click the **Feature Flags** tab. You will see a list of experimental features.
@@ -113,7 +113,7 @@ docker run -d -p 80:80 -p 443:443 \
**Result:** The feature is disabled.
# Enabling Features with the Rancher API
## Enabling Features with the Rancher API
1. Go to `<RANCHER-SERVER-URL>/v3/features`.
1. In the `data` section, you will see an array containing all of the features that can be turned on with feature flags. The name of the feature is in the `id` field. Click the name of the feature you want to enable.
versioned_docs/version-2.0-2.4/pages-for-subheaders/install-cluster-autoscaler.md
+1 -1
View File
@@ -15,7 +15,7 @@ Cluster Autoscaler is designed to run on Kubernetes master nodes. It can run in
It's possible to run a customized deployment of Cluster Autoscaler on worker nodes, but extra care needs to be taken to ensure that Cluster Autoscaler remains up and running.
# Cloud Providers
## Cloud Providers
Cluster Autoscaler provides support to distinct cloud providers. For more information, go to [cluster-autoscaler supported cloud providers.](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler#deployment)
versioned_docs/version-2.0-2.4/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md
+2 -2
View File
@@ -6,7 +6,7 @@ description: Learn how to install Rancher in development and production environm
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Prerequisite
## Prerequisite
Set up the Rancher server's local Kubernetes cluster.
@@ -19,7 +19,7 @@ For the tutorial to install an RKE Kubernetes cluster, refer to [this page.](../
For the tutorial to install a K3s Kubernetes cluster, refer to [this page.](../how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.](../how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md)
# Install the Rancher Helm Chart
## Install the Rancher Helm Chart
Rancher is installed using the Helm package manager for Kubernetes. Helm charts provide templating syntax for Kubernetes YAML manifest documents.
versioned_docs/version-2.0-2.4/pages-for-subheaders/installation-and-upgrade.md
+5 -4
View File
@@ -5,7 +5,7 @@ description: Learn how to install Rancher in development and production environm
This section provides an overview of the architecture options of installing Rancher, describing advantages of each option.
# Terminology
## Terminology
In this section,
@@ -13,7 +13,7 @@ In this section,
- **RKE (Rancher Kubernetes Engine)** is a certified Kubernetes distribution and CLI/library which creates and manages a Kubernetes cluster.
- **K3s (Lightweight Kubernetes)** is also a fully compliant Kubernetes distribution. It is newer than RKE, easier to use, and more lightweight, with a binary size of less than 100 MB. As of Rancher v2.4, Rancher can be installed on a K3s cluster.
# Overview of Installation Options
## Overview of Installation Options
Rancher can be installed on these main architectures:
@@ -60,10 +60,11 @@ When the nodes in your Kubernetes cluster are running and fulfill the [node requ
For a longer discussion of Rancher architecture, refer to the [architecture overview,](rancher-manager-architecture.md) [recommendations for production-grade architecture,](../reference-guides/rancher-manager-architecture/architecture-recommendations.md) or our [best practices guide.](../reference-guides/best-practices/deployment-types.md)
# Prerequisites
## Prerequisites
Before installing Rancher, make sure that your nodes fulfill all of the [installation requirements.](installation-requirements.md)
# Architecture Tip
## Architecture Tip
For the best performance and greater security, we recommend a separate, dedicated Kubernetes cluster for the Rancher management server. Running user workloads on this cluster is not advised. After deploying Rancher, you can [create or import clusters](kubernetes-clusters-in-rancher-setup.md) for running your workloads.
versioned_docs/version-2.0-2.4/pages-for-subheaders/installation-requirements.md
+4 -4
View File
@@ -25,7 +25,7 @@ For a list of best practices that we recommend for running the Rancher server in
The Rancher UI works best in Firefox or Chrome.
# Operating Systems and Container Runtime Requirements
## Operating Systems and Container Runtime Requirements
Rancher should work with any modern Linux distribution.
@@ -53,11 +53,11 @@ If you are installing Rancher on a K3s cluster with **Raspbian Buster**, follow
If you are installing Rancher on a K3s cluster with Alpine Linux, follow [these steps](https://rancher.com/docs/k3s/latest/en/advanced/#additional-preparation-for-alpine-linux-setup) for additional setup.
### Installing Docker
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](../getting-started/installation-and-upgrade/installation-requirements/install-docker.md) to install Docker with one command.
# Hardware Requirements
## Hardware Requirements
This section describes the CPU, memory, and disk requirements for the nodes where the Rancher server is installed.
@@ -133,7 +133,7 @@ These requirements apply to installing Rancher on an RKE Kubernetes cluster befo
Rancher performance depends on etcd in the cluster performance. To ensure optimal speed, we recommend always using SSD disks to back your Rancher management Kubernetes cluster. On cloud providers, you will also want to use the minimum size that allows the maximum IOPS. In larger clusters, consider using dedicated storage devices for etcd data and wal directories.
# Networking Requirements
## Networking Requirements
This section describes the networking requirements for the node(s) where the Rancher server is installed.
versioned_docs/version-2.0-2.4/pages-for-subheaders/istio.md
+7 -7
View File
@@ -31,19 +31,19 @@ Rancher's Istio integration comes with comprehensive visualization aids:
Istio needs to be set up by a Rancher administrator or cluster administrator before it can be used in a project.
# Prerequisites
## Prerequisites
Before enabling Istio, we recommend that you confirm that your Rancher worker nodes have enough [CPU and memory](../explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md) to run all of the components of Istio.
# Setup Guide
## Setup Guide
Refer to the [setup guide](istio-setup-guide.md) for instructions on how to set up Istio and use it in a project.
# Disabling Istio
## Disabling Istio
To remove Istio components from a cluster, namespace, or workload, refer to the section on [disabling Istio.](../explanations/integrations-in-rancher/istio/disable-istio.md)
# Accessing Visualizations
## Accessing Visualizations
> By default, only cluster owners have access to Jaeger and Kiali. For instructions on how to allow project members to access them, see [this section.](../explanations/integrations-in-rancher/istio/rbac-for-istio.md)
@@ -55,19 +55,19 @@ To see the visualizations, go to the cluster where Istio is set up and click **T
You can also get to the visualization tools from the project view.
# Viewing the Kiali Traffic Graph
## Viewing the Kiali Traffic Graph
1. From the project view in Rancher, click **Resources > Istio.**
1. If you are a cluster owner, you can go to the **Traffic Graph** tab. This tab has the Kiali network visualization integrated into the UI.
# Viewing Traffic Metrics
## Viewing Traffic Metrics
Istio’s monitoring features provide visibility into the performance of all your services.
1. From the project view in Rancher, click **Resources > Istio.**
1. Go to the **Traffic Metrics** tab. After traffic is generated in your cluster, you should be able to see metrics for **Success Rate, Request Volume, 4xx Response Count, Project 5xx Response Count** and **Request Duration.** Cluster owners can see all of the metrics, while project members can see a subset of the metrics.
# Architecture
## Architecture
Istio installs a service mesh that uses [Envoy](https://www.envoyproxy.io/learn/service-mesh) sidecar proxies to intercept traffic to each workload. These sidecars intercept and manage service-to-service communication, allowing fine-grained observation and control over traffic within the cluster.
versioned_docs/version-2.0-2.4/pages-for-subheaders/kubernetes-clusters-in-rancher-setup.md
+3 -3
View File
@@ -15,7 +15,7 @@ import ClusterCapabilitiesTable from '../shared-files/_cluster-capabilities-tabl
<ClusterCapabilitiesTable />
# Setting up Clusters in a Hosted Kubernetes Provider
## Setting up Clusters in a Hosted Kubernetes Provider
In this scenario, Rancher does not provision Kubernetes because it is installed by providers such as Google Kubernetes Engine (GKE), Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service.
@@ -23,7 +23,7 @@ If you use a Kubernetes provider such as Google GKE, Rancher integrates with its
For more information, refer to the section on [hosted Kubernetes clusters.](set-up-clusters-from-hosted-kubernetes-providers.md)
# Launching Kubernetes with Rancher
## Launching Kubernetes with Rancher
Rancher uses the [Rancher Kubernetes Engine (RKE)](https://rancher.com/docs/rke/latest/en/) as a library when provisioning Kubernetes on your own nodes. RKE is Rancher’s own lightweight Kubernetes installer.
@@ -55,7 +55,7 @@ You can bring any nodes you want to Rancher and use them to create a cluster.
These nodes include on-prem bare metal servers, cloud-hosted virtual machines, or on-prem virtual machines.
# Importing Existing Clusters
## Importing Existing Clusters
_Available from Rancher v2.0.x-v2.4.x_
versioned_docs/version-2.0-2.4/pages-for-subheaders/kubernetes-components.md
+1 -1
View File
@@ -11,7 +11,7 @@ This section includes troubleshooting tips in the following categories:
- [Troubleshooting nginx-proxy Nodes](../troubleshooting/kubernetes-components/troubleshooting-nginx-proxy.md)
- [Troubleshooting Worker Nodes and Generic Components](../troubleshooting/kubernetes-components/troubleshooting-worker-nodes-and-generic-components.md)
# Kubernetes Component Diagram
## Kubernetes Component Diagram
![Cluster diagram](/img/clusterdiagram.svg)<br/>
<sup>Lines show the traffic flow between components. Colors are used purely for visual aid</sup>
versioned_docs/version-2.0-2.4/pages-for-subheaders/project-tools.md
+4 -4
View File
@@ -4,17 +4,17 @@ title: Tools for Logging, Monitoring, and More
Rancher contains a variety of tools that aren't included in Kubernetes to assist in your DevOps operations. Rancher can integrate with external services to help your clusters run more efficiently.
# Notifiers
## Notifiers
[Notifiers](../explanations/integrations-in-rancher/notifiers.md) are services that inform you of alert events. You can configure notifiers to send alert notifications to staff best suited to take corrective action. Notifications can be sent with Slack, email, PagerDuty, WeChat, and webhooks.
# Alerts
## Alerts
[Alerts](./cluster-alerts.md) are rules that trigger notifications. Before you can receive alerts, you must configure one or more notifier in Rancher. The scope for alerts can be set at either the cluster or project level.
For details on project-level alerts, see [this page.](../reference-guides/rancher-project-tools/project-alerts.md)
# Logging
## Logging
Logging is helpful because it allows you to:
@@ -30,7 +30,7 @@ For details on setting up logging at the cluster level, refer to the [logging se
For details on project-level logging, see [this section.](../reference-guides/rancher-project-tools/project-logging.md)
# Monitoring
## Monitoring
_Available as of v2.2.0_
versioned_docs/version-2.0-2.4/pages-for-subheaders/rancher-behind-an-http-proxy.md
+1 -1
View File
@@ -6,7 +6,7 @@ In a lot of enterprise environments, servers or VMs running on premise do not ha
Alternatively, it is also possible to set up Rancher completely air-gapped without any Internet access. This process is described in detail in the [Rancher docs](air-gapped-helm-cli-install.md).
# Installation Outline
## Installation Outline
1. [Set up infrastructure](../getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/set-up-infrastructure.md)
2. [Set up a Kubernetes cluster](../getting-started/installation-and-upgrade/other-installation-methods/rancher-behind-an-http-proxy/install-kubernetes.md)
versioned_docs/version-2.0-2.4/pages-for-subheaders/rancher-on-a-single-node-with-docker.md
+3 -3
View File
@@ -14,15 +14,15 @@ A Docker installation of Rancher is recommended only for development and testing
For Rancher v2.0-v2.4, there is no migration path from a Docker installation to a high-availability installation. Therefore, you may want to use a Kubernetes installation from the start.
# Requirements for OS, Docker, Hardware, and Networking
## Requirements for OS, Docker, Hardware, and Networking
Make sure that your node fulfills the general [installation requirements.](installation-requirements.md)
# 1. Provision Linux Host
## 1. Provision Linux Host
Provision a single Linux host according to our [Requirements](installation-requirements.md) to launch your Rancher server.
# 2. Choose an SSL Option and Install Rancher
## 2. Choose an SSL Option and Install Rancher
For security purposes, SSL (Secure Sockets Layer) is required when using Rancher. SSL secures all Rancher network communication, like when you login or interact with a cluster.
versioned_docs/version-2.0-2.4/pages-for-subheaders/upgrades.md
+8 -8
View File
@@ -18,7 +18,7 @@ If you installed Rancher using the RKE Add-on yaml, follow the directions to [mi
- [Known Upgrade Issues](#known-upgrade-issues)
- [RKE Add-on Installs](#rke-add-on-installs)
# Prerequisites
## Prerequisites
### Access to kubeconfig
@@ -54,7 +54,7 @@ If you are upgrading Rancher from v2.x to v2.3+, and you are using external TLS
[Let's Encrypt will be blocking cert-manager instances older than 0.8.0 starting November 1st 2019.](https://community.letsencrypt.org/t/blocking-old-cert-manager-versions/98753) Upgrade cert-manager to the latest version by following [these instructions.](../getting-started/installation-and-upgrade/resources/upgrade-cert-manager.md)
# Upgrade Outline
## Upgrade Outline
Follow the steps to upgrade Rancher server:
@@ -63,7 +63,7 @@ Follow the steps to upgrade Rancher server:
- [3. Upgrade Rancher](#3-upgrade-rancher)
- [4. Verify the Upgrade](#4-verify-the-upgrade)
# 1. Back up Your Kubernetes Cluster that is Running Rancher Server
## 1. Back up Your Kubernetes Cluster that is Running Rancher Server
[Take a one-time snapshot](../how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher-launched-kubernetes-clusters.md#option-b-one-time-snapshots)
@@ -71,7 +71,7 @@ of your Kubernetes cluster running Rancher server.
You'll use the backup as a restoration point if something goes wrong during upgrade.
# 2. Update the Helm chart repository
## 2. Update the Helm chart repository
1. Update your local helm repo cache.
@@ -121,7 +121,7 @@ You'll use the backup as a restoration point if something goes wrong during upgr
helm fetch rancher-<CHART_REPO>/rancher --version=v2.4.11
```
# 3. Upgrade Rancher
## 3. Upgrade Rancher
This section describes how to upgrade normal (Internet-connected) or air gap installations of Rancher with Helm.
@@ -256,7 +256,7 @@ kubectl -n cattle-system apply -R -f ./rancher
</TabItem>
</Tabs>
# 4. Verify the Upgrade
## 4. Verify the Upgrade
Log into Rancher to confirm that the upgrade succeeded.
@@ -264,7 +264,7 @@ Log into Rancher to confirm that the upgrade succeeded.
>
> See [Restoring Cluster Networking](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md#restoring-cluster-networking).
# Known Upgrade Issues
## Known Upgrade Issues
The following table lists some of the most noteworthy issues to be considered when upgrading Rancher. A more complete list of known issues for each Rancher version can be found in the release notes on [GitHub](https://github.com/rancher/rancher/releases) and on the [Rancher forums.](https://forums.rancher.com/c/announcements/12)
@@ -276,7 +276,7 @@ Upgrading to v2.2.0-v2.2.x | Rancher introduced the [system charts](https://gith
Upgrading from v2.0.13 or earlier | If your cluster's certificates have expired, you will need to perform [additional steps](../how-to-guides/advanced-user-guides/manage-clusters/rotate-certificates.md#rotating-expired-certificates-after-upgrading-older-rancher-versions) to rotate the certificates.
Upgrading from v2.0.7 or earlier | Rancher introduced the `system` project, which is a project that's automatically created to store important namespaces that Kubernetes needs to operate. During upgrade to v2.0.7+, Rancher expects these namespaces to be unassigned from all projects. Before beginning upgrade, check your system namespaces to make sure that they're unassigned to [prevent cluster networking issues.](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md)
# RKE Add-on Installs
## RKE Add-on Installs
**Important: RKE add-on install is only supported up to Rancher v2.0.8**
versioned_docs/version-2.0-2.4/pages-for-subheaders/use-existing-nodes.md
+2 -2
View File
@@ -9,7 +9,7 @@ To use this option you'll need access to servers you intend to use in your Kuber
This section describes how to set up a custom cluster.
# Creating a Cluster with Custom Nodes
## Creating a Cluster with Custom Nodes
>**Want to use Windows hosts as Kubernetes workers?**
>
@@ -106,7 +106,7 @@ If you share resources between clusters, you can change the tag to:
Key=kubernetes.io/cluster/CLUSTERID, Value=shared
```
# Optional Next Steps
## Optional Next Steps
After creating your cluster, you can access it through the Rancher UI. As a best practice, we recommend setting up these alternate ways of accessing your cluster:
versioned_docs/version-2.0-2.4/pages-for-subheaders/use-new-nodes-in-an-infra-provider.md
+4 -4
View File
@@ -9,7 +9,7 @@ One benefit of installing Kubernetes on node pools hosted by an infrastructure p
The available cloud providers to create a node template are decided based on active [node drivers](use-new-nodes-in-an-infra-provider.md#node-drivers).
# Node Templates
## Node Templates
A node template is the saved configuration for the parameters to use when provisioning nodes in a specific cloud provider. These nodes can be launched from the UI. Rancher uses [Docker Machine](https://docs.docker.com/machine/) to provision these nodes. The available cloud providers to create node templates are based on the active node drivers in Rancher.
@@ -40,7 +40,7 @@ To access all node templates, an administrator will need to do the following:
**Result:** All node templates are listed and grouped by owner. The templates can be edited or cloned by clicking the **&#8942;.**
# Node Pools
## Node Pools
Using Rancher, you can create pools of nodes based on a [node template](#node-templates).
@@ -108,7 +108,7 @@ You can disable node auto-replace from the Rancher UI with the following steps:
**Result:** Node auto-replace is disabled for the node pool.
# Cloud Credentials
## Cloud Credentials
_Available as of v2.2.0_
@@ -124,6 +124,6 @@ Node templates can use cloud credentials to store credentials for launching node
After cloud credentials are created, the user can start [managing the cloud credentials that they created](../reference-guides/user-settings/manage-cloud-credentials.md).
# Node Drivers
## Node Drivers
If you don't find the node driver that you want to use, you can see if it is available in Rancher's built-in [node drivers and activate it](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md#activating-deactivating-node-drivers), or you can [add your own custom node driver](../how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers.md#adding-custom-node-drivers).
versioned_docs/version-2.0-2.4/pages-for-subheaders/use-windows-clusters.md
+6 -7
View File
@@ -20,7 +20,7 @@ For the full list of requirements, see [this section.](#requirements-for-windows
For a summary of Kubernetes features supported in Windows, see the Kubernetes documentation on [supported functionality and limitations for using Kubernetes with Windows](https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#supported-functionality-and-limitations) or the [guide for scheduling Windows containers in Kubernetes](https://kubernetes.io/docs/setup/production-environment/windows/user-guide-windows-containers/).
# Requirements for Windows Clusters
## Requirements for Windows Clusters
The general node requirements for networking, operating systems, and Docker are the same as the node requirements for a [Rancher installation](installation-requirements.md).
@@ -95,7 +95,7 @@ If you are using the GCE (Google Compute Engine) cloud provider, you must do the
- Enable the GCE cloud provider in the `cluster.yml` by following [these steps.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/set-up-cloud-providers/other-cloud-providers/google-compute-engine.md)
- When provisioning the cluster in Rancher, choose **Custom cloud provider** as the cloud provider in the Rancher UI.
# Tutorial: How to Create a Cluster with Windows Support
## Tutorial: How to Create a Cluster with Windows Support
This tutorial describes how to create a Rancher-provisioned cluster with the three nodes in the [recommended architecture.](#guide-architecture)
@@ -103,8 +103,7 @@ When you provision a cluster with Rancher on existing nodes, you will add nodes
To set up a cluster with support for Windows nodes and containers, you will need to complete the tasks below.
# 1. Provision Hosts
## 1. Provision Host
To begin provisioning a cluster on existing nodes with Windows support, prepare your hosts.
@@ -128,7 +127,7 @@ You will provision three nodes:
If your nodes are hosted by a **Cloud Provider** and you want automation support such as loadbalancers or persistent storage devices, your nodes have additional configuration requirements. For details, see [Selecting Cloud Providers.](../pages-for-subheaders/set-up-cloud-providers.md)
# 2. Create the Cluster on Existing Nodes
## 2. Create the Cluster on Existing Nodes
The instructions for creating a Windows cluster on existing nodes are very similar to the general [instructions for creating a custom cluster](use-existing-nodes.md) with some Windows-specific requirements.
@@ -143,7 +142,7 @@ The instructions for creating a Windows cluster on existing nodes are very simil
> **Important:** For <b>Host Gateway (L2bridge)</b> networking, it's best to use the same Layer 2 network for all nodes. Otherwise, you need to configure the route rules for them. For details, refer to the [documentation on configuring cloud-hosted VM routes.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md#cloud-hosted-vm-routes-configuration) You will also need to [disable private IP address checks](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/network-requirements-for-host-gateway.md#disabling-private-ip-address-checks) if you are using Amazon EC2, Google GCE, or Azure VM.
# 3. Add Nodes to the Cluster
## 3. Add Nodes to the Cluster
This section describes how to register your Linux and Worker nodes to your cluster. You will run a command on each node, which will install the Rancher agent and allow Rancher to manage each node.
@@ -221,6 +220,6 @@ After creating your cluster, you can access it through the Rancher UI. As a best
- **Access your cluster with the kubectl CLI:** Follow [these steps](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#accessing-clusters-with-kubectl-on-your-workstation) to access clusters with kubectl on your workstation. In this case, you will be authenticated through the Rancher server’s authentication proxy, then Rancher will connect you to the downstream cluster. This method lets you manage the cluster without the Rancher UI.
- **Access your cluster with the kubectl CLI, using the authorized cluster endpoint:** Follow [these steps](../how-to-guides/advanced-user-guides/manage-clusters/access-clusters/use-kubectl-and-kubeconfig.md#authenticating-directly-with-a-downstream-cluster) to access your cluster with kubectl directly, without authenticating through the Rancher server. We recommend setting up this alternative method to access your cluster so that in case you can’t connect to Rancher, you can still access the cluster.
# Configuration for Storage Classes in Azure
## Configuration for Storage Classes in Azure
If you are using Azure VMs for your nodes, you can use [Azure files](https://docs.microsoft.com/en-us/azure/aks/azure-files-dynamic-pv) as a StorageClass for the cluster. For details, refer to [this section.](../how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/use-windows-clusters/azure-storageclass-configuration.md)