Skip to content

apiextensions_v1

CustomResourceColumnDefinition

class lightkube.models.apiextensions_v1.CustomResourceColumnDefinition(jsonPath, name, type, description=None, format=None, priority=None)

CustomResourceColumnDefinition specifies a column for server side printing.

parameters

  • jsonPath str - 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.
  • name str - name is a human readable name for the column.
  • type str - type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.
  • description str - (optional) description is a human readable description of this column.
  • format str - (optional) 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 int - (optional) 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.

CustomResourceConversion

class lightkube.models.apiextensions_v1.CustomResourceConversion(strategy, webhook=None)

CustomResourceConversion describes how to convert different versions of a CR.

parameters

  • strategy str - 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 WebhookConversion - (optional) webhook describes how to call the conversion webhook. Required when strategy is set to Webhook.

CustomResourceDefinition

class lightkube.models.apiextensions_v1.CustomResourceDefinition(spec, apiVersion=None, kind=None, metadata=None, status=None)

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

parameters

  • spec CustomResourceDefinitionSpec - spec describes how the user wants the resources to appear
  • apiVersion str - (optional) 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
  • kind str - (optional) 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
  • metadata meta_v1.ObjectMeta - (optional)
  • status CustomResourceDefinitionStatus - (optional) status indicates the actual state of the CustomResourceDefinition

CustomResourceDefinitionCondition

class lightkube.models.apiextensions_v1.CustomResourceDefinitionCondition(status, type, lastTransitionTime=None, message=None, reason=None)

CustomResourceDefinitionCondition contains details for the current condition of this pod.

parameters

  • status str - status is the status of the condition. Can be True, False, Unknown.
  • type str - type is the type of the condition. Types include Established, NamesAccepted and Terminating.
  • lastTransitionTime meta_v1.Time - (optional) lastTransitionTime last time the condition transitioned from one status to another.
  • message str - (optional) message is a human-readable message indicating details about last transition.
  • reason str - (optional) reason is a unique, one-word, CamelCase reason for the condition's last transition.

CustomResourceDefinitionList

class lightkube.models.apiextensions_v1.CustomResourceDefinitionList(items, apiVersion=None, kind=None, metadata=None)

CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

parameters

  • items CustomResourceDefinition - items list individual CustomResourceDefinition objects
  • apiVersion str - (optional) 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
  • kind str - (optional) 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
  • metadata meta_v1.ListMeta - (optional)

CustomResourceDefinitionNames

class lightkube.models.apiextensions_v1.CustomResourceDefinitionNames(kind, plural, categories=None, listKind=None, shortNames=None, singular=None)

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

parameters

  • kind str - 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.
  • plural str - 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.
  • categories List[str] - (optional) 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 str - (optional) listKind is the serialized kind of the list for this resource. Defaults to "kindList".
  • shortNames List[str] - (optional) 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 str - (optional) singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

CustomResourceDefinitionSpec

class lightkube.models.apiextensions_v1.CustomResourceDefinitionSpec(group, names, scope, versions, conversion=None, preserveUnknownFields=None)

CustomResourceDefinitionSpec describes how a user wants their resource to appear

parameters

  • group str - 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 CustomResourceDefinitionNames - names specify the resource and kind names for the custom resource.
  • scope str - scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced.
  • versions CustomResourceDefinitionVersion - 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 CustomResourceConversion - (optional) conversion defines conversion settings for the CRD.
  • preserveUnknownFields bool - (optional) 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.

CustomResourceDefinitionStatus

class lightkube.models.apiextensions_v1.CustomResourceDefinitionStatus(acceptedNames=None, conditions=None, storedVersions=None)

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

parameters

  • acceptedNames CustomResourceDefinitionNames - (optional) acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec.
  • conditions CustomResourceDefinitionCondition - (optional) conditions indicate state for particular aspects of a CustomResourceDefinition
  • storedVersions List[str] - (optional) 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.

CustomResourceDefinitionVersion

class lightkube.models.apiextensions_v1.CustomResourceDefinitionVersion(name, served, storage, additionalPrinterColumns=None, deprecated=None, deprecationWarning=None, schema=None, subresources=None)

CustomResourceDefinitionVersion describes a version for CRD.

parameters

  • name str - 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 bool - served is a flag enabling/disabling this version from being served via REST APIs
  • storage bool - storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
  • additionalPrinterColumns CustomResourceColumnDefinition - (optional) 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 bool - (optional) 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 str - (optional) 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 CustomResourceValidation - (optional) schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.
  • subresources CustomResourceSubresources - (optional) subresources specify what subresources this version of the defined custom resource have.

CustomResourceSubresourceScale

class lightkube.models.apiextensions_v1.CustomResourceSubresourceScale(specReplicasPath, statusReplicasPath, labelSelectorPath=None)

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

parameters

  • specReplicasPath str - 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 str - 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 str - (optional) 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 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.

CustomResourceSubresourceStatus

CustomResourceSubresources

class lightkube.models.apiextensions_v1.CustomResourceSubresources(scale=None, status=None)

CustomResourceSubresources defines the status and scale subresources for CustomResources.

parameters

  • scale CustomResourceSubresourceScale - (optional) scale indicates the custom resource should serve a /scale subresource that returns an autoscaling/v1 Scale object.
  • status CustomResourceSubresourceStatus - (optional) 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.

CustomResourceValidation

class lightkube.models.apiextensions_v1.CustomResourceValidation(openAPIV3Schema=None)

CustomResourceValidation is a list of validation methods for CustomResources.

parameters

  • openAPIV3Schema JSONSchemaProps - (optional) openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

ExternalDocumentation

class lightkube.models.apiextensions_v1.ExternalDocumentation(description=None, url=None)

ExternalDocumentation allows referencing an external resource for extended documentation.

parameters

  • description str - (optional)
  • url str - (optional)

JSON

JSONSchemaProps

class lightkube.models.apiextensions_v1.JSONSchemaProps(d_ref=None, d_schema=None, additionalItems=None, additionalProperties=None, allOf=None, anyOf=None, default=None, definitions=None, dependencies=None, description=None, enum=None, example=None, exclusiveMaximum=None, exclusiveMinimum=None, externalDocs=None, format=None, id=None, items=None, maxItems=None, maxLength=None, maxProperties=None, maximum=None, minItems=None, minLength=None, minProperties=None, minimum=None, multipleOf=None, not_=None, nullable=None, oneOf=None, pattern=None, patternProperties=None, properties=None, required=None, title=None, type=None, uniqueItems=None, x_kubernetes_embedded_resource=None, x_kubernetes_int_or_string=None, x_kubernetes_list_map_keys=None, x_kubernetes_list_type=None, x_kubernetes_map_type=None, x_kubernetes_preserve_unknown_fields=None)

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

parameters

  • d_ref str - (optional)
  • d_schema str - (optional)
  • additionalItems JSONSchemaPropsOrBool - (optional)
  • additionalProperties JSONSchemaPropsOrBool - (optional)
  • allOf JSONSchemaProps - (optional)
  • anyOf JSONSchemaProps - (optional)
  • default JSON - (optional) 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.
  • definitions dict - (optional)
  • dependencies dict - (optional)
  • description str - (optional)
  • enum JSON - (optional)
  • example JSON - (optional)
  • exclusiveMaximum bool - (optional)
  • exclusiveMinimum bool - (optional)
  • externalDocs ExternalDocumentation - (optional)
  • format str - (optional) 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.
  • id str - (optional)
  • items JSONSchemaPropsOrArray - (optional)
  • maxItems int - (optional)
  • maxLength int - (optional)
  • maxProperties int - (optional)
  • maximum float - (optional)
  • minItems int - (optional)
  • minLength int - (optional)
  • minProperties int - (optional)
  • minimum float - (optional)
  • multipleOf float - (optional)
  • not_ JSONSchemaProps - (optional)
  • nullable bool - (optional)
  • oneOf JSONSchemaProps - (optional)
  • pattern str - (optional)
  • patternProperties dict - (optional)
  • properties dict - (optional)
  • required List[str] - (optional)
  • title str - (optional)
  • type str - (optional)
  • uniqueItems bool - (optional)
  • x_kubernetes_embedded_resource bool - (optional) x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata).
  • x_kubernetes_int_or_string bool - (optional) x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf:
    • type: integer
    • type: string 2) allOf:
    • anyOf:
    • type: integer
    • type: string
    • ... zero or more
  • x_kubernetes_list_map_keys List[str] - (optional) x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type map by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items.
  • x_kubernetes_list_type str - (optional) x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) atomic: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) set: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type atomic or an array with x-kubernetes-list-type atomic. 3) map: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays.
  • x_kubernetes_map_type str - (optional) x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) granular: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) atomic: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated.
  • x_kubernetes_preserve_unknown_fields bool - (optional) x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden.

JSONSchemaPropsOrArray

JSONSchemaPropsOrBool

JSONSchemaPropsOrStringArray

ServiceReference

class lightkube.models.apiextensions_v1.ServiceReference(name, namespace, path=None, port=None)

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

parameters

  • name str - name is the name of the service. Required
  • namespace str - namespace is the namespace of the service. Required
  • path str - (optional) path is an optional URL path at which the webhook will be contacted.
  • port int - (optional) 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.

WebhookClientConfig

class lightkube.models.apiextensions_v1.WebhookClientConfig(caBundle=None, service=None, url=None)

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

parameters

  • caBundle str - (optional) 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 ServiceReference - (optional) 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 str - (optional) 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.

WebhookConversion

class lightkube.models.apiextensions_v1.WebhookConversion(conversionReviewVersions, clientConfig=None)

WebhookConversion describes how to call a conversion webhook

parameters

  • conversionReviewVersions List[str] - 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 WebhookClientConfig - (optional) clientConfig is the instructions for how to call the webhook if strategy is Webhook.