Role

This declares one namespaced Role to be managed by Inrun.

Example:

onCreate:
  roles:
    - name: "{{ .metadata.name }}-role"
      namespace: "{{ .metadata.name }}-ns"
      rules:
        - apiGroups: ["apps"]
          resources: ["deployments"]
          verbs: ["get", "list", "watch", "update", "patch"]
          resourceNames: ["{{ .metadata.name }}"]

Lifecycle

Declare this resource under onCreate for an idempotent, one-time create: Inrun creates it on the first reconcile and leaves it untouched afterward. Set reconcile: true on the same entry to also apply it as drift correction on every subsequent reconcile. This is a shorthand for declaring the identical entry under onReconcile as well — there’s no need to do both.

Declare a resource under onDelete to run explicit cleanup before the CR’s finalizer is removed. Most resources need no onDelete entry — they are garbage-collected automatically through owner references when the CR itself is deleted.

Fields

name

Type: string

Name — Role name. Default when omitted: “{{ .metadata.name }}-role”

namespace

Type: string

Namespace — target namespace. Default when omitted: “{{ .metadata.namespace }}”

labels

Type: map

Labels — applied to Role metadata. Values support template expressions.

rules

Type: list

Rules — the permissions granted by this Role. Required: at least one rule.

rules:
  - apiGroups: ["apps"]
    resources: ["deployments"]
    verbs: ["get", "list", "watch", "update", "patch"]
    resourceNames: ["{{ .metadata.name }}"]

when

Type: list

When lists conditions that must all pass for this entry to be written; see Condition. When an entry kept in sync (onReconcile, or reconcile: true) stops passing, the object it wrote is removed.

reconcile

Type: boolean

Reconcile: true — also apply this declaration as drift correction on every reconcile. Equivalent to declaring the same entry under both onCreate and onReconcile. When false (default), only runs on onCreate (idempotent create).

forEach

Type: object

ForEach declares dynamic expansion over a list field. When set, one source declaration becomes N declarations — one per list element. .item and .<as> are available in template expressions within this declaration.

forEach:
  field: spec.regions
  as: region

or

Type: list

Or lists conditions of which at least one must pass, alongside When.

forceConflict

Type: boolean

ForceConflict, when true, sets Force: true when applying this resource, taking ownership of conflicting fields instead of returning a conflict error. Overrides the CRD-level ForceConflict setting.

Quick reference