PersistentVolumeClaim

2 min read

This declares one PersistentVolumeClaim to be managed by Inrun.

Example:

onCreate:
  persistentVolumeClaims:
    - name: "{{ .metadata.name }}-data"
      storage: 10Gi
      accessModes: ["ReadWriteOnce"]

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 — PVC name. Required.


namespace

Type: string

Namespace — target namespace. Default: CR namespace.


storageClassName

Type: string

StorageClassName — storage class to use. Empty means cluster default.


accessModes

Type: list

AccessModes — access modes. Default: [“ReadWriteOnce”]. Supports: ReadWriteOnce, ReadOnlyMany, ReadWriteMany, ReadWriteOncePod.


storage

Type: string

Storage — requested storage size (e.g. “10Gi”). Required.


volumeMode

Type: string

VolumeMode — Filesystem or Block. Default: Filesystem.


volumeName

Type: string

VolumeName — bind to a specific PV by name.


labels

Type: map

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


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).


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.


or

Type: list

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


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

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

YAML keyType
namestring
namespacestring
storageClassNamestring
accessModeslist
storagestring
volumeModestring
volumeNamestring
labelsmap
reconcileboolean
whenlist
orlist
forEachobject
forceConflictboolean