mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-10-03 08:23:16 +00:00
26 lines
61 KiB
HTML
26 lines
61 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-2.5 plugin-docs plugin-id-default docs-doc-id-cluster-provisioning/rke-clusters/options/options">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.3.1">
|
||
<title data-rh="true">RKE Cluster Configuration Reference | Rancher</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://ranchermanager.docs.rancher.com/v2.5/cluster-provisioning/rke-clusters/options"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="2.5"><meta data-rh="true" name="docusaurus_tag" content="docs-default-2.5"><meta data-rh="true" name="docsearch:version" content="2.5"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-2.5"><meta data-rh="true" property="og:title" content="RKE Cluster Configuration Reference | Rancher"><meta data-rh="true" name="description" content="When Rancher installs Kubernetes, it uses RKE as the Kubernetes distribution."><meta data-rh="true" property="og:description" content="When Rancher installs Kubernetes, it uses RKE as the Kubernetes distribution."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="alternate" href="https://ranchermanager.docs.rancher.com/v2.5/cluster-provisioning/rke-clusters/options" hreflang="en"><link data-rh="true" rel="alternate" href="https://ranchermanager.docs.rancher.com/zh/v2.5/cluster-provisioning/rke-clusters/options" hreflang="zh"><link data-rh="true" rel="alternate" href="https://ranchermanager.docs.rancher.com/v2.5/cluster-provisioning/rke-clusters/options" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://30NEY6C9UY-dsn.algolia.net" crossorigin="anonymous"><link data-rh="true" rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration"><link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-57KS2MW",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
|
||
|
||
|
||
<link rel="search" type="application/opensearchdescription+xml" title="Rancher" href="/opensearch.xml">
|
||
|
||
<script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" charset="UTF-8" data-domain-script="0f98beb0-fc4c-417d-a42e-564e2cae42d2" async></script>
|
||
<script src="/scripts/optanonwrapper.js" async></script><link rel="stylesheet" href="/assets/css/styles.efd70281.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.5e8050ed.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.7c8ccb50.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-57KS2MW" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
||
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/rancher-logo-horiz-color.svg" alt="logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/rancher-logo-horiz-color.svg" alt="logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate"></b></a><div class="navbar__item dropdown dropdown--hoverable"><a aria-current="page" class="navbar__link active" aria-haspopup="true" aria-expanded="false" role="button" href="/v2.5">v2.5</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/cluster-provisioning/rke-clusters/options">Latest</a></li><li><a class="dropdown__link" href="/v2.7/cluster-provisioning/rke-clusters/options">v2.7</a></li><li><a class="dropdown__link" href="/v2.6/cluster-provisioning/rke-clusters/options">v2.6</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/v2.5/cluster-provisioning/rke-clusters/options">v2.5</a></li><li><a class="dropdown__link" href="/v2.0-v2.4">v2.0-v2.4</a></li><li><a class="dropdown__link" href="/versions">All versions</a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/v2.5/cluster-provisioning/rke-clusters/options" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh/v2.5/cluster-provisioning/rke-clusters/options" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh">简体中文</a></li></ul></div><a href="https://github.com/rancher/rancher-docs" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link navbar__github">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><a href="https://www.rancher.com" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Rancher Home<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><main class="docMainContainer_gTbr docMainContainerEnhanced_Uz_u"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->Rancher<!-- --> <b>v2.5</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/cluster-provisioning/rke-clusters/options">latest version</a></b> (<!-- -->Latest<!-- -->).</div></div><div class="docItemContainer_Djhp"><article><span class="theme-doc-version-badge badge badge--secondary">Version: v2.5</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>RKE Cluster Configuration Reference</h1></header><p>When Rancher installs Kubernetes, it uses <a href="/v2.5/pages-for-subheaders/launch-kubernetes-with-rancher">RKE</a> as the Kubernetes distribution.</p><p>This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster.</p><p>You can configure the Kubernetes options one of two ways:</p><ul><li><a href="#rancher-ui-options">Rancher UI</a>: Use the Rancher UI to select options that are commonly customized when setting up a Kubernetes cluster.</li><li><a href="#cluster-config-file">Cluster Config File</a>: Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the options available in an RKE installation, except for system_images configuration, by specifying them in YAML.</li></ul><p>The RKE cluster config options are nested under the <code>rancher_kubernetes_engine_config</code> directive. For more information, see the section about the <a href="#cluster-config-file">cluster config file.</a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="rancher-ui-options">Rancher UI Options<a href="#rancher-ui-options" class="hash-link" aria-label="Direct link to Rancher UI Options" title="Direct link to Rancher UI Options"></a></h2><p>When creating a cluster using one of the options described in <a href="/v2.5/pages-for-subheaders/launch-kubernetes-with-rancher">Rancher Launched Kubernetes</a>, you can configure basic Kubernetes options using the <strong>Cluster Options</strong> section.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="kubernetes-version">Kubernetes Version<a href="#kubernetes-version" class="hash-link" aria-label="Direct link to Kubernetes Version" title="Direct link to Kubernetes Version"></a></h3><p>The version of Kubernetes installed on your cluster nodes. Rancher packages its own version of Kubernetes based on <a href="https://github.com/rancher/hyperkube" target="_blank" rel="noopener noreferrer">hyperkube</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="network-provider">Network Provider<a href="#network-provider" class="hash-link" aria-label="Direct link to Network Provider" title="Direct link to Network Provider"></a></h3><p>The <a href="https://kubernetes.io/docs/concepts/cluster-administration/networking/" target="_blank" rel="noopener noreferrer">Network Provider</a> that the cluster uses. For more details on the different networking providers, please view our <a href="/v2.5/faq/container-network-interface-providers">Networking FAQ</a>.</p><blockquote><p><strong>Note:</strong> After you launch the cluster, you cannot change your network provider. Therefore, choose which network provider you want to use carefully, as Kubernetes doesn't allow switching between network providers. Once a cluster is created with a network provider, changing network providers would require you tear down the entire cluster and all its applications.</p></blockquote><p>Out of the box, Rancher is compatible with the following network providers:</p><ul><li><a href="https://github.com/projectcalico/canal" target="_blank" rel="noopener noreferrer">Canal</a></li><li><a href="https://github.com/coreos/flannel#flannel" target="_blank" rel="noopener noreferrer">Flannel</a></li><li><a href="https://docs.projectcalico.org/v3.11/introduction/" target="_blank" rel="noopener noreferrer">Calico</a></li><li><a href="https://github.com/weaveworks/weave" target="_blank" rel="noopener noreferrer">Weave</a></li></ul><p><strong>Notes on Weave:</strong></p><p>When Weave is selected as network provider, Rancher will automatically enable encryption by generating a random password. If you want to specify the password manually, please see how to configure your cluster using a <a href="/v2.5/cluster-provisioning/rke-clusters/cluster-provisioning/rke-clusters/options#cluster-config-file">Config File</a> and the <a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/#weave-network-plug-in-options" target="_blank" rel="noopener noreferrer">Weave Network Plug-in Options</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="project-network-isolation">Project Network Isolation<a href="#project-network-isolation" class="hash-link" aria-label="Direct link to Project Network Isolation" title="Direct link to Project Network Isolation"></a></h3><p>Project network isolation is used to enable or disable communication between pods in different projects.</p><div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Rancher v2.5.8+</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Rancher before v2.5.8</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>To enable project network isolation as a cluster option, you will need to use any RKE network plugin that supports the enforcement of Kubernetes network policies, such as Canal or the Cisco ACI plugin.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>To enable project network isolation as a cluster option, you will need to use Canal as the CNI.</p></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="kubernetes-cloud-providers">Kubernetes Cloud Providers<a href="#kubernetes-cloud-providers" class="hash-link" aria-label="Direct link to Kubernetes Cloud Providers" title="Direct link to Kubernetes Cloud Providers"></a></h3><p>You can configure a <a href="/v2.5/pages-for-subheaders/set-up-cloud-providers">Kubernetes cloud provider</a>. If you want to use <a href="/v2.5/pages-for-subheaders/create-kubernetes-persistent-storage">volumes and storage</a> in Kubernetes, typically you must select the specific cloud provider in order to use it. For example, if you want to use Amazon EBS, you would need to select the <code>aws</code> cloud provider.</p><blockquote><p><strong>Note:</strong> If the cloud provider you want to use is not listed as an option, you will need to use the <a href="#cluster-config-file">config file option</a> to configure the cloud provider. Please reference the <a href="https://rancher.com/docs/rke/latest/en/config-options/cloud-providers/" target="_blank" rel="noopener noreferrer">RKE cloud provider documentation</a> on how to configure the cloud provider.</p></blockquote><p>If you want to see all the configuration options for a cluster, please click <strong>Show advanced options</strong> on the bottom right. The advanced options are described below:</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="private-registries">Private registries<a href="#private-registries" class="hash-link" aria-label="Direct link to Private registries" title="Direct link to Private registries"></a></h3><p>The cluster-level private registry configuration is only used for provisioning clusters.</p><p>There are two main ways to set up private registries in Rancher: by setting up the <a href="/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/global-default-private-registry">global default registry</a> through the <strong>Settings</strong> tab in the global view, and by setting up a private registry in the advanced options in the cluster-level settings. The global default registry is intended to be used for air-gapped setups, for registries that do not require credentials. The cluster-level private registry is intended to be used in all setups in which the private registry requires credentials.</p><p>If your private registry requires credentials, you need to pass the credentials to Rancher by editing the cluster options for each cluster that needs to pull images from the registry.</p><p>The private registry configuration option tells Rancher where to pull the <a href="https://rancher.com/docs/rke/latest/en/config-options/system-images/" target="_blank" rel="noopener noreferrer">system images</a> or <a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/" target="_blank" rel="noopener noreferrer">addon images</a> that will be used in your cluster.</p><ul><li><strong>System images</strong> are components needed to maintain the Kubernetes cluster.</li><li><strong>Add-ons</strong> are used to deploy several cluster components, including network plug-ins, the ingress controller, the DNS provider, or the metrics server.</li></ul><p>See the <a href="https://rancher.com/docs/rke/latest/en/config-options/private-registries/" target="_blank" rel="noopener noreferrer">RKE documentation on private registries</a> for more information on the private registry for components applied during the provisioning of the cluster.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="authorized-cluster-endpoint">Authorized Cluster Endpoint<a href="#authorized-cluster-endpoint" class="hash-link" aria-label="Direct link to Authorized Cluster Endpoint" title="Direct link to Authorized Cluster Endpoint"></a></h3><p>Authorized Cluster Endpoint can be used to directly access the Kubernetes API server, without requiring communication through Rancher.</p><blockquote><p>The authorized cluster endpoint is available only in clusters that Rancher has provisioned <a href="/v2.5/pages-for-subheaders/rancher-manager-architecture#tools-for-provisioning-kubernetes-clusters">using RKE</a>. It is not available for clusters in hosted Kubernetes providers, such as Amazon's EKS. Additionally, the authorized cluster endpoint cannot be enabled for RKE clusters that are registered with Rancher; it is available only on Rancher-launched Kubernetes clusters.</p></blockquote><p>This is enabled by default in Rancher-launched Kubernetes clusters, using the IP of the node with the <code>controlplane</code> role and the default Kubernetes self signed certificates.</p><p>For more detail on how an authorized cluster endpoint works and why it is used, refer to the <a href="/v2.5/reference-guides/rancher-manager-architecture/communicating-with-downstream-user-clusters#4-authorized-cluster-endpoint">architecture section.</a></p><p>We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the <a href="/v2.5/reference-guides/rancher-manager-architecture/architecture-recommendations#architecture-for-an-authorized-cluster-endpoint">recommended architecture section.</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="node-pools">Node Pools<a href="#node-pools" class="hash-link" aria-label="Direct link to Node Pools" title="Direct link to Node Pools"></a></h3><p>For information on using the Rancher UI to set up node pools in an RKE cluster, refer to <a href="/v2.5/pages-for-subheaders/use-new-nodes-in-an-infra-provider">this page.</a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="advanced-options">Advanced Options<a href="#advanced-options" class="hash-link" aria-label="Direct link to Advanced Options" title="Direct link to Advanced Options"></a></h2><p>The following options are available when you create clusters in the Rancher UI. They are located under <strong>Advanced Options.</strong></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="nginx-ingress">NGINX Ingress<a href="#nginx-ingress" class="hash-link" aria-label="Direct link to NGINX Ingress" title="Direct link to NGINX Ingress"></a></h3><p>Option to enable or disable the <a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/ingress-controllers/" target="_blank" rel="noopener noreferrer">NGINX ingress controller</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="node-port-range">Node Port Range<a href="#node-port-range" class="hash-link" aria-label="Direct link to Node Port Range" title="Direct link to Node Port Range"></a></h3><p>Option to change the range of ports that can be used for <a href="https://kubernetes.io/docs/concepts/services-networking/service/#nodeport" target="_blank" rel="noopener noreferrer">NodePort services</a>. Default is <code>30000-32767</code>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="metrics-server-monitoring">Metrics Server Monitoring<a href="#metrics-server-monitoring" class="hash-link" aria-label="Direct link to Metrics Server Monitoring" title="Direct link to Metrics Server Monitoring"></a></h3><p>Option to enable or disable <a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/metrics-server/" target="_blank" rel="noopener noreferrer">Metrics Server</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="pod-security-policy-support">Pod Security Policy Support<a href="#pod-security-policy-support" class="hash-link" aria-label="Direct link to Pod Security Policy Support" title="Direct link to Pod Security Policy Support"></a></h3><p>Option to enable and select a default <a href="/v2.5/how-to-guides/advanced-user-guides/authentication-permissions-and-global-configuration/create-pod-security-policies">Pod Security Policy</a>. You must have an existing Pod Security Policy configured before you can use this option.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="docker-version-on-nodes">Docker Version on Nodes<a href="#docker-version-on-nodes" class="hash-link" aria-label="Direct link to Docker Version on Nodes" title="Direct link to Docker Version on Nodes"></a></h3><p>Option to require <a href="/v2.5/pages-for-subheaders/installation-requirements">a supported Docker version</a> installed on the cluster nodes that are added to the cluster, or to allow unsupported Docker versions installed on the cluster nodes.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="docker-root-directory">Docker Root Directory<a href="#docker-root-directory" class="hash-link" aria-label="Direct link to Docker Root Directory" title="Direct link to Docker Root Directory"></a></h3><p>If the nodes you are adding to the cluster have Docker configured with a non-default Docker Root Directory (default is <code>/var/lib/docker</code>), please specify the correct Docker Root Directory in this option.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="recurring-etcd-snapshots">Recurring etcd Snapshots<a href="#recurring-etcd-snapshots" class="hash-link" aria-label="Direct link to Recurring etcd Snapshots" title="Direct link to Recurring etcd Snapshots"></a></h3><p>Option to enable or disable <a href="https://rancher.com/docs/rke/latest/en/etcd-snapshots/#etcd-recurring-snapshots" target="_blank" rel="noopener noreferrer">recurring etcd snapshots</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="agent-environment-variables">Agent Environment Variables<a href="#agent-environment-variables" class="hash-link" aria-label="Direct link to Agent Environment Variables" title="Direct link to Agent Environment Variables"></a></h3><p><em>Available as of v2.5.6</em></p><p>Option to set environment variables for <a href="/v2.5/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/launch-kubernetes-with-rancher/about-rancher-agents">rancher agents</a>. The environment variables can be set using key value pairs. If rancher agent requires use of proxy to communicate with Rancher server, <code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code> and <code>NO_PROXY</code> environment variables can be set using agent environment variables.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="cluster-config-file">Cluster Config File<a href="#cluster-config-file" class="hash-link" aria-label="Direct link to Cluster Config File" title="Direct link to Cluster Config File"></a></h2><p>Instead of using the Rancher UI to choose Kubernetes options for the cluster, advanced users can create an RKE config file. Using a config file allows you to set any of the <a href="https://rancher.com/docs/rke/latest/en/config-options/" target="_blank" rel="noopener noreferrer">options available</a> in an RKE installation, except for <code>system_images</code> configuration. The <code>system_images</code> option is not supported when creating a cluster with the Rancher UI or API.</p><ul><li>To edit an RKE config file directly from the Rancher UI, click <strong>Edit as YAML</strong>.</li><li>To read from an existing RKE file, click <strong>Read from a file</strong>.</li></ul><p><img loading="lazy" alt="image" src="/assets/images/cluster-options-yaml-994a3b9b3d53ed35101fa31517f64620.png" width="2708" height="258" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="config-file-structure-in-rancher-v230">Config File Structure in Rancher v2.3.0+<a href="#config-file-structure-in-rancher-v230" class="hash-link" aria-label="Direct link to Config File Structure in Rancher v2.3.0+" title="Direct link to Config File Structure in Rancher v2.3.0+"></a></h3><p>RKE (Rancher Kubernetes Engine) is the tool that Rancher uses to provision Kubernetes clusters. Rancher's cluster config files used to have the same structure as <a href="https://rancher.com/docs/rke/latest/en/example-yamls/" target="_blank" rel="noopener noreferrer">RKE config files,</a> but the structure changed so that in Rancher, RKE cluster config items are separated from non-RKE config items. Therefore, configuration for your cluster needs to be nested under the <code>rancher_kubernetes_engine_config</code> directive in the cluster config file. Cluster config files created with earlier versions of Rancher will need to be updated for this format. An example cluster config file is included below.</p><details id="v2.3.0-cluster-config-file" class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>Example Cluster Config File</summary><div><div class="collapsibleContent_i85q"><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Cluster Config</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">docker_root_dir</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> /var/lib/docker</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">enable_cluster_alerting</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">enable_cluster_monitoring</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">enable_network_policy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">local_cluster_auth_endpoint</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">enabled</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Rancher Config</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">rancher_kubernetes_engine_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Your RKE template config goes here.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">addon_job_timeout</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">30</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">authentication</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">strategy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> x509</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">ignore_docker_version</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># # Currently only nginx ingress provider is supported.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># # To disable ingress controller, set `provider: none`</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># # To enable ingress on specific nodes, use the node_selector, eg:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># provider: nginx</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># node_selector:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># app: ingress</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">ingress</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">provider</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> nginx</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">kubernetes_version</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> v1.15.3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">rancher3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">monitoring</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">provider</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> metrics</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">server</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># If you are using calico on AWS</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># network:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># plugin: calico</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># calico_network_provider:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># cloud_provider: aws</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># # To specify flannel interface</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># network:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># plugin: flannel</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># flannel_network_provider:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># iface: eth1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># # To specify flannel interface for canal plugin</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># network:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># plugin: canal</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># canal_network_provider:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># iface: eth1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">network</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">options</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">flannel_backend_type</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> vxlan</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">plugin</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> canal</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># services:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># kube-api:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># service_cluster_ip_range: 10.43.0.0/16</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># kube-controller:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># cluster_cidr: 10.42.0.0/16</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># service_cluster_ip_range: 10.43.0.0/16</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># kubelet:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># cluster_domain: cluster.local</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># cluster_dns_server: 10.43.0.10</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic">#</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">services</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">etcd</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">backup_config</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">enabled</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">interval_hours</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">12</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">retention</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">6</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">safe_timestamp</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">creation</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 12h</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">extra_args</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">election-timeout</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">5000</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">heartbeat-interval</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">500</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">gid</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">retention</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 72h</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">snapshot</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">uid</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">kube_api</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">always_pull_images</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">pod_security_policy</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">service_node_port_range</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 30000</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token number" style="color:rgb(247, 140, 108)">32767</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">ssh_agent_auth</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">windows_prefered_cluster</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">false</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div></div></details><h3 class="anchor anchorWithStickyNavbar_LWe7" id="default-dns-provider">Default DNS provider<a href="#default-dns-provider" class="hash-link" aria-label="Direct link to Default DNS provider" title="Direct link to Default DNS provider"></a></h3><p>The table below indicates what DNS provider is deployed by default. See <a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/dns/" target="_blank" rel="noopener noreferrer">RKE documentation on DNS provider</a> for more information how to configure a different DNS provider. CoreDNS can only be used on Kubernetes v1.12.0 and higher.</p><table><thead><tr><th>Rancher version</th><th>Kubernetes version</th><th>Default DNS provider</th></tr></thead><tbody><tr><td>v2.2.5 and higher</td><td>v1.14.0 and higher</td><td>CoreDNS</td></tr><tr><td>v2.2.5 and higher</td><td>v1.13.x and lower</td><td>kube-dns</td></tr><tr><td>v2.2.4 and lower</td><td>any</td><td>kube-dns</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="rancher-specific-parameters">Rancher specific parameters<a href="#rancher-specific-parameters" class="hash-link" aria-label="Direct link to Rancher specific parameters" title="Direct link to Rancher specific parameters"></a></h2><p>Besides the RKE config file options, there are also Rancher specific settings that can be configured in the Config File (YAML):</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="docker_root_dir">docker_root_dir<a href="#docker_root_dir" class="hash-link" aria-label="Direct link to docker_root_dir" title="Direct link to docker_root_dir"></a></h3><p>See <a href="#docker-root-directory">Docker Root Directory</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="enable_cluster_monitoring">enable_cluster_monitoring<a href="#enable_cluster_monitoring" class="hash-link" aria-label="Direct link to enable_cluster_monitoring" title="Direct link to enable_cluster_monitoring"></a></h3><p>Option to enable or disable <a href="/v2.5/pages-for-subheaders/monitoring-and-alerting">Cluster Monitoring</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="enable_network_policy">enable_network_policy<a href="#enable_network_policy" class="hash-link" aria-label="Direct link to enable_network_policy" title="Direct link to enable_network_policy"></a></h3><p>Option to enable or disable Project Network Isolation.</p><p>Before Rancher v2.5.8, project network isolation is only available if you are using the Canal network plugin for RKE.</p><p>In v2.5.8+, project network isolation is available if you are using any RKE network plugin that supports the enforcement of Kubernetes network policies, such as Canal or the Cisco ACI plugin.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="local_cluster_auth_endpoint">local_cluster_auth_endpoint<a href="#local_cluster_auth_endpoint" class="hash-link" aria-label="Direct link to local_cluster_auth_endpoint" title="Direct link to local_cluster_auth_endpoint"></a></h3><p>See <a href="#authorized-cluster-endpoint">Authorized Cluster Endpoint</a>.</p><p>Example:</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">local_cluster_auth_endpoint</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">enabled</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">fqdn</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"FQDN"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">ca_certs</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">"BASE64_CACERT"</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="custom-network-plug-in">Custom Network Plug-in<a href="#custom-network-plug-in" class="hash-link" aria-label="Direct link to Custom Network Plug-in" title="Direct link to Custom Network Plug-in"></a></h3><p>You can add a custom network plug-in by using the <a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/" target="_blank" rel="noopener noreferrer">user-defined add-on functionality</a> of RKE. You define any add-on that you want deployed after the Kubernetes cluster is deployed.</p><p>There are two ways that you can specify an add-on:</p><ul><li><a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#in-line-add-ons" target="_blank" rel="noopener noreferrer">In-line Add-ons</a></li><li><a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#referencing-yaml-files-for-add-ons" target="_blank" rel="noopener noreferrer">Referencing YAML Files for Add-ons</a></li></ul><p>For an example of how to configure a custom network plug-in by editing the <code>cluster.yml</code>, refer to the <a href="https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/custom-network-plugin-example" target="_blank" rel="noopener noreferrer">RKE documentation.</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.5/cluster-provisioning/rke-clusters/options/options.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2023-06-26T16:40:17.000Z">Jun 26, 2023</time></b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#rancher-ui-options" class="table-of-contents__link toc-highlight">Rancher UI Options</a><ul><li><a href="#kubernetes-version" class="table-of-contents__link toc-highlight">Kubernetes Version</a></li><li><a href="#network-provider" class="table-of-contents__link toc-highlight">Network Provider</a></li><li><a href="#project-network-isolation" class="table-of-contents__link toc-highlight">Project Network Isolation</a></li><li><a href="#kubernetes-cloud-providers" class="table-of-contents__link toc-highlight">Kubernetes Cloud Providers</a></li><li><a href="#private-registries" class="table-of-contents__link toc-highlight">Private registries</a></li><li><a href="#authorized-cluster-endpoint" class="table-of-contents__link toc-highlight">Authorized Cluster Endpoint</a></li><li><a href="#node-pools" class="table-of-contents__link toc-highlight">Node Pools</a></li></ul></li><li><a href="#advanced-options" class="table-of-contents__link toc-highlight">Advanced Options</a><ul><li><a href="#nginx-ingress" class="table-of-contents__link toc-highlight">NGINX Ingress</a></li><li><a href="#node-port-range" class="table-of-contents__link toc-highlight">Node Port Range</a></li><li><a href="#metrics-server-monitoring" class="table-of-contents__link toc-highlight">Metrics Server Monitoring</a></li><li><a href="#pod-security-policy-support" class="table-of-contents__link toc-highlight">Pod Security Policy Support</a></li><li><a href="#docker-version-on-nodes" class="table-of-contents__link toc-highlight">Docker Version on Nodes</a></li><li><a href="#docker-root-directory" class="table-of-contents__link toc-highlight">Docker Root Directory</a></li><li><a href="#recurring-etcd-snapshots" class="table-of-contents__link toc-highlight">Recurring etcd Snapshots</a></li><li><a href="#agent-environment-variables" class="table-of-contents__link toc-highlight">Agent Environment Variables</a></li></ul></li><li><a href="#cluster-config-file" class="table-of-contents__link toc-highlight">Cluster Config File</a><ul><li><a href="#config-file-structure-in-rancher-v230" class="table-of-contents__link toc-highlight">Config File Structure in Rancher v2.3.0+</a></li><li><a href="#default-dns-provider" class="table-of-contents__link toc-highlight">Default DNS provider</a></li></ul></li><li><a href="#rancher-specific-parameters" class="table-of-contents__link toc-highlight">Rancher specific parameters</a><ul><li><a href="#docker_root_dir" class="table-of-contents__link toc-highlight">docker_root_dir</a></li><li><a href="#enable_cluster_monitoring" class="table-of-contents__link toc-highlight">enable_cluster_monitoring</a></li><li><a href="#enable_network_policy" class="table-of-contents__link toc-highlight">enable_network_policy</a></li><li><a href="#local_cluster_auth_endpoint" class="table-of-contents__link toc-highlight">local_cluster_auth_endpoint</a></li><li><a href="#custom-network-plug-in" class="table-of-contents__link toc-highlight">Custom Network Plug-in</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 SUSE Rancher. All Rights Reserved.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.5e8050ed.js"></script>
|
||
<script src="/assets/js/main.7c8ccb50.js"></script>
|
||
</body>
|
||
</html> |