Remove unsupported front matter fields

This commit is contained in:
Billy Tat
2022-09-23 10:11:24 -07:00
parent 5b064e6548
commit c390289797
1553 changed files with 871 additions and 4500 deletions
@@ -1,8 +1,5 @@
---
title: API Tokens
weight: 1
aliases:
- /rancher/v2.0-v2.4/en/cluster-admin/api/api-tokens/
---
By default, some cluster-level API tokens are generated with infinite time-to-live (`ttl=0`). In other words, API tokens with `ttl=0` never expire unless you invalidate them. Tokens are not invalidated by changing a password.
@@ -1,10 +1,5 @@
---
title: Tips for Setting Up Containers
weight: 100
aliases:
- /rancher/v2.0-v2.4/en/best-practices/containers
- /rancher/v2.0-v2.4/en/best-practices/v2.0-v2.4/containers
- /rancher/v2.x/en/best-practices/v2.0-v2.4/containers/
---
Running well-built containers can greatly impact the overall performance and security of your environment.
@@ -15,14 +10,14 @@ For a more detailed discussion of security for containers, you can also refer to
### Use a Common Container OS
When possible, you should try to standardize on a common container base OS.
When possible, you should try to standardize on a common container base OS.
Smaller distributions such as Alpine and BusyBox reduce container image size and generally have a smaller attack/vulnerability surface.
Popular distributions such as Ubuntu, Fedora, and CentOS are more field-tested and offer more functionality.
### Start with a FROM scratch container
If your microservice is a standalone static binary, you should use a FROM scratch container.
If your microservice is a standalone static binary, you should use a FROM scratch container.
The FROM scratch container is an [official Docker image](https://hub.docker.com/_/scratch) that is empty so that you can use it to design minimal images.
@@ -1,10 +1,5 @@
---
title: Rancher Deployment Strategies
weight: 100
aliases:
- /rancher/v2.0-v2.4/en/best-practices/deployment-strategies
- /rancher/v2.0-v2.4/en/best-practices/v2.0-v2.4/deployment-strategies
- /rancher/v2.x/en/best-practices/v2.0-v2.4/deployment-strategies/
---
There are two recommended deployment strategies. Each one has its own pros and cons. Read more about which one would fit best for your use case:
@@ -1,10 +1,5 @@
---
title: Tips for Running Rancher
weight: 100
aliases:
- /rancher/v2.0-v2.4/en/best-practices/deployment-types
- /rancher/v2.0-v2.4/en/best-practices/v2.0-v2.4/deployment-types
- /rancher/v2.x/en/best-practices/v2.0-v2.4/deployment-types/
---
A high-availability Kubernetes installation, defined as an installation of Rancher on a Kubernetes cluster with at least three nodes, should be used in any production installation of Rancher, as well as any installation deemed "important." Multiple Rancher instances running on multiple nodes ensure high availability that cannot be accomplished with a single node environment.
@@ -1,11 +1,5 @@
---
title: Tips for Scaling, Security and Reliability
weight: 101
aliases:
- /rancher/v2.0-v2.4/en/best-practices/management
- /rancher/v2.0-v2.4/en/best-practices/v2.0-v2.4/management
- /rancher/v2.x/en/best-practices/management/
- /rancher/v2.x/en/best-practices/v2.0-v2.4/management/
---
Rancher allows you to set up numerous combinations of configurations. Some configurations are more appropriate for development and testing, while there are other best practices for production environments for maximum availability and fault tolerance. The following best practices should be followed for production.
@@ -1,7 +1,6 @@
---
title: Rancher CLI
description: Interact with Rancher using command line interface (CLI) tools from your workstation.
weight: 21
---
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,5 @@
---
title: EC2 Node Template Configuration
weight: 1
---
import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
---
title: Azure Node Template Configuration
weight: 1
---
import Tabs from '@theme/Tabs';
@@ -1,6 +1,5 @@
---
title: DigitalOcean Node Template Configuration
weight: 1
---
import Tabs from '@theme/Tabs';
@@ -1,9 +1,5 @@
---
title: vSphere Node Template Configuration in Rancher before v2.0.4
shortTitle: Before v2.0.4
weight: 5
aliases:
- /rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/prior-to-2.0.4/
---
@@ -1,9 +1,5 @@
---
title: vSphere Node Template Configuration in Rancher v2.0.4
shortTitle: v2.0.4
weight: 4
aliases:
- /rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.0.4/
---
@@ -19,7 +15,7 @@ In the **Account Access** section, enter the vCenter FQDN or IP address and the
## Scheduling
Choose what hypervisor the virtual machine will be scheduled to.
Choose what hypervisor the virtual machine will be scheduled to.
| Parameter | Required | Description |
|:------------------------|:--------:|:------------------------------------------------------------|
@@ -56,7 +52,7 @@ Optionally, you can:
- Assign labels to the VMs that can be used as a base for scheduling rules in the cluster.
- Customize the configuration of the Docker daemon on the VMs that will be created.
> **Note:** Custom attributes are a legacy feature that will eventually be removed from vSphere.
> **Note:** Custom attributes are a legacy feature that will eventually be removed from vSphere.
## Cloud Init
@@ -1,9 +1,5 @@
---
title: vSphere Node Template Configuration in Rancher v2.2.0
shortTitle: v2.2.0
weight: 3
aliases:
- /rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.2.0/
---
@@ -22,7 +18,7 @@ Your cloud credential has these fields:
| Username and password | Enter your vSphere login username and password. |
## Scheduling
Choose what hypervisor the virtual machine will be scheduled to.
Choose what hypervisor the virtual machine will be scheduled to.
| Parameter | Required | Description |
|:------------------------|:--------:|:------------------------------------------------------------|
@@ -60,7 +56,7 @@ Optionally, you can:
- Assign labels to the VMs that can be used as a base for scheduling rules in the cluster.
- Customize the configuration of the Docker daemon on the VMs that will be created.
> **Note:** Custom attributes are a legacy feature that will eventually be removed from vSphere.
> **Note:** Custom attributes are a legacy feature that will eventually be removed from vSphere.
## Cloud Init
[Cloud-init](https://cloudinit.readthedocs.io/en/latest/) allows you to initialize your nodes by applying configuration on the first boot. This may involve things such as creating users, authorizing SSH keys or setting up the network.
@@ -1,9 +1,5 @@
---
title: vSphere Node Template Configuration in Rancher v2.3.0
shortTitle: v2.3.0
weight: 2
aliases:
- /rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.0/
---
## Account Access
@@ -21,9 +17,9 @@ Your cloud credential has these fields:
| Username and password | Enter your vSphere login username and password. |
## Scheduling
Choose what hypervisor the virtual machine will be scheduled to.
Choose what hypervisor the virtual machine will be scheduled to.
In the **Scheduling** section, enter:
In the **Scheduling** section, enter:
- The name/path of the **Data Center** to create the VMs in
- The name of the **VM Network** to attach to
@@ -66,7 +62,7 @@ Optionally, you can:
- Assign labels to the VMs that can be used as a base for scheduling rules in the cluster.
- Customize the configuration of the Docker daemon on the VMs that will be created.
> **Note:** Custom attributes are a legacy feature that will eventually be removed from vSphere.
> **Note:** Custom attributes are a legacy feature that will eventually be removed from vSphere.
## Cloud Init
@@ -1,9 +1,5 @@
---
title: vSphere Node Template Configuration in Rancher v2.3.3
shortTitle: v2.3.3
weight: 1
aliases:
- /rancher/v2.x/en/cluster-provisioning/rke-clusters/node-pools/vsphere/vsphere-node-template-config/v2.3.3/
---
@@ -23,7 +19,7 @@ Your cloud credential has these fields:
## Scheduling
Choose what hypervisor the virtual machine will be scheduled to.
Choose what hypervisor the virtual machine will be scheduled to.
The fields in the **Scheduling** section should auto-populate with the data center and other scheduling options that are available to you in vSphere.
@@ -1,6 +1,5 @@
---
title: RKE Cluster Configuration Reference
weight: 2250
---
When Rancher installs Kubernetes, it uses [RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) as the Kubernetes distribution.
@@ -1,9 +1,5 @@
---
title: Rancher Agent Options
weight: 2500
aliases:
- /rancher/v2.0-v2.4/en/admin-settings/agent-options/
- /rancher/v2.0-v2.4/en/cluster-provisioning/custom-clusters/agent-options
---
Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to [create a cluster with custom nodes](../../../../pages-for-subheaders/use-existing-nodes.md) and add the options to the generated `docker run` command when adding a node.
@@ -1,6 +1,5 @@
---
title: OpenLDAP Configuration Reference
weight: 2
---
This section is intended to be used as a reference when setting up an OpenLDAP authentication provider in Rancher.
@@ -1,9 +1,5 @@
---
title: Creating an EKS Cluster
shortTitle: Amazon EKS
weight: 2110
aliases:
- /rancher/v2.0-v2.4/en/tasks/clusters/creating-a-cluster/create-cluster-eks/
---
Amazon EKS provides a managed control plane for your Kubernetes cluster. Amazon EKS runs the Kubernetes control plane instances across multiple Availability Zones to ensure high availability. Rancher provides an intuitive user interface for managing and deploying the Kubernetes clusters you run in Amazon EKS. With this guide, you will use Rancher to quickly and easily launch an Amazon EKS Kubernetes cluster in your AWS account. For more information on Amazon EKS, see this [documentation](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html).
@@ -1,11 +1,5 @@
---
title: Rancher Helm Chart Options
weight: 1
aliases:
- /rancher/v2.0-v2.4/en/installation/options/
- /rancher/v2.0-v2.4/en/installation/options/chart-options/
- /rancher/v2.0-v2.4/en/installation/options/helm2/helm-rancher/chart-options/
- /rancher/v2.0-v2.4/en/installation/resources/chart-options
---
This page is a configuration reference for the Rancher Helm chart.
@@ -1,10 +1,5 @@
---
title: TLS Settings
weight: 3
aliases:
- /rancher/v2.0-v2.4/en/installation/options/tls-settings/
- /rancher/v2.0-v2.4/en/admin-settings/tls-settings
- /rancher/v2.0-v2.4/en/installation/resources/encryption/tls-settings
---
In Rancher v2.1.7, the default TLS configuration changed to only accept TLS 1.2 and secure TLS cipher suites. TLS 1.3 and TLS 1.3 exclusive cipher suites are not supported.
@@ -1,6 +1,5 @@
---
title: Kubernetes Concepts
weight: 4
---
This page explains concepts related to Kubernetes that are important for understanding how Rancher works. The descriptions below provide a simplified interview of Kubernetes components. For more details, refer to the [official documentation on Kubernetes components.](https://kubernetes.io/docs/concepts/overview/components/)
@@ -34,7 +33,7 @@ Rancher uses etcd as a data store in both single node and high-availability inst
The state of a Kubernetes cluster is maintained in [etcd.](https://kubernetes.io/docs/concepts/overview/components/#etcd) The etcd nodes run the etcd database.
The etcd database component is a distributed key-value store used as Kubernetes storage for all cluster data, such as cluster coordination and state management. It is recommended to run etcd on multiple nodes so that there's always a backup available for failover.
The etcd database component is a distributed key-value store used as Kubernetes storage for all cluster data, such as cluster coordination and state management. It is recommended to run etcd on multiple nodes so that there's always a backup available for failover.
Although you can run etcd on just one node, etcd requires a majority of nodes, a quorum, to agree on updates to the cluster state. The cluster should always contain enough healthy etcd nodes to form a quorum. For a cluster with n members, a quorum is (n/2)+1. For any odd-sized cluster, adding one node will always increase the number of nodes necessary for a quorum.
@@ -45,7 +44,7 @@ Three etcd nodes is generally sufficient for smaller clusters and five etcd node
Controlplane nodes run the Kubernetes API server, scheduler, and controller manager. These nodes take care of routine tasks to ensure that your cluster maintains your configuration. Because all cluster data is stored on your etcd nodes, control plane nodes are stateless. You can run control plane on a single node, although three or more nodes are recommended for redundancy. Additionally, a single node can share the control plane and etcd roles.
### Worker Nodes
Each [worker node](https://kubernetes.io/docs/concepts/architecture/nodes/) runs the following:
- **Kubelets:** An agent that monitors the state of the node, ensuring your containers are healthy.
@@ -1,8 +1,5 @@
---
title: Concepts
weight: 1
aliases:
- /rancher/v2.0-v2.4/en/k8s-in-rancher/pipelines/concepts
---
The purpose of this page is to explain common concepts and terminology related to pipelines.
@@ -1,8 +1,5 @@
---
title: Configuring Persistent Data for Pipeline Components
weight: 600
aliases:
- /rancher/v2.0-v2.4/en/k8s-in-rancher/pipelines/storage
---
import Tabs from '@theme/Tabs';
@@ -1,9 +1,5 @@
---
title: Example Repositories
weight: 500
aliases:
- /rancher/v2.0-v2.4/en/tools/pipelines/quick-start-guide/
- /rancher/v2.0-v2.4/en/k8s-in-rancher/pipelines/example-repos
---
Rancher ships with several example repositories that you can use to familiarize yourself with pipelines. We recommend configuring and testing the example repository that most resembles your environment before using pipelines with your own repositories in a production environment. Use this example repository as a sandbox for repo configuration, build demonstration, etc. Rancher includes example repositories for:
@@ -1,9 +1,5 @@
---
title: Example YAML File
weight: 501
aliases:
- /rancher/v2.0-v2.4/en/tools/pipelines/reference/
- /rancher/v2.0-v2.4/en/k8s-in-rancher/pipelines/example
---
Pipelines can be configured either through the UI or using a yaml file in the repository, i.e. `.rancher-pipeline.yml` or `.rancher-pipeline.yaml`.
@@ -1,8 +1,5 @@
---
title: Pipeline Configuration Reference
weight: 1
aliases:
- /rancher/v2.0-v2.4/en/k8s-in-rancher/pipelines/config
---
In this section, you'll learn how to configure pipelines.
@@ -1,11 +1,5 @@
---
title: v2.0.x Pipeline Documentation
weight: 9000
aliases:
- /rancher/v2.0-v2.4/en/project-admin/tools/pipelines/docs-for-v2.0.x
- /rancher/v2.0-v2.4/en/project-admin/pipelines/docs-for-v2.0.x
- /rancher/v2.0-v2.4/en/k8s-in-rancher/pipelines/docs-for-v2.0.x
- /rancher/v2.x/en/pipelines/docs-for-v2.0.x/
---
>**Note:** This section describes the pipeline feature as implemented in Rancher v2.0.x. If you are using Rancher v2.1 or later, where pipelines have been significantly improved, please refer to the new documentation for [v2.1 or later](../../pages-for-subheaders/pipelines.md).
@@ -1,8 +1,5 @@
---
title: Tools for Logging, Monitoring, and More
weight: 2033
aliases:
- /rancher/v2.0-v2.4/en/toolcluster-admin/tools/notifiers-and-alerts/
---
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.
@@ -1,6 +1,5 @@
---
title: Architecture Recommendations
weight: 3
---
Kubernetes cluster. If you are installing Rancher on a single node, the main architecture recommendation that applies to your installation is that the cluster running Rancher should be [separate from downstream clusters.](#separation-of-rancher-and-user-clusters)
@@ -1,11 +1,5 @@
---
title: Project Alerts
weight: 2526
aliases:
- /rancher/v2.0-v2.4/en/project-admin/tools/alerts
- /rancher/v2.0-v2.4/en/monitoring-alerting/legacy/alerts/project-alerts
- /rancher/v2.0-v2.4/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-alerts/project-alerts
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-alerts/project-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.
@@ -1,13 +1,5 @@
---
title: Project Logging
shortTitle: Project Logging
weight: 2527
aliases:
- /rancher/v2.0-v2.4/en/project-admin/tools/logging
- /rancher/v2.0-v2.4/en/logging/legacy/project-logging
- /rancher/v2.0-v2.4/en/logging/v2.0.x-v2.4.x/project-logging
- /rancher/v2.x/en/logging/v2.0.x-v2.4.x/project-logging/
- /rancher/v2.x/en/monitoring-alerting/v2.0.x-v2.4.x/cluster-monitoring/project-monitoring/
---
Rancher can integrate with a variety of popular logging services and tools that exist outside of your Kubernetes clusters.
@@ -1,9 +1,5 @@
---
title: Hardening Guide v2.1
weight: 104
aliases:
- /rancher/v2.0-v2.4/en/security/hardening-2.1
- /rancher/v2.x/en/security/rancher-2.1/hardening-2.1/
---
This document provides prescriptive guidance for hardening a production installation of Rancher v2.1.x. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).
@@ -1,9 +1,5 @@
---
title: CIS Benchmark Rancher Self-Assessment Guide v2.1
weight: 209
aliases:
- /rancher/v2.0-v2.4/en/security/benchmark-2.1
- /rancher/v2.x/en/security/rancher-2.1/benchmark-2.1/
---
This document is a companion to the Rancher v2.1 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.
@@ -1,9 +1,5 @@
---
title: Hardening Guide v2.2
weight: 103
aliases:
- /rancher/v2.0-v2.4/en/security/hardening-2.2
- /rancher/v2.x/en/security/rancher-2.2/hardening-2.2/
---
This document provides prescriptive guidance for hardening a production installation of Rancher v2.2.x. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).
@@ -1,9 +1,5 @@
---
title: CIS Benchmark Rancher Self-Assessment Guide v2.2
weight: 208
aliases:
- /rancher/v2.0-v2.4/en/security/benchmark-2.2
- /rancher/v2.x/en/security/rancher-2.2/benchmark-2.2/
---
This document is a companion to the Rancher v2.2 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.
@@ -1,10 +1,7 @@
---
title: Hardening Guide v2.3
weight: 102
aliases:
- /rancher/v2.0-v2.4/en/security/hardening-2.3
- /rancher/v2.x/en/security/rancher-2.3.x/rancher-v2.3.0/hardening-2.3/
---
This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.0-v2.3.2. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).
> This hardening guide describes how to secure the nodes in your cluster, and it is recommended to follow this guide before installing Kubernetes.
@@ -1,9 +1,5 @@
---
title: CIS Benchmark Rancher Self-Assessment Guide v2.3
weight: 207
aliases:
- /rancher/v2.0-v2.4/en/security/benchmark-2.3
- /rancher/v2.x/en/security/rancher-2.3.x/rancher-v2.3.0/benchmark-2.3/
---
This document is a companion to the Rancher v2.3 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.
@@ -1,9 +1,5 @@
---
title: Hardening Guide v2.3.3
weight: 101
aliases:
- /rancher/v2.0-v2.4/en/security/hardening-2.3.3
- /rancher/v2.x/en/security/rancher-2.3.x/rancher-v2.3.3/hardening-2.3.3/
---
This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.3. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).
@@ -1,9 +1,5 @@
---
title: CIS Benchmark Rancher Self-Assessment Guide - Rancher v2.3.3
weight: 206
aliases:
- /rancher/v2.0-v2.4/en/security/benchmark-2.3.3
- /rancher/v2.x/en/security/rancher-2.3.x/rancher-v2.3.3/benchmark-2.3.3/
---
This document is a companion to the Rancher v2.3.3 security hardening guide. The hardening guide provides prescriptive guidance for hardening a production installation of Rancher, and this benchmark guide is meant to help you evaluate the level of security of the hardened cluster against each control in the benchmark.
@@ -1,9 +1,5 @@
---
title: Hardening Guide v2.3.5
weight: 100
aliases:
- /rancher/v2.0-v2.4/en/security/hardening-2.3.5
- /rancher/v2.x/en/security/rancher-2.3.x/rancher-v2.3.5/hardening-2.3.5/
---
This document provides prescriptive guidance for hardening a production installation of Rancher v2.3.5. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).
@@ -1,9 +1,5 @@
---
title: CIS Benchmark Rancher Self-Assessment Guide - v2.3.5
weight: 205
aliases:
- /rancher/v2.0-v2.4/en/security/benchmark-2.3.5
- /rancher/v2.x/en/security/rancher-2.3.x/rancher-v2.3.5/benchmark-2.3.5/
---
### CIS Kubernetes Benchmark v1.5 - Rancher v2.3.5 with Kubernetes v1.15
@@ -1,9 +1,5 @@
---
title: Hardening Guide v2.4
weight: 99
aliases:
- /rancher/v2.0-v2.4/en/security/hardening-2.4
- /rancher/v2.x/en/security/rancher-2.4/hardening-2.4/
---
This document provides prescriptive guidance for hardening a production installation of Rancher v2.4. It outlines the configurations and controls required to address Kubernetes benchmark controls from the Center for Information Security (CIS).
@@ -1,9 +1,5 @@
---
title: CIS Benchmark Rancher Self-Assessment Guide - v2.4
weight: 204
aliases:
- /rancher/v2.0-v2.4/en/security/benchmark-2.4
- /rancher/v2.x/en/security/rancher-2.4/benchmark-2.4/
---
### CIS Kubernetes Benchmark v1.5 - Rancher v2.4 with Kubernetes v1.15
@@ -1,6 +1,5 @@
---
title: Rancher CVEs and Resolutions
weight: 300
---
Rancher is committed to informing the community of security issues in our products. Rancher will publish CVEs (Common Vulnerabilities and Exposures) for issues we have resolved.
@@ -1,6 +1,5 @@
---
title: RKE1 Example YAML
weight: 60
---
Below is an example RKE template configuration file for reference.
@@ -8,9 +7,9 @@ Below is an example RKE template configuration file for reference.
The YAML in the RKE template uses the same customization that is used when you create an RKE cluster. However, since the YAML is within the context of a Rancher provisioned RKE cluster, the customization from the RKE docs needs to be nested under the `rancher_kubernetes_engine` directive.
```yaml
#
#
# Cluster Config
#
#
docker_root_dir: /var/lib/docker
enable_cluster_alerting: false
@@ -20,7 +19,7 @@ enable_cluster_alerting: false
# but end users could still turn alerting
# on or off.
enable_cluster_monitoring: true
enable_cluster_monitoring: true
# This setting is not enforced. Clusters
# created with this sample template
# would have monitoring turned on
@@ -30,54 +29,54 @@ enable_cluster_monitoring: true
enable_network_policy: false
local_cluster_auth_endpoint:
enabled: true
#
#
# Rancher Config
#
#
rancher_kubernetes_engine_config: # Your RKE template config goes here.
addon_job_timeout: 30
authentication:
strategy: x509
ignore_docker_version: true
#
#
# # Currently only nginx ingress provider is supported.
# # To disable ingress controller, set `provider: none`
# # To enable ingress on specific nodes, use the node_selector, eg:
# provider: nginx
# node_selector:
# app: ingress
#
#
ingress:
provider: nginx
kubernetes_version: v1.15.3-rancher3-1
monitoring:
provider: metrics-server
#
#
# If you are using calico on AWS
#
#
# network:
# plugin: calico
# calico_network_provider:
# cloud_provider: aws
#
#
# # To specify flannel interface
#
#
# network:
# plugin: flannel
# flannel_network_provider:
# iface: eth1
#
#
# # To specify flannel interface for canal plugin
#
#
# network:
# plugin: canal
# canal_network_provider:
# iface: eth1
#
#
network:
options:
flannel_backend_type: vxlan
plugin: canal
#
#
# services:
# kube-api:
# service_cluster_ip_range: 10.43.0.0/16
@@ -87,7 +86,7 @@ rancher_kubernetes_engine_config: # Your RKE template config goes here.
# kubelet:
# cluster_domain: cluster.local
# cluster_dns_server: 10.43.0.10
#
#
services:
etcd:
backup_config:
@@ -1,6 +1,5 @@
---
title: Advanced Options for Docker Installs
weight: 5
---
When installing Rancher, there are several [advanced options](../../pages-for-subheaders/resources.md) that can be enabled:
@@ -1,9 +1,5 @@
---
title: HTTP Proxy Configuration
weight: 251
aliases:
- /rancher/v2.0-v2.4/en/installation/proxy-configuration/
- /rancher/v2.0-v2.4/en/installation/single-node/proxy
---
If you operate Rancher behind a proxy and you want to access services through the proxy (such as retrieving catalogs), you must provide Rancher information about your proxy. As Rancher is written in Go, it uses the common proxy environment variables as shown below.
@@ -1,6 +1,5 @@
---
title: System Tools
weight: 22
---
System Tools is a tool to perform operational tasks on [Rancher Launched Kubernetes](../pages-for-subheaders/launch-kubernetes-with-rancher.md) clusters or [installations of Rancher on an RKE cluster.](../pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster.md) The tasks include:
@@ -1,9 +1,5 @@
---
title: API Keys
weight: 7005
aliases:
- /rancher/v2.0-v2.4/en/concepts/api-keys/
- /rancher/v2.0-v2.4/en/tasks/user-settings/api-keys/
---
## API Keys and User Authentication
@@ -31,7 +27,7 @@ API Keys are composed of four components:
_Available as of v2.4.6_
Expiration period will be bound by `v3/settings/auth-token-max-ttl-minutes`. If it exceeds the max-ttl, API key will be created with max-ttl as the expiration period.
A scope will limit the API key so that it will only work against the Kubernetes API of the specified cluster. If the cluster is configured with an Authorized Cluster Endpoint, you will be able to use a scoped token directly against the cluster's API without proxying through the Rancher server. See [Authorized Cluster Endpoints](../../pages-for-subheaders/rancher-manager-architecture.md#4-authorized-cluster-endpoint) for more information.
4. Click **Create**.
@@ -1,6 +1,5 @@
---
title: Managing Cloud Credentials
weight: 7011
---
_Available as of v2.2.0_
@@ -31,7 +30,7 @@ All cloud credentials are bound to the user profile of who created it. They **ca
## Updating a Cloud Credential
When access credentials are changed or compromised, updating a cloud credential allows you to rotate those credentials while keeping the same node template.
When access credentials are changed or compromised, updating a cloud credential allows you to rotate those credentials while keeping the same node template.
1. From your user settings, select **User Avatar > Cloud Credentials**.
1. Choose the cloud credential you want to edit and click the **⋮ > Edit**.
@@ -1,6 +1,5 @@
---
title: Managing Node Templates
weight: 7010
---
When you provision a cluster [hosted by an infrastructure provider](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md), [node templates](../../pages-for-subheaders/use-new-nodes-in-an-infra-provider.md#node-templates) are used to provision the cluster nodes. These templates use Docker Machine configuration options to define an operating system image and settings/parameters for the node. You can create node templates in two contexts:
@@ -1,6 +1,5 @@
---
title: User Preferences
weight: 7012
---
Each user can choose preferences to personalize their Rancher experience. To change preference settings, open the **User Settings** menu and then select **Preferences**.
@@ -1,8 +1,5 @@
---
title: Migration Tools CLI Reference
weight: 100
aliases:
- /rancher/v2.x/en/v1.6-migration/run-migration-tool/migration-tools-ref/
---
The migration-tools CLI includes multiple commands and options to assist your migration from Rancher v1.6 to Rancher v2.x.
@@ -84,4 +81,4 @@ migration-tools parse --docker-file <DOCKER_COMPOSE_ABSOLUTE_PATH> --rancher-fil
>**Note:** If you omit the `--docker-file` and `--rancher-file` options from your command, the migration-tools CLI checks its home directory for these Compose files.
**Result:** The migration-tools CLI parses your Compose files and outputs Kubernetes manifest specs as well as an `output.txt` file. For each service in the stack, a Kubernetes manifest is created and named the same as your service. The `output.txt` file lists all constructs for each service in `docker-compose.yml` that requires special handling to be successfully migrated to Rancher v2.x. Each construct links to the relevant blog articles on how to implement it in Rancher v2.x.
**Result:** The migration-tools CLI parses your Compose files and outputs Kubernetes manifest specs as well as an `output.txt` file. For each service in the stack, a Kubernetes manifest is created and named the same as your service. The `output.txt` file lists all constructs for each service in `docker-compose.yml` that requires special handling to be successfully migrated to Rancher v2.x. Each construct links to the relevant blog articles on how to implement it in Rancher v2.x.