mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-10-20 16:46:12 +00:00
17 lines
36 KiB
HTML
17 lines
36 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-pages-for-subheaders/installation-requirements">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<meta name="generator" content="Docusaurus v2.0.0-beta.21">
|
||
<link rel="search" type="application/opensearchdescription+xml" title="Rancher Manager" href="/opensearch.xml"><title data-rh="true">Installation Requirements | Rancher Manager</title><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="http://docs.ranchermanager.rancher.io//pages-for-subheaders/installation-requirements"><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="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Installation Requirements | Rancher Manager"><meta data-rh="true" name="description" content="Learn the node requirements for each node running Rancher server when you’re configuring Rancher to run either in a Docker or Kubernetes setup"><meta data-rh="true" property="og:description" content="Learn the node requirements for each node running Rancher server when you’re configuring Rancher to run either in a Docker or Kubernetes setup"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="http://docs.ranchermanager.rancher.io//pages-for-subheaders/installation-requirements"><link data-rh="true" rel="alternate" href="http://docs.ranchermanager.rancher.io//pages-for-subheaders/installation-requirements" hreflang="en"><link data-rh="true" rel="alternate" href="http://docs.ranchermanager.rancher.io//zh/pages-for-subheaders/installation-requirements" hreflang="zh"><link data-rh="true" rel="alternate" href="http://docs.ranchermanager.rancher.io//pages-for-subheaders/installation-requirements" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://30NEY6C9UY-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.31d3122a.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.6d86be68.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.2a2e2876.js" as="script">
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<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"><a href="#" class="skipToContent_fXgn">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><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.6</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/pages-for-subheaders/installation-requirements">v2.6</a></li><li><a class="dropdown__link" href="/v2.5/pages-for-subheaders/installation-requirements">v2.5</a></li><li><a class="dropdown__link" href="/v2.0-v2.4/pages-for-subheaders/installation-requirements">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"><a aria-current="page" class="navbar__item navbar__link navbar__docs navbar__link--active" href="/">Docs</a><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="/pages-for-subheaders/installation-requirements" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active">English</a></li><li><a href="/zh/pages-for-subheaders/installation-requirements" target="_self" rel="noopener noreferrer" class="dropdown__link">简体中文</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_lCJq"><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 class="main-wrapper 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"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">Rancher 2.6</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/getting-started">Getting Started</a><button aria-label="Toggle the collapsible sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/introduction">Introduction</a><button aria-label="Toggle the collapsible sidebar category 'Introduction'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/quick-start-guides">Quick Start Guides</a><button aria-label="Toggle the collapsible sidebar category 'Quick Start Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" tabindex="0" href="/pages-for-subheaders/installation-and-upgrade">Installation and Upgrade</a><button aria-label="Toggle the collapsible sidebar category 'Installation and Upgrade'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current="page" aria-expanded="true" tabindex="0" href="/pages-for-subheaders/installation-requirements">Installation Requirements</a><button aria-label="Toggle the collapsible sidebar category 'Installation Requirements'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/installation-and-upgrade/installation-requirements/install-docker">Installing Docker</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/installation-and-upgrade/installation-requirements/dockershim">Dockershim</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-4 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/installation-and-upgrade/installation-requirements/port-requirements">Port Requirements</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster">Install/Upgrade on a Kubernetes Cluster</a><button aria-label="Toggle the collapsible sidebar category 'Install/Upgrade on a Kubernetes Cluster'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/other-installation-methods">Other Installation Methods</a><button aria-label="Toggle the collapsible sidebar category 'Other Installation Methods'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/resources">Resources</a><button aria-label="Toggle the collapsible sidebar category 'Resources'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/installation-and-upgrade/upgrade-and-roll-back-kubernetes">Upgrading and Rolling Back Kubernetes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/installation-and-upgrade/upgrade-kubernetes-without-upgrading-rancher">Upgrading Kubernetes without Upgrading Rancher</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/advanced-options">Advanced Options</a><button aria-label="Toggle the collapsible sidebar category 'Advanced Options'" type="button" class="clean-btn menu__caret"></button></div></li></ul></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/how-to-guides">How-to Guides</a><button aria-label="Toggle the collapsible sidebar category 'How-to Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/reference-guides">Reference Guides</a><button aria-label="Toggle the collapsible sidebar category 'Reference Guides'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/explanations">Explanations</a><button aria-label="Toggle the collapsible sidebar category 'Explanations'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/faq">FAQ</a><button aria-label="Toggle the collapsible sidebar category 'FAQ'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/troubleshooting">Troubleshooting</a><button aria-label="Toggle the collapsible sidebar category 'Troubleshooting'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/contribute-to-rancher">Contributing to Rancher</a></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_GujU"><div class="docItemContainer_Adtb"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/getting-started"><span itemprop="name">Getting Started</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/pages-for-subheaders/installation-and-upgrade"><span itemprop="name">Installation and Upgrade</span></a><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Installation Requirements</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: v2.6</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_aoJ5"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Installation Requirements</h1></header><p>This page describes the software, hardware, and networking requirements for the nodes where the Rancher server will be installed. The Rancher server can be installed on a single node or a high-availability Kubernetes cluster.</p><div class="admonition admonition-note alert alert--secondary"><div class="admonition-heading"><h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width="14" height="16" viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>Important:</h5></div><div class="admonition-content"><p>If you install Rancher on a Kubernetes cluster, requirements are different from the <a href="/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters">node requirements for downstream user clusters,</a> which will run your apps and services.</p></div></div><p>Make sure the node(s) for the Rancher server fulfill the following requirements:</p><ul><li><a href="#operating-systems-and-container-runtime-requirements">Operating Systems and Container Runtime Requirements</a><ul><li><a href="#rke-specific-requirements">RKE Specific Requirements</a></li><li><a href="#k3s-specific-requirements">K3s Specific Requirements</a></li><li><a href="#rke2-specific-requirements">RKE2 Specific Requirements</a></li><li><a href="#installing-docker">Installing Docker</a></li></ul></li><li><a href="#hardware-requirements">Hardware Requirements</a></li><li><a href="#cpu-and-memory">CPU and Memory</a><ul><li><a href="#rke-and-hosted-kubernetes">RKE and Hosted Kubernetes</a></li><li><a href="#k3s-kubernetes">K3s Kubernetes</a></li><li><a href="#rke2-kubernetes">RKE2 Kubernetes</a></li><li><a href="#docker">Docker</a></li></ul></li><li><a href="#ingress">Ingress</a></li><li><a href="#disks">Disks</a></li><li><a href="#networking-requirements">Networking Requirements</a><ul><li><a href="#node-ip-addresses">Node IP Addresses</a></li><li><a href="#port-requirements">Port Requirements</a></li></ul></li><li><a href="#dockershim-support">Dockershim Support</a></li></ul><p>For a list of best practices that we recommend for running the Rancher server in production, refer to the <a href="/reference-guides/best-practices/rancher-server/tips-for-running-rancher">best practices section.</a></p><p>The Rancher UI works best in Firefox or Chrome.</p><h1>Operating Systems and Container Runtime Requirements</h1><p>Rancher should work with any modern Linux distribution.</p><p>Docker is required for nodes that will run RKE Kubernetes clusters. It is not required for Kubernetes installs.</p><p>Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the <a href="https://rancher.com/support-maintenance-terms/" target="_blank" rel="noopener noreferrer">support maintenance terms.</a></p><p>For details on which OS and Docker versions were tested with each Rancher version, refer to the <a href="https://rancher.com/support-maintenance-terms/" target="_blank" rel="noopener noreferrer">support maintenance terms.</a></p><p>All supported operating systems are 64-bit x86.</p><p>The <code>ntp</code> (Network Time Protocol) package should be installed. This prevents errors with certificate validation that can occur when the time is not synchronized between the client and server.</p><p>Some distributions of Linux may have default firewall rules that block communication with Helm. We recommend disabling firewalld. For Kubernetes v1.19, v1.20 and v1.21, firewalld must be turned off.</p><p>If you don't feel comfortable doing so you might check suggestions in the <a href="https://github.com/rancher/rancher/issues/28840" target="_blank" rel="noopener noreferrer">respective issue</a>. Some users were successful <a href="https://github.com/rancher/rancher/issues/28840#issuecomment-787404822" target="_blank" rel="noopener noreferrer">creating a separate firewalld zone with a policy of ACCEPT for the Pod CIDR</a>.</p><p>If you plan to run Rancher on ARM64, see <a href="/getting-started/installation-and-upgrade/advanced-options/enable-experimental-features/rancher-on-arm64">Running on ARM64 (Experimental).</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rke-specific-requirements">RKE Specific Requirements<a class="hash-link" href="#rke-specific-requirements" title="Direct link to heading"></a></h3><p>For the container runtime, RKE should work with any modern Docker version.</p><p>Note that the following sysctl setting must be applied:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">net.bridge.bridge-nf-call-iptables=1</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="k3s-specific-requirements">K3s Specific Requirements<a class="hash-link" href="#k3s-specific-requirements" title="Direct link to heading"></a></h3><p>For the container runtime, K3s should work with any modern version of Docker or containerd.</p><p>Rancher needs to be installed on a supported Kubernetes version. To find out which versions of Kubernetes are supported for your Rancher version, refer to the <a href="https://rancher.com/support-maintenance-terms/" target="_blank" rel="noopener noreferrer">support maintenance terms.</a> To specify the K3s version, use the INSTALL_K3S_VERSION environment variable when running the K3s installation script.</p><p>If you are installing Rancher on a K3s cluster with <strong>Raspbian Buster</strong>, follow <a href="https://rancher.com/docs/k3s/latest/en/advanced/#enabling-legacy-iptables-on-raspbian-buster" target="_blank" rel="noopener noreferrer">these steps</a> to switch to legacy iptables.</p><p>If you are installing Rancher on a K3s cluster with Alpine Linux, follow <a href="https://rancher.com/docs/k3s/latest/en/advanced/#additional-preparation-for-alpine-linux-setup" target="_blank" rel="noopener noreferrer">these steps</a> for additional setup.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rke2-specific-requirements">RKE2 Specific Requirements<a class="hash-link" href="#rke2-specific-requirements" title="Direct link to heading"></a></h3><p>For details on which OS versions were tested with RKE2, refer to the <a href="https://rancher.com/support-maintenance-terms/" target="_blank" rel="noopener noreferrer">support maintenance terms.</a></p><p>Docker is not required for RKE2 installs.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="installing-docker">Installing Docker<a class="hash-link" href="#installing-docker" title="Direct link to heading"></a></h3><p>Docker is required for Helm chart installs, and it can be installed by following the steps in the official <a href="https://docs.docker.com/" target="_blank" rel="noopener noreferrer">Docker documentation.</a> Rancher also provides <a href="/getting-started/installation-and-upgrade/installation-requirements/install-docker">scripts</a> to install Docker with one command.</p><h1>Hardware Requirements</h1><p>The following sections describe the CPU, memory, and disk requirements for the nodes where the Rancher server is installed.</p><h1>CPU and Memory</h1><p>Hardware requirements scale based on the size of your Rancher deployment. Provision each individual node according to the requirements. The requirements are different depending on if you are installing Rancher in a single container with Docker, or if you are installing Rancher on a Kubernetes cluster.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rke-and-hosted-kubernetes">RKE and Hosted Kubernetes<a class="hash-link" href="#rke-and-hosted-kubernetes" title="Direct link to heading"></a></h3><p>These CPU and memory requirements apply to each host in the Kubernetes cluster where the Rancher server is installed.</p><p>These requirements apply to RKE Kubernetes clusters, as well as to hosted Kubernetes clusters such as EKS.</p><table><thead><tr><th>Deployment Size</th><th>Clusters</th><th>Nodes</th><th>vCPUs</th><th>RAM</th></tr></thead><tbody><tr><td>Small</td><td>Up to 150</td><td>Up to 1500</td><td>2</td><td>8 GB</td></tr><tr><td>Medium</td><td>Up to 300</td><td>Up to 3000</td><td>4</td><td>16 GB</td></tr><tr><td>Large</td><td>Up to 500</td><td>Up to 5000</td><td>8</td><td>32 GB</td></tr><tr><td>X-Large</td><td>Up to 1000</td><td>Up to 10,000</td><td>16</td><td>64 GB</td></tr><tr><td>XX-Large</td><td>Up to 2000</td><td>Up to 20,000</td><td>32</td><td>128 GB</td></tr></tbody></table><p>Every use case and environment is different. Please <a href="https://rancher.com/contact/" target="_blank" rel="noopener noreferrer">contact Rancher</a> to review yours.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="k3s-kubernetes">K3s Kubernetes<a class="hash-link" href="#k3s-kubernetes" title="Direct link to heading"></a></h3><p>These CPU and memory requirements apply to each host in a <a href="/pages-for-subheaders/install-upgrade-on-a-kubernetes-cluster">K3s Kubernetes cluster where the Rancher server is installed.</a></p><table><thead><tr><th>Deployment Size</th><th>Clusters</th><th>Nodes</th><th>vCPUs</th><th>RAM</th><th>Database Size</th></tr></thead><tbody><tr><td>Small</td><td>Up to 150</td><td>Up to 1500</td><td>2</td><td>8 GB</td><td>2 cores, 4 GB + 1000 IOPS</td></tr><tr><td>Medium</td><td>Up to 300</td><td>Up to 3000</td><td>4</td><td>16 GB</td><td>2 cores, 4 GB + 1000 IOPS</td></tr><tr><td>Large</td><td>Up to 500</td><td>Up to 5000</td><td>8</td><td>32 GB</td><td>2 cores, 4 GB + 1000 IOPS</td></tr><tr><td>X-Large</td><td>Up to 1000</td><td>Up to 10,000</td><td>16</td><td>64 GB</td><td>2 cores, 4 GB + 1000 IOPS</td></tr><tr><td>XX-Large</td><td>Up to 2000</td><td>Up to 20,000</td><td>32</td><td>128 GB</td><td>2 cores, 4 GB + 1000 IOPS</td></tr></tbody></table><p>Every use case and environment is different. Please <a href="https://rancher.com/contact/" target="_blank" rel="noopener noreferrer">contact Rancher</a> to review yours.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="rke2-kubernetes">RKE2 Kubernetes<a class="hash-link" href="#rke2-kubernetes" title="Direct link to heading"></a></h3><p>These CPU and memory requirements apply to each instance with RKE2 installed. Minimum recommendations are outlined here.</p><table><thead><tr><th>Deployment Size</th><th>Clusters</th><th>Nodes</th><th>vCPUs</th><th>RAM</th></tr></thead><tbody><tr><td>Small</td><td>Up to 5</td><td>Up to 50</td><td>2</td><td>5 GB</td></tr><tr><td>Medium</td><td>Up to 15</td><td>Up to 200</td><td>3</td><td>9 GB</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="docker">Docker<a class="hash-link" href="#docker" title="Direct link to heading"></a></h3><p>These CPU and memory requirements apply to a host with a <a href="/pages-for-subheaders/rancher-on-a-single-node-with-docker">single-node</a> installation of Rancher.</p><table><thead><tr><th>Deployment Size</th><th>Clusters</th><th>Nodes</th><th>vCPUs</th><th>RAM</th></tr></thead><tbody><tr><td>Small</td><td>Up to 5</td><td>Up to 50</td><td>1</td><td>4 GB</td></tr><tr><td>Medium</td><td>Up to 15</td><td>Up to 200</td><td>2</td><td>8 GB</td></tr></tbody></table><h1>Ingress</h1><p>Each node in the Kubernetes cluster that Rancher is installed on should run an Ingress.</p><p>The Ingress should be deployed as DaemonSet to ensure your load balancer can successfully route traffic to all nodes.</p><p>For RKE and K3s installations, you don't have to install the Ingress manually because it is installed by default.</p><p>For hosted Kubernetes clusters (EKS, GKE, AKS) and RKE2 Kubernetes installations, you will need to set up the ingress.</p><ul><li><strong>Amazon EKS:</strong> For details on how to install Rancher on Amazon EKS, including how to install an ingress so that the Rancher server can be accessed, refer to <a href="/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks">this page.</a></li><li><strong>AKS:</strong> For details on how to install Rancher with Azure Kubernetes Service, including how to install an ingress so that the Rancher server can be accessed, refer to <a href="/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks">this page.</a></li><li><strong>GKE:</strong> For details on how to install Rancher with Google Kubernetes Engine, including how to install an ingress so that the Rancher server can be accessed, refer to <a href="/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-gke">this page.</a></li></ul><h1>Disks</h1><p>Rancher performance depends on etcd in the cluster performance. To ensure optimal speed, we recommend always using SSD disks to back your Rancher management Kubernetes cluster. On cloud providers, you will also want to use the minimum size that allows the maximum IOPS. In larger clusters, consider using dedicated storage devices for etcd data and wal directories.</p><h1>Networking Requirements</h1><p>This section describes the networking requirements for the node(s) where the Rancher server is installed.</p><div class="admonition admonition-caution alert alert--warning"><div class="admonition-heading"><h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>caution</h5></div><div class="admonition-content"><p>If a server containing Rancher has the <code>X-Frame-Options=DENY</code> header, some pages in the new Rancher UI will not be able to render after upgrading from the legacy UI. This is because some legacy pages are embedded as iFrames in the new UI.</p></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="node-ip-addresses">Node IP Addresses<a class="hash-link" href="#node-ip-addresses" title="Direct link to heading"></a></h3><p>Each node used should have a static IP configured, regardless of whether you are installing Rancher on a single node or on an HA cluster. In case of DHCP, each node should have a DHCP reservation to make sure the node gets the same IP allocated.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="port-requirements">Port Requirements<a class="hash-link" href="#port-requirements" title="Direct link to heading"></a></h3><p>To operate properly, Rancher requires a number of ports to be open on Rancher nodes and on downstream Kubernetes cluster nodes. <a href="/getting-started/installation-and-upgrade/installation-requirements/port-requirements">Port Requirements</a> lists all the necessary ports for Rancher and Downstream Clusters for the different cluster types.</p><h1>Dockershim Support</h1><p>For more information on Dockershim support, refer to <a href="/getting-started/installation-and-upgrade/installation-requirements/dockershim">this page</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/docs/pages-for-subheaders/installation-requirements.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_eYIM" 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_vbeJ"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2022-09-23T17:11:24.000Z">9/23/2022</time></b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/pages-for-subheaders/installation-and-upgrade"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Installing/Upgrading Rancher</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/getting-started/installation-and-upgrade/installation-requirements/install-docker"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Installing Docker</div></a></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="#rke-specific-requirements" class="table-of-contents__link toc-highlight">RKE Specific Requirements</a></li><li><a href="#k3s-specific-requirements" class="table-of-contents__link toc-highlight">K3s Specific Requirements</a></li><li><a href="#rke2-specific-requirements" class="table-of-contents__link toc-highlight">RKE2 Specific Requirements</a></li><li><a href="#installing-docker" class="table-of-contents__link toc-highlight">Installing Docker</a></li><li><a href="#rke-and-hosted-kubernetes" class="table-of-contents__link toc-highlight">RKE and Hosted Kubernetes</a></li><li><a href="#k3s-kubernetes" class="table-of-contents__link toc-highlight">K3s Kubernetes</a></li><li><a href="#rke2-kubernetes" class="table-of-contents__link toc-highlight">RKE2 Kubernetes</a></li><li><a href="#docker" class="table-of-contents__link toc-highlight">Docker</a></li><li><a href="#node-ip-addresses" class="table-of-contents__link toc-highlight">Node IP Addresses</a></li><li><a href="#port-requirements" class="table-of-contents__link toc-highlight">Port Requirements</a></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 © 2022 SUSE Rancher. All Rights Reserved.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.6d86be68.js"></script>
|
||
<script src="/assets/js/main.2a2e2876.js"></script>
|
||
</body>
|
||
</html> |