From d096677eb68e60c8224d33825616f682f004a476 Mon Sep 17 00:00:00 2001 From: martyav Date: Wed, 14 Feb 2024 17:56:34 -0500 Subject: [PATCH 01/29] 358 Glossary project initial draft + styling for definition tags --- docs/glossary.md | 286 +++++++++++++++++++++++++++++++++++++++++++++ src/css/custom.css | 17 +++ 2 files changed, 303 insertions(+) create mode 100644 docs/glossary.md diff --git a/docs/glossary.md b/docs/glossary.md new file mode 100644 index 000000000000..cb5e0549b852 --- /dev/null +++ b/docs/glossary.md @@ -0,0 +1,286 @@ +--- +title: Glossary +--- + + + + + + + +## A + +
+
+ Apps +
+

+ Rancher v2.6.5 and later +

+
+ The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Apps & Marketplace, or Catalogs. +
+

+ Related terms: Apps & Marketplace, Catalogs +

+
+ Apps & Marketplace +
+

+ Rancher v2.5.0–2.6.5 +

+
+ The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps. +
+

+ Related terms: Apps, Catalogs +

+
+ +## C + +
+
+ Catalogs +
+

+ Rancher v2.4.x and earlier +

+
+ The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. +
+

+ Related terms: Apps, Apps & Marketplace +

+
+ +## D + +
+
+ Downstream cluster +
+
+ Placeholder +
+

+ Related terms: Managed cluster +

+
+ +## E + +
+
+ Extension +
+
+ Placeholder +
+

+ Related terms: Apps +

+
+ +## K + +
+
+ K3s +
+
+ Placeholder +
+

+ Related terms: RKE +

+
+ +## L + +
+
+ Local cluster +
+
+ Placeholder +
+

+ Related terms: Rancher server +

+
+ +## M + +
+
+ Managed cluster +
+
+ Placeholder +
+

+ Related terms: Downstream cluster +

+
+ +## N + +
+
+ Node template +
+
+ Placeholder +
+
+ +## P + +
+
+ Prime +
+
+ Shorthand for Rancher Prime, the paid tier of Rancher. Rancher Prime is intended for enterprise-level organizations. See the definition of Rancher Prime for more details. +
+

+ Related terms: Rancher Prime +

+
+ Project +
+
+ Placeholder +
+
+ PSA +
+
+ Placeholder +
+
+ PSA configuration template (PSACT) +
+
+ Placeholder +
+
+ PSP +
+
+ Placeholder +
+
+ +## R + +
+
+ Rancher CLI +
+
+ Placeholder +
+
+ Rancher Community +
+
+ Placeholder -- we'll need to disambiguate this from the The Community by SUSE, as in, the community of users. Rancher Community Edition? +
+

+ Related terms: Rancher Prime +

+
+ Rancher Enterprise +
+
+ An alternative name for Rancher Prime. +
+

+ Related terms: Rancher Prime +

+
+ Rancher Kubernetes API (RK-API) +
+
+ Placeholder +
+
+ Rancher Kubernetes Engine (RKE) +
+
+ Rancher Kubernetes Engine (RKE) is a CNCF-certified Kubernetes distribution that runs entirely within Docker containers. There are two main lines of RKE available. The 1.x software line is sometimes called RKE1, or simply RKE. The next-generation line is called RKE2 or RKE Government. +
+

+ Related terms: K3s +

+
+ Rancher Prime +
+

+ Rancher v2.8 and later +

+
+ Placeholder +
+

+ Related terms: Rancher Community +

+
+ Rancher server +
+
+ Placeholder +
+

+ Related terms: Upstream cluster +

+
+ RKE1 +
+
+ An alternative name for the 1.x software line of Rancher Kubernetes Engine (RKE). Sometimes simply called, RKE. +
+

+ Related terms: Rancher Kubernetes Engine, RKE2 +

+
+ RKE2 +
+
+ A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. +
+

+ Related terms: RKE Government +

+
+ RKE Government +
+
+ An alternative name for RKE2. +
+

+ Related terms: RKE2 +

+
+ +## U + +
+
+ UI +
+
+ Placeholder +
+
+ Upstream cluster +
+
+ Placeholder +
+

+ Related terms: Rancher server +

+
diff --git a/src/css/custom.css b/src/css/custom.css index 7172cf684c51..e0c051dae23e 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -135,6 +135,23 @@ code { font-family: 'Roboto Mono', monospace; } +dd { + margin-top: 1rem; + margin-bottom: 1rem; +} + +dd+p { + margin-inline-start: 40px; /*This is intended to match the margin spacing for the dd element*/ +} + +dt { + font-weight: bold; +} + +dt+p { + margin-bottom: 0; +} + hr { background-image: -webkit-linear-gradient(left,#f3f3f3,#adadb1,#f3f3f3); margin: 0 auto; From 4cd21ac99336b7b512788efbfa43f21faee2efc2 Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 15 Feb 2024 14:00:00 -0500 Subject: [PATCH 02/29] added sidebar, revised styling --- docs/glossary.md | 119 +++++++++++++++++++++++++++++++-------------- sidebars.js | 1 + src/css/custom.css | 6 +++ 3 files changed, 90 insertions(+), 36 deletions(-) diff --git a/docs/glossary.md b/docs/glossary.md index cb5e0549b852..d337cf641833 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -2,38 +2,66 @@ title: Glossary --- - + +This page covers Rancher-specific terminology and symbols which might be unfamiliar, or which differs between Rancher versions. + +## 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
+
+ App +
+
+ Unless specified otherwise, a Rancher application. Rancher applications use either Helm charts or Rancher charts to deploy. +
+

+ Related terms: Rancher charts +

Apps

- Rancher v2.6.5 and later + Versions: Rancher v2.6.5 and later

- The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Apps & Marketplace, or Catalogs. + 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 Apps & Marketplace, or Catalogs.

- Related terms: Apps & Marketplace, Catalogs + Related terms: Apps & Marketplace, Catalogs

Apps & Marketplace

- Rancher v2.5.0–2.6.5 + Versions: Rancher v2.5.0–2.6.5

- The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps. + The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps.

- Related terms: Apps, Catalogs + Related terms: Apps, Catalogs

@@ -44,13 +72,22 @@ title: Glossary Catalogs

- Rancher v2.4.x and earlier + Versions: Rancher v2.4.x and earlier +

+
+ The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. +
+

+ Related terms: Apps, Apps & Marketplace

+
+ Community +
- The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. + Placeholder -- we also use The Community by SUSE, as in, the community of users. Rancher Community Edition?

- Related terms: Apps, Apps & Marketplace + Related terms: Rancher Prime

@@ -64,7 +101,7 @@ title: Glossary Placeholder

- Related terms: Managed cluster + Related terms: Managed cluster

@@ -78,7 +115,7 @@ title: Glossary Placeholder

- Related terms: Apps + Related terms: Apps

@@ -92,7 +129,7 @@ title: Glossary Placeholder

- Related terms: RKE + Related terms: RKE

@@ -106,7 +143,7 @@ title: Glossary Placeholder

- Related terms: Rancher server + Related terms: Rancher server

@@ -120,7 +157,7 @@ title: Glossary Placeholder

- Related terms: Downstream cluster + Related terms: Downstream cluster

@@ -142,10 +179,10 @@ title: Glossary Prime
- Shorthand for Rancher Prime, the paid tier of Rancher. Rancher Prime is intended for enterprise-level organizations. See the definition of Rancher Prime for more details. + Placeholder

- Related terms: Rancher Prime + Related terms: Rancher Prime

Project @@ -177,28 +214,25 @@ title: Glossary
- Rancher CLI + Rancher chart
Placeholder
- Rancher Community + Rancher Command Line Interface (CLI)
- Placeholder -- we'll need to disambiguate this from the The Community by SUSE, as in, the community of users. Rancher Community Edition? + Placeholder
-

- Related terms: Rancher Prime -

Rancher Enterprise
- An alternative name for Rancher Prime. + An alternative name for Rancher Prime.

- Related terms: Rancher Prime + Related terms: Rancher Prime

Rancher Kubernetes API (RK-API) @@ -210,22 +244,29 @@ title: Glossary Rancher Kubernetes Engine (RKE)
- Rancher Kubernetes Engine (RKE) is a CNCF-certified Kubernetes distribution that runs entirely within Docker containers. There are two main lines of RKE available. The 1.x software line is sometimes called RKE1, or simply RKE. The next-generation line is called RKE2 or RKE Government. +
    +
  1. + 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. The next-generation line is called RKE2 or RKE Government. +
    2. +
  2. + Shorthand for RKE1, the 1.x software line of RKE. +
    3. +

- Related terms: K3s + Related terms: K3s, RKE1, RKE2

Rancher Prime

- Rancher v2.8 and later + Versions: Rancher v2.8 and later

Placeholder

- Related terms: Rancher Community + Related terms: Rancher Community

Rancher server @@ -234,34 +275,40 @@ title: Glossary Placeholder

- Related terms: Upstream cluster + Related terms: Upstream cluster

RKE1
- An alternative name for the 1.x software line of Rancher Kubernetes Engine (RKE). Sometimes simply called, RKE. + An alternative name for the 1.x software line of Rancher Kubernetes Engine (RKE). Sometimes called RKE for short.

- Related terms: Rancher Kubernetes Engine, RKE2 + Related terms: Rancher Kubernetes Engine, RKE2

RKE2
+

+ Versions: Rancher v2.6.0 +

- A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. + A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government.

- Related terms: RKE Government + Related terms: RKE Government

RKE Government
+

+ Versions: Rancher v2.6.0 +

An alternative name for RKE2.

- Related terms: RKE2 + Related terms: RKE2

@@ -281,6 +328,6 @@ title: Glossary Placeholder

- Related terms: Rancher server + Related terms: Rancher server

diff --git a/sidebars.js b/sidebars.js index e80a933e2bc9..7499e8a62b5b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1367,6 +1367,7 @@ const sidebars = { ] }, "contribute-to-rancher", + "glossary", ] } module.exports = sidebars; diff --git a/src/css/custom.css b/src/css/custom.css index e0c051dae23e..6775d659825c 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -142,6 +142,7 @@ dd { dd+p { margin-inline-start: 40px; /*This is intended to match the margin spacing for the dd element*/ + font-weight: lighter; } dt { @@ -152,6 +153,11 @@ dt+p { margin-bottom: 0; } +dt+p, dd+p { + font-size: .9rem; + font-weight: lighter; +} + hr { background-image: -webkit-linear-gradient(left,#f3f3f3,#adadb1,#f3f3f3); margin: 0 auto; From 922778fa7f8eb6e9aa9b348cb622395d235acf90 Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 15 Feb 2024 14:03:43 -0500 Subject: [PATCH 03/29] redundant styling specification --- src/css/custom.css | 1 - 1 file changed, 1 deletion(-) diff --git a/src/css/custom.css b/src/css/custom.css index 6775d659825c..b36578ba1939 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -142,7 +142,6 @@ dd { dd+p { margin-inline-start: 40px; /*This is intended to match the margin spacing for the dd element*/ - font-weight: lighter; } dt { From 3d25e71bb9f1ea8f4725dec32b7691373f709785 Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 15 Feb 2024 14:07:49 -0500 Subject: [PATCH 04/29] typo --- docs/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/glossary.md b/docs/glossary.md index d337cf641833..bd3e1a2ae20c 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -43,7 +43,7 @@ This page covers Rancher-specific terminology and symbols which might be unfamil Apps

- Versions: Rancher v2.6.5 and later + Versions: Rancher v2.6.5 and later

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 Apps & Marketplace, or Catalogs. From bf2f6ac35335efd81d4dadf723a2438d9dcfb634 Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 22 Feb 2024 11:28:01 -0500 Subject: [PATCH 05/29] switching to shared-file/import structure so we have a single source file to update regardless of version to achieve this, we needed to use an madx-code-block to give us a proper side navigation TOC --- docs/glossary.md | 324 +------------------------------------- shared-files/_glossary.md | 321 +++++++++++++++++++++++++++++++++++++ 2 files changed, 326 insertions(+), 319 deletions(-) create mode 100644 shared-files/_glossary.md diff --git a/docs/glossary.md b/docs/glossary.md index bd3e1a2ae20c..c77febd0155f 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -10,324 +10,10 @@ title: Glossary This page covers Rancher-specific terminology and symbols which might be unfamiliar, or which differs between Rancher versions. -## Icons & Symbols +```mdx-code-block +import Glossary, {toc as GlossaryTOC} from "/shared-files/_glossary.md" -
-
- ☰ -
-
- 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 - -
-
- App -
-
- Unless specified otherwise, a Rancher application. Rancher applications use either Helm charts or Rancher charts to deploy. -
-

- Related terms: Rancher charts -

-
- Apps -
-

- Versions: Rancher v2.6.5 and later -

-
- 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 Apps & Marketplace, or Catalogs. -
-

- Related terms: Apps & Marketplace, Catalogs -

-
- Apps & Marketplace -
-

- Versions: Rancher v2.5.0–2.6.5 -

-
- The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps. -
-

- Related terms: Apps, Catalogs -

-
- -## C - -
-
- Catalogs -
-

- Versions: Rancher v2.4.x and earlier -

-
- The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. -
-

- Related terms: Apps, Apps & Marketplace -

-
- Community -
-
- Placeholder -- we also use The Community by SUSE, as in, the community of users. Rancher Community Edition? -
-

- Related terms: Rancher Prime -

-
- -## D - -
-
- Downstream cluster -
-
- Placeholder -
-

- Related terms: Managed cluster -

-
- -## E - -
-
- Extension -
-
- Placeholder -
-

- Related terms: Apps -

-
- -## K - -
-
- K3s -
-
- Placeholder -
-

- Related terms: RKE -

-
- -## L - -
-
- Local cluster -
-
- Placeholder -
-

- Related terms: Rancher server -

-
- -## M - -
-
- Managed cluster -
-
- Placeholder -
-

- Related terms: Downstream cluster -

-
- -## N - -
-
- Node template -
-
- Placeholder -
-
- -## P - -
-
- Prime -
-
- Placeholder -
-

- Related terms: Rancher Prime -

-
- Project -
-
- Placeholder -
-
- PSA -
-
- Placeholder -
-
- PSA configuration template (PSACT) -
-
- Placeholder -
-
- PSP -
-
- Placeholder -
-
- -## R - -
-
- Rancher chart -
-
- Placeholder -
-
- Rancher Command Line Interface (CLI) -
-
- Placeholder -
-
- Rancher Enterprise -
-
- An alternative name for Rancher Prime. -
-

- Related terms: Rancher Prime -

-
- Rancher Kubernetes API (RK-API) -
-
- Placeholder -
-
- Rancher Kubernetes Engine (RKE) -
-
-
    -
  1. - 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. The next-generation line is called RKE2 or RKE Government. -
    2. -
  2. - Shorthand for RKE1, the 1.x software line of RKE. -
    3. -
-
-

- Related terms: K3s, RKE1, RKE2 -

-
- Rancher Prime -
-

- Versions: Rancher v2.8 and later -

-
- Placeholder -
-

- Related terms: Rancher Community -

-
- Rancher server -
-
- Placeholder -
-

- Related terms: Upstream cluster -

-
- RKE1 -
-
- An alternative name for the 1.x software line of Rancher Kubernetes Engine (RKE). Sometimes called RKE for short. -
-

- Related terms: Rancher Kubernetes Engine, RKE2 -

-
- RKE2 -
-

- Versions: Rancher v2.6.0 -

-
- A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government. -
-

- Related terms: RKE Government -

-
- RKE Government -
-

- Versions: Rancher v2.6.0 -

-
- An alternative name for RKE2. -
-

- Related terms: RKE2 -

-
- -## U - -
-
- UI -
-
- Placeholder -
-
- Upstream cluster -
-
- Placeholder -
-

- Related terms: Rancher server -

-
+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 000000000000..293b4afbbf04 --- /dev/null +++ b/shared-files/_glossary.md @@ -0,0 +1,321 @@ +## 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 + +
+
+ App +
+
+ Unless specified otherwise, a Rancher application. Rancher applications use either Helm charts or Rancher charts to deploy. +
+

+ Related terms: Rancher charts +

+
+ Apps +
+

+ Versions: Rancher v2.6.5 and later +

+
+ 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 Apps & Marketplace, or Catalogs. +
+

+ Related terms: Apps & Marketplace, Catalogs +

+
+ Apps & Marketplace +
+

+ Versions: Rancher v2.5.0–2.6.5 +

+
+ The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps. +
+

+ Related terms: Apps, Catalogs +

+
+ +## C + +
+
+ Catalogs +
+

+ Versions: Rancher v2.4.x and earlier +

+
+ The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. +
+

+ Related terms: Apps, Apps & Marketplace +

+
+ Community +
+
+ Placeholder -- we also use The Community by SUSE, as in, the community of users. Rancher Community Edition? +
+

+ Related terms: Rancher Prime +

+
+ +## D + +
+
+ Downstream cluster +
+
+ Placeholder +
+

+ Related terms: Managed cluster +

+
+ +## E + +
+
+ Extension +
+
+ Placeholder +
+

+ Related terms: Apps +

+
+ +## K + +
+
+ K3s +
+
+ Placeholder +
+

+ Related terms: RKE +

+
+ +## L + +
+
+ Local cluster +
+
+ Placeholder +
+

+ Related terms: Rancher server +

+
+ +## M + +
+
+ Managed cluster +
+
+ Placeholder +
+

+ Related terms: Downstream cluster +

+
+ +## N + +
+
+ Node template +
+
+ Placeholder +
+
+ +## P + +
+
+ Prime +
+
+ Placeholder +
+

+ Related terms: Rancher Prime +

+
+ Project +
+
+ Placeholder +
+
+ PSA +
+
+ Placeholder +
+
+ PSA configuration template (PSACT) +
+
+ Placeholder +
+
+ PSP +
+
+ Placeholder +
+
+ +## R + +
+
+ Rancher chart +
+
+ Placeholder +
+
+ Rancher Command Line Interface (CLI) +
+
+ Placeholder +
+
+ Rancher Enterprise +
+
+ An alternative name for Rancher Prime. +
+

+ Related terms: Rancher Prime +

+
+ Rancher Kubernetes API (RK-API) +
+
+ Placeholder +
+
+ Rancher Kubernetes Engine (RKE) +
+
+
    +
  1. + 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. The next-generation line is called RKE2 or RKE Government. +
    2. +
  2. + Shorthand for RKE1, the 1.x software line of RKE. +
    3. +
+
+

+ Related terms: K3s, RKE1, RKE2 +

+
+ Rancher Prime +
+

+ Versions: Rancher v2.8 and later +

+
+ Placeholder +
+

+ Related terms: Rancher Community +

+
+ Rancher server +
+
+ Placeholder +
+

+ Related terms: Upstream cluster +

+
+ RKE1 +
+
+ An alternative name for the 1.x software line of Rancher Kubernetes Engine (RKE). Sometimes called RKE for short. +
+

+ Related terms: Rancher Kubernetes Engine, RKE2 +

+
+ RKE2 +
+

+ Versions: Rancher v2.6.0 +

+
+ A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government. +
+

+ Related terms: RKE Government +

+
+ RKE Government +
+

+ Versions: Rancher v2.6.0 +

+
+ An alternative name for RKE2. +
+

+ Related terms: RKE2 +

+
+ +## U + +
+
+ UI +
+
+ Placeholder +
+
+ Upstream cluster +
+
+ Placeholder +
+

+ Related terms: Rancher server +

+
\ No newline at end of file From 8b06eec86194258c6fe08a00180d112500ae8bff Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 22 Feb 2024 15:58:32 -0500 Subject: [PATCH 06/29] updated styling + synonyms --- docs/glossary.md | 2 +- shared-files/_glossary.md | 78 +++++++++++++++++++++------------------ src/css/custom.css | 13 ++----- 3 files changed, 47 insertions(+), 46 deletions(-) diff --git a/docs/glossary.md b/docs/glossary.md index c77febd0155f..63563751eb38 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -8,7 +8,7 @@ title: Glossary -This page covers Rancher-specific terminology and symbols which might be unfamiliar, or which differs between Rancher versions. +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" diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 293b4afbbf04..477743f43822 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -19,37 +19,28 @@
- App + Apps
- Unless specified otherwise, a Rancher application. Rancher applications use either Helm charts or Rancher charts to deploy. + 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 Apps & Marketplace, or Catalogs.
-

- Related terms: Rancher charts -

-
- Apps -

Versions: Rancher v2.6.5 and later

-
- 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 Apps & Marketplace, or Catalogs. -

- Related terms: Apps & Marketplace, 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 chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps.

- Related terms: Apps, Catalogs + Versions: Rancher v2.5.0–2.6.5 +

+

+ Synonyms: Apps, Catalogs

@@ -59,14 +50,14 @@
Catalogs
-

- Versions: Rancher v2.4.x and earlier -

The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps.

- Related terms: Apps, Apps & Marketplace + Versions: Rancher v2.4.x and earlier +

+

+ Synonyms: Apps, Apps & Marketplace

Community @@ -89,7 +80,10 @@ Placeholder

- Related terms: Managed cluster + Synonyms: Managed cluster +

+

+ Related terms: Hosted cluster, Imported cluster, Rancher server

@@ -103,7 +97,7 @@ Placeholder

- Related terms: Apps + Related terms: Apps & Marketplace

@@ -131,7 +125,10 @@ Placeholder

- Related terms: Rancher server + Synonyms: Rancher server, Upstream cluster +

+

+ Related terms: Managed cluster

@@ -145,7 +142,10 @@ Placeholder

- Related terms: Downstream cluster + Synonyms: Downstream cluster +

+

+ Related terms: Rancher server

@@ -170,7 +170,10 @@ Placeholder

- Related terms: Rancher Prime + Versions: Rancher v2.8 and later +

+

+ Related terms: Community

Project @@ -220,7 +223,10 @@ An alternative name for Rancher Prime.

- Related terms: Rancher Prime + Synonyms: Rancher Prime +

+

+ Related terms: Community

Rancher Kubernetes API (RK-API) @@ -247,12 +253,12 @@
Rancher Prime
-

- Versions: Rancher v2.8 and later -

Placeholder
+

+ Versions: Rancher v2.8 and later +

Related terms: Rancher Community

@@ -263,7 +269,7 @@ Placeholder

- Related terms: Upstream cluster + Synonyms: Local cluster, Upstream cluster

RKE1 @@ -277,14 +283,14 @@
RKE2
-

- Versions: Rancher v2.6.0 -

A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government.

- Related terms: RKE Government + Versions: Rancher v2.6.0 +

+

+ Synonyms: RKE Government

RKE Government @@ -296,7 +302,7 @@ An alternative name for RKE2.

- Related terms: RKE2 + Synonyms: RKE2

@@ -316,6 +322,6 @@ Placeholder

- Related terms: Rancher server + Synonyms: Local cluster, Rancher server

\ No newline at end of file diff --git a/src/css/custom.css b/src/css/custom.css index b36578ba1939..5015eee093f8 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -140,21 +140,16 @@ dd { margin-bottom: 1rem; } -dd+p { - margin-inline-start: 40px; /*This is intended to match the margin spacing for the dd element*/ -} - dt { font-weight: bold; + margin-top: 1rem; } -dt+p { - margin-bottom: 0; -} - -dt+p, dd+p { +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 { From d6fae3ba9d715119d469e05ba1e661b463ce9e6e Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 23 Feb 2024 14:21:36 -0500 Subject: [PATCH 07/29] moved version back to before def as grouping it with the synonyms/related terms was visually confusing added some definitions (catalogs, downstream cluster) --- shared-files/_glossary.md | 47 ++++++++++++++++++++++----------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 477743f43822..d034120c7ec2 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -21,24 +21,24 @@
Apps
-
- 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 Apps & Marketplace, or Catalogs. -

Versions: Rancher v2.6.5 and later

+
+ 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 Apps & Marketplace, or Catalogs. +

Synonyms: Apps & Marketplace, Catalogs

Apps & Marketplace
+

+ Rancher v2.5.0–2.6.5 +

The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps.
-

- Versions: Rancher v2.5.0–2.6.5 -

Synonyms: Apps, Catalogs

@@ -50,12 +50,19 @@
Catalogs
-
- The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. -

- Versions: Rancher v2.4.x and earlier + Versions: (Def. 1) Rancher v2.4.x and earlier, (Def. 2) Rancher v2.7.x and later

+
+
    +
  • + The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. +
    • +
  • + Extension catalogs, container image repositories that can be imported to add extensions to your Rancher instance. +
    • +
+

Synonyms: Apps, Apps & Marketplace

@@ -77,7 +84,7 @@ Downstream cluster
- Placeholder + A Kubernetes cluster that is managed by a cluster which hosts Rancher.

Synonyms: Managed cluster @@ -97,7 +104,7 @@ Placeholder

- Related terms: Apps & Marketplace + Related terms: Apps & Marketplace, Catalogs, Integrations

@@ -166,12 +173,12 @@
Prime
-
- Placeholder -

Versions: Rancher v2.8 and later

+
+ Placeholder +

Related terms: Community

@@ -283,20 +290,20 @@
RKE2
+

+ Versions: Rancher v2.6.0 and later +

A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government.
-

- Versions: Rancher v2.6.0 -

Synonyms: RKE Government

RKE Government
-

- Versions: Rancher v2.6.0 +

+ Versions: Rancher v2.6.0 and later

An alternative name for RKE2. From eee8ccb8cb63af79e5b28f5c9c62cf88e3102665 Mon Sep 17 00:00:00 2001 From: martyav Date: Mon, 26 Feb 2024 16:49:06 -0500 Subject: [PATCH 08/29] styling --- shared-files/_glossary.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index d034120c7ec2..9cc069feac85 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -34,7 +34,7 @@ Apps & Marketplace

- Rancher v2.5.0–2.6.5 + Versions: Rancher v2.5.0–2.6.5

The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps. @@ -51,17 +51,17 @@ Catalogs

- Versions: (Def. 1) Rancher v2.4.x and earlier, (Def. 2) Rancher v2.7.x and later + Versions: 1. Rancher v2.4.x and earlier 2. Rancher v2.7.x and later

-
    +
    1. The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps.
    2. Extension catalogs, container image repositories that can be imported to add extensions to your Rancher instance.
      3. -
+

Synonyms: Apps, Apps & Marketplace From 8ab00c6afdbe6cb6aa4058a8092848cb5b4b5e7f Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 1 Mar 2024 10:59:54 -0500 Subject: [PATCH 09/29] filling out definitions icons through M --- shared-files/_glossary.md | 89 +++++++++++++++++++++++++++++++++------ 1 file changed, 75 insertions(+), 14 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 9cc069feac85..2ad01e978597 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -70,10 +70,10 @@ Community

- Placeholder -- we also use The Community by SUSE, as in, the community of users. Rancher Community Edition? + A build of Rancher that's available to the entire Rancher community.

- Related terms: Rancher Prime + Related terms: Prime, Rancher Prime

@@ -84,13 +84,13 @@ Downstream cluster
- A Kubernetes cluster that is managed by a cluster which hosts Rancher. + An alternative name for a Kubernetes cluster that is managed by a Rancher server. A Rancher server is the cluster that hosts Rancher.

Synonyms: Managed cluster

- Related terms: Hosted cluster, Imported cluster, Rancher server + Related terms: Hosted cluster, Imported cluster, Rancher server, Registered cluster

@@ -100,14 +100,51 @@
Extension
+

+ Versions: Rancher v2.7.0 and later +

- Placeholder + 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. Some examples of common Extensions include Fleet and Harvester (both built-in), Kubewarden (manual), and Elemental (manual).

Related terms: Apps & Marketplace, Catalogs, Integrations

+## H + +
+
+ Hosted cluster +
+
+ A managed cluster that is hosted in the cloud, by a Kubernetes provider. Rancher integrates with the hosted Kubernetes provider's cloud APIs, so that you can manage the remote cluster from the Rancher UI. Rancher supports a variety of hosted Kubernetes providers, including Amazon Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), and Google Kubernetes Engine (GKE). +
+

+ Related terms: Managed cluster +

+
+ +## I + +
+
+ Imported cluster +
+

+ Versions: Rancher 2.0 to v2.4 +

+
+ An existing cluster which is provisioned by a third-party and connected to a Rancher server. Rancher agents are set up to communicate between the imported cluster and the Rancher server, so that the imported cluster can be managed by Rancher. Registered clusters in later versions of Rancher are roughly synonymous with imported clusters. The main difference is that the Rancher UI provides more management features for registered clusters, and, in some cases, may offer the same features to imported clusters as clusters provisioned through Rancher. +
+

+ Synonyms: Registered cluster +

+

+ Related terms: Managed cluster +

+
+ ## K
@@ -115,7 +152,7 @@ K3s
- Placeholder + A lightweight Kubernetes distribution chiefly designed for workloads that run unattended under tight resource constraints. "K3s" isn't an acronym; it is wordplay on "K8s", an abbreviation for "Kubernetes", and refers to the small footprint of the distribution.

Related terms: RKE @@ -129,7 +166,7 @@ Local cluster

- Placeholder + An alternative name for the cluster which hosts Rancher. The cluster that hosts Rancher works as a server that manages other clusters.

Synonyms: Rancher server, Upstream cluster @@ -146,7 +183,7 @@ Managed cluster

- Placeholder + A Kubernetes cluster that is managed by a Rancher server. Managed clusters can run on a variety of infrastructure and can be located anywhere. Rancher can provision Kubernetes from a hosted provider, provision compute nodes and then install Kubernetes onto them, or import existing Kubernetes clusters running anywhere.

Synonyms: Downstream cluster @@ -159,6 +196,12 @@ ## N

+
+ Neuvector Prime +
+
+ Placeholder +
Node template
@@ -171,11 +214,8 @@
- Prime + Prime
-

- Versions: Rancher v2.8 and later -

Placeholder
@@ -260,15 +300,24 @@
Rancher Prime
+

+ Versions: Rancher v2.8 and later +

Placeholder

- Versions: Rancher v2.8 and later + Related terms: Rancher Community

+
+ Rancher Prime Hosted +

- Related terms: Rancher Community + Versions: Rancher v2.8 and later

+
+ Placeholder +
Rancher server
@@ -278,6 +327,18 @@

Synonyms: Local cluster, Upstream cluster

+
+ Registered cluster +
+
+ Placeholder +
+

+ Synonyms: +

+

+ Related terms: +

RKE1
From 2c0f47076411cb228cd304918482e3c21c7c0ce0 Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 1 Mar 2024 11:30:20 -0500 Subject: [PATCH 10/29] build failed due to comment tag? --- shared-files/_glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 2ad01e978597..f26db255163d 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -197,7 +197,7 @@
- Neuvector Prime + Neuvector Prime
Placeholder From aab9de6657f50b8bb589d4c0af5f8e180ae2359c Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 1 Mar 2024 12:45:49 -0500 Subject: [PATCH 11/29] rem'd comments as they were causing the build to fail due to unexpected token error --- shared-files/_glossary.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index f26db255163d..99ef6077d890 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -197,10 +197,10 @@
- Neuvector Prime + Neuvector Prime
- Placeholder + Placeholder - Note that this can be used stand-alone or in combination with Rancher Prime
Node template @@ -214,10 +214,10 @@
- Prime + Prime
- Placeholder + Placeholder - Both Neuvector and Rancher have stand-alone Prime offerings, plus there's a SaaS offering. Rancher Prime Hosted, with Prime in the name

Related terms: Community @@ -310,13 +310,13 @@ Related terms: Rancher Community

- Rancher Prime Hosted + Rancher Prime Hosted

Versions: Rancher v2.8 and later

- Placeholder + Placeholder - SaaS offering -- see https://www.rancher.com/products/rancher-platform and scroll down
Rancher server From d1a10452432c8d30e642984d08d849ae4de17567 Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 1 Mar 2024 15:53:51 -0500 Subject: [PATCH 12/29] revised some definitions --- shared-files/_glossary.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 99ef6077d890..9af5361d517f 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -84,7 +84,7 @@ Downstream cluster
- An alternative name for a Kubernetes cluster that is managed by a Rancher server. A Rancher server is the cluster that hosts Rancher. + An alternative name for a Kubernetes cluster that is managed by a Rancher server.

Synonyms: Managed cluster @@ -135,7 +135,7 @@ Versions: Rancher 2.0 to v2.4

- An existing cluster which is provisioned by a third-party and connected to a Rancher server. Rancher agents are set up to communicate between the imported cluster and the Rancher server, so that the imported cluster can be managed by Rancher. Registered clusters in later versions of Rancher are roughly synonymous with imported clusters. The main difference is that the Rancher UI provides more management features for registered clusters, and, in some cases, may offer the same features to imported clusters as clusters provisioned through Rancher. + An existing cluster which is provisioned by a third-party and connected to a Rancher server. Rancher agents are set up to communicate between the imported cluster and the Rancher server, so that the imported cluster can be managed by Rancher. Registered clusters in later versions of Rancher are roughly synonymous with imported clusters. The main difference is that the Rancher UI provides more management features for registered clusters, and, in some cases, may offer the same featureset to imported clusters as to clusters provisioned through Rancher.

Synonyms: Registered cluster @@ -152,7 +152,7 @@ K3s

- A lightweight Kubernetes distribution chiefly designed for workloads that run unattended under tight resource constraints. "K3s" isn't an acronym; it is wordplay on "K8s", an abbreviation for "Kubernetes", and refers to the small footprint of the distribution. + A lightweight Kubernetes distribution chiefly designed for workloads that run unattended under tight resource constraints.

Related terms: RKE @@ -166,7 +166,7 @@ Local cluster

- An alternative name for the cluster which hosts Rancher. The cluster that hosts Rancher works as a server that manages other clusters. + An alternative name for the cluster which hosts Rancher. In this case, "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. Because the cluster that hosts Rancher works as a server that manages other clusters, it is also called a Rancher server.

Synonyms: Rancher server, Upstream cluster @@ -183,7 +183,7 @@ Managed cluster

- A Kubernetes cluster that is managed by a Rancher server. Managed clusters can run on a variety of infrastructure and can be located anywhere. Rancher can provision Kubernetes from a hosted provider, provision compute nodes and then install Kubernetes onto them, or import existing Kubernetes clusters running anywhere. + A Kubernetes cluster that is managed by a Rancher server. Managed clusters can run on a variety of infrastructure and can be located anywhere.

Synonyms: Downstream cluster From 450913f0aed689a5c9913a21766e646e377dc2cc Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 5 Mar 2024 12:32:13 -0500 Subject: [PATCH 13/29] revised wording and some formatting fixes --- shared-files/_glossary.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 9af5361d517f..9a4ec08e65a2 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -84,7 +84,7 @@ Downstream cluster

- An alternative name for a Kubernetes cluster that is managed by a Rancher server. + An alternative name for a Managed cluster: a Kubernetes cluster that is managed by a Rancher server.

Synonyms: Managed cluster @@ -104,7 +104,7 @@ Versions: Rancher v2.7.0 and later

- 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. Some examples of common Extensions include Fleet and Harvester (both built-in), Kubewarden (manual), and Elemental (manual). + 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.

Related terms: Apps & Marketplace, Catalogs, Integrations @@ -118,7 +118,7 @@ Hosted cluster

- A managed cluster that is hosted in the cloud, by a Kubernetes provider. Rancher integrates with the hosted Kubernetes provider's cloud APIs, so that you can manage the remote cluster from the Rancher UI. Rancher supports a variety of hosted Kubernetes providers, including Amazon Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), and Google Kubernetes Engine (GKE). + 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.

Related terms: Managed cluster @@ -132,10 +132,10 @@ Imported cluster

- Versions: Rancher 2.0 to v2.4 + Versions: Rancher 2.0–v2.4

- An existing cluster which is provisioned by a third-party and connected to a Rancher server. Rancher agents are set up to communicate between the imported cluster and the Rancher server, so that the imported cluster can be managed by Rancher. Registered clusters in later versions of Rancher are roughly synonymous with imported clusters. The main difference is that the Rancher UI provides more management features for registered clusters, and, in some cases, may offer the same featureset to imported clusters as to clusters provisioned through Rancher. + 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.

Synonyms: Registered cluster @@ -166,7 +166,7 @@ Local cluster

- An alternative name for the cluster which hosts Rancher. In this case, "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. Because the cluster that hosts Rancher works as a server that manages other clusters, it is also called a Rancher server. + An alternative name for the Rancher server, the cluster which 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.

Synonyms: Rancher server, Upstream cluster @@ -183,7 +183,7 @@ Managed cluster

- A Kubernetes cluster that is managed by a Rancher server. Managed clusters can run on a variety of infrastructure and can be located anywhere. + 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.

Synonyms: Downstream cluster From a5954a35c8cb7ff5af59926db0696278fdda4e0e Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 7 Mar 2024 12:38:50 -0500 Subject: [PATCH 14/29] syncing with list in PR --- shared-files/_glossary.md | 74 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 9a4ec08e65a2..26d435ce03c3 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -66,6 +66,15 @@

Synonyms: Apps, Apps & Marketplace

+
+ Cloud credentials +
+
+ Placeholder +
+

+ Related terms: Hosted clusters +

Community
@@ -80,6 +89,12 @@ ## D
+
+ Deployment +
+
+ Placeholder +
Downstream cluster
@@ -109,6 +124,12 @@

Related terms: Apps & Marketplace, Catalogs, Integrations

+
+ External authentication +
+
+ Placeholder +
## H @@ -143,6 +164,12 @@

Related terms: Managed cluster

+
+ Integration +
+
+ Placeholder +
## K @@ -162,6 +189,12 @@ ## L
+
+ Local authentication +
+
+ Placeholder +
Local cluster
@@ -179,6 +212,12 @@ ## M
+
+ Machine pool +
+
+ Placeholder +
Managed cluster
@@ -208,6 +247,12 @@
Placeholder
+
+ Node template +
+
+ Placeholder +
## P @@ -228,6 +273,12 @@
Placeholder
+
+ Project resource quota +
+
+ Placeholder +
PSA
@@ -372,6 +423,12 @@

Synonyms: RKE2

+
+ Roles +
+
+ Placeholder +
## U @@ -392,4 +449,21 @@

Synonyms: Local cluster, Rancher server

+
+ Users +
+
+ Placeholder +
+
+ +## W + +
+
+ Workload +
+
+ Placeholder +
\ No newline at end of file From b2253e2d99b62487dd446f3487a0c428a32ba936 Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 7 Mar 2024 14:14:05 -0500 Subject: [PATCH 15/29] versioning --- versioned_docs/version-2.0-2.4/glossary.md | 19 +++++++++++++++++++ versioned_docs/version-2.5/glossary.md | 19 +++++++++++++++++++ versioned_docs/version-2.6/glossary.md | 19 +++++++++++++++++++ versioned_docs/version-2.7/glossary.md | 19 +++++++++++++++++++ versioned_docs/version-2.8/glossary.md | 19 +++++++++++++++++++ 5 files changed, 95 insertions(+) create mode 100644 versioned_docs/version-2.0-2.4/glossary.md create mode 100644 versioned_docs/version-2.5/glossary.md create mode 100644 versioned_docs/version-2.6/glossary.md create mode 100644 versioned_docs/version-2.7/glossary.md create mode 100644 versioned_docs/version-2.8/glossary.md 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 000000000000..16aa7f9d6b2e --- /dev/null +++ b/versioned_docs/version-2.0-2.4/glossary.md @@ -0,0 +1,19 @@ +--- +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 000000000000..16aa7f9d6b2e --- /dev/null +++ b/versioned_docs/version-2.5/glossary.md @@ -0,0 +1,19 @@ +--- +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 000000000000..16aa7f9d6b2e --- /dev/null +++ b/versioned_docs/version-2.6/glossary.md @@ -0,0 +1,19 @@ +--- +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 000000000000..16aa7f9d6b2e --- /dev/null +++ b/versioned_docs/version-2.7/glossary.md @@ -0,0 +1,19 @@ +--- +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 000000000000..16aa7f9d6b2e --- /dev/null +++ b/versioned_docs/version-2.8/glossary.md @@ -0,0 +1,19 @@ +--- +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; +``` From 3fc4ffcf459fc5a5ad25bdcb53509d748a1e8966 Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 24 May 2024 14:33:47 -0400 Subject: [PATCH 16/29] rm'd placeholders --- shared-files/_glossary.md | 200 -------------------------------------- 1 file changed, 200 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 26d435ce03c3..7a3560e0859c 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -89,12 +89,6 @@ ## D
-
- Deployment -
-
- Placeholder -
Downstream cluster
@@ -124,12 +118,6 @@

Related terms: Apps & Marketplace, Catalogs, Integrations

-
- External authentication -
-
- Placeholder -
## H @@ -164,12 +152,6 @@

Related terms: Managed cluster

-
- Integration -
-
- Placeholder -
## K @@ -189,12 +171,6 @@ ## L
-
- Local authentication -
-
- Placeholder -
Local cluster
@@ -212,12 +188,6 @@ ## M
-
- Machine pool -
-
- Placeholder -
Managed cluster
@@ -232,88 +202,9 @@

-## N - -
-
- Neuvector Prime -
-
- Placeholder - Note that this can be used stand-alone or in combination with Rancher Prime -
-
- Node template -
-
- Placeholder -
-
- Node template -
-
- Placeholder -
-
- -## P - -
-
- Prime -
-
- Placeholder - Both Neuvector and Rancher have stand-alone Prime offerings, plus there's a SaaS offering. Rancher Prime Hosted, with Prime in the name -
-

- Related terms: Community -

-
- Project -
-
- Placeholder -
-
- Project resource quota -
-
- Placeholder -
-
- PSA -
-
- Placeholder -
-
- PSA configuration template (PSACT) -
-
- Placeholder -
-
- PSP -
-
- Placeholder -
-
- ## R
-
- Rancher chart -
-
- Placeholder -
-
- Rancher Command Line Interface (CLI) -
-
- Placeholder -
Rancher Enterprise
@@ -326,12 +217,6 @@

Related terms: Community

-
- Rancher Kubernetes API (RK-API) -
-
- Placeholder -
Rancher Kubernetes Engine (RKE)
@@ -348,48 +233,6 @@

Related terms: K3s, RKE1, RKE2

-
- Rancher Prime -
-

- Versions: Rancher v2.8 and later -

-
- Placeholder -
-

- Related terms: Rancher Community -

-
- Rancher Prime Hosted -
-

- Versions: Rancher v2.8 and later -

-
- Placeholder - SaaS offering -- see https://www.rancher.com/products/rancher-platform and scroll down -
-
- Rancher server -
-
- Placeholder -
-

- Synonyms: Local cluster, Upstream cluster -

-
- Registered cluster -
-
- Placeholder -
-

- Synonyms: -

-

- Related terms: -

RKE1
@@ -423,47 +266,4 @@

Synonyms: RKE2

-
- Roles -
-
- Placeholder -
- -## U - -
-
- UI -
-
- Placeholder -
-
- Upstream cluster -
-
- Placeholder -
-

- Synonyms: Local cluster, Rancher server -

-
- Users -
-
- Placeholder -
-
- -## W - -
-
- Workload -
-
- Placeholder -
-
\ No newline at end of file From 2ba4a20586f2070da5ea862d2983325135730dd6 Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 24 May 2024 15:41:52 -0400 Subject: [PATCH 17/29] added Sunil's definitions --- shared-files/_glossary.md | 60 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 57 insertions(+), 3 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 7a3560e0859c..d32336bd5ce6 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -231,13 +231,34 @@

- Related terms: K3s, RKE1, RKE2 + Related terms: K3s, RKE1, RKE2, RKE Government +

+
+ 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. +
+

+ Synonyms: Rancher Enterprise +

+
+ Rancher server +
+
+ Rancher Server is 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. +
+

+ Synonyms: Local cluster, Upstream cluster +

+

+ Related terms: Managed cluster

RKE1
- An alternative name for the 1.x software line of Rancher Kubernetes Engine (RKE). Sometimes called RKE for short. + An alternative name for the 1.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.

Related terms: Rancher Kubernetes Engine, RKE2 @@ -249,7 +270,7 @@ Versions: Rancher v2.6.0 and later

- A version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government. + A fully conformant version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government.

Synonyms: RKE Government @@ -266,4 +287,37 @@

Synonyms: RKE2

+ Roles + +
+ Within Rancher, roles determine what actions a user can make within a cluster or project. +
+
+ +## U + +
+
+ Upstream cluster +
+
+ An upstream cluster is the local Kubernetes cluster that your Rancher installation is provisioned on. +
+

+ Synonyms: Local cluster, Rancher server +

+

+ Related terms: Managed cluster +

+ +## W + +
+
+ Workload +
+
+ Workloads are 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 From 855697a84d0f9f475d45559f6eb84ce85ca0aab4 Mon Sep 17 00:00:00 2001 From: martyav Date: Fri, 24 May 2024 15:55:46 -0400 Subject: [PATCH 18/29] tag --- shared-files/_glossary.md | 1 + 1 file changed, 1 insertion(+) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index d32336bd5ce6..4ad092e4ad59 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -287,6 +287,7 @@

Synonyms: RKE2

+
Roles
From c17c2af727a0d13f19cc3f6acfd8ebde245872b4 Mon Sep 17 00:00:00 2001 From: Marty Hernandez Avedon Date: Tue, 28 May 2024 10:26:38 -0400 Subject: [PATCH 19/29] Apply suggestions from code review Co-authored-by: Billy Tat Co-authored-by: Sunil Singh --- shared-files/_glossary.md | 38 ++++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 4ad092e4ad59..ac0538a489a6 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -25,7 +25,7 @@ Versions: Rancher v2.6.5 and later

- 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 Apps & Marketplace, or Catalogs. + 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 @@ -37,7 +37,7 @@ Versions: Rancher v2.5.0–2.6.5

- The section of the Rancher UI where you manage Helm chart repositories. In earlier versions of Rancher, this section was called Catalogs. In later versions, it is called Apps. + 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 @@ -51,12 +51,12 @@ Catalogs

- Versions: 1. Rancher v2.4.x and earlier 2. Rancher v2.7.x and later + Versions: 1. Rancher v2.4 and earlier 2. Rancher v2.7 and later

  1. - The section of the Rancher UI where you manage Helm chart repositories. In later versions of Rancher, this section is called Apps & Marketplace, or Apps. + 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.
  2. Extension catalogs, container image repositories that can be imported to add extensions to your Rancher instance. @@ -93,13 +93,13 @@ Downstream cluster
    - An alternative name for a Managed cluster: a Kubernetes cluster that is managed by a Rancher server. + An alternative name for a Managed cluster: a Kubernetes cluster that is managed by a Rancher server.

    Synonyms: Managed cluster

    - Related terms: Hosted cluster, Imported cluster, Rancher server, Registered cluster + Related terms: Hosted cluster, Imported cluster, Rancher server, Registered cluster, Upstream cluster

@@ -113,7 +113,7 @@ Versions: Rancher v2.7.0 and later

- 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. + 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 @@ -141,10 +141,10 @@ Imported cluster

- Versions: Rancher 2.0–v2.4 + Versions: Rancher v2.0–2.4

- 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. + 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.

Synonyms: Registered cluster @@ -164,7 +164,7 @@ A lightweight Kubernetes distribution chiefly designed for workloads that run unattended under tight resource constraints.

- Related terms: RKE + Related terms: RKE2

@@ -192,7 +192,7 @@ Managed cluster
- 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 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.

Synonyms: Downstream cluster @@ -231,10 +231,13 @@

- Related terms: K3s, RKE1, RKE2, RKE Government + Synonyms: RKE1 +

+

+ Related terms: K3s, RKE2, RKE Government

- Rancher Prime + 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. @@ -258,10 +261,13 @@ RKE1
- An alternative name for the 1.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. + An alternative name for the 1.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.

- Related terms: Rancher Kubernetes Engine, RKE2 + Synonyms: Rancher Kubernetes Engine +

+

+ Related terms: RKE2

RKE2 @@ -282,7 +288,7 @@ Versions: Rancher v2.6.0 and later

- An alternative name for RKE2. + An alternative name for RKE2.

Synonyms: RKE2 From 1cb17fcd1ea9119a1d643dd09b6c42094a2053d4 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 May 2024 11:00:39 -0400 Subject: [PATCH 20/29] rm'd placeholder --- shared-files/_glossary.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index ac0538a489a6..2ee86532f63f 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -66,15 +66,6 @@

Synonyms: Apps, Apps & Marketplace

-
- Cloud credentials -
-
- Placeholder -
-

- Related terms: Hosted clusters -

Community
From 1388f572be65c78e6a4d1210623aa04d83a3d344 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 May 2024 11:21:30 -0400 Subject: [PATCH 21/29] rancher server definition + synonyms --- shared-files/_glossary.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 2ee86532f63f..11ab2fc9a345 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -166,13 +166,13 @@ Local cluster
- An alternative name for the Rancher server, the cluster which 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. + An alternative name for the 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.

Synonyms: Rancher server, Upstream cluster

- Related terms: Managed cluster + Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster

@@ -196,11 +196,17 @@ ## R
+
+ Rancher +
+
+ Rancher is 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 Enterprise
- An alternative name for Rancher Prime. + An alternative name for Rancher Prime.

Synonyms: Rancher Prime @@ -240,19 +246,19 @@ Rancher server

- Rancher Server is 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. + The Kubernetes cluster that hosts Rancher and manages the other clusters in the Rancher deployment.

Synonyms: Local cluster, Upstream cluster

- Related terms: Managed cluster + Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster

RKE1
- An alternative name for the 1.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. + 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 @@ -299,13 +305,13 @@ Upstream cluster

- An upstream cluster is the local Kubernetes cluster that your Rancher installation is provisioned on. + An alternative name for the Rancher server, that hosts Rancher and manages the other clusters in the Rancher deployment.

Synonyms: Local cluster, Rancher server

- Related terms: Managed cluster + Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster

From 7a361d78cda3dbebf1ab7b96785a9e4958b6e359 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 May 2024 11:26:45 -0400 Subject: [PATCH 22/29] rm'd note from files to put in issue --- docs/glossary.md | 2 -- versioned_docs/version-2.0-2.4/glossary.md | 2 -- versioned_docs/version-2.5/glossary.md | 2 -- versioned_docs/version-2.6/glossary.md | 2 -- versioned_docs/version-2.7/glossary.md | 2 -- versioned_docs/version-2.8/glossary.md | 2 -- 6 files changed, 12 deletions(-) diff --git a/docs/glossary.md b/docs/glossary.md index 63563751eb38..1db06477569e 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -2,8 +2,6 @@ title: Glossary --- - - diff --git a/versioned_docs/version-2.0-2.4/glossary.md b/versioned_docs/version-2.0-2.4/glossary.md index 16aa7f9d6b2e..0f632535cf34 100644 --- a/versioned_docs/version-2.0-2.4/glossary.md +++ b/versioned_docs/version-2.0-2.4/glossary.md @@ -2,8 +2,6 @@ title: Glossary --- - - diff --git a/versioned_docs/version-2.5/glossary.md b/versioned_docs/version-2.5/glossary.md index 16aa7f9d6b2e..0f632535cf34 100644 --- a/versioned_docs/version-2.5/glossary.md +++ b/versioned_docs/version-2.5/glossary.md @@ -2,8 +2,6 @@ title: Glossary --- - - diff --git a/versioned_docs/version-2.6/glossary.md b/versioned_docs/version-2.6/glossary.md index 16aa7f9d6b2e..0f632535cf34 100644 --- a/versioned_docs/version-2.6/glossary.md +++ b/versioned_docs/version-2.6/glossary.md @@ -2,8 +2,6 @@ title: Glossary --- - - diff --git a/versioned_docs/version-2.7/glossary.md b/versioned_docs/version-2.7/glossary.md index 16aa7f9d6b2e..0f632535cf34 100644 --- a/versioned_docs/version-2.7/glossary.md +++ b/versioned_docs/version-2.7/glossary.md @@ -2,8 +2,6 @@ title: Glossary --- - - diff --git a/versioned_docs/version-2.8/glossary.md b/versioned_docs/version-2.8/glossary.md index 16aa7f9d6b2e..0f632535cf34 100644 --- a/versioned_docs/version-2.8/glossary.md +++ b/versioned_docs/version-2.8/glossary.md @@ -2,8 +2,6 @@ title: Glossary --- - - From 5ebf85775c515bddd5ea828e641ccfdfbb94d00d Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 May 2024 11:56:14 -0400 Subject: [PATCH 23/29] rm rancher enterprise, rke government --- shared-files/_glossary.md | 33 +++------------------------------ 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 11ab2fc9a345..6b04fe610e1d 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -202,25 +202,13 @@
Rancher is 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 Enterprise -
-
- An alternative name for Rancher Prime. -
-

- Synonyms: Rancher Prime -

-

- Related terms: Community -

Rancher Kubernetes Engine (RKE)
  1. - 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. The next-generation line is called RKE2 or RKE Government. + 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. The next-generation line is called RKE2.
  2. Shorthand for RKE1, the 1.x software line of RKE. @@ -231,7 +219,7 @@ Synonyms: RKE1

    - Related terms: K3s, RKE2, RKE Government + Related terms: K3s, RKE2

    Rancher Prime @@ -273,23 +261,8 @@ Versions: Rancher v2.6.0 and later

    - A fully conformant version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards. Sometimes called RKE Government. + A fully conformant version of the Rancher Kubernetes Engine (RKE) that is designed for security and compliance with US federal government standards.
    -

    - Synonyms: RKE Government -

    -
    - RKE Government -
    -

    - Versions: Rancher v2.6.0 and later -

    -
    - An alternative name for RKE2. -
    -

    - Synonyms: RKE2 -

    Roles
    From b85427b025e78a43da040b5e13dc01513eea17c4 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 May 2024 17:39:09 -0400 Subject: [PATCH 24/29] + extension catalogs & registered cluster, syncing related terms, syncing language in definitions --- shared-files/_glossary.md | 59 +++++++++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 21 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 6b04fe610e1d..f3f39c583413 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -54,18 +54,14 @@ Versions: 1. Rancher v2.4 and earlier 2. Rancher v2.7 and later

    -
      -
    1. - 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. -
      2. -
    2. - Extension catalogs, container image repositories that can be imported to add extensions to your Rancher instance. -
      3. -
    + 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
    @@ -84,7 +80,7 @@ Downstream cluster
    - An alternative name for a Managed cluster: a Kubernetes cluster that is managed by a Rancher server. + An alternative name for a managed cluster, a Kubernetes cluster that is managed by a Rancher server.

    Synonyms: Managed cluster @@ -109,6 +105,15 @@

    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 @@ -121,7 +126,7 @@ 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.

- Related terms: Managed cluster + Related terms: Downstream cluster, Imported cluster, Managed cluster, Registered cluster

@@ -135,13 +140,10 @@ Versions: Rancher v2.0–2.4

- 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. + 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.

- Synonyms: Registered cluster -

-

- Related terms: Managed cluster + Related terms: Downstream cluster, Hosted cluster, Managed cluster, Reistered cluster

@@ -155,7 +157,7 @@ A lightweight Kubernetes distribution chiefly designed for workloads that run unattended under tight resource constraints.

- Related terms: RKE2 + Related terms: RKE, RKE2

@@ -166,7 +168,7 @@ Local cluster
- An alternative name for the 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. + 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.

Synonyms: Rancher server, Upstream cluster @@ -200,7 +202,7 @@ Rancher

- Rancher is 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. + 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) @@ -239,6 +241,18 @@

Synonyms: Local cluster, Upstream cluster

+

+ Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster, Registered cluster +

+
+ Registered cluster +
+

+ Versions: Rancher v2.0–2.4 +

+
+ 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. +

Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster

@@ -263,11 +277,14 @@
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
- Within Rancher, roles determine what actions a user can make within a cluster or project. + Roles determine what actions a Rancher user can make within a cluster or project.
@@ -278,7 +295,7 @@ Upstream cluster
- An alternative name for the Rancher server, that hosts Rancher and manages the other clusters in the Rancher deployment. + An alternative name for the Rancher server, the Kubernetes cluster that hosts Rancher and manages the other clusters in the Rancher deployment.

Synonyms: Local cluster, Rancher server @@ -295,6 +312,6 @@ Workload

- Workloads are 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. + 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 From 65cd5f16f27a27455a1c5398fe7b4c87736f2400 Mon Sep 17 00:00:00 2001 From: martyav Date: Tue, 28 May 2024 17:51:12 -0400 Subject: [PATCH 25/29] extra tag --- shared-files/_glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index f3f39c583413..59c644dfb3d2 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -126,7 +126,7 @@ 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.

- Related terms: Downstream cluster, Imported cluster, Managed cluster, Registered cluster + Related terms: Downstream cluster, Imported cluster, Managed cluster, Registered cluster

From d2a94869f986398fd50e99b99549ab4c56169184 Mon Sep 17 00:00:00 2001 From: martyav Date: Wed, 29 May 2024 10:21:05 -0400 Subject: [PATCH 26/29] versioning info for rke2 --- shared-files/_glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 59c644dfb3d2..8438fad971db 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -272,7 +272,7 @@ RKE2

- Versions: Rancher v2.6.0 and later + 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. From b72f80a671ea8a16a2ee397e09dcfb2270b837a5 Mon Sep 17 00:00:00 2001 From: Marty Hernandez Avedon Date: Wed, 29 May 2024 17:58:59 -0400 Subject: [PATCH 27/29] Apply suggestions from code review Co-authored-by: Billy Tat --- shared-files/_glossary.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 8438fad971db..416e3a399aa3 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -174,7 +174,7 @@ Synonyms: Rancher server, Upstream cluster

- Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster + Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster, Registered cluster

@@ -191,7 +191,7 @@ Synonyms: Downstream cluster

- Related terms: Rancher server + Related terms: Hosted cluster, Imported cluster, Rancher server, Registered cluster

@@ -229,9 +229,6 @@
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.
-

- Synonyms: Rancher Enterprise -

Rancher server
@@ -266,7 +263,7 @@ Synonyms: Rancher Kubernetes Engine

- Related terms: RKE2 + Related terms: K3s, RKE2

RKE2 @@ -295,7 +292,7 @@ Upstream cluster
- An alternative name for the Rancher server, the Kubernetes cluster that hosts Rancher and manages the other clusters in the Rancher deployment. + An alternative name for the Rancher server, the Kubernetes cluster that hosts Rancher and manages the other clusters in the Rancher deployment.

Synonyms: Local cluster, Rancher server From 29d4e3c61b4c9dd59483308c110b0a6406e8a42f Mon Sep 17 00:00:00 2001 From: Marty Hernandez Avedon Date: Thu, 30 May 2024 10:37:37 -0400 Subject: [PATCH 28/29] Apply suggestions from code review Co-authored-by: Billy Tat --- shared-files/_glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 416e3a399aa3..421c17ae65f8 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -298,7 +298,7 @@ Synonyms: Local cluster, Rancher server

- Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster + Related terms: Downstream cluster, Hosted cluster, Imported cluster, Managed cluster, Registered cluster

From a03bcfca8e2da1e2e20cf9d2f65e8902a0d6256a Mon Sep 17 00:00:00 2001 From: martyav Date: Thu, 30 May 2024 10:42:24 -0400 Subject: [PATCH 29/29] updated RKE def --- shared-files/_glossary.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/shared-files/_glossary.md b/shared-files/_glossary.md index 421c17ae65f8..f1f6d3825cc4 100644 --- a/shared-files/_glossary.md +++ b/shared-files/_glossary.md @@ -208,14 +208,7 @@ Rancher Kubernetes Engine (RKE)
-
    -
  1. - 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. The next-generation line is called RKE2. -
    2. -
  2. - Shorthand for RKE1, the 1.x software line of RKE. -
    3. -
+ 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