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

Moving Windows security info to new page #31851

Merged

Conversation

marosset
Copy link
Contributor

Moving Windows security information to a new page

Part of #31428

/label refactor
/sig windows

@k8s-ci-robot k8s-ci-robot added this to the 1.24 milestone Feb 22, 2022
@k8s-ci-robot k8s-ci-robot added sig/windows Categorizes an issue or PR as relevant to SIG Windows. refactor Indicates a PR with large refactoring changes e.g. removes files or moves content cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 22, 2022
@netlify
Copy link

netlify bot commented Feb 22, 2022

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

🔨 Explore the source changes: 9b68767

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/621815a2b1cba7000808f549

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 22, 2022
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Feb 22, 2022
@marosset marosset mentioned this pull request Feb 22, 2022
31 tasks
@sftim
Copy link
Contributor

sftim commented Feb 22, 2022

/sig security

@k8s-ci-robot k8s-ci-robot added the sig/security Categorizes an issue or PR as relevant to SIG Security. label Feb 22, 2022
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

I've made some suggestions - what do you think @marosset ?

Comment on lines +32 to +55
Privileged containers are [not supported](#compatibility-v1-pod-spec-containers-securitycontext) on Windows.
Instead [HostProcess containers](/docs/tasks/configure-pod-container/create-hostprocess-pod) can be used on Windows to perform many of the tasks performed by privileged containers on Linux.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this belongs elsewhere, perhaps as a note in https://kubernetes.io/docs/concepts/workloads/pods/#privileged-mode-for-containers ?

Maybe at least restate it there.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, this is already stated at https://kubernetes.io/docs/concepts/workloads/pods/#privileged-mode-for-containers

If your cluster has the WindowsHostProcessContainers feature enabled, you can create a Windows HostProcess pod by setting the windowsOptions.hostProcess flag on the security context of the pod spec. All containers in these pods must run as Windows HostProcess containers. HostProcess pods run directly on the host and can also be used to perform administrative tasks as is done with Linux privileged containers.

Should we just remove mention of it here?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's a little bit tidier to use the same or very similar wording in both places; it's also fine to leave them different and then after this merges log a good-first-issue about making the two places match.
(We like to have a nice pool of easily tractable fixes).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this would qualify as an easily tractable fix so I can open that issue and add the help-wanted tag after this merges if that could help new contributors get started making PRs into this repo.

content/en/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
@marosset
Copy link
Contributor Author

/assign @brasmith-ms

@k8s-ci-robot
Copy link
Contributor

@marosset: GitHub didn't allow me to assign the following users: brasmith-ms.

Note that only kubernetes members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @brasmith-ms

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

LGTM from a content and style perspective. There are some nits to if you'd like to.

Once you're happy, please squash commits.

content/en/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
content/en/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
content/en/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
content/en/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
content/en/docs/concepts/security/windows-security.md Outdated Show resolved Hide resolved
@marosset marosset force-pushed the move-windows-security-1.24 branch from bafd73a to 9b68767 Compare February 24, 2022 23:32
@marosset
Copy link
Contributor Author

@sftim I incorporated your feedback and rebased.

- jayunit100
- jsturtevant
- marosset
- perithompson
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: s/perithompson/aravindh

@marosset
Copy link
Contributor Author

marosset commented Mar 3, 2022

@tengqm
Copy link
Contributor

tengqm commented Mar 25, 2022

Let's get the balls rolling. Approving based the feedback/revision history.
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 25, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 62019ad90a1229c7effce34f430ff3dab242e184

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 25, 2022
@k8s-ci-robot k8s-ci-robot merged commit 2bdb3fe into kubernetes:dev-1.24 Mar 25, 2022
@marosset
Copy link
Contributor Author

@tengqm Thanks for merging this.
I discussed these PRs and the parent issue during one of the sig-docs community meetings in March.
The we all discussed was to stage all of the PRs that split up intro-windows-in-kubernetes.md in the dev-1.24 branch but hold them until after the initial dev-1.24->main and then do another merge shortly after.
The intentions here was sig-docs leads weren't sure they would have enough bandwidth to adequately review the Windows PRs due to all the dockershim removal work. @sftim, @nate-double-u, and a few others were there as well.
My apologies for not adding a hold here.
Would you all like me to revert this PR or is it OK to keep in dev-1.24?

I'm OK either way.
I'm going to focus on the rest of the items listed in #31428 after 1.24 code freeze.

@sftim
Copy link
Contributor

sftim commented Mar 25, 2022

At this point a revert won't achieve what we'd want (reduced workload for the release docs team). I guess these are OK to live with, and the changes are beneficial.

@sftim
Copy link
Contributor

sftim commented Mar 25, 2022

From SIG Docs side, we could have added a hold and didn't. Sorry about that.

@tengqm
Copy link
Contributor

tengqm commented Mar 25, 2022

What I had in mind when kicking this in was: 1. a refactoring work is nontrivial, we will need to achieve the goal in a step by step way; 2. the Windows docs are well maintained so far and people are actively improving them, we are supposed to encourage that; 3. having a PR not moving on for 20+ days (as you both mentioned, no WIP sign) worries me, from the review history of this one, I can only see some non-blocking nits.

I'm sorry for not checking the meeting notes for these.

@sftim
Copy link
Contributor

sftim commented Apr 6, 2022

SIG Docs discussed, in a meeting yesterday, that once there are a bunch of PRs that are ready to merge into the main branch, SIG Docs can help get those merged.

In my view, there great part of the effort is lining up PRs that are good to merge, and actually merging them is more restricted (needs an approver's time) but less effort.

We also agreed in that meeting that those involved favor continuing to work towards doing that merge after the v1.24 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. refactor Indicates a PR with large refactoring changes e.g. removes files or moves content sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/security Categorizes an issue or PR as relevant to SIG Security. sig/windows Categorizes an issue or PR as relevant to SIG Windows. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants