+
+
+
+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"
+
+
+
+export const toc = GlossaryTOC;
+```
\ No newline at end of file
diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md
new file mode 100644
index 00000000000..f1f6d3825cc
--- /dev/null
+++ b/shared-files/_glossary.md
@@ -0,0 +1,307 @@
+## Icons & Symbols
+
+
+
+ ☰
+
+
+ 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.
+
+
+ ⋮
+
+
+ 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.
+
+
+
+## A
+
+
+
+ Apps
+
+
+ Versions: Rancher v2.6.5 and later
+
+
+ When describing navigation within Rancher, the section of the Rancher UI where you manage Helm charts and Helm chart repositories. In earlier versions of Rancher, this section was called Apps & Marketplace, or Catalogs.
+
+
+ Synonyms:Apps & Marketplace, Catalogs
+
+
+ Apps & Marketplace
+
+
+ Versions: Rancher v2.5.0–2.6.5
+
+
+ The section of the Rancher UI where you manage Helm charts and Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps.
+
+
+ Synonyms:Apps, Catalogs
+
+
+
+## C
+
+
+
+ Catalogs
+
+
+ Versions: 1. Rancher v2.4 and earlier 2. Rancher v2.7 and later
+
+
+ The section of the Rancher UI where you manage Helm charts and Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps.
+
+
+ Synonyms:Apps, Apps & Marketplace
+
+
+ Related terms:Extension catalogs
+
+
+ Community
+
+
+ A build of Rancher that's available to the entire Rancher community.
+
+
+ Related terms:Prime, Rancher Prime
+
+
+
+## D
+
+
+
+ Downstream cluster
+
+
+ An alternative name for a managed cluster, a Kubernetes cluster that is managed by a Rancher server.
+
+ 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 include Kubewarden and Elemental.
+
+
+ Related terms:Apps & Marketplace, Catalogs, Integrations
+
+
+ Extension catalogs
+
+
+ Versions: Rancher v2.7.0 and later
+
+
+ Container image repositories that can be imported to add UI extensions to your Rancher instance.
+
+
+
+## H
+
+
+
+ Hosted cluster
+
+
+ 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.
+
+ An existing cluster that was provisioned by a third party, then set up to be managed by Rancher. Registered clusters 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.
+
+ A lightweight Kubernetes distribution chiefly designed for workloads that run unattended under tight resource constraints.
+
+
+ Related terms:RKE, RKE2
+
+
+
+## L
+
+
+
+ Local cluster
+
+
+ An alternative name for a Rancher server, the Kubernetes cluster that hosts Rancher and manages other clusters. Here, local 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.
+
+ 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.
+
+ A Kubernetes management tool to deploy and run clusters anywhere and on any provider. Rancher includes all the software and downstream cluster components used to manage the entire Rancher deployment.
+
+
+ Rancher Kubernetes Engine (RKE)
+
+
+ A CNCF-certified Kubernetes distribution that runs entirely within Docker containers. There are two main versions of RKE available. The 1.x software line is sometimes called RKE1, or simply RKE. The next-generation line is called RKE2.
+
+
+ Synonyms:RKE1
+
+
+ Related terms:K3s, RKE2
+
+
+ Rancher Prime
+
+
+ Rancher Prime is a new edition of the commercial, enterprise offering built on the the same source code. Installation assets are hosted on a trusted registry owned and managed by Rancher with additional value coming in from security assurances, extended lifecycles, access to focused architectures and Kubernetes advisories.
+
+
+ Rancher server
+
+
+ The Kubernetes cluster that hosts Rancher and manages the other clusters in the Rancher deployment.
+
+ An existing cluster that was provisioned by a third party, then set up to be managed by Rancher. Older versions of Rancher use Imported cluster to refer to a similar concept. The main difference is that there are more management features exposed in the Rancher UI for registered clusters than for imported clusters.
+
+ An alternative name for the v1.x software line of Rancher Kubernetes Engine (RKE). Sometimes called RKE for short. RKE1 is a certified Kubernetes distribution and CLI/library which creates and manages a Kubernetes cluster.
+
+
+ Synonyms:Rancher Kubernetes Engine
+
+
+ Related terms:K3s, RKE2
+
+
+ RKE2
+
+
+ Versions: Rancher v2.6.0 and later (to provision clusters), Rancher 2.5.0 and later (to register clusters)
+
+
+ A fully conformant version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards.
+
+
+ Related terms:K3s, RKE
+
+
+ Roles
+
+
+ Roles determine what actions a Rancher user can make within a cluster or project.
+
+
+
+## U
+
+
+
+ Upstream cluster
+
+
+ An alternative name for the Rancher server, the Kubernetes cluster that hosts Rancher and manages the other clusters in the Rancher deployment.
+
+ Objects that set deployment rules for pods. Based on these rules, Kubernetes performs the deployment and updates the workload with the current state of the application. Workloads let you define the rules for application scheduling, scaling, and upgrade.
+
+
\ No newline at end of file
diff --git a/sidebars.js b/sidebars.js
index aee844d0bf2..9be8b8ccca2 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -1357,6 +1357,7 @@ const sidebars = {
]
},
"contribute-to-rancher",
+ "glossary",
]
}
module.exports = sidebars;
diff --git a/src/css/custom.css b/src/css/custom.css
index 2ac4b3638a1..fba344882c2 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -144,6 +144,23 @@ code {
font-family: 'Roboto Mono', monospace;
}
+dd {
+ margin-top: 1rem;
+ margin-bottom: 1rem;
+}
+
+dt {
+ font-weight: bold;
+ margin-top: 1rem;
+}
+
+dl p {
+ font-size: .9rem;
+ font-weight: lighter;
+ margin-inline-start: 40px; /*This is intended to match the margin spacing for the dd element*/
+ margin-bottom: 0;
+}
+
hr {
background-image: -webkit-linear-gradient(left,#f3f3f3,#adadb1,#f3f3f3);
margin: 0 auto;
diff --git a/versioned_docs/version-2.0-2.4/glossary.md b/versioned_docs/version-2.0-2.4/glossary.md
new file mode 100644
index 00000000000..0f632535cf3
--- /dev/null
+++ b/versioned_docs/version-2.0-2.4/glossary.md
@@ -0,0 +1,17 @@
+---
+title: Glossary
+---
+
+
+
+
+
+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"
+
+
+
+export const toc = GlossaryTOC;
+```
diff --git a/versioned_docs/version-2.5/glossary.md b/versioned_docs/version-2.5/glossary.md
new file mode 100644
index 00000000000..0f632535cf3
--- /dev/null
+++ b/versioned_docs/version-2.5/glossary.md
@@ -0,0 +1,17 @@
+---
+title: Glossary
+---
+
+
+
+
+
+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"
+
+
+
+export const toc = GlossaryTOC;
+```
diff --git a/versioned_docs/version-2.6/glossary.md b/versioned_docs/version-2.6/glossary.md
new file mode 100644
index 00000000000..0f632535cf3
--- /dev/null
+++ b/versioned_docs/version-2.6/glossary.md
@@ -0,0 +1,17 @@
+---
+title: Glossary
+---
+
+
+
+
+
+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"
+
+
+
+export const toc = GlossaryTOC;
+```
diff --git a/versioned_docs/version-2.7/glossary.md b/versioned_docs/version-2.7/glossary.md
new file mode 100644
index 00000000000..0f632535cf3
--- /dev/null
+++ b/versioned_docs/version-2.7/glossary.md
@@ -0,0 +1,17 @@
+---
+title: Glossary
+---
+
+
+
+
+
+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"
+
+
+
+export const toc = GlossaryTOC;
+```
diff --git a/versioned_docs/version-2.8/glossary.md b/versioned_docs/version-2.8/glossary.md
new file mode 100644
index 00000000000..0f632535cf3
--- /dev/null
+++ b/versioned_docs/version-2.8/glossary.md
@@ -0,0 +1,17 @@
+---
+title: Glossary
+---
+
+
+
+
+
+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"
+
+
+
+export const toc = GlossaryTOC;
+```