Skip to content

Commit 937fb7f

Browse files
authored
Docs: CRDS: shows how to get crds names for config and adds an image (#1971)
* Docs: CRDS: shows how to get crds names for config and adds an image * Docs: Crds - add monitor all in api group example
1 parent f7a22f7 commit 937fb7f

2 files changed

Lines changed: 38 additions & 4 deletions

File tree

docs/images/crd_demo.png

127 KB
Loading

docs/setup-robusta/crds.rst

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ The CRDs monitoring feature enables you to view and manage Custom Resource Defin
1313
* Full YAML manifests
1414
* Detailed resource descriptions
1515

16+
.. image:: /images/crd_demo.png
17+
:width: 800
18+
:align: center
19+
:alt: CRDs monitoring in Robusta UI
20+
1621
Prerequisites
1722
-------------
1823

@@ -21,10 +26,33 @@ To enable CRD monitoring, the Robusta agent needs appropriate permissions to rea
2126
Configuration
2227
-------------
2328

29+
Finding CRD Names and API Groups
30+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
31+
32+
Get the CRD names and API groups to use in the configuration below:
33+
34+
.. code-block:: bash
35+
36+
kubectl get crd \
37+
-o custom-columns=NAME:.spec.names.plural,API_GROUP:.spec.group
38+
39+
This will output something like:
40+
41+
.. code-block:: text
42+
43+
NAME API_GROUP
44+
alertmanagerconfigs monitoring.coreos.com
45+
alertmanagers monitoring.coreos.com
46+
imagejobs eraser.sh
47+
imagelists eraser.sh
48+
nodenetworkconfigs acn.azure.com
49+
overlayextensionconfigs acn.azure.com
50+
...
51+
2452
Basic Configuration
2553
^^^^^^^^^^^^^^^^^^^
2654

27-
Specify read permissions for the CRDs you need to monitor:
55+
Specify read permissions for the CRDs you need to monitor. You can list specific resources or use ``"*"`` to monitor all resources in an API group:
2856

2957
.. code-block:: yaml
3058
@@ -40,11 +68,17 @@ Specify read permissions for the CRDs you need to monitor:
4068
verbs:
4169
- "list"
4270
- "get"
71+
72+
Or to monitor all resources in an API group:
73+
74+
.. code-block:: yaml
75+
76+
runner:
77+
customClusterRoleRules:
4378
- apiGroups:
44-
- "acme.cert-manager.io"
79+
- "cert-manager.io"
4580
resources:
46-
- "challenges"
47-
- "orders"
81+
- "*"
4882
verbs:
4983
- "list"
5084
- "get"

0 commit comments

Comments
 (0)