Skip to content

meta_v1

APIGroup

class lightkube.models.meta_v1.APIGroup(name, versions, apiVersion=None, kind=None, preferredVersion=None, serverAddressByClientCIDRs=None)

APIGroup contains the name, the supported versions, and the preferred version of a group.

parameters

  • name str - name is the name of the group.
  • versions GroupVersionForDiscovery - versions are the versions supported in this group.
  • 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
  • preferredVersion GroupVersionForDiscovery - (optional) preferredVersion is the version preferred by the API server, which probably is the storage version.
  • serverAddressByClientCIDRs ServerAddressByClientCIDR - (optional) 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.

APIGroupList

class lightkube.models.meta_v1.APIGroupList(groups, apiVersion=None, kind=None)

APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.

parameters

  • groups APIGroup - groups is a list of APIGroup.
  • 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

APIResource

class lightkube.models.meta_v1.APIResource(kind, name, namespaced, singularName, verbs, categories=None, group=None, shortNames=None, storageVersionHash=None, version=None)

APIResource specifies the name of a resource and whether it is namespaced.

parameters

  • kind str - kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
  • name str - name is the plural name of the resource.
  • namespaced bool - namespaced indicates if a resource is namespaced or not.
  • singularName 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.
  • verbs List[str] - verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
  • categories List[str] - (optional) categories is a list of the grouped resources this resource belongs to (e.g. 'all')
  • group str - (optional) 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".
  • shortNames List[str] - (optional) shortNames is a list of suggested short names of the resource.
  • storageVersionHash str - (optional) 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.
  • version str - (optional) 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)".

APIResourceList

class lightkube.models.meta_v1.APIResourceList(groupVersion, resources, apiVersion=None, kind=None)

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

parameters

  • groupVersion str - groupVersion is the group and version this APIResourceList is for.
  • resources APIResource - resources contains the name of the resources and if they are namespaced.
  • 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

APIVersions

class lightkube.models.meta_v1.APIVersions(serverAddressByClientCIDRs, versions, apiVersion=None, kind=None)

APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.

parameters

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

Condition

class lightkube.models.meta_v1.Condition(lastTransitionTime, message, reason, status, type, observedGeneration=None)

Condition contains details for one aspect of the current state of this API Resource.

parameters

  • lastTransitionTime Time - lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
  • message str - message is a human readable message indicating details about the transition. This may be an empty string.
  • reason str - reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
  • status str - status of the condition, one of True, False, Unknown.
  • type str - type of condition in CamelCase or in foo.example.com/CamelCase.
  • observedGeneration int - (optional) observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

DeleteOptions

class lightkube.models.meta_v1.DeleteOptions(apiVersion=None, dryRun=None, gracePeriodSeconds=None, kind=None, orphanDependents=None, preconditions=None, propagationPolicy=None)

DeleteOptions may be provided when deleting an API object.

parameters

  • 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
  • dryRun List[str] - (optional) 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
  • gracePeriodSeconds int - (optional) 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.
  • 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
  • orphanDependents bool - (optional) 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 - (optional) Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
  • propagationPolicy str - (optional) 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.

FieldsV1

GroupVersionForDiscovery

class lightkube.models.meta_v1.GroupVersionForDiscovery(groupVersion, version)

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

parameters

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

LabelSelector

class lightkube.models.meta_v1.LabelSelector(matchExpressions=None, matchLabels=None)

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

parameters

  • matchExpressions LabelSelectorRequirement - (optional) matchExpressions is a list of label selector requirements. The requirements are ANDed.
  • matchLabels dict - (optional) 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.

LabelSelectorRequirement

class lightkube.models.meta_v1.LabelSelectorRequirement(key, operator, values=None)

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

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 List[str] - (optional) 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.

ListMeta

class lightkube.models.meta_v1.ListMeta(continue_=None, remainingItemCount=None, resourceVersion=None, selfLink=None)

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

parameters

  • continue_ str - (optional) 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.
  • remainingItemCount int - (optional) 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.
  • resourceVersion str - (optional) String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info
  • selfLink str - (optional) selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

ManagedFieldsEntry

class lightkube.models.meta_v1.ManagedFieldsEntry(apiVersion=None, fieldsType=None, fieldsV1=None, manager=None, operation=None, subresource=None, time=None)

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

parameters

  • apiVersion str - (optional) 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.
  • fieldsType str - (optional) FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
  • fieldsV1 FieldsV1 - (optional) FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
  • manager str - (optional) Manager is an identifier of the workflow managing these fields.
  • operation str - (optional) Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
  • subresource str - (optional) Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
  • time Time - (optional) Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'

MicroTime

ObjectMeta

class lightkube.models.meta_v1.ObjectMeta(annotations=None, clusterName=None, creationTimestamp=None, deletionGracePeriodSeconds=None, deletionTimestamp=None, finalizers=None, generateName=None, generation=None, labels=None, managedFields=None, name=None, namespace=None, ownerReferences=None, resourceVersion=None, selfLink=None, uid=None)

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

parameters

  • annotations dict - (optional) 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
  • clusterName str - (optional) 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.
  • creationTimestamp Time - (optional) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info
  • deletionGracePeriodSeconds int - (optional) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
  • deletionTimestamp Time - (optional) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info
  • finalizers List[str] - (optional) 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.
  • generateName str - (optional) 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
  • generation int - (optional) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
  • labels dict - (optional) 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
  • managedFields ManagedFieldsEntry - (optional) 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 str - (optional) 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
  • namespace str - (optional) Namespace defines the space within which 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
  • ownerReferences OwnerReference - (optional) 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.
  • resourceVersion str - (optional) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info
  • selfLink str - (optional) SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.
  • uid str - (optional) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info

OwnerReference

class lightkube.models.meta_v1.OwnerReference(apiVersion, kind, name, uid, blockOwnerDeletion=None, controller=None)

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

parameters

  • apiVersion str - API version of the referent.
  • kind str - Kind of the referent. More info
  • name str - Name of the referent. More info
  • uid str - UID of the referent. More info
  • blockOwnerDeletion bool - (optional) 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.
  • controller bool - (optional) If true, this reference points to the managing controller.

Patch

Preconditions

class lightkube.models.meta_v1.Preconditions(resourceVersion=None, uid=None)

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

parameters

  • resourceVersion str - (optional) Specifies the target ResourceVersion
  • uid str - (optional) Specifies the target UID.

ServerAddressByClientCIDR

class lightkube.models.meta_v1.ServerAddressByClientCIDR(clientCIDR, serverAddress)

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

parameters

  • clientCIDR str - The CIDR with which clients can match their IP to figure out the server address that they should use.
  • serverAddress 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.

Status

class lightkube.models.meta_v1.Status(apiVersion=None, code=None, details=None, kind=None, message=None, metadata=None, reason=None, status=None)

Status is a return value for calls that don't return other objects.

parameters

  • 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
  • code int - (optional) Suggested HTTP return code for this status, 0 if not set.
  • details StatusDetails - (optional) 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.
  • 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
  • message str - (optional) A human-readable description of the status of this operation.
  • metadata ListMeta - (optional) Standard list metadata. More info
  • reason str - (optional) 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.
  • status str - (optional) Status of the operation. One of: "Success" or "Failure". More info

StatusCause

class lightkube.models.meta_v1.StatusCause(field=None, message=None, reason=None)

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

parameters

  • field str - (optional) 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 - (optional) A human-readable description of the cause of the error. This field may be presented as-is to a reader.
  • reason str - (optional) A machine-readable description of the cause of the error. If this value is empty there is no information available.

StatusDetails

class lightkube.models.meta_v1.StatusDetails(causes=None, group=None, kind=None, name=None, retryAfterSeconds=None, uid=None)

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

parameters

  • causes StatusCause - (optional) The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
  • group str - (optional) The group attribute of the resource associated with the status StatusReason.
  • kind str - (optional) The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info
  • name str - (optional) The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
  • retryAfterSeconds int - (optional) 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 str - (optional) UID of the resource. (when there is a single resource which can be described). More info

Time

WatchEvent

class lightkube.models.meta_v1.WatchEvent(object, type)

Event represents a single event to a watched resource.

parameters

  • object runtime.RawExtension - 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 -