mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-05-16 10:03:28 +00:00
Reorganize Rancher v2.5 docs
This commit is contained in:
Catherine Luse
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: API
|
||||
weight: 7500
|
||||
weight: 19
|
||||
---
|
||||
|
||||
## How to use the API
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
---
|
||||
title: Applications
|
||||
weight: 3000
|
||||
---
|
||||
|
||||
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. Tools are divided into following categories:
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [Notifiers and Alerts](#notifiers-and-alerts)
|
||||
- [Logging](#logging)
|
||||
- [Monitoring](#monitoring)
|
||||
- [Istio](#istio)
|
||||
- [OPA Gatekeeper](#opa-gatekeeper)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Notifiers and Alerts
|
||||
|
||||
Notifiers and alerts are two features that work together to inform you of events in the Rancher system.
|
||||
|
||||
[Notifiers]({{<baseurl>}}/rancher/v2.x/en/cluster-admin/tools/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. Notifications can be sent with Slack, email, PagerDuty, WeChat, and webhooks.
|
||||
|
||||
[Alerts]({{<baseurl>}}/rancher/v2.x/en/cluster-admin/tools/alerts) are rules that trigger those 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.
|
||||
|
||||
## Logging
|
||||
|
||||
Logging is helpful because it allows you to:
|
||||
|
||||
- Capture and analyze the state of your cluster
|
||||
- Look for trends in your environment
|
||||
- Save your logs to a safe location outside of your cluster
|
||||
- Stay informed of events like a container crashing, a pod eviction, or a node dying
|
||||
- More easily debugg and troubleshoot problems
|
||||
|
||||
Rancher can integrate with Elasticsearch, splunk, kafka, syslog, and fluentd.
|
||||
|
||||
For details, refer to the [logging section.]({{<baseurl>}}/rancher/v2.x/en/cluster-admin/tools/logging)
|
||||
|
||||
## Monitoring
|
||||
|
||||
_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. For details, refer to the [monitoring section.]({{<baseurl>}}/rancher/v2.x/en/cluster-admin/tools/monitoring)
|
||||
|
||||
## Istio
|
||||
|
||||
[Istio](https://istio.io/) is an open-source tool that makes it easier for DevOps teams to observe, control, troubleshoot, and secure the traffic within a complex network of microservices. For details on how to enable Istio in Rancher, refer to the [Istio section.]({{<baseurl>}}/rancher/v2.x/en/cluster-admin/tools/istio)
|
||||
|
||||
## OPA Gatekeeper
|
||||
|
||||
[OPA Gatekeeper](https://github.com/open-policy-agent/gatekeeper) is an open-source project that provides integration between OPA and Kubernetes to provide policy control via admission controller webhooks. For details on how to enable Gatekeeper in Rancher, refer to the [OPA Gatekeeper section.]({{<baseurl>}}/rancher/v2.x/en/cluster-admin/tools/opa-gatekeeper)
|
||||
@@ -1,10 +0,0 @@
|
||||
---
|
||||
title: Back up and Restore Applications
|
||||
weight: 2
|
||||
---
|
||||
|
||||
> This page is under construction.
|
||||
|
||||
In this section, you'll learn how to create additional backup templates for the backup/restore application so that any Kubernetes application can be backed up and restored.
|
||||
|
||||
For information about how to backup and restore Rancher, refer to [this section.](../../backup-restore)
|
||||
+1
-8
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Backups and Disaster Recovery
|
||||
weight: 200
|
||||
weight: 8
|
||||
---
|
||||
|
||||
> This section is under construction.
|
||||
@@ -12,10 +12,3 @@ To protect yourself from a disaster scenario, you should create backups on a reg
|
||||
We recommend using the backup/restore application to back up Rancher and to restore it from backup.
|
||||
|
||||
The Helm chart for the application is available as in Rancher. After you have enabled the application, you will be able to use backup templates for Rancher, Fleet, and the Enterprise Cluster Manager.
|
||||
|
||||
### Special Scenarios for Rollbacks
|
||||
|
||||
Because of the changes necessary to address [CVE-2018-20321](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-20321), special steps are necessary if the user wants to roll back to a previous version of Rancher where this vulnerability exists, so they are needed for these situations:
|
||||
|
||||
- Rolling back from v2.1.6+ to any version between v2.1.0 - v2.1.5 or v2.0.0 - v2.0.10.
|
||||
- Rolling back from v2.0.11+ to any version between v2.0.0 - v2.0.10.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Classic
|
||||
weight: 2
|
||||
---
|
||||
|
||||
> This section is under construction.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Normal
|
||||
weight: 1
|
||||
---
|
||||
|
||||
> This section is under construction.
|
||||
@@ -3,7 +3,7 @@ title: The Rancher Command Line Interface
|
||||
description: The Rancher CLI is a unified tool that you can use to interact with Rancher. With it, you can operate Rancher using a command line interface rather than the GUI
|
||||
metaTitle: "Using the Rancher Command Line Interface "
|
||||
metaDescription: "The Rancher CLI is a unified tool that you can use to interact with Rancher. With it, you can operate Rancher using a command line interface rather than the GUI"
|
||||
weight: 6000
|
||||
weight: 16
|
||||
---
|
||||
|
||||
The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Cluster Explorer
|
||||
weight: 2005
|
||||
weight: 5
|
||||
---
|
||||
|
||||
> This section is under construction.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Contributing to Rancher
|
||||
weight: 18000
|
||||
weight: 22
|
||||
---
|
||||
|
||||
This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue.
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
---
|
||||
title: Disaster Recovery
|
||||
weight: 3
|
||||
---
|
||||
|
||||
> This page is under construction.
|
||||
|
||||
This section applies to Rancher installations in which the underlying Kubernetes cluster was created with the Rancher CLI.
|
||||
|
||||
We recommend using the backup/restore application to back up Rancher and to restore it from backup.
|
||||
|
||||
The Helm chart for the application is available as in Rancher. After you have enabled the application, you will be able to use backup templates for apps such as Rancher, Fleet, and the Enterprise Cluster Manager. Then apps can be restored from Kubernetes custom resources.
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Enterprise Cluster Manager
|
||||
weight: 2
|
||||
weight: 6
|
||||
---
|
||||
|
||||
After installation, the [system administrator]({{<baseurl>}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/) should configure Rancher to configure authentication, authorization, security, default settings, security policies, drivers and global DNS entries.
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Access Control
|
||||
weight: 300
|
||||
weight: 1
|
||||
---
|
||||
|
||||
> This section is under construction.
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Best Practices Guide
|
||||
weight: 1000
|
||||
weight: 3
|
||||
---
|
||||
|
||||
The purpose of this section is to consolidate best practices for Rancher implementations. This also includes recommendations for related technologies, such as Kubernetes, Docker, containers, and more. The objective is to improve the outcome of a Rancher implementation using the operational experience of Rancher and its customers.
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Global DNS
|
||||
weight: 1
|
||||
weight: 100
|
||||
---
|
||||
|
||||
> This page is under construction.
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Projects and Kubernetes Namespaces with Rancher
|
||||
description: Rancher Projects ease the administrative burden of your cluster and support multi-tenancy. Learn to create projects and divide projects into Kubernetes namespaces
|
||||
weight: 2
|
||||
weight: 200
|
||||
---
|
||||
|
||||
A namespace is a Kubernetes concept that allows a virtual cluster within a cluster, which is useful for dividing the cluster into separate "virtual clusters" that each have their own access control and resource quotas.
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Installation Requirements
|
||||
description: Learn the node requirements for each node running Rancher server when you’re configuring Rancher to run either in a Docker or Kubernetes setup
|
||||
weight: 1
|
||||
weight: 2
|
||||
---
|
||||
|
||||
> This section is under construction.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user