package kubecaml

  1. Overview
  2. Docs
package kubecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Persistent_volume_spec is the specification of a persistent volume.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?vsphere_volume: Kubernetes.Definitions.Api.Core.V1.Vsphere_virtual_disk_volume_source.t -> ?volume_mode:string -> ?storageos: Kubernetes.Definitions.Api.Core.V1.Storage_os_persistent_volume_source.t -> ?storage_class_name:string -> ?scale_io: Kubernetes.Definitions.Api.Core.V1.Scale_io_persistent_volume_source.t -> ?rbd:Kubernetes.Definitions.Api.Core.V1.Rbd_persistent_volume_source.t -> ?quobyte:Kubernetes.Definitions.Api.Core.V1.Quobyte_volume_source.t -> ?portworx_volume:Kubernetes.Definitions.Api.Core.V1.Portworx_volume_source.t -> ?photon_persistent_disk: Kubernetes.Definitions.Api.Core.V1.Photon_persistent_disk_volume_source.t -> ?persistent_volume_reclaim_policy:string -> ?node_affinity:Kubernetes.Definitions.Api.Core.V1.Volume_node_affinity.t -> ?nfs:Kubernetes.Definitions.Api.Core.V1.Nfs_volume_source.t -> ?mount_options:string list -> ?local:Kubernetes.Definitions.Api.Core.V1.Local_volume_source.t -> ?iscsi:Kubernetes.Definitions.Api.Core.V1.Iscsi_persistent_volume_source.t -> ?host_path:Kubernetes.Definitions.Api.Core.V1.Host_path_volume_source.t -> ?glusterfs:Kubernetes.Definitions.Api.Core.V1.Glusterfs_volume_source.t -> ?gce_persistent_disk: Kubernetes.Definitions.Api.Core.V1.Gce_persistent_disk_volume_source.t -> ?flocker:Kubernetes.Definitions.Api.Core.V1.Flocker_volume_source.t -> ?flex_volume: Kubernetes.Definitions.Api.Core.V1.Flex_persistent_volume_source.t -> ?fc:Kubernetes.Definitions.Api.Core.V1.Fc_volume_source.t -> ?csi:Kubernetes.Definitions.Api.Core.V1.Csi_persistent_volume_source.t -> ?claim_ref:Kubernetes.Definitions.Api.Core.V1.Object_reference.t -> ?cinder:Kubernetes.Definitions.Api.Core.V1.Cinder_volume_source.t -> ?cephfs:Kubernetes.Definitions.Api.Core.V1.Ceph_fs_persistent_volume_source.t -> ?capacity: Kubernetes.Definitions.Apimachinery.Pkg.Api.Resource.Quantity.Object.t -> ?azure_file: Kubernetes.Definitions.Api.Core.V1.Azure_file_persistent_volume_source.t -> ?azure_disk:Kubernetes.Definitions.Api.Core.V1.Azure_disk_volume_source.t -> ?aws_elastic_block_store: Kubernetes.Definitions.Api.Core.V1.Aws_elastic_block_store_volume_source.t -> ?access_modes:string list -> unit -> t
val access_modes : t -> string list option

Access_modes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

Aws_elastic_block_store represents an Aws Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Azure_disk represents an Azure Data Disk mount on the host and bind mount to the pod.

Azure_file represents an Azure File Service mount on the host and bind mount to the pod.

A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

Ceph_fs represents a Ceph Fs mount on the host that shares a pod's lifetime

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

Claim_ref is part of a bi_directional binding between Persistent_volume and Persistent_volume_claim. Expected to be non_nil when bound. claim.volume_name is the authoritative bind between Pv and Pvc. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

Csi represents storage that handled by an external Csi driver (beta feature).

Fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Flex_volume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running

Gce_persistent_disk represents a Gce Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

Host_path represents a directory on the host. Provisioned by a developer or tester. This is useful for single_node development and testing only! On_host storage is not supported in any way and Will Not Work in a multi_node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

Iscsi represents an Iscsi Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.

Local represents directly_attached storage with node affinity

val mount_options : t -> string list option

A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

Nfs represents an Nfs mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Node_affinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.

val persistent_volume_reclaim_policy : t -> string option

What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created Persistent_volumes), Delete (default for dynamically provisioned Persistent_volumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this Persistent_volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

Photon_persistent_disk represents a Photon_controller persistent disk attached and mounted on kubelets host machine

Portworx_volume represents a portworx volume attached and mounted on kubelets host machine

Quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md

Scale_io represents a Scale_io persistent volume attached and mounted on Kubernetes nodes.

val storage_class_name : t -> string option

Name of Storage_class to which this persistent volume belongs. Empty value means that this volume does not belong to any Storage_class.

Storage_os represents a Storage_os volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md

val volume_mode : t -> string option

volume_mode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. This is an alpha feature and may change in the future.

Vsphere_volume represents a v_sphere volume attached and mounted on kubelets host machine

module Object : Object.S with type value := t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events Blog Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct