docs icon indicating copy to clipboard operation
docs copied to clipboard

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

Open julz opened this issue 4 years ago • 12 comments
trafficstars

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?

julz avatar Jul 26 '21 13:07 julz

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 avatar Jul 26 '21 14:07 RichardJJG

/assign

julz avatar Sep 07 '21 15:09 julz

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[bot] avatar Dec 07 '21 01:12 github-actions[bot]

@julz Do you still want to do this issue?

snneji avatar Feb 04 '22 13:02 snneji

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

/unassign

julz avatar Feb 13 '22 13:02 julz

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[bot] avatar May 15 '22 01:05 github-actions[bot]

/remove-lifecycle stale

evankanderson avatar May 15 '22 01:05 evankanderson

/accept

evankanderson avatar Jun 23 '22 16:06 evankanderson

Should this doc go in the "Install" section?

evankanderson avatar Jun 23 '22 16:06 evankanderson

@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 avatar Jun 29 '22 20:06 abrennan89

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.

abrennan89 avatar Aug 10 '22 15:08 abrennan89

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

evankanderson avatar Jul 31 '24 12:07 evankanderson