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

docs: add known issue for cni folder issue #5596

Merged
merged 8 commits into from
Jan 31, 2025
Merged

docs: add known issue for cni folder issue #5596

merged 8 commits into from
Jan 31, 2025

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Jan 29, 2025

Describe the Change

This PR adds a known issue regarding CNI folder permissions in 4.5

Changed Pages

💻 agent-mode-deployments-cni-folder-permission-issues

Jira Tickets

🎫 Jira Ticket

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

@lennessyy lennessyy marked this pull request as ready for review January 29, 2025 23:41
@lennessyy lennessyy requested a review from a team as a code owner January 29, 2025 23:41
Copy link

netlify bot commented Jan 29, 2025

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit fa4029b
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/679d44e8b9aca1000803dd50
😎 Deploy Preview https://deploy-preview-5596--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/docs-content/troubleshooting/edge.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/edge.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/edge.md Show resolved Hide resolved
docs/docs-content/troubleshooting/edge.md Show resolved Hide resolved
docs/docs-content/troubleshooting/edge.md Show resolved Hide resolved
@lennessyy lennessyy requested a review from rrpolanco January 30, 2025 18:13
Copy link
Contributor

@benradstone benradstone left a comment

Choose a reason for hiding this comment

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

Approved with one suggestion.

Comment on lines 420 to 421
Agent mode clusters that use PKX-E as the Kubernetes layer have the contents of the `/opt/cni/bin` folder set in
correctly. This prevents the CNI from operating.
Copy link
Contributor

Choose a reason for hiding this comment

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

This only affects CNI providers that do not run as root such as Cilium. For example, using Calico CNI does not require this workaround.

@@ -93,68 +93,212 @@ Palette. You will then create a cluster profile and use the registered host to d
:::

- If installing the FIPS version of Agent Mode on a Rocky Linux edge host, you must configure your SELinux policies to
grant rsync the required host permissions. Follow the process below to apply the necessary configurations before
installing Agent Mode.
grant rsync the required host permissions and ensure you enable cgroup V2.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'rsync'?

@@ -93,68 +93,212 @@ Palette. You will then create a cluster profile and use the registered host to d
:::

- If installing the FIPS version of Agent Mode on a Rocky Linux edge host, you must configure your SELinux policies to
grant rsync the required host permissions. Follow the process below to apply the necessary configurations before
installing Agent Mode.
grant rsync the required host permissions and ensure you enable cgroup V2.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'cgroup'?


<br />
If you are using Cilium and have firewalld enabled, you must also configure the appropriate firewalld rules. Follow
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'firewalld'?


<br />
If you are using Cilium and have firewalld enabled, you must also configure the appropriate firewalld rules. Follow
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'firewalld'?


### Configure rsync

1. Enable SELinux to allow full rsync access.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'SELinux'?


### Configure firewalld (Cilium Only)

12. (Optional) If you are using Cilium and have firewalld enabled, put the the following commands into a shell
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'firewalld'?


### Configure firewalld (Cilium Only)

12. (Optional) If you are using Cilium and have firewalld enabled, put the the following commands into a shell
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Repetition] 'the' is repeated!


6. Install the compiled policy module.
13. Execute the script with the name of the firewalld zone. For example, the following script sets the rules in the
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'execute' instead of 'Execute'.


6. Install the compiled policy module.
13. Execute the script with the name of the firewalld zone. For example, the following script sets the rules in the
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'firewalld'?

## Scenario - Agent Mode Deployments CNI Folder Permission Issues

Agent mode clusters that use PKX-E as the Kubernetes layer have the contents of the `/opt/cni/bin` folder set
incorrectly. This prevents the CNI that do not run as root, such as Cilium, from operating.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.

@lennessyy lennessyy enabled auto-merge (squash) January 31, 2025 21:51
@lennessyy lennessyy merged commit 8e024ba into master Jan 31, 2025
14 of 15 checks passed
@lennessyy lennessyy deleted the DOC-1639 branch January 31, 2025 21:57
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