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

[EPIC] Create "Securing Kubernetes and Knative" section for admin guide #4060

Open
julz opened this issue Jul 26, 2021 · 12 comments
Open

[EPIC] Create "Securing Kubernetes and Knative" section for admin guide #4060

julz opened this issue Jul 26, 2021 · 12 comments
Assignees
Labels
Epic Epics to group issues kind/security Issues or PRs related to security or CVEs. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. status/blocked triage/needs-eng-input Engineering input is requested

Comments

@julz
Copy link
Member

julz commented Jul 26, 2021

Describe the change you'd like to see

We should document in the admin guide how to set up Knative and Kubernetes securely (referencing up-stream guides as appropriate).

Topics might include (this is an initial brainstorm, and we should think carefully about which bits belong in our docs vs being better as references to upstream docs):

  • Link to our threat model, to be clear about currently supported/unsupported use cases
  • Link to our vulnerability reporting processes
  • Namespace isolation considerations (e.g. suggested network policy)
  • Protecting shared components
  • Securing pods
    • "Out of the box" protections (e.g. minimal set of allowed volumes, subset of securityContext etc)
    • Description of relevant feature flags
    • Using PodSecurityPolicies and custom runtimes (e.g. Kata, gVisor)
    • Private registries

Additional context
Add any other context or screenshots about the feature request here.

/assign @evankanderson for thoughts
/assign @RichardJJG is there a template we should start from for this?

@RichardJJG
Copy link
Contributor

RichardJJG commented Jul 26, 2021

Ideally all the docs would be made from the Procedure template because

  • when people read docs they mostly just want to be told what to do and how to do it
  • it's easier to write a good Procedure topic than a good Concept topic

The Concept template is necessary where you need to give a lot of context for procedures that would otherwise seem very alien.
Beyond that you have to ask "does the reader really need to know this?" and, if they do,
"how can I deliver this information as instructions for what the reader needs to do with it?"

@RichardJJG RichardJJG added the Epic Epics to group issues label Jul 28, 2021
@julz
Copy link
Member Author

julz commented Sep 7, 2021

/assign

@github-actions
Copy link

github-actions bot commented Dec 7, 2021

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 7, 2021
@github-actions github-actions bot closed this as completed Jan 6, 2022
@snneji
Copy link
Contributor

snneji commented Feb 4, 2022

@julz Do you still want to do this issue?

@snneji snneji reopened this Feb 4, 2022
@github-actions github-actions bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 5, 2022
@julz
Copy link
Member Author

julz commented Feb 13, 2022

Oops, no this isn't on my todo list at the moment, let me free it up for someone else

/unassign

@github-actions
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 15, 2022
@evankanderson
Copy link
Member

/remove-lifecycle stale

@knative-prow knative-prow bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 15, 2022
@abrennan89 abrennan89 added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label May 19, 2022
@abrennan89 abrennan89 added triage/needs-eng-input Engineering input is requested kind/security Issues or PRs related to security or CVEs. priority/high labels May 27, 2022
@evankanderson
Copy link
Member

/accept

@evankanderson
Copy link
Member

Should this doc go in the "Install" section?

@abrennan89
Copy link
Contributor

@evankanderson it would depend on the doc. I think the idea was that this issue needs to be broken up into smaller issues depending on which docs are required.
I don't think the docs WG really have the expertise to define what's required here in terms of doc deliverables. Maybe this issue can move to the security WG and ya'll can come back to us with smaller use cases / user stories and then we can advise on where specific procedures etc might fit into the docs?

@abrennan89 abrennan89 changed the title Create "Securing Kubernetes and Knative" section for admin guide [EPIC] Create "Securing Kubernetes and Knative" section for admin guide Jun 29, 2022
@abrennan89
Copy link
Contributor

Per the above comment, closing this issue as it has been open for over a year with no action.
If there is docs work required from the docs WG, please open smaller issues with details of the required work. Otherwise I think this should be tracked / worked on in the Security WG instead.

@evankanderson
Copy link
Member

Reopening as work for the security WG, not the docs WG.

@evankanderson evankanderson reopened this Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic Epics to group issues kind/security Issues or PRs related to security or CVEs. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. status/blocked triage/needs-eng-input Engineering input is requested
Projects
Status: Ready to Work
Development

No branches or pull requests

5 participants