Cluster permissions documentation generator

This is a very primitive, one-shot, project to convert a file that contains ClusterRole into a markdown table.

Usage

Usage of ./cluster-permissions-doc-generator:
  -in string
        path to a file which contains a ClusterRole rules. Only one ClusterRole is supported.
  -out string
        path to a file were the content should be written

YAML Comments

It supports comments which precede a rule, for example:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: my-role
rules:
# <ul><li>`Namespaces` are watched because...</li>
# <li>`Nodes` are watched because...</li>
# <li>`Endpoints` are watched because...</li></ul>
- apiGroups:
    - ""
  resources:
    - endpoints
    - namespaces
    - nodes
  verbs:
    - get
    - list
    - watch

This would be converted into the following:

<!--- START CLUSTER ROLES DOCUMENTATION --->
| API Groups  | Resources | Non Resource URLs | Resource Names | Verbs | Comment |
| ----------- | --------- | ----- | -------------- | ----------------- | ------- |
||<ul><li>endpoints</li><li>namespaces</li><li>nodes</li></ul>|none|none|<ul><li>get</li><li>list</li><li>watch</li></ul>|<ul><li>`Namespaces` are watched because...</li> <li>`Nodes` are watched because...</li> <li>`Endpoints` are watched because...</li></ul>|
<!--- END CLUSTER ROLES DOCUMENTATION --->

And this would be displayed as:

API Groups	Resources	Non Resource URLs	Resource Names	Verbs	Comment
	endpoints namespaces nodes	none	none	get list watch	Namespaces are watched because... Nodes are watched because... Endpoints are watched because...

If an output file is set using -out then the content is either:

• Added to the end of the file
• Updated between the markers <!--- START CLUSTER ROLES DOCUMENTATION ---> and <!--- END CLUSTER ROLES DOCUMENTATION --->

Limitations

• Template is hardcoded.
• Only one file can be provided.
• File must contain only one cluster role.