Glossary project part 1 #1305
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Glossary | ||
| --- | ||
|
|
||
| <!-- This page uses HTML definition list tags. dl indicates the start and end of a definition list. dt indicates the defined term, and dd the definition. These will stay in place until we upgrade to Docusaurus 3 and are able to add the remark-definition-list plugin for native Markdown syntax. We are currently blocked as the plugin requires a handler that isn't currently exposed. See https://github.com/facebook/docusaurus/discussions/8743#discussioncomment-6085581 and https://github.com/facebook/docusaurus/pull/9674 --> | ||
|
|
||
| <head> | ||
| <link rel="canonical" href="https://ranchermanager.docs.rancher.com/glossary"/> | ||
| </head> | ||
|
|
||
| This page covers Rancher-specific terminology and symbols which might be unfamiliar, or which differ between Rancher versions. | ||
|
|
||
| ```mdx-code-block | ||
| import Glossary, {toc as GlossaryTOC} from "/shared-files/_glossary.md" | ||
|
|
||
| <Glossary /> | ||
|
|
||
| export const toc = GlossaryTOC; | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,324 @@ | ||||||
| ## Icons & Symbols | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| ☰ | ||||||
| </dt> | ||||||
| <dd> | ||||||
| The navigation menu toggle, a button in the far top left corner of the Rancher UI. Clicking the ☰ opens a sidebar that provides access to the main sections of the Rancher interface. | ||||||
| </dd> | ||||||
| <dt> | ||||||
| ⋮ | ||||||
| </dt> | ||||||
| <dd> | ||||||
| The submenu toggle, a button found at the far right of many table rows throughout the Rancher UI. Clicking the ⋮ opens a submenu containing a contextual list of tasks related to the item in that row. | ||||||
| </dd> | ||||||
| </dl> | ||||||
|
|
||||||
| ## A | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Apps | ||||||
| </dt> | ||||||
| <p> | ||||||
| <b>Versions:</b> Rancher v2.6.5 and later | ||||||
| </p> | ||||||
| <dd> | ||||||
| When describing navigation within Rancher, the section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called <i>Apps & Marketplace</i>, or <i>Catalogs</i>. | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Synonyms:</b> <i>Apps & Marketplace, Catalogs</i> | ||||||
| </p> | ||||||
| <dt> | ||||||
| Apps & Marketplace | ||||||
| </dt> | ||||||
| <p> | ||||||
| <b>Versions:</b> Rancher v2.5.0–2.6.5 | ||||||
| </p> | ||||||
| <dd> | ||||||
| The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called <i>Catalogs</i>. In later versions, it is called <i>Apps</i>. | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Synonyms:</b> <i>Apps, Catalogs</i> | ||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## C | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Catalogs | ||||||
| </dt> | ||||||
| <p> | ||||||
| <b>Versions:</b> 1. Rancher v2.4.x and earlier 2. Rancher v2.7.x and later | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </p> | ||||||
| <dd> | ||||||
| <ol> | ||||||
| <li> | ||||||
| The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called <i>Apps & Marketplace</i>, or <i>Apps</i>. | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </li> | ||||||
| <li> | ||||||
| Extension catalogs, container image repositories that can be imported to add extensions to your Rancher instance. | ||||||
btat marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </li> | ||||||
| </ol> | ||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Synonyms:</b> <i>Apps, Apps & Marketplace</i> | ||||||
| </p> | ||||||
| <dt> | ||||||
| Cloud credentials | ||||||
| </dt> | ||||||
| <dd> | ||||||
| Placeholder | ||||||
btat marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Hosted clusters</i> | ||||||
| </p> | ||||||
| <dt> | ||||||
| Community | ||||||
| </dt> | ||||||
| <dd> | ||||||
| A build of Rancher that's available to the entire Rancher community. | ||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Prime, Rancher Prime</i> | ||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## D | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Downstream cluster | ||||||
| </dt> | ||||||
| <dd> | ||||||
| An alternative name for a <i>Managed</i> cluster: a Kubernetes cluster that is managed by a Rancher server. | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Synonyms:</b> <i>Managed cluster</i> | ||||||
| </p> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Hosted cluster, Imported cluster, Rancher server, Registered cluster</i> | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## E | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Extension | ||||||
| </dt> | ||||||
| <p> | ||||||
| <b>Versions:</b> Rancher v2.7.0 and later | ||||||
| </p> | ||||||
| <dd> | ||||||
| Helm charts that can extend and enhance the Rancher UI, and tailor Rancher to your specific environment. Some Extensions require manual installation on a cluster, while others are built into Rancher. Built-in Extensions include Fleet and Harvester. Manually installed Extensions inlcude Kubewarden and Elemental. | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Apps & Marketplace, Catalogs, Integrations</i> | ||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## H | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Hosted cluster | ||||||
| </dt> | ||||||
| <dd> | ||||||
| A managed cluster that is hosted in the cloud, by a Kubernetes provider. Rancher supports a variety of hosted Kubernetes providers, including Amazon Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), and Google Kubernetes Engine (GKE). Rancher integrates with the hosted Kubernetes provider's cloud APIs, so that you can manage the cluster from the Rancher UI. | ||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Managed cluster</i> | ||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## I | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Imported cluster | ||||||
| </dt> | ||||||
| <p> | ||||||
| <b>Versions:</b> Rancher 2.0–v2.4 | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </p> | ||||||
| <dd> | ||||||
| An existing cluster that was provisioned by a third-party, then set up to be managed by Rancher. <i>Registered clusters</i> in later versions of Rancher are roughly synonymous with imported clusters. The main difference is that there are more management features exposed in the Rancher UI for registered clusters than for imported clusters. | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Synonyms:</b> Registered cluster | ||||||
| </p> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Managed cluster</i> | ||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## K | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| K3s | ||||||
| </dt> | ||||||
| <dd> | ||||||
| A lightweight Kubernetes distribution chiefly designed for workloads that run unattended under tight resource constraints. | ||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>RKE</i> | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## L | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Local cluster | ||||||
| </dt> | ||||||
| <dd> | ||||||
| An alternative name for the <i>Rancher server</i>, the cluster which hosts Rancher and manages other clusters. Here, <i>local</i> refers to the location of the Rancher installation, not to the user's local workstation. Local clusters can be hosted on-premises, in air-gapped environments, or in the cloud. | ||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Synonyms:</b> <i>Rancher server, Upstream cluster</i> | ||||||
| </p> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Managed cluster</i> | ||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## M | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Managed cluster | ||||||
| </dt> | ||||||
| <dd> | ||||||
| A Kubernetes cluster that is managed by a Rancher server. Managed clusters can run on a variety of infrastructure and can be located anywhere, including in the cloud, on-premises, or in air-gapped environments. | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dd> | ||||||
| <p> | ||||||
| <b>Synonyms:</b> <i>Downstream cluster</i> | ||||||
| </p> | ||||||
| <p> | ||||||
| <b>Related terms:</b> <i>Rancher server</i> | ||||||
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </p> | ||||||
| </dl> | ||||||
|
|
||||||
| ## R | ||||||
|
|
||||||
| <dl> | ||||||
| <dt> | ||||||
| Rancher Enterprise | ||||||
btat marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </dt> | ||||||
| <dd> | ||||||
| An alternative name for <i>Rancher Prime</i>. | ||||||
|
||||||
| An alternative name for <i>Rancher Prime</i>. | |
| An alternative name for <i>Rancher Prime</i>. |
Outdated
There was a problem hiding this comment.
Is this considered a second definition or is the ordered list used as a workaround to add another paragraph?
Shorthand for RKE1 - it seems a bit awkward to call the preferred term a shorthand of a secondary form.
the 1.x software line of RKE - we're kind of defining RKE by making a reference to RKE with this part.
Also, both parts of the second listitem seemed like they can be dropped since the first listitem already makes a similar reference.
There was a problem hiding this comment.
It was intended as a second definition, but if we don't need it we can get rid of the list
There was a problem hiding this comment.
I'd vote for removing it.
Forgot to include this in my original comment:
the 1.x software line of RKE - we're kind of defining RKE by making a reference to RKE with this part.
There was a problem hiding this comment.
If definition 2 stood alone without the previous definition describing RKE, it would be more confusing. But, at any rate, definition 1 already covers the RKE1 usage ("The 1.x software line is sometimes called RKE1") so the second definition isn't necessary. We can just remove the second definition and update that sentence in the first to, "The 1.x software line is sometimes called RKE1, or simply RKE."
martyav marked this conversation as resolved.
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Rancher v2.6.0 and later this is only accurate for provisioning. In v2.5 it's possible to register RKE2 clusters. Not sure how we should update this without causing the version field to be super inconsistent though.
There was a problem hiding this comment.
Maybe it can be noted in parentheses.
"v2.5 (to register), v2.6 (to provision)"
There was a problem hiding this comment.
Just applied the parentheses idea
There was a problem hiding this comment.
This seems like a removal candidate. We don't use the term other than when we introduce RKE2.
If we remove this, there are multiple references to this that need to be updated.
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
martyav marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
btat marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
btat marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1367,6 +1367,7 @@ const sidebars = { | |
| ] | ||
| }, | ||
| "contribute-to-rancher", | ||
| "glossary", | ||
| ] | ||
| } | ||
| module.exports = sidebars; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Glossary | ||
| --- | ||
|
|
||
| <!-- This page uses HTML definition list tags. dl indicates the start and end of a definition list. dt indicates the defined term, and dd the definition. These will stay in place until we upgrade to Docusaurus 3 and are able to add the remark-definition-list plugin for native Markdown syntax. We are currently blocked as the plugin requires a handler that isn't currently exposed. See https://github.com/facebook/docusaurus/discussions/8743#discussioncomment-6085581 and https://github.com/facebook/docusaurus/pull/9674 --> | ||
|
|
||
| <head> | ||
| <link rel="canonical" href="https://ranchermanager.docs.rancher.com/glossary"/> | ||
| </head> | ||
|
|
||
| This page covers Rancher-specific terminology and symbols which might be unfamiliar, or which differ between Rancher versions. | ||
|
|
||
| ```mdx-code-block | ||
| import Glossary, {toc as GlossaryTOC} from "/shared-files/_glossary.md" | ||
|
|
||
| <Glossary /> | ||
|
|
||
| export const toc = GlossaryTOC; | ||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.