gatekeeper icon indicating copy to clipboard operation
gatekeeper copied to clipboard

Create documentation aimed at "gatekeeper admins"

Open tsandall opened this issue 6 years ago • 7 comments

We need to explain how people can manage Gatekeeper installations. Some things that come to mind:

  • How do you install and upgrade Gatekeeper (gotchas?)
  • How do you secure Gatekeeper itself?
  • RBAC configuration required to replicate K8s objects into OPA
  • How do you monitor Gatekeeper performance?
  • Debug FAQ for common problems (webhook misconfigured, network issues, logs, etc.)
  • How are webhook certificates provisioned (this is handled by kube-builder but that's an implementation detail from the admin's POV so we should cover it.)

tsandall avatar Feb 26 '19 01:02 tsandall

@tsandall I'd love to work on this, if nobody else has started or expressed an interest here.

marccampbell avatar Mar 14 '19 00:03 marccampbell

@marccampbell that would be great. I was originally planning to work on some the "docs" issues myself but happy to collaborate. I was going to wait until there was something to run before starting to work these.

tsandall avatar Mar 14 '19 14:03 tsandall

We should explicitly document that Gatekeeper will not self-manage per #94.

tsandall avatar Apr 22 '19 15:04 tsandall

I wanted to +1 this specifically wanting to know about how I should diagnose potential performance problems and provide scale numbers as well (i.e. how many X should I expect to run on Y resources/setup).

snuggie12 avatar Dec 10 '20 02:12 snuggie12

can I contribute this doc

brownpanthera avatar Mar 17 '21 10:03 brownpanthera

Happy to have contributions!

I don't think we have any heavy process around docs, just creating/submitting a PR.

@sozercan Do you have any thoughts about a good process here? Do we want to scope the contents we're looking for?

maxsmythe avatar Mar 18 '21 07:03 maxsmythe

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jul 23 '22 08:07 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Oct 11 '22 02:10 stale[bot]