Type Members

1.  case class CustomResourceColumnDefinition(name: String, type: String, jsonPath: String, description: Option[String] = None, format: Option[String] = None, priority: Option[Int] = None) extends Product with Serializable

   CustomResourceColumnDefinition specifies a column for server side printing.

   CustomResourceColumnDefinition specifies a column for server side printing.

   name

   name is a human readable name for the column.

   jsonPath

   jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.

   description

   description is a human readable description of this column.

   format

   format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.

   priority

   priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0.

2.  case class CustomResourceConversion(strategy: String, webhook: Option[WebhookConversion] = None) extends Product with Serializable

   CustomResourceConversion describes how to convert different versions of a CR.

   CustomResourceConversion describes how to convert different versions of a CR.

   strategy

   strategy specifies how custom resources are converted between versions. Allowed values are: - None: The converter only change the apiVersion and would not touch any other field in the custom resource. - Webhook: API Server will call to an external webhook to do the conversion. Additional information is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.

   webhook

   webhook describes how to call the conversion webhook. Required when strategy is set to Webhook.

3.  case class CustomResourceDefinition(spec: CustomResourceDefinitionSpec, apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ObjectMeta] = None, status: Option[CustomResourceDefinitionStatus] = None) extends Product with Serializable

   CustomResourceDefinition represents a resource that should be exposed on the API server.

   CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

   spec

   spec describes how the user wants the resources to appear

   apiVersion

   APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

   kind

   Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

   metadata

   Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

   status

   status indicates the actual state of the CustomResourceDefinition

4.  case class CustomResourceDefinitionCondition(type: String, status: String, lastTransitionTime: Option[Time] = None, message: Option[String] = None, reason: Option[String] = None) extends Product with Serializable

   CustomResourceDefinitionCondition contains details for the current condition of this pod.

   CustomResourceDefinitionCondition contains details for the current condition of this pod.

   status

   status is the status of the condition. Can be True, False, Unknown.

   lastTransitionTime

   lastTransitionTime last time the condition transitioned from one status to another.

   message

   message is a human-readable message indicating details about last transition.

   reason

   reason is a unique, one-word, CamelCase reason for the condition's last transition.

5.  case class CustomResourceDefinitionList(items: Seq[CustomResourceDefinition], apiVersion: Option[String] = None, kind: Option[String] = None, metadata: Option[ListMeta] = None) extends Product with Serializable

   CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

   CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

   items

   items list individual CustomResourceDefinition objects

   apiVersion

   APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

   kind

   Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

   metadata

   Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

6.  case class CustomResourceDefinitionNames(plural: String, kind: String, categories: Option[Seq[String]] = None, listKind: Option[String] = None, shortNames: Option[Seq[String]] = None, singular: Option[String] = None) extends Product with Serializable

   CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

   CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

   plural

   plural is the plural name of the resource to serve. The custom resources are served under /apis/<group>/<version>/.../<plural>. Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>). Must be all lowercase.

   kind

   kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.

   categories

   categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.

   listKind

   listKind is the serialized kind of the list for this resource. Defaults to "kindList".

   shortNames

   shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>. It must be all lowercase.

   singular

   singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind

7.  case class CustomResourceDefinitionSpec(group: String, names: CustomResourceDefinitionNames, scope: String, versions: Seq[CustomResourceDefinitionVersion], conversion: Option[CustomResourceConversion] = None, preserveUnknownFields: Option[Boolean] = None) extends Product with Serializable

   CustomResourceDefinitionSpec describes how a user wants their resource to appear

   CustomResourceDefinitionSpec describes how a user wants their resource to appear

   group

   group is the API group of the defined custom resource. The custom resources are served under /apis/<group>/.... Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>).

   names

   names specify the resource and kind names for the custom resource.

   scope

   scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced.

   versions

   versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

   conversion

   conversion defines conversion settings for the CRD.

   preserveUnknownFields

   preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting x-preserve-unknown-fields to true in spec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.

8.  case class CustomResourceDefinitionStatus(acceptedNames: Option[CustomResourceDefinitionNames] = None, conditions: Option[Seq[CustomResourceDefinitionCondition]] = None, storedVersions: Option[Seq[String]] = None) extends Product with Serializable

   CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

   CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

   acceptedNames

   acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.

   conditions

   conditions indicate state for particular aspects of a CustomResourceDefinition

   storedVersions

   storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from spec.versions while they exist in this list.

9.  case class CustomResourceDefinitionVersion(name: String, served: Boolean, storage: Boolean, additionalPrinterColumns: Option[Seq[CustomResourceColumnDefinition]] = None, deprecated: Option[Boolean] = None, deprecationWarning: Option[String] = None, schema: Option[CustomResourceValidation] = None, subresources: Option[CustomResourceSubresources] = None) extends Product with Serializable

   CustomResourceDefinitionVersion describes a version for CRD.

   CustomResourceDefinitionVersion describes a version for CRD.

   name

   name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at /apis/<group>/<version>/... if served is true.

   served

   served is a flag enabling/disabling this version from being served via REST APIs

   storage

   storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.

   additionalPrinterColumns

   additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used.

   deprecated

   deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.

   deprecationWarning

   deprecationWarning overrides the default warning returned to API clients. May only be set when deprecated is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists

   schema

   schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.

   subresources

   subresources specify what subresources this version of the defined custom resource have

10.  case class CustomResourceSubresourceScale(specReplicasPath: String, statusReplicasPath: String, labelSelectorPath: Option[String] = None) extends Product with Serializable

    CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

    CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

    specReplicasPath

    specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale spec.replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .spec. If there is no value under the given path in the custom resource, the /scale subresource will return an error on GET.

    statusReplicasPath

    statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale status.replicas. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. If there is no value under the given path in the custom resource, the status.replicas value in the /scale subresource will default to 0.

    labelSelectorPath

    labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale status.selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status or .spec. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the status.selector value in the /scale subresource will default to the empty string.

11.  case class CustomResourceSubresourceStatus() extends Product with Serializable

    CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources.

    CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the .status JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza

12.  case class CustomResourceSubresources(scale: Option[CustomResourceSubresourceScale] = None, status: Option[CustomResourceSubresourceStatus] = None) extends Product with Serializable

    CustomResourceSubresources defines the status and scale subresources for CustomResources.

    CustomResourceSubresources defines the status and scale subresources for CustomResources.

    scale

    scale indicates the custom resource should serve a /scale subresource that returns an autoscaling/v1 Scale object.

    status

    status indicates the custom resource should serve a /status subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the status stanza of the object. 2. requests to the custom resource /status subresource ignore changes to anything other than the status stanza of the object.

13.  case class CustomResourceValidation(openAPIV3Schema: Option[JSONSchemaProps] = None) extends Product with Serializable

    CustomResourceValidation is a list of validation methods for CustomResources.

    CustomResourceValidation is a list of validation methods for CustomResources.

    openAPIV3Schema

    openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

14.  case class ExternalDocumentation(description: Option[String] = None, url: Option[String] = None) extends Product with Serializable

    ExternalDocumentation allows referencing an external resource for extended documentation.

15.  case class JSONSchemaProps($ref: Option[String] = None, $schema: Option[String] = None, additionalItems: Option[JSONSchemaPropsOrBool] = None, additionalProperties: Option[JSONSchemaPropsOrBool] = None, allOf: Option[Seq[JSONSchemaProps]] = None, anyOf: Option[Seq[JSONSchemaProps]] = None, default: Option[JSON] = None, definitions: Option[Map[String, JSONSchemaProps]] = None, dependencies: Option[Map[String, JSONSchemaPropsOrStringArray]] = None, description: Option[String] = None, enum: Option[Seq[JSON]] = None, example: Option[JSON] = None, exclusiveMaximum: Option[Boolean] = None, exclusiveMinimum: Option[Boolean] = None, externalDocs: Option[ExternalDocumentation] = None, format: Option[String] = None, id: Option[String] = None, items: Option[JSONSchemaPropsOrArray] = None, maxItems: Option[Long] = None, maxLength: Option[Long] = None, maxProperties: Option[Long] = None, maximum: Option[Double] = None, minItems: Option[Long] = None, minLength: Option[Long] = None, minProperties: Option[Long] = None, minimum: Option[Double] = None, multipleOf: Option[Double] = None, not: Option[JSONSchemaProps] = None, nullable: Option[Boolean] = None, oneOf: Option[Seq[JSONSchemaProps]] = None, pattern: Option[String] = None, patternProperties: Option[Map[String, JSONSchemaProps]] = None, properties: Option[Map[String, JSONSchemaProps]] = None, required: Option[Seq[String]] = None, title: Option[String] = None, type: Option[String] = None, uniqueItems: Option[Boolean] = None, x-kubernetes-embedded-resource: Option[Boolean] = None, x-kubernetes-int-or-string: Option[Boolean] = None, x-kubernetes-list-map-keys: Option[Seq[String]] = None, x-kubernetes-list-type: Option[String] = None, x-kubernetes-map-type: Option[String] = None, x-kubernetes-preserve-unknown-fields: Option[Boolean] = None, x-kubernetes-validations: Option[Seq[ValidationRule]] = None) extends Product with Serializable

    JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

    JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

    default

    default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.

    format

    format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:

    • bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
    • ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR
    • mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$
    • uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$
    • uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
    • uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$
    • isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041"
    • isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^{(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex} \d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
    • rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339.

16.  case class ServiceReference(namespace: String, name: String, path: Option[String] = None, port: Option[Int] = None) extends Product with Serializable

    ServiceReference holds a reference to Service.legacy.k8s.io

    ServiceReference holds a reference to Service.legacy.k8s.io

    namespace

    namespace is the namespace of the service. Required

    name

    name is the name of the service. Required

    path

    path is an optional URL path at which the webhook will be contacted.

    port

    port is an optional service port at which the webhook will be contacted. port should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility.

17.  case class ValidationRule(rule: String, message: Option[String] = None) extends Product with Serializable

    ValidationRule describes a validation rule written in the CEL expression language.

    ValidationRule describes a validation rule written in the CEL expression language.

    rule

    Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The self variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"} If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via self.field and field presence can be checked via has(self.field). Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via self[mapKey], map containment can be checked via mapKey in self and all entries of the map are accessible via CEL macros and functions such as self.all(...). If the Rule is scoped to an array, the elements of the array are accessible via self[i] and also by macros and functions. If the Rule is scoped to a scalar, self is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"} The apiVersion, kind, metadata.name and metadata.generateName are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible. Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields.

    • Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
    • A schema with no type and x-kubernetes-preserve-unknown-fields set to true
    • An array where the items schema is of an "unknown type"
    • An object where the additionalProperties schema is of an "unknown type" Only property names of the form [a-zA-Z_.-/][a-zA-Z0-9_.-/]* are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '' escapes to 'underscores'
    • '.' escapes to 'dot' - '-' escapes to 'dash' - '/' escapes to 'slash' - Property names that exactly match a CEL RESERVED keyword escape to '{keyword}'. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples:
    • Rule accessing a property named "namespace": {"rule": "self.namespace > 0"}
    • Rule accessing a property named "x-prop": {"rule": "self.xdashprop > 0"}
    • Rule accessing a property named "redactd": {"rule": "self.redactunderscoresd > 0"} Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
    • 'set': X + Y performs a union where the array positions of all elements in X are preserved and non-intersecting elements in Y are appended, retaining their partial order.
    • 'map': X + Y performs a merge where the array positions of all keys in X are preserved but the values are overwritten by values in Y when the key sets of X and Y intersect. Elements in Y with non-intersecting keys are appended, retaining their partial order.

    message

    Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"

18.  case class WebhookClientConfig(caBundle: Option[String] = None, service: Option[ServiceReference] = None, url: Option[String] = None) extends Product with Serializable

    WebhookClientConfig contains the information to make a TLS connection with the webhook.

    WebhookClientConfig contains the information to make a TLS connection with the webhook.

    caBundle

    caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used.

    service

    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.

    url

    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.

19.  case class WebhookConversion(conversionReviewVersions: Seq[String], clientConfig: Option[WebhookClientConfig] = None) extends Product with Serializable

    WebhookConversion describes how to call a conversion webhook

    WebhookConversion describes how to call a conversion webhook

    conversionReviewVersions

    conversionReviewVersions is an ordered list of preferred ConversionReview versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail.

    clientConfig

    clientConfig is the instructions for how to call the webhook if strategy is Webhook.