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.

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

Glossary project (M to Rancher E) #1332

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

Conversation

LucasSaintarbor
Copy link
Contributor

Description

Define terms (M to Rancher E) listed in #358

  • Machine pool
  • Neuvector Prime
  • Node template
  • Prime
  • Project
  • Project resource quotas
  • PSA
  • PSA Config Template
  • PSP
  • Rancher chart
  • Rancher CLI
  • Rancher Enterprise

Comments

@martyav martyav mentioned this pull request Jun 10, 2024
46 tasks
@martyav
Copy link
Contributor

martyav commented Jun 10, 2024

I just closed #358 Glossary project #1125 but the info you might want there is now in the comments of the parent issue, Add a glossary of Rancher-specific terms

@LucasSaintarbor LucasSaintarbor marked this pull request as ready for review June 18, 2024 17:11
shared-files/_glossary.md Outdated Show resolved Hide resolved
Comment on lines +221 to +223
<p>
<b>Related terms:</b> <i>Neuvector</i>
</p>
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.

shared-files/_glossary.md Outdated Show resolved Hide resolved
shared-files/_glossary.md Outdated Show resolved Hide resolved
shared-files/_glossary.md Outdated Show resolved Hide resolved
Comment on lines +279 to +282
<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>
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.

shared-files/_glossary.md Outdated Show resolved Hide resolved
shared-files/_glossary.md Outdated Show resolved Hide resolved
shared-files/_glossary.md Outdated Show resolved Hide resolved
shared-files/_glossary.md Outdated Show resolved Hide resolved
<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.

shared-files/_glossary.md Outdated Show resolved Hide resolved
Comment on lines +221 to +223
<p>
<b>Related terms:</b> <i>Neuvector</i>
</p>
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.

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

LucasSaintarbor and others added 3 commits June 28, 2024 11:03
Co-authored-by: Marty Hernandez Avedon <[email protected]>
Co-authored-by: Marty Hernandez Avedon <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants