Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Glossary project (M to Rancher E) #1332

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Glossary project (M to Rancher E) #1332

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c3f55ce
Add glossary term templates
LucasSaintarbor Jun 7, 2024
a31dfba
Renive <!-- To Do --> Comments
LucasSaintarbor Jun 7, 2024
f865ff8
Add defintions
LucasSaintarbor Jun 10, 2024
a054afb
Update definitions, versions, synonyms, related terms
LucasSaintarbor Jun 17, 2024
d643deb
Update shared-files/_glossary.md
LucasSaintarbor Jun 28, 2024
079f956
Change Neuvector > NeuVector
LucasSaintarbor Jun 28, 2024
c9862c6
Apply Marty's suggestions from code review
LucasSaintarbor Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 134 additions & 1 deletion shared-files/_glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,17 @@

## M


<dl>
<dt>
Machine Pool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should define what a machine is first.

</dt>
<p>
<b>Versions:</b> Rancher v2.6 and later
</p>
<dd>
A machine pool is a logical grouping of nodes within a Kubernetes cluster, such as an RKE2, K3s, EKS, AKS, or GKE cluster. Each pool can be configured independently, allowing for flexibility in managing different types of workloads and resource requirements. Machine pool configurations include information like Pool Name, Machine Count, and Roles, as well as options like Auto Replace, Drain Before Delete, Kubernetes Node Labels, and Taints.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A machine pool is a logical grouping of nodes within a Kubernetes cluster, such as an RKE2, K3s, EKS, AKS, or GKE cluster. Each pool can be configured independently, allowing for flexibility in managing different types of workloads and resource requirements. Machine pool configurations include information like Pool Name, Machine Count, and Roles, as well as options like Auto Replace, Drain Before Delete, Kubernetes Node Labels, and Taints.
A logical grouping of nodes within a Kubernetes cluster. Each pool can be configured independently, allowing for flexibility in managing different types of workloads and resource requirements. Machine pool configurations include information like Pool Name, Machine Count, and Roles, as well as options like Auto Replace, Drain Before Delete, Kubernetes Node Labels, and Taints.

</dd>
<dt>
Managed cluster
</dt>
Expand All @@ -195,11 +205,95 @@
</p>
</dl>

## N


<dl>
<dt>
Neuvector Prime
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dt>
<p>
<b>Versions:</b> Rancher v2.8 and later
</p>
<dd>
Nuevector Prime is an end-to-end container security platform for containers, pods, and hosts. It offers real-time compliance, visibility, and protection for critical applications and data during runtime. NeuVector provides a firewall, container process/file system monitoring, security auditing with CIS benchmarks, and vulnerability scanning.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<p>
<b>Related terms:</b> <i>Neuvector</i>
</p>
Comment on lines +221 to +223
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we should include Neuvector as a related term. If we do, we should define it as well, or at least link to an official page describing it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on not mentioning a term as related unless we have a definition.

<dt>
Node Template
</dt>
<dd>
A node template is the saved configuration for the parameters to use when provisioning nodes in a specific cloud provider. These nodes can be launched from the UI. Rancher uses Docker Machine to provision these nodes. The available cloud providers to create node templates are based on the active node drivers in Rancher. After you create a node template in Rancher, it's saved so that you can use it again to create node pools. Node templates are bound to your login. After you add a template, you can remove it from your user profile.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
</dl>

## P

<dl>
<dt>
Prime
</dt>
<p>
<b>Versions:</b> Rancher v2.7 and later
</p>
<dd>
Prime represents a new edition of the commercial enterprise offering for Rancher and Nuevector. Rancher Prime and Nuevector Prime are built on the same source code and will, therefore, continue to be 100% open source. Additional value comes from security assurances, extended lifecycles, access to focused architectures, and Kubernetes advisories. These Prime offerings also offer options to get production support for innovative projects and installation assets are hosted on a trusted registry owned and managed by SUSE.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<p>
<b>Related terms:</b> <i>Rancher Enterprise, Rancher Prime, Nuevector Prime</i>
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</p>
<dt>
Project
</dt>
<dd>
A project is a group of namespaces, and it is a concept introduced by Rancher. In terms of hierarchy, clusters contain projects and projects contain namespaces. Namespaces provide a mechanism for isolating groups of resources within a single cluster. Projects allow you to manage multiple namespaces as a group and perform Kubernetes operations in them. You can use projects to support multi-tenancy so that a team can access a project within a cluster without having access to other projects in the same cluster.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<dt>
Project Resource Quotas
</dt>
<dd>
Similar to how namespaces divide cluster resources among multiple users, a project resource quota limits the cluster resources that a project (and its namespaces) can consume.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<p>
<b>Synonyms:</b> <i>Resource quotas</i>
</p>
<dt>
Pod Security Admission (PSA)
</dt>
<p>
<b>Versions:</b> Rancher v2.7.2 and later
</p>
<dd>
Pod Security Admission (PSA) is a built-in Kubernetes controller that enforces the Pod Security Standards (PSS) on pods running in a namespace. PSA places requirements on a pod's security context and other related fields and categorizes pods into three levels based on their security requirements: Privileged, Baseline, and Restricted.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<dt>
Pod Security Admission (PSA) Config Template
</dt>
<p>
<b>Versions:</b> Rancher v2.7.2 and later
</p>
<dd>
If you have administrator privileges, you can customize security restrictions and permissions by creating additional PSA templates, or by editing existing templates. Pod Security admission (PSA) configuration templates are a Rancher custom-defined resource (CRD), available in Rancher v2.7.2 and above. The templates provide pre-defined security configurations that you can apply to a cluster:
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
<ul>
<li>rancher-privileged: The most permissive configuration. It doesn't restrict the behavior of any pods. This allows for known privilege escalations. This policy has no exemptions.</li>
<li>rancher-restricted: A heavily restricted configuration that follows current best practices for hardening pods. You must make namespace-level exemptions for Rancher components.</li>
</ul>
Comment on lines +279 to +282
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<ul>
<li>rancher-privileged: The most permissive configuration. It doesn't restrict the behavior of any pods. This allows for known privilege escalations. This policy has no exemptions.</li>
<li>rancher-restricted: A heavily restricted configuration that follows current best practices for hardening pods. You must make namespace-level exemptions for Rancher components.</li>
</ul>

I feel like we don't need to list the levels here, just for brevity.

</dd>
<dt>
Pod Security Policies (PSP)
</dt>
<dd>
Pod Security Policies (PSPs) are objects that control security-sensitive aspects of the pod specification (such as root privileges). If a pod does not meet the conditions specified in the PSP, Kubernetes will not allow it to start. PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
</dl>

## R

<dl>
<dt>
Rancher
Rancher
</dt>
<dd>
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.
Expand All @@ -216,12 +310,51 @@
<p>
<b>Related terms:</b> <i>K3s, RKE2</i>
</p>
<dt>
Rancher Chart
</dt>
<p>
<b>Versions:</b> Rancher v2.6 and later
</p>
<dd>
Rancher charts differ slightly from Helm charts in their directory structures. They are native Helm charts with two files that enhance user experience: app-readme.md and questions.yaml. Rancher charts add simplified chart descriptions and configuration forms to make application deployment easy, allowing Rancher users to understand how to launch an application without having to read through the entire list of Helm variables.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<dt>
Rancher CLI
</dt>
<dd>
The Rancher CLI (Command Line Interface) is a unified tool that you can use to interact with Rancher. With this tool, you can operate Rancher using a command line rather than the GUI.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<dt>
Rancher Enterprise
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We currently don't use this to refer to the product and we have zero usage in our docs. We should remove it as a term and any references to it as a term.

</dt>
<p>
<b>Versions:</b> Rancher v2.7 and later
</p>
<dd>
Rancher Enterprise, or Rancher Prime, is a new edition of the commercial enterprise offering built on the same source code. Installation assets are hosted on a trusted registry owned and managed by Rancher, with additional value coming from security assurances, extended lifecycles, access to focused architectures, and Kubernetes advisories.
LucasSaintarbor marked this conversation as resolved.
Show resolved Hide resolved
</dd>
<p>
<b>Synonyms:</b> <i>Rancher Prime</i>
</p>
<p>
<b>Related terms:</b> <i>Prime</i>
</p>
<dt>
Rancher Prime
</dt>
<p>
<b>Versions:</b> Rancher v2.7 and later
</p>
<dd>
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.
</dd>
<p>
<b>Synonyms:</b> <i>Rancher Enterprise</i>
</p>
<p>
<b>Related terms:</b> <i>Prime</i>
</p>
<dt>
Rancher server
</dt>
Expand Down