#358 Glossary project

[martyav]

Fixes #358

Reminders

• See the README for more details on how to work with the Rancher docs.

• Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.

• If the pull request is dependent on an upcoming release, make sure to target the release branch instead of main.

Description

Adds a glossary of Rancher-related terms.

Since we were struggling to add a plugin that would provide prettier Markdown syntax for definition lists, we're using HTML tags. The tags are necessary for Algolia to index the terms and make them searchable.

I also included some CSS styling.

---

List of terms to define

• ☰
• ⋮
• Apps
• Apps & Marketplace
• Catalogs (section)
• Catalogs (Helm chart repos)
• Cloud credentials
• Community (Rancher edition) -> discuss with Cam
• Deployment
• Downstream cluster
• Extensions
• External auth
• Hosted cluster
• Imported
• Integrations
• Hosted cluster
• Hosted pools
• K3s
• Local auth
• Local cluster
• Machine pool
• Managed cluster
• Neuvector Prime
• Node template
• Prime
• Project
• Project resource quotas
• PSA
• PSA Config Template
• PSP
• Rancher chart
• Rancher CLI
• Rancher Enterprise
• Rancher Kubernetes API (RK-API)
• Rancher Kubernetes Engine
• Rancher Prime
• Rancher server
• Registered cluster
• RKE1
• RKE2
• RKE Government
• Roles
• UI
• Upstream cluster
• Users
• Workload

---

Screenshot as of Feb 15 (latest):

Comments

We (@martyav & @sunilarjun) looked into adding a plugin that would provide native Markdown syntax for definition lists. We landed on this page , which has instructions on adding remark-deflist (repo) to your Docusaurus instance, but the instructions didn't seem to work for our config. I tried remark-definition-list (repo), but that didn't work either. While looking for a solution, I ran across this comment on an issue complaining that the instructions for adding Remark plugins needed improvement. It seems that the plugins need a remark-rehype handler to be configured. There was a PR to add this functionality to the Docusaurus config file, but I don't think it's available yet on Docusaurus 2. We might need to upgrade to Docusaurus 3. In the meantime, the HTML tags are perfectly functional.

[martyav]

@btat @sunilarjun @LucasSaintarbor

Opening for review so we can discuss definitions and styling.

[martyav]

For the purposes of dividing up the word on definitions --

@LucasSaintarbor, could you do Managed Clusters through Rancher Enterprise, and @sunilarjun could you take RK-API through Upstream clusters? I tried to do it evenly so that we each have 8 or 9 entries.

If we add more it should be roughly,
Me - Icons, Numbers, Symbols to L
Lucas - M to Rancher E
Sunil - Rancher F to Z

If something is already filled out, feel free to modify and review.

[sunilarjun]

Some definitions are still in progress but wanted to post the list here as it is nearing completion:

Rancher Kubernetes API (RK-API)
Versions: Rancher v2.8 and later

Users can utilize standard API requests with respect to available Rancher resources through the RK-API.

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 referred to as RKE1. RKE2 or RKE Government is a Kubernetes distribution that focuses on security and compliance for U.S. Federal Government entities.

Related Terms: RKE1, the 1.x software line of RKE.


Rancher Prime
Versions: Rancher v2.8 and later

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.

Related terms: Rancher Enterprise

Rancher Server
Versions: All versions

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.

Related terms: Rancher

Registered Cluster

RKE1
RKE1 is a certified Kubernetes distribution and CLI/library which creates and manages a Kubernetes cluster.

Related terms: RKE (Rancher Kubernetes Engine)

RKE2
RKE2 is a fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector.

Related Terms: RKE Government

Roles
Within Rancher, roles determine what actions a user can make within a cluster or project.

UI

Upstream Cluster
An upstream cluster is the local Kubernetes cluster that your Rancher installation is provisioned on.

Users

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.

[martyav]

Since #1305 is merged, #1332 is now open, and we've ported some of the comments from this PR to the parent issue, I'm closing this PR. Closing the PR helps clean up the repo as we have a number of very long-lived PRs currently open.