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

Document addition of namespace labels for pods needing elevated privileges #1706

Merged
merged 23 commits into from
Oct 26, 2023

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Oct 24, 2023

Describe the Change

This PR adds the steps to change Pod Security Standards by applying labels to namespaces if users encounter problems during deployment of cluster profiles with Packs that require elevated privileges.

Review Changes

💻 Preview

🎫 PAC-828

@netlify
Copy link

netlify bot commented Oct 24, 2023

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit c12dc4b
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/653a8117dd20ed0008209133
😎 Deploy Preview https://deploy-preview-1706--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.

@lennessyy lennessyy changed the title Namespace elevated priviledges Document addition of namespace labels for pods needing elevated privileges Oct 24, 2023
lennessyy and others added 3 commits October 24, 2023 16:43
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
lennessyy and others added 6 commits October 25, 2023 10:48
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
@lennessyy lennessyy marked this pull request as ready for review October 25, 2023 18:08
@lennessyy lennessyy requested a review from a team as a code owner October 25, 2023 18:08
Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

Lenny, this PR is looking great. It would be good to add one more example where suggested and we need to fix a link so it uses the relative path.

docs/docs-content/troubleshooting/cluster-deployment.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/cluster-deployment.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/cluster-deployment.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/cluster-deployment.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/cluster-deployment.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/cluster-deployment.md Outdated Show resolved Hide resolved
docs/docs-content/troubleshooting/cluster-deployment.md Outdated Show resolved Hide resolved
@ritawatson
Copy link
Contributor

Great use of a tip. :)

lennessyy and others added 3 commits October 25, 2023 15:11
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
@lennessyy lennessyy requested a review from ritawatson October 25, 2023 22:48
@karl-cardenas-coding
Copy link
Contributor

@lennessyy Check your content for ableism. I saw the term "running", you can replace this with non-ableism terms, such as "active"

Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

This PR looks great. In the Examples section, I suggest using 'you' instead of 'we'. 'We' is used to refer to Spectro Cloud.
The 4.1 backport label also needs to be added.

@lennessyy
Copy link
Contributor Author

lennessyy commented Oct 25, 2023

@karl-cardenas-coding I just checked - there are two instances of the word "running" in this page, and they both are from a section not touched by this PR. I was going to correct those following your comment, but those instances refer to the pods in "running" stage. I wonder if this is the literal word that is used in kubectl when someone uses "kubectl get pods", and it might be confusing if we changed it to something else.

@karl-cardenas-coding
Copy link
Contributor

In that case, you can leave them. I skimmed so I missed the context. But yes, that is a correct context and usage of referring to the k8s term.

@lennessyy lennessyy added the backport-version-4-1 Backport change to version 4.1 label Oct 25, 2023
Copy link

@vishwanaths vishwanaths left a comment

Choose a reason for hiding this comment

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

Do you want to explicitly state that k8s version needs to be in format major.minor version? if they add more, thats likely to fail.
like v1.25, v1.26, v1.27 and so on?

@lennessyy lennessyy merged commit d621475 into master Oct 26, 2023
7 checks passed
@lennessyy lennessyy deleted the namespace-elevated-priviledges branch October 26, 2023 17:29
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Oct 26, 2023
…elevated privileges (#1706)

* PAC-828 Document addition of namespace labels for pods needing elevated privileges

* fix formatting

* clarify cluster profile

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Style guide edits

* Add clarification for multiple namespaces

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Incorporate feedback

* Incorporate feedback

* vale comments

* change step numbers

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Add second example

* vale comments

* second person voice

* Explicitly call out how to provide versions

---------

Co-authored-by: Lenny Chen <lennychen@Waterdeep.local>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit d621475)
@vault-token-factory-spectrocloud
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
version-4-1

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

lennessyy added a commit that referenced this pull request Oct 26, 2023
…elevated privileges (#1706) (#1713)

* PAC-828 Document addition of namespace labels for pods needing elevated privileges

* fix formatting

* clarify cluster profile

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Style guide edits

* Add clarification for multiple namespaces

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Incorporate feedback

* Incorporate feedback

* vale comments

* change step numbers

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Update docs/docs-content/troubleshooting/cluster-deployment.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Add second example

* vale comments

* second person voice

* Explicitly call out how to provide versions

---------

Co-authored-by: Lenny Chen <lennychen@Waterdeep.local>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
(cherry picked from commit d621475)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-1 Backport change to version 4.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants