package kubecaml

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

Object_meta is metadata that all persisted resources must have, which includes all objects users must create.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?uid:string -> ?self_link:string -> ?resource_version:string -> ?owner_references: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Owner_reference.t list -> ?namespace:string -> ?name:string -> ?labels:Object.Of_strings.t -> ?initializers: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Initializers.t -> ?generation:int -> ?generate_name:string -> ?finalizers:string list -> ?deletion_timestamp: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Time.t -> ?deletion_grace_period_seconds:int -> ?creation_timestamp: Kubernetes.Definitions.Apimachinery.Pkg.Apis.Meta.V1.Time.t -> ?cluster_name:string -> ?annotations:Object.Of_strings.t -> unit -> t
val annotations : t -> Object.Of_strings.t option

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

val cluster_name : t -> string option

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

Creation_timestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens_before order across separate operations. Clients may not set this value. It is represented in Rfc3339 form and is in Utc.

populated by the system. Read_only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

val deletion_grace_period_seconds : t -> int option

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletion_timestamp is also set. May only be shortened. Read_only.

Deletion_timestamp is Rfc 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletion_timestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (sigkill) to the container and after cleanup, remove the pod from the Api. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

populated by the system when a graceful deletion is requested. Read_only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

val finalizers : t -> string list option

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletion_timestamp of the object is non_nil, entries in this list can only be removed.

val generate_name : t -> string option

Generate_name is an optional prefix, used by the server, to generate a unique name Only If the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

if this field is specified and the generated name exists, the server will Not return a 409 - instead, it will either return 201 Created or 500 with Reason Server_timeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry_after header).

applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

val generation : t -> int option

A sequence number representing a specific generation of the desired state. Populated by the system. Read_only.

An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.

when an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.

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

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

val name : t -> string option

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

val namespace : t -> string option

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

must be a Dns_label. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

List of objects depended by this object. If All objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

val resource_version : t -> string option

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

populated by the system. Read_only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

Self_link is a Url representing this object. Populated by the system. Read_only.

val uid : t -> string option

Uid is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on Put operations.

populated by the system. Read_only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

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