Skip to content

Commit

Permalink
Add provided ServiceAccount documentation to drafts
Browse files Browse the repository at this point in the history
Signed-off-by: Tayler Geiger <[email protected]>
  • Loading branch information
trgeiger committed Sep 9, 2024
1 parent c4470cc commit 9c10a83
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/drafts/provided-serviceaccount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Provided ServiceAccount for ClusterExtension Installation and Management

While OLMv0 provides many mechanisms for permission configuration via OperatorGroups,
or by manipulating CatalogSources, cluster administrators must be aware of these options
and actually implement them. If no ServiceAccount is explicitly specified for installing
and upgrading operators, then cluster-admin is used by default. This can pose security risks
by providing more permissions than are actually required for the management of any specific bundle.

Adhering to OLM v1's "Secure by Default" tenet, OLM v1 does not have the permissions necessary to install content. This follows the least privilege principle and reduces the chance of a [confused deputy attack](https://en.wikipedia.org/wiki/Confused_deputy_problem). Instead, a ServiceAccount must be provided by users to install and manage content.

The ServiceAccount is specified in the ClusterExtension manifest as follows:

```yaml
apiVersion: olm.operatorframework.io/v1alpha1
kind: ClusterExtension
metadata:
name: argocd
spec:
source:
sourceType: Catalog
catalog:
packageName: argocd-operator
version: 0.6.0
install:
namespace: argocd
serviceAccount:
name: argocd-installer
```
If no ServiceAccount is provided in the ClusterExtension manifest, then the manifest will be rejected.
Installation will also fail if the ServiceAccount does not have the necessary permissions to install a bundle.
//TODO: Add link to documentation on determining least privileges required for the ServiceAccount

0 comments on commit 9c10a83

Please sign in to comment.