Skip to content

Commit 58d5578

Browse files
committed
edits
1 parent 9ce7c4e commit 58d5578

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

docs/vendor/replicated-sdk-customizing.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For information about how to use a custom domain for the Replicated SDK image, s
88

99
This section describes role-based access control (RBAC) for the Replicated SDK, including the default RBAC, minimum RBAC requirements, and how to install the SDK with custom RBAC.
1010

11-
It also describes how to enable the `replicated.minimalRBAC` field to use a less-permissive default RBAC role for the Replicated SDK 1.7.0 and later.
11+
It also describes how to enable the `replicated.minimalRBAC` field to use a less-permissive default RBAC role for the Replicated SDK version 1.7.0 and later.
1212

1313
### Enable `minimalRBAC`
1414

@@ -154,7 +154,7 @@ rules:
154154

155155
#### Default `minimalRBAC` Role With Custom Status Informers {#default-status-informers}
156156

157-
If you defined custom status informers for your application, then the default `minimalRBAC` role includes permissions only for the specific resources that you defined as status informers. These resources are specified by name when possible.
157+
If you defined custom status informers for your application, then the default `minimalRBAC` role is _not_ created with the ability to access all secrets, and other resources are specified by name when possible.
158158

159159
For example, the following custom `statusInformer` configuration defines specific Deployment and Service resources as status informers for the application:
160160

@@ -302,35 +302,36 @@ rules:
302302
- replicated-meta-data
303303
```
304304

305-
### Minimum RBAC Requirements
305+
### Install the SDK with Custom RBAC
306+
307+
This section describes how to install the SDK with custom RBAC permissions, include the minimum RBAC requirements for custom roles. To install with custom RBAC, you can use a custom ServiceAccount or a custom ClusterRole. See the sections below for more information.
308+
309+
#### Minimum RBAC Requirements
306310

307311
This section describes the minimum RBAC permissions required by the Replicated SDK. Any custom RBAC role that you create must include these permissions at minimum.
308312

309-
The SDK requires the following minimum RBAC permissions:
313+
The SDK requires the following minimum RBAC permissions to start:
310314
* Create Secrets.
311315
* Get and update Secrets named `replicated`, `replicated-instance-report`, `replicated-meta-data`, and `replicated-custom-app-metrics-report`.
312316
* Get the `replicated` deployment.
313317
* Get the `replicaset` and `pods` corresponding to the `replicated` deployment.
314-
* The SDK requires the following minimum RBAC permissions for status informers:
315-
* 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.
316-
317-
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.
318-
* If you did _not_ define custom status informers, then the SDK must have permissions to `get`, `list`, and `watch` the following resources:
318+
319+
The SDK requires the following minimum RBAC permissions for status informers:
320+
* 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.
321+
322+
For example, 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.
323+
* If you did _not_ define custom status informers, then the SDK must:
324+
* Have permissions to `get`, and `list` all secrets within the namespace in order to discover the Helm Chart secret for your app.
325+
* Have permissions to `get`, `list`, and `watch` the following resources:
319326
* Deployments
320-
* Daemonsets
327+
* DaemonSets
321328
* Ingresses
322329
* PersistentVolumeClaims
323-
* Statefulsets
324-
* Services
325-
* 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.
326-
* For any Daemonset and Statefulset resources used as status informers, the SDK requires `list` permissions for pods in the namespace.
327-
* For any Service resources used as status informers, the SDK requires `get` permissions for Endpoint resources with the same name as the service.
328-
329-
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_.
330-
331-
### Install the SDK with Custom RBAC
332-
333-
This section describes how to install the SDK with custom RBAC permissions. To install with custom RBAC, you can use a custom ServiceAccount or a custom ClusterRole. See the sections below for more information.
330+
* StatefulSets
331+
* Services
332+
* 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.
333+
* For any DaemonSet and StatefulSet resources used as status informers, the SDK requires `list` permissions for pods in the namespace.
334+
* For any Service resources used as status informers, the SDK requires `get` permissions for Endpoint resources with the same name as the service.
334335

335336
#### Use a Custom ServiceAccount
336337

0 commit comments

Comments
 (0)