sighupio/gatekeeper-policy-manager

ConstraintTemplates page should show description when available

ralgozino opened this issue 3 years ago · 2 comments

ralgozino commented 3 years ago

ConstraintTemlpates can have an optional metadata.annotations.description field with a nice description of the ConstraintTemplate.

See for example:

https://github.com/open-policy-agent/gatekeeper-library/blob/259ad1bdd8945d6df451d3fc2867109d76b854e2/library/general/containerlimits/template.yaml#L5-L10

If the description exists, GPM should show it in the UI.

ralgozino commented 3 years ago

There's also a description field for the parameters:

https://github.com/open-policy-agent/gatekeeper-library/blob/259ad1bdd8945d6df451d3fc2867109d76b854e2/library/general/containerlimits/template.yaml#L22-L28

ralgozino commented 3 years ago

There's actually a whole metadata annotations now:
https://www.openpolicyagent.org/docs/latest/annotations/