package kubecaml

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

Rule is a tuple of Api_groups, Api_version, and Resources.it is recommended to make sure that all the tuple expansions are valid.

type t
val to_yojson : t -> Yojson.Safe.t
val of_yojson : Yojson.Safe.t -> t Ppx_deriving_yojson_runtime.error_or
val make : ?resources:string list -> ?api_versions:string list -> ?api_groups:string list -> unit -> t
val api_groups : t -> string list option

Api_groups is the Api groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required.

val api_versions : t -> string list option

Api_versions is the Api versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required.

val resources : t -> string list option

Resources is a list of resources this rule applies to.

for example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*/scale' means all scale subresources. '*/*' means all resources and their subresources.

if wildcard is present, the validation rule will ensure resources do not overlap with each other.

depending on the enclosing object, subresources might not be allowed. Required.

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