package kubecaml

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

Represents a Storage_os persistent volume resource.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?volume_namespace:string -> ?volume_name:string -> ?secret_ref:Kubernetes.Definitions.Api.Core.V1.Object_reference.t -> ?read_only:bool -> ?fs_type:string -> unit -> t
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 read_only : t -> bool option

Defaults to false (read/write). Read_only here will force the Read_only setting in Volume_mounts.

Secret_ref specifies the secret to use for obtaining the Storage_os Api credentials. If not specified, default values will be attempted.

val volume_name : t -> string option

Volume_name is the human_readable name of the Storage_os volume. Volume names are only unique within a namespace.

val volume_namespace : t -> string option

Volume_namespace specifies the scope of the volume within Storage_os. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within Storage_os for tighter integration. Set Volume_name to any name to override the default behaviour. Set to "default" if you are not using namespaces within Storage_os. Namespaces that do not pre_exist within Storage_os will be created.

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