Skip to content

Commit

Permalink
Add deployerServiceAccount docs (#520)
Browse files Browse the repository at this point in the history
* Add deployerServiceAccount docs

* Emphasize 'namespace' in cluster-admin grant line
  • Loading branch information
eshiroma authored Jul 23, 2020
1 parent bad130d commit ea16d50
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -921,6 +921,46 @@ If this section is not specified, users see a warning when deploying the app to
an Istio-enabled environment. The [`ISTIO_ENABLED`](#type-istio_enabled) type
indicates whether Istio is enabled on the cluster.

---

## deployerServiceAccount

Nested under `x-google-marketplace` in schema V2, this can be used for
specifying custom roles for the deployer service account, including
cluster-scoped permissions. The deployer is granted `cluster-admin` in the
deployment **namespace** unless one or more roles with type `Role` are defined.
This property follows the exact same interface as the `x-google-marketplace`
`SERVICE_ACCOUNT` property type.

In accordance with the principle of least privilege, predefined
`cluster-admin`, `admin`, and `edit` are not supported as cluster-scoped
(`type: ClusterRole`) roles; `CUSTOM` roles defining specific rules must be
used instead.

The `description` field (required) should explain why the app needs the
requested permissions, particularly cluster-scoped permissions. It may be
shown to users in the UI.

Example:

```yaml
properties:
# Property definitions...
required:
# Required properties...
x-google-marketplace:
deployerServiceAccount:
description: >
Creates app resources, including the MyAppCustomResource CRD.
roles:
- type: ClusterRole
rulesType: CUSTOM
rules:
- apiGroups: ['apiextensions.k8s.io']
resources: ['customresourcedefinitions']
verbs: ['*']
```

## form

### help widget
Expand Down

0 comments on commit ea16d50

Please sign in to comment.