avionix.kube.meta

class avionix.kube.meta.APIGroup(name, preferred_version, server_address_by_client_cidrs, versions, api_version=None)
Parameters

  • name (str) – name is the name of the group.

  • preferred_version (GroupVersionForDiscovery) – preferredVersion is the version preferred by the API server, which probably is the storage version.

  • server_address_by_client_cidrs (List[ServerAddressByClientCIDR]) – a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

  • versions (List[GroupVersionForDiscovery]) – versions are the versions supported in this group.

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

class avionix.kube.meta.APIResource(name, categories, group, namespaced, short_names, singular_name, storage_version_hash, verbs, version)
Parameters

  • name (str) – name is the plural name of the resource.

  • categories (List[str]) – categories is a list of the grouped resources this resource belongs to (e.g. ‘all’)

  • group (str) – group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale”.

  • namespaced (bool) – namespaced indicates if a resource is namespaced or not.

  • short_names (List[str]) – shortNames is a list of suggested short names of the resource.

  • singular_name (str) – singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.

  • storage_version_hash (str) – The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.

  • verbs (List[str]) – verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

  • version (str) – version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource’s group)”.

class avionix.kube.meta.APIVersions(server_address_by_client_cidrs, versions, api_version=None)
Parameters

  • server_address_by_client_cidrs (List[ServerAddressByClientCIDR]) – a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.

  • versions (List[str]) – versions are the api versions that are available.

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

class avionix.kube.meta.DeleteOptions(dry_run, orphan_dependents, preconditions, propagation_policy, grace_period_seconds=None, api_version=None)
Parameters

  • dry_run (List[str]) – When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

  • orphan_dependents (bool) – Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

  • preconditions (Preconditions) – Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

  • propagation_policy (str) – Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

  • grace_period_seconds (Optional[int]) – The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

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

class avionix.kube.meta.GroupVersionForDiscovery(group_version, version)
Parameters

  • group_version (str) – groupVersion specifies the API group and version in the form “group/version”

  • version (str) – version specifies the version in the form of “version”. This is to save the clients the trouble of splitting the GroupVersion.

class avionix.kube.meta.LabelSelector(match_labels=None, match_expressions=None)
Parameters

  • match_labels (Optional[dict]) – matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

  • match_expressions (Optional[List[LabelSelectorRequirement]]) – matchExpressions is a list of label selector requirements. The requirements are ANDed.

class avionix.kube.meta.LabelSelectorRequirement(key, operator, values=None)
Parameters

  • key (str) – key is the label key that the selector applies to.

  • operator (str) – operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

  • values (Optional[List[str]]) – values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

class avionix.kube.meta.ListMeta(continue_, remaining_item_count)
Parameters

  • continue – continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

  • remaining_item_count (int) – remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

class avionix.kube.meta.ManagedFieldsEntry(fields_type=None, fields_v1=None, manager=None, operation=None, time=None, api_version=None)
Parameters

  • fields_type (Optional[str]) – FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

  • fields_v1 (Optional[dict]) – FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

  • manager (Optional[str]) – Manager is an identifier of the workflow managing these fields.

  • operation (Optional[str]) – Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.

  • time (Optional[datetime]) – Time is timestamp of when these fields were set. It should always be empty if Operation is ‘Apply’

  • api_version (Optional[str]) – APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

class avionix.kube.meta.MicroTime
class avionix.kube.meta.ObjectMeta(annotations=None, cluster_name=None, finalizers=None, generate_name=None, labels=None, managed_fields=None, name=None, namespace=None, owner_references=None)
Parameters

  • annotations (Optional[dict]) – Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • cluster_name (Optional[str]) – The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

  • finalizers (Optional[List[str]]) – Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

  • generate_name (Optional[str]) – GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency # noqa

  • labels (Optional[dict]) – Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • managed_fields (Optional[List[ManagedFieldsEntry]]) – ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

  • name (Optional[str]) – Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • namespace (Optional[str]) – Namespace defines the space within each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

  • owner_references (Optional[List[OwnerReference]]) – List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

class avionix.kube.meta.OwnerReference(name, uid, controller=None, block_owner_deletion=None, api_version=None)
Parameters

  • name (str) – Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

  • uid (str) – UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

  • controller (Optional[bool]) – If true, this reference points to the managing controller.

  • block_owner_deletion (Optional[bool]) – If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

  • api_version (Optional[str]) – API version of the referent.

class avionix.kube.meta.Patch
class avionix.kube.meta.Preconditions(resource_version=None, uid=None)
Parameters

  • resource_version (Optional[str]) – Specifies the target ResourceVersion

  • uid (Optional[str]) – Specifies the target UID.

class avionix.kube.meta.ServerAddressByClientCIDR(client_cidr, server_address)
Parameters

  • client_cidr (str) – The CIDR with which clients can match their IP to figure out the server address that they should use.

  • server_address (str) – Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

class avionix.kube.meta.Status(metadata, code, message, reason, details=None, api_version=None)
Parameters

  • metadata (ListMeta) – Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds # noqa

  • code (int) – Suggested HTTP return code for this status, 0 if not set.

  • message (str) – A human-readable description of the status of this operation.

  • reason (str) – A machine-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

  • details (Optional[StatusDetails]) – Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

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

class avionix.kube.meta.StatusCause(field, message, reason)
Parameters

  • field (str) – The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: “name” - the field “name” on the current resource “items[0].name” - the field “name” on the first array entry in “items”

  • message (str) – A human-readable description of the cause of the error. This field may be presented as-is to a reader.

  • reason (str) – A machine-readable description of the cause of the error. If this value is empty there is no information available.

class avionix.kube.meta.StatusDetails(name, causes, group, retry_after_seconds=None, uid=None)
Parameters

  • name (str) – The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

  • causes (List[StatusCause]) – The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

  • group (str) – The group attribute of the resource associated with the status StatusReason.

  • retry_after_seconds (Optional[int]) – If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.

  • uid (Optional[str]) – UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

class avionix.kube.meta.Time
class avionix.kube.meta.WatchEvent(object, type)
Parameters

  • object (str) –

    Object is:

    • If Type is Added or Modified: the new state of the object.

    • If Type is Deleted: the state of the object immediately before deletion.

    • If Type is Error: Status is recommended; other types may make sense depending on context.

  • type (str) – None