Skip to content

Commit 7038caa

Browse files
committed
refactor the minimal RBAC requirements description again
1 parent 89358f7 commit 7038caa

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/vendor/replicated-sdk-customizing.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -264,29 +264,29 @@ rules:
264264

265265
### Install the SDK with Custom RBAC
266266

267-
#### Custom RBAC Requirements
268-
269-
The SDK requires the following minimum RBAC permissions:
267+
The SDK requires the following minimum RBAC permissions to start:
270268
* Create Secrets.
271269
* Get and update Secrets named `replicated`, `replicated-instance-report`, `replicated-meta-data`, and `replicated-custom-app-metrics-report`.
272270
* Get the `replicated` deployment.
273271
* Get the `replicaset` and `pods` corresponding to the `replicated` deployment.
274-
* The SDK requires the following minimum RBAC permissions for status informers:
275-
* If you defined custom status informers, then the SDK must have permissions to `list` and `watch` all the types of resources listed in the `replicated.statusInformers` array in your Helm chart `values.yaml` file, as well as the ability to `get` the named resource.
276-
277-
For instance, if you have a single status informer `deployment/myapp`, then the SDK requires permissions to `list` and `watch` all deployments as well as `get` the `myapp` deployment.
278-
* If you did _not_ define custom status informers, then the SDK must have permissions to `get`, `list`, and `watch` the following resources:
279-
* Deployments
280-
* Daemonsets
281-
* Ingresses
282-
* PersistentVolumeClaims
283-
* Statefulsets
284-
* Services
285-
* For any Ingress resources used as status informers, the SDK requires `get` permissions for the Service resources listed in the `backend.Service.Name` field of the Ingress resource.
286-
* For any Daemonset and Statefulset resources used as status informers, the SDK requires `list` permissions for pods in the namespace.
287-
* For any Service resources used as status informers, the SDK requires `get` permissions for Endpoint resources with the same name as the service.
288-
289-
The Replicated Vendor Portal uses status informers to provide application status data. For more information, see [Helm Installations](/vendor/insights-app-status#helm-installations) in _Enabling and Understanding Application Status_.
272+
273+
The SDK requires the following minimum RBAC permissions for status informers:
274+
* If you defined custom status informers, then the SDK must have permissions to `list` and `watch` all the types of resources listed in the `replicated.statusInformers` array in your Helm chart `values.yaml` file, as well as the ability to `get` the named resource.
275+
276+
For instance, if you have a single status informer `deployment/myapp`, then the SDK requires permissions to `list` and `watch` all deployments as well as `get` the `myapp` deployment.
277+
* If you did _not_ define custom status informers, then the SDK must have permissions to `get`, `list`, and `watch` the following resources:
278+
* Deployments
279+
* Daemonsets
280+
* Ingresses
281+
* PersistentVolumeClaims
282+
* Statefulsets
283+
* Services
284+
* If you did _not_ define custom status informers, then the SDK must have permissions to `get`, and `list` all secrets within the namespace in order to discover the Helm Chart secret for your app and determine what resources to monitor.
285+
* For any Ingress resources used as status informers, the SDK requires `get` permissions for the Service resources listed in the `backend.Service.Name` field of the Ingress resource.
286+
* For any Daemonset and Statefulset resources used as status informers, the SDK requires `list` permissions for pods in the namespace.
287+
* For any Service resources used as status informers, the SDK requires `get` permissions for Endpoint resources with the same name as the service.
288+
289+
The Replicated Vendor Portal uses status informers to provide application status data. For more information, see [Helm Installations](/vendor/insights-app-status#helm-installations) in _Enabling and Understanding Application Status_.
290290

291291
#### Custom ServiceAccount
292292

0 commit comments

Comments
 (0)