PersistentVolumeClaim

k8sBlock storage volumek8s-persistent-volume-claim

A Pod's request for storage of a given size and access mode, bound to one PersistentVolume.

Provider
k8s
Category
Data
Also known as
pvc
Properties · 1 set by this component
propertytypevaluesrequiredkind defaultthis component
accessMode · component propertyenumread-write-once | read-only-many | read-write-many | read-write-once-podno—inherited
dynamicProvisioning · component propertyboolean—notrueinherited
encryptionAtRestboolean—no—inherited
expandable · component propertyboolean—nofalseinherited
inUseProtection · component propertyboolean—notrueinherited
iopsinteger—no—inherited
managedboolean—nofalse▸ false
mediaTypeenumssd | hddno—inherited
redundancyenumlocal | zonal | regionalno—inherited
sizeGibinteger—no—inherited
snapshotsboolean—nofalseinherited
volumeMode · component propertyenumfilesystem | blocknofilesysteminherited
Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.
Use it in a design
nodes:
  - { id: "persistent-volume-claim", component: "k8s-persistent-volume-claim" }
Other Block storage volume products · 28
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# Kubernetes PersistentVolumeClaim: a Pod's request for storage of a given size and access mode,
# bound to one PersistentVolume. Per "Persistent Volumes" volumeMode defaults to Filesystem, the
# access mode must be requested explicitly and has no default, omitting storageClassName routes the
# claim to the cluster's default StorageClass for dynamic provisioning while an empty string
# disables it, and storage object in use protection keeps a bound claim from being removed while a
# Pod still uses it. Resizing needs allowVolumeExpansion on the class, which is unset by default.
schemaVersion: "1"
type: "component"
id: "k8s-persistent-volume-claim"
kind: "block-storage"
provider: "k8s"
docs: "https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims"
aliases: ["pvc"]
defaults:
  managed: false
properties:
  volumeMode:
    type: "enum"
    values: ["filesystem", "block"]
    default: "filesystem"
  accessMode:
    type: "enum"
    values: ["read-write-once", "read-only-many", "read-write-many", "read-write-once-pod"]
  dynamicProvisioning:
    type: "boolean"
    default: true
  inUseProtection:
    type: "boolean"
    default: true
  expandable:
    type: "boolean"
    default: false

The same page as markdown, for an agent: /catalogue/components/k8s-persistent-volume-claim.md