knative / docs

User documentation for Knative components.
https://knative.dev/docs/
Other
4.5k stars 1.22k forks source link

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

Open julz opened 3 years ago

julz commented 3 years ago

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):

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 commented 3 years ago

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

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?"

julz commented 3 years ago

/assign

github-actions[bot] commented 2 years ago

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.

snneji commented 2 years ago

@julz Do you still want to do this issue?

julz commented 2 years ago

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

/unassign

github-actions[bot] commented 2 years ago

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.

evankanderson commented 2 years ago

/remove-lifecycle stale

evankanderson commented 2 years ago

/accept

evankanderson commented 2 years ago

Should this doc go in the "Install" section?

abrennan89 commented 2 years ago

@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 commented 2 years ago

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 commented 1 month ago

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