package kubecaml

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

Webhook_client_config contains the information to make a Tls connection with the webhook

type t
val to_yojson : t -> Yojson.Safe.t
val of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_or
val make : ?url:string -> ?service: Kubernetes.Definitions.Api.Admissionregistration.V1beta1.Service_reference.t -> ca_bundle:string -> unit -> t
val ca_bundle : t -> string

`ca_bundle` is a Pem encoded Ca bundle which will be used to validate the webhook's server certificate. Required.

`service` is a reference to the service for this webhook. Either `service` or `url` must be specified.

if the webhook is running within the cluster, then you should use `service`.

if there is only one port open for the service, that port will be used. If there are multiple ports open, port 443 will be used if it is open, otherwise it is an error.

val url : t -> string option

`url` gives the location of the webhook, in standard Url form (`[scheme://]host:port/path`). Exactly one of `url` or `service` must be specified.

the `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external Dns in some apiservers (e.g., `kube_apiserver` cannot resolve in_cluster Dns as that would be a layering violation). `host` may also be an Ip address.

please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non_portable, i.e., not easy to turn up in a new cluster.

the scheme must be "https"; the Url must begin with "https://".

a path is optional, and if present may be any string permissible in a Url. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier.

attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.

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 OCaml Planet 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