mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-10-03 08:23:16 +00:00
18 lines
30 KiB
HTML
18 lines
30 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-2.0-2.4 plugin-docs plugin-id-default docs-doc-id-contribute-to-rancher">
|
||
<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">Contributing to Rancher | 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//v2.0-v2.4/contribute-to-rancher"><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.0-2.4"><meta data-rh="true" name="docusaurus_tag" content="docs-default-2.0-2.4"><meta data-rh="true" name="docsearch:version" content="2.0-2.4"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-2.0-2.4"><meta data-rh="true" property="og:title" content="Contributing to Rancher | Rancher Manager"><meta data-rh="true" name="description" content="This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue."><meta data-rh="true" property="og:description" content="This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="http://docs.ranchermanager.rancher.io//v2.0-v2.4/contribute-to-rancher"><link data-rh="true" rel="alternate" href="http://docs.ranchermanager.rancher.io//v2.0-v2.4/contribute-to-rancher" hreflang="en"><link data-rh="true" rel="alternate" href="http://docs.ranchermanager.rancher.io//zh/v2.0-v2.4/contribute-to-rancher" hreflang="zh"><link data-rh="true" rel="alternate" href="http://docs.ranchermanager.rancher.io//v2.0-v2.4/contribute-to-rancher" 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.2d5cc7b2.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.c1fac406.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.0-v2.4">v2.0-v2.4</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/contribute-to-rancher">v2.6</a></li><li><a class="dropdown__link" href="/v2.5/contribute-to-rancher">v2.5</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/v2.0-v2.4/contribute-to-rancher">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="/v2.0-v2.4">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="/v2.0-v2.4/contribute-to-rancher" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active">English</a></li><li><a href="/zh/v2.0-v2.4/contribute-to-rancher" 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 btn btn-secondary icon-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="/v2.0-v2.4">Rancher 2.0-2.4</a></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="/v2.0-v2.4/getting-started">Getting Started</a><button aria-label="Toggle the collapsible sidebar category 'Getting Started'" 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="/v2.0-v2.4/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="/v2.0-v2.4/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="/v2.0-v2.4/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="/v2.0-v2.4/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="/v2.0-v2.4/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 menu__link--active" aria-current="page" href="/v2.0-v2.4/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="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->Rancher Manager<!-- --> <b>v2.0-v2.4</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/contribute-to-rancher">latest version</a></b> (<!-- -->v2.6<!-- -->).</div></div><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 breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Contributing to Rancher</span><meta itemprop="position" content="1"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: v2.0-v2.4</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>Contributing to Rancher</h1></header><p>This section explains the repositories used for Rancher, how to build the repositories, and what information to include when you file an issue.</p><p>For more detailed information on how to contribute to the development of Rancher projects, refer to the <a href="https://github.com/rancher/rancher/wiki" target="_blank" rel="noopener noreferrer">Rancher Developer Wiki</a>. The wiki has resources on many topics, including the following:</p><ul><li>How to set up the Rancher development environment and run tests</li><li>The typical flow of an issue through the development lifecycle</li><li>Coding guidelines and development best practices</li><li>Debugging and troubleshooting</li><li>Developing the Rancher API</li></ul><p>On the Rancher Users Slack, the channel for developers is <strong>#developer</strong>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="repositories">Repositories<a class="hash-link" href="#repositories" title="Direct link to heading"></a></h2><p>All of repositories are located within our main GitHub organization. There are many repositories used for Rancher, but we'll provide descriptions of some of the main ones used in Rancher.</p><table><thead><tr><th>Repository</th><th>URL</th><th>Description</th></tr></thead><tbody><tr><td>Rancher</td><td><a href="https://github.com/rancher/rancher" target="_blank" rel="noopener noreferrer">https://github.com/rancher/rancher</a></td><td>This repository is the main source code for Rancher 2.x.</td></tr><tr><td>Types</td><td><a href="https://github.com/rancher/types" target="_blank" rel="noopener noreferrer">https://github.com/rancher/types</a></td><td>This repository is the repository that has all the API types for Rancher 2.x.</td></tr><tr><td>API Framework</td><td><a href="https://github.com/rancher/norman" target="_blank" rel="noopener noreferrer">https://github.com/rancher/norman</a></td><td>This repository is an API framework for building Rancher style APIs backed by Kubernetes Custom Resources.</td></tr><tr><td>User Interface</td><td><a href="https://github.com/rancher/ui" target="_blank" rel="noopener noreferrer">https://github.com/rancher/ui</a></td><td>This repository is the source of the UI.</td></tr><tr><td>(Rancher) Docker Machine</td><td><a href="https://github.com/rancher/machine" target="_blank" rel="noopener noreferrer">https://github.com/rancher/machine</a></td><td>This repository is the source of the Docker Machine binary used when using Node Drivers. This is a fork of the <code>docker/machine</code> repository.</td></tr><tr><td>machine-package</td><td><a href="https://github.com/rancher/machine-package" target="_blank" rel="noopener noreferrer">https://github.com/rancher/machine-package</a></td><td>This repository is used to build the Rancher Docker Machine binary.</td></tr><tr><td>kontainer-engine</td><td><a href="https://github.com/rancher/kontainer-engine" target="_blank" rel="noopener noreferrer">https://github.com/rancher/kontainer-engine</a></td><td>This repository is the source of kontainer-engine, the tool to provision hosted Kubernetes clusters.</td></tr><tr><td>RKE repository</td><td><a href="https://github.com/rancher/rke" target="_blank" rel="noopener noreferrer">https://github.com/rancher/rke</a></td><td>This repository is the source of Rancher Kubernetes Engine, the tool to provision Kubernetes clusters on any machine.</td></tr><tr><td>CLI</td><td><a href="https://github.com/rancher/cli" target="_blank" rel="noopener noreferrer">https://github.com/rancher/cli</a></td><td>This repository is the source code for the Rancher CLI used in Rancher 2.x.</td></tr><tr><td>(Rancher) Helm repository</td><td><a href="https://github.com/rancher/helm" target="_blank" rel="noopener noreferrer">https://github.com/rancher/helm</a></td><td>This repository is the source of the packaged Helm binary. This is a fork of the <code>helm/helm</code> repository.</td></tr><tr><td>Telemetry repository</td><td><a href="https://github.com/rancher/telemetry" target="_blank" rel="noopener noreferrer">https://github.com/rancher/telemetry</a></td><td>This repository is the source for the Telemetry binary.</td></tr><tr><td>loglevel repository</td><td><a href="https://github.com/rancher/loglevel" target="_blank" rel="noopener noreferrer">https://github.com/rancher/loglevel</a></td><td>This repository is the source of the loglevel binary, used to dynamically change log levels.</td></tr></tbody></table><p>To see all libraries/projects used in Rancher, see the <a href="https://github.com/rancher/rancher/blob/master/go.mod" target="_blank" rel="noopener noreferrer"><code>go.mod</code> file</a> in the <code>rancher/rancher</code> repository.</p><p><img loading="lazy" alt="Rancher diagram" src="/assets/images/ranchercomponentsdiagram-f0dd28703a683fd512eb6ffd91fe1447.svg" width="1172" height="1117" class="img_ev3q"><br></p><sup>Rancher components used for provisioning/managing Kubernetes clusters.</sup><h2 class="anchor anchorWithStickyNavbar_LWe7" id="building">Building<a class="hash-link" href="#building" title="Direct link to heading"></a></h2><p>Every repository should have a Makefile and can be built using the <code>make</code> command. The <code>make</code> targets are based on the scripts in the <code>/scripts</code> directory in the repository, and each target will use <a href="https://github.com/rancher/dapper" target="_blank" rel="noopener noreferrer">Dapper</a> to run the target in an isolated environment. The <code>Dockerfile.dapper</code> will be used for this process, and includes all the necessary build tooling needed.</p><p>The default target is <code>ci</code>, and will run <code>./scripts/validate</code>, <code>./scripts/build</code>, <code>./scripts/test</code> and <code>./scripts/package</code>. The resulting binaries of the build will be in <code>./build/bin</code> and are usually also packaged in a Docker image.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="bugs-issues-or-questions">Bugs, Issues or Questions<a class="hash-link" href="#bugs-issues-or-questions" title="Direct link to heading"></a></h2><p>If you find any bugs or are having any trouble, please search the <a href="https://github.com/rancher/rancher/issues" target="_blank" rel="noopener noreferrer">reported issue</a> as someone may have experienced the same issue or we are actively working on a solution.</p><p>If you can't find anything related to your issue, contact us by <a href="https://github.com/rancher/rancher/issues/new" target="_blank" rel="noopener noreferrer">filing an issue</a>. Though we have many repositories related to Rancher, we want the bugs filed in the Rancher repository so we won't miss them! If you want to ask a question or ask fellow users about an use case, we suggest creating a post on the <a href="https://forums.rancher.com" target="_blank" rel="noopener noreferrer">Rancher Forums</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="checklist-for-filing-issues">Checklist for Filing Issues<a class="hash-link" href="#checklist-for-filing-issues" title="Direct link to heading"></a></h3><p>Please follow this checklist when filing an issue which will helps us investigate and fix the issue. More info means more data we can use to determine what is causing the issue or what might be related to the issue.</p><blockquote><p><strong>Note:</strong> For large amounts of data, please use <a href="https://gist.github.com/" target="_blank" rel="noopener noreferrer">GitHub Gist</a> or similar and link the created resource in the issue.
|
||
<strong>Important:</strong> Please remove any sensitive data as it will be publicly viewable.</p></blockquote><ul><li><p><strong>Resources:</strong> Provide as much as detail as possible on the used resources. As the source of the issue can be many things, including as much of detail as possible helps to determine the root cause. See some examples below:</p><ul><li><strong>Hosts:</strong> What specifications does the host have, like CPU/memory/disk, what cloud does it happen on, what Amazon Machine Image are you using, what DigitalOcean droplet are you using, what image are you provisioning that we can rebuild or use when we try to reproduce</li><li><strong>Operating System:</strong> What operating system are you using? Providing specifics helps here like the output of <code>cat /etc/os-release</code> for exact OS release and <code>uname -r</code> for exact kernel used</li><li><strong>Docker:</strong> What Docker version are you using, how did you install it? Most of the details of Docker can be found by supplying output of <code>docker version</code> and <code>docker info</code></li><li><strong>Environment:</strong> Are you in a proxy environment, are you using recognized CA/self signed certificates, are you using an external loadbalancer</li><li><strong>Rancher:</strong> What version of Rancher are you using, this can be found on the bottom left of the UI or be retrieved from the image tag you are running on the host</li><li><strong>Clusters:</strong> What kind of cluster did you create, how did you create it, what did you specify when you were creating it</li></ul></li><li><p><strong>Steps to reproduce the issue:</strong> Provide as much detail on how you got into the reported situation. This helps the person to reproduce the situation you are in.</p><ul><li>Provide manual steps or automation scripts used to get from a newly created setup to the situation you reported.</li></ul></li><li><p><strong>Logs:</strong> Provide data/logs from the used resources.</p><ul><li><p>Rancher</p><ul><li><p>Docker install</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">docker logs \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">--timestamps \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">$(docker ps | grep -E "rancher/rancher:|rancher/rancher " | awk '{ print $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></li><li><p>Kubernetes install using <code>kubectl</code></p><blockquote><p><strong>Note:</strong> Make sure you configured the correct kubeconfig (for example, <code>export KUBECONFIG=$PWD/kube_config_rancher-cluster.yml</code> if Rancher is installed on a Kubernetes cluster) or are using the embedded kubectl via the UI.</p></blockquote><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">kubectl -n cattle-system \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">logs \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">-l app=rancher \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">--timestamps=true</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></li><li><p>Docker install using <code>docker</code> on each of the nodes in the RKE cluster</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">docker logs \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">--timestamps \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">$(docker ps | grep -E "rancher/rancher@|rancher_rancher" | awk '{ print $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></li><li><p>Kubernetes Install with RKE Add-On</p><blockquote><p><strong>Note:</strong> Make sure you configured the correct kubeconfig (for example, <code>export KUBECONFIG=$PWD/kube_config_rancher-cluster.yml</code> if the Rancher server is installed on a Kubernetes cluster) or are using the embedded kubectl via the UI.</p></blockquote><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">kubectl -n cattle-system \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">logs \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">--timestamps=true \</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">-f $(kubectl --kubeconfig $KUBECONFIG get pods -n cattle-system -o json | jq -r '.items[] | select(.spec.containers[].name="cattle-server") | .metadata.name')</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></li></ul></li><li><p>System logging (these might not all exist, depending on operating system)</p><ul><li><code>/var/log/messages</code></li><li><code>/var/log/syslog</code></li><li><code>/var/log/kern.log</code></li></ul></li><li><p>Docker daemon logging (these might not all exist, depending on operating system)</p><ul><li><code>/var/log/docker.log</code></li></ul></li></ul></li><li><p><strong>Metrics:</strong> If you are experiencing performance issues, please provide as much of data (files or screenshots) of metrics which can help determining what is going on. If you have an issue related to a machine, it helps to supply output of <code>top</code>, <code>free -m</code>, <code>df</code> which shows processes/memory/disk usage.</p></li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="docs">Docs<a class="hash-link" href="#docs" title="Direct link to heading"></a></h2><p>If you have any updates to our documentation, please make any pull request to our docs repo.</p><ul><li><p><a href="https://github.com/rancher/docs" target="_blank" rel="noopener noreferrer">Rancher 2.x Docs repository</a>: This repo is where all the docs for Rancher 2.x are located. They are located in the <code>content</code> folder in the repo.</p></li><li><p><a href="https://github.com/rancher/rancher.github.io" target="_blank" rel="noopener noreferrer">Rancher 1.x Docs repository</a>: This repo is where all the docs for Rancher 1.x are located. They are located in the <code>rancher</code> folder in the repo.</p></li></ul></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.0-2.4/contribute-to-rancher.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-15T22:58:57.000Z">9/15/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="/v2.0-v2.4/troubleshooting/other-troubleshooting-tips/logging"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Logging</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="#repositories" class="table-of-contents__link toc-highlight">Repositories</a></li><li><a href="#building" class="table-of-contents__link toc-highlight">Building</a></li><li><a href="#bugs-issues-or-questions" class="table-of-contents__link toc-highlight">Bugs, Issues or Questions</a><ul><li><a href="#checklist-for-filing-issues" class="table-of-contents__link toc-highlight">Checklist for Filing Issues</a></li></ul></li><li><a href="#docs" class="table-of-contents__link toc-highlight">Docs</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.2d5cc7b2.js"></script>
|
||
<script src="/assets/js/main.c1fac406.js"></script>
|
||
</body>
|
||
</html> |