package kubecaml

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

Represents storage that is managed by an external Csi volume driver (beta feature)

type t
val to_yojson : t -> Yojson.Safe.t
val make : volume_handle:string -> ?volume_attributes:Object.Of_strings.t -> ?read_only:bool -> ?node_stage_secret_ref:Kubernetes.Definitions.Api.Core.V1.Secret_reference.t -> ?node_publish_secret_ref: Kubernetes.Definitions.Api.Core.V1.Secret_reference.t -> ?fs_type:string -> driver:string -> ?controller_publish_secret_ref: Kubernetes.Definitions.Api.Core.V1.Secret_reference.t -> unit -> t
val controller_publish_secret_ref : t -> Kubernetes.Definitions.Api.Core.V1.Secret_reference.t option

Controller_publish_secret_ref is a reference to the secret object containing sensitive information to pass to the Csi driver to complete the Csi Controller_publish_volume and Controller_unpublish_volume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

val driver : t -> string

Driver is the name of the driver to use for this volume. Required.

val fs_type : t -> string option

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

val node_publish_secret_ref : t -> Kubernetes.Definitions.Api.Core.V1.Secret_reference.t option

Node_publish_secret_ref is a reference to the secret object containing sensitive information to pass to the Csi driver to complete the Csi Node_publish_volume and Node_unpublish_volume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

val node_stage_secret_ref : t -> Kubernetes.Definitions.Api.Core.V1.Secret_reference.t option

Node_stage_secret_ref is a reference to the secret object containing sensitive information to pass to the Csi driver to complete the Csi Node_stage_volume and Node_stage_volume and Node_unstage_volume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

val read_only : t -> bool option

Optional: The value to pass to Controller_publish_volume_request. Defaults to false (read/write).

val volume_attributes : t -> Object.Of_strings.t option

Attributes of the volume to publish.

val volume_handle : t -> string

Volume_handle is the unique volume name returned by the Csi volume plugin’s Create_volume to refer to the volume on all subsequent calls. Required.

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