avionix.kube.apiextensions

Classes for creating custom Kubernetes objects

class avionix.kube.apiextensions.CustomResourceColumnDefinition(name, json_path, type, description=None, format=None, priority=None)
Parameters

  • name (str) – name is a human readable name for the column.

  • json_path (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.

  • type (str) – type is an OpenAPI type definition for this column. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.

  • description (Optional[str]) – description is a human readable description of this column.

  • format (Optional[str]) – 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 (Optional[int]) – 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.

class avionix.kube.apiextensions.CustomResourceConversion(webhook, strategy)
Parameters

  • webhook (WebhookConversion) – webhook describes how to call the conversion webhook. Required when strategy is set to Webhook.

  • 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.

class avionix.kube.apiextensions.CustomResourceDefinition(metadata, spec, api_version=None)
Parameters
class avionix.kube.apiextensions.CustomResourceDefinitionNames(categories, kind, plural, list_kind=None, short_names=None, singular=None)
Parameters

  • categories (List[str]) – 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.

  • 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.

  • list_kind (Optional[str]) – listKind is the serialized kind of the list for this resource. Defaults to kind List”.

  • short_names (Optional[List[str]]) – 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 (Optional[str]) – singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

class avionix.kube.apiextensions.CustomResourceDefinitionSpec(group, names, scope, versions, conversion=None, preserve_unknown_fields=None)
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 (List[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 (Optional[CustomResourceConversion]) – conversion defines conversion settings for the CRD.

  • preserve_unknown_fields (Optional[bool]) – 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 # noqa for details.

class avionix.kube.apiextensions.CustomResourceDefinitionVersion(name, additional_printer_columns, schema, served, storage, subresources=None)
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.

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

  • schema (CustomResourceValidation) – schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource.

  • 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.

  • subresources (Optional[CustomResourceSubresources]) – subresources specify what subresources this version of the defined custom resource have.

class avionix.kube.apiextensions.CustomResourceSubresourceScale(spec_replicas_path, status_replicas_path, label_selector_path=None)
Parameters

  • spec_replicas_path (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.

  • status_replicas_path (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.

  • label_selector_path (Optional[str]) – 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 # noqa 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.

class avionix.kube.apiextensions.CustomResourceSubresources(scale)
Parameters

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

class avionix.kube.apiextensions.CustomResourceValidation(open_apiv3_schema)
Parameters

open_apiv3_schema (JSONSchemaProps) – openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning.

class avionix.kube.apiextensions.ExternalDocumentation(url, description=None)
Parameters

  • url (str) – None

  • description (Optional[str]) – None

class avionix.kube.apiextensions.JSON
class avionix.kube.apiextensions.JSONSchemaProps(type=None, additional_items=None, additional_properties=None, all_of=None, any_of=None, default=None, definitions=None, dependencies=None, description=None, enum=None, example=None, exclusive_maximum=None, exclusive_minimum=None, external_docs=None, format=None, id=None, items=None, max_items=None, max_length=None, max_properties=None, maximum=None, min_items=None, min_length=None, min_properties=None, minimum=None, multiple_of=None, not_=None, nullable=None, one_of=None, pattern=None, pattern_properties=None, properties=None, required=None, title=None, unique_items=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)
Parameters

  • type (Optional[str]) – None

  • additional_items (Optional[JSONSchemaPropsOrBool]) – None

  • additional_properties (Optional[JSONSchemaPropsOrBool]) – None

  • all_of (Optional[List[JSONSchemaProps]]) – None

  • any_of (Optional[List[JSONSchemaProps]]) – None

  • default (Optional[JSON]) – 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 (Optional[dict]) – None

  • dependencies (Optional[dict]) – None

  • description (Optional[str]) – None

  • enum (Optional[List[JSON]]) – None

  • example (Optional[JSON]) – None

  • exclusive_maximum (Optional[bool]) – None

  • exclusive_minimum (Optional[bool]) – None

  • external_docs (Optional[ExternalDocumentation]) – None

  • format (Optional[str]) – 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|35d{3})d{11})$ # noqa 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 (Optional[str]) – None

  • items (Optional[JSONSchemaPropsOrArray]) – None

  • max_items (Optional[int]) – None

  • max_length (Optional[int]) – None

  • max_properties (Optional[int]) – None

  • maximum (Union[int, float, None]) – None

  • min_items (Optional[int]) – None

  • min_length (Optional[int]) – None

  • min_properties (Optional[int]) – None

  • minimum (Union[int, float, None]) – None

  • multiple_of (Union[int, float, None]) – None

  • not – None

  • nullable (Optional[bool]) – None

  • one_of (Optional[List[JSONSchemaProps]]) – None

  • pattern (Optional[str]) – None

  • pattern_properties (Optional[dict]) – None

  • properties (Optional[dict]) – None

  • required (Optional[List[str]]) – None

  • title (Optional[str]) – None

  • unique_items (Optional[bool]) – None

  • x_kubernetes_embedded_resource (Optional[bool]) – 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 (Optional[bool]) – 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 (Optional[List[str]]) – 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 (Optional[str]) – 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 (Optional[str]) – 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 (Optional[bool]) – 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.

class avionix.kube.apiextensions.JSONSchemaPropsOrArray
class avionix.kube.apiextensions.JSONSchemaPropsOrBool
class avionix.kube.apiextensions.WebhookClientConfig(ca_bundle=None, service=None, url=None)
Parameters

  • ca_bundle (Optional[str]) – 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 (Optional[ServiceReference]) – 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 (Optional[str]) – 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.

class avionix.kube.apiextensions.WebhookConversion(client_config, conversion_review_versions)
Parameters

  • client_config (WebhookClientConfig) – clientConfig is the instructions for how to call the webhook if strategy is Webhook.

  • conversion_review_versions (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.