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

Doc: Adding initial hardening guide #5881

Merged
merged 2 commits into from
Sep 1, 2020

Conversation

timdeluxe
Copy link
Contributor

What this PR does / why we need it:

ingress-nginx is hardened in several places by default, but it can be done even more secure. This hardening guide looks at best practises documents of CIS benchmarks and a cipherli.st fork and checks what needs to be done of if the ingress-nginx default is already sufficient.
Originally it was discussed here: nginxinc/kubernetes-ingress#887 and so i published it in our own repo, since i was recommended to do so in that issue.
However dodevops/k8s-ingress-nginx-hardening#1 gave me the hint, to add it to this community-driven project and hence this PR.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Which issue/s this PR fixes

How Has This Been Tested?

Tested with make live-docs, but table is still to wide. However i don't know a better format, any recommendations?

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly. (Basically it is an addition to the documentation)
  • I've read the CONTRIBUTION guide
  • I have added tests to cover my changes. (Obsolete due to no code change)
  • All new and existing tests passed. (Obsolete due to no code change)

WIP remark:

I added the flag WIP since there are some points in the hardening guide, where i have no clue (marked with question marks, like "???"). I need help on those points.
Also as already mentioned above, the table format may be improved to something else, but i have no idea what. Any ideas?

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 10, 2020
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 10, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @timdeluxe!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 10, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @timdeluxe. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 10, 2020
@aledbf
Copy link
Member

aledbf commented Jul 10, 2020

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 10, 2020
@aledbf
Copy link
Member

aledbf commented Jul 10, 2020

@timdeluxe please check the CLA bot hint

@timdeluxe
Copy link
Contributor Author

/check-cla

@timdeluxe
Copy link
Contributor Author

@timdeluxe please check the CLA bot hint

I comitted with the wrong email adress (my fault). I hope my amend action helped... If not i might need to do another PR?

@timdeluxe
Copy link
Contributor Author

@timdeluxe please check the CLA bot hint

I comitted with the wrong email adress (my fault). I hope my amend action helped... If not i might need to do another PR?

Hm, looks like i need to redo the whole PR, because my amend action made a new commit and an old one with the wrong email is still included in the PR. Am i correct?

I would work on the given feedbacks here and then push the changes to another PR and close this one here. Would that be the right way @aledbf ?

@aledbf
Copy link
Member

aledbf commented Jul 10, 2020

@timdeluxe please squash the commits. I think that is enough. Or you can close this PR and create a new one with just one commit. Up to you :)

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 10, 2020
@timdeluxe
Copy link
Contributor Author

@timdeluxe please squash the commits. I think that is enough. Or you can close this PR and create a new one with just one commit. Up to you :)

Squashing worked, thanks. Will work on the feedback in the next days...

@aledbf
Copy link
Member

aledbf commented Jul 27, 2020

@timdeluxe friendly ping

@timdeluxe
Copy link
Contributor Author

@aledbf Sorry, i was and am on vacation, will continue to work on this on monday.

@timdeluxe
Copy link
Contributor Author

Please apologize that it took a biiit longer. I now updated all the points you thankfully gave feedback too. That also closes all open lines with question marks.

@timdeluxe timdeluxe changed the title [WIP] Doc: Adding initial hardening guide Doc: Adding initial hardening guide Aug 30, 2020
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 30, 2020
@aledbf
Copy link
Member

aledbf commented Sep 1, 2020

/lgtm
/approve

@aledbf
Copy link
Member

aledbf commented Sep 1, 2020

@timdeluxe thanks!

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, timdeluxe

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 Sep 1, 2020
@k8s-ci-robot k8s-ci-robot merged commit bf4bdff into kubernetes:master Sep 1, 2020
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. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants