package kubecaml

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

Api_service_spec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

type t
val to_yojson : t -> Yojson.Safe.t
val make : version_priority:int -> ?version:string -> service: Kubernetes.Definitions.Kube_aggregator.Pkg.Apis.Apiregistration.V1beta1.Service_reference.t -> ?insecure_skip_tls_verify:bool -> group_priority_minimum:int -> ?group:string -> ca_bundle:string -> unit -> t
val ca_bundle : t -> string

Ca_bundle is a Pem encoded Ca bundle which will be used to validate an Api server's serving certificate.

val group : t -> string option

Group is the Api group name this server hosts

val group_priority_minimum : t -> int

Group_priority_mininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher Group_priority_mininum values such that the whole group gets a higher priority. The primary sort is based on Group_priority_minimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and Paa_ses (open_shift, Deis) are recommended to be in the 2000s

val insecure_skip_tls_verify : t -> bool option

Insecure_skip_tls_verify disables Tls certificate verification when communicating with this server. This is strongly discouraged. You should use the Ca_bundle instead.

Service is a reference to the service for this Api server. It must communicate on port 443 If the Service is nil, that means the handling for the Api groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.

val version : t -> string option

Version is the Api version this server hosts. For example, "v1"

val version_priority : t -> int

Version_priority controls the ordering of this Api version inside of its group. Must be greater than zero. The primary sort is based on Version_priority, ordered highest to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) Since it's inside of a group, the number can be small, probably in the 10s.

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

Innovation. Community. Security.