Top Level API Objects
Definitions
resource.Quantity
Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.
The serialization format is:
<quantity> ::= <signedNumber><suffix> (Note that <suffix> may be empty, from the "" case in <decimalSI>.) <digit> ::= 0 | 1 | … | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) <decimalSI> ::= m | "" | k | M | G | T | P | E (Note that 1024 = 1Ki but 1000 = 1k; I didn’t choose the capitalization.) <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber>
No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.
When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.
Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: a. No precision is lost b. No fractional digits will be emitted c. The exponent (or suffix) is as large as possible. The sign will be omitted unless the number is negative.
Examples: 1.5 will be serialized as "1500m" 1.5Gi will be serialized as "1536Mi"
Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.
Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don’t diff.)
This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
Type : string
runtime.RawExtension
RawExtension is used to hold extensions in external versions.
To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.Object `json:"myPlugin"`
} type PluginA struct {
AOption string `json:"aOption"`
}
runtime.TypeMeta `json:",inline"`
MyPlugin runtime.RawExtension `json:"myPlugin"`
} type PluginA struct {
AOption string `json:"aOption"`
}
"kind":"MyAPIObject",
"apiVersion":"v1",
"myPlugin": {
"kind":"PluginA",
"aOption":"foo",
},
}
So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package’s DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)
Type : object
v1.APIGroup
APIGroup contains the name, the supported versions, and the preferred version of a group.
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
name |
name is the name of the group. |
string |
preferredVersion |
preferredVersion is the version preferred by the API server, which probably is the storage version. |
|
serverAddressByClientCIDRs |
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. |
< v1.ServerAddressByClientCIDR > array |
versions |
versions are the versions supported in this group. |
< v1.GroupVersionForDiscovery > array |
v1.APIGroupList
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
groups |
groups is a list of APIGroup. |
< v1.APIGroup > array |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
v1.APIResource
APIResource specifies the name of a resource and whether it is namespaced.
| Name | Description | Schema |
|---|---|---|
categories |
categories is a list of the grouped resources this resource belongs to (e.g. 'all') |
< string > array |
group |
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". |
string |
kind |
kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') |
string |
name |
name is the plural name of the resource. |
string |
namespaced |
namespaced indicates if a resource is namespaced or not. |
boolean |
shortNames |
shortNames is a list of suggested short names of the resource. |
< string > array |
singularName |
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. |
string |
storageVersionHash |
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. |
string |
verbs |
verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) |
< string > array |
version |
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)". |
string |
v1.APIResourceList
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.
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
groupVersion |
groupVersion is the group and version this APIResourceList is for. |
string |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
resources |
resources contains the name of the resources and if they are namespaced. |
< v1.APIResource > array |
v1.Condition
Condition represents the state of the operator’s reconciliation functionality.
| Name | Schema |
|---|---|
lastHeartbeatTime |
|
message |
string |
reason |
string |
status |
string |
type |
string |
v1.DeleteOptions
DeleteOptions may be provided when deleting an API object.
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
dryRun |
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 |
< string > array |
gracePeriodSeconds |
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. |
integer (int64) |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
orphanDependents |
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. |
boolean |
preconditions |
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
|
propagationPolicy |
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. |
string |
v1.FieldsV1
FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item’s key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.
The exact format is defined in sigs.k8s.io/structured-merge-diff
Type : object
v1.GroupVersionForDiscovery
GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.
| Name | Description | Schema |
|---|---|---|
groupVersion |
groupVersion specifies the API group and version in the form "group/version" |
string |
version |
version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion. |
string |
v1.LabelSelector
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.
| Name | Description | Schema |
|---|---|---|
matchExpressions |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
< v1.LabelSelectorRequirement > array |
matchLabels |
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. |
< string, string > map |
v1.LabelSelectorRequirement
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
| Name | Description | Schema |
|---|---|---|
key |
key is the label key that the selector applies to. |
string |
operator |
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. |
string |
values |
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. |
< string > array |
v1.ListMeta
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
| Name | Description | Schema |
|---|---|---|
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. |
string |
remainingItemCount |
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. |
integer (int64) |
resourceVersion |
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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
string |
selfLink |
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. |
string |
v1.ManagedFieldsEntry
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
| Name | Description | Schema |
|---|---|---|
apiVersion |
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. |
string |
fieldsType |
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" |
string |
fieldsV1 |
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. |
|
manager |
Manager is an identifier of the workflow managing these fields. |
string |
operation |
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. |
string |
time |
Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' |
v1.ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
| Name | Description | Schema |
|---|---|---|
annotations |
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 |
< string, string > map |
clusterName |
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. |
string |
deletionGracePeriodSeconds |
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. |
integer (int64) |
deletionTimestamp |
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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
finalizers |
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. |
< string > array |
generateName |
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 |
string |
generation |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
integer (int64) |
labels |
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 |
< string, string > map |
managedFields |
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. |
< v1.ManagedFieldsEntry > array |
name |
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 |
string |
namespace |
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 |
string |
ownerReferences |
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. |
< v1.OwnerReference > array |
resourceVersion |
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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
string |
selfLink |
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. |
string |
uid |
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: http://kubernetes.io/docs/user-guide/identifiers#uids |
string |
v1.OwnerReference
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.
| Name | Description | Schema |
|---|---|---|
apiVersion |
API version of the referent. |
string |
blockOwnerDeletion |
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. |
boolean |
controller |
If true, this reference points to the managing controller. |
boolean |
kind |
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
string |
uid |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
string |
v1.Patch
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
Type : object
v1.PersistentVolumeClaimSpec
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
| Name | Description | Schema |
|---|---|---|
accessModes |
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
< string > array |
dataSource |
This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change. |
|
resources |
Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
selector |
A label query over volumes to consider for binding. |
|
storageClassName |
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
string |
volumeMode |
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. |
string |
volumeName |
VolumeName is the binding reference to the PersistentVolume backing this claim. |
string |
v1.Preconditions
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
| Name | Description | Schema |
|---|---|---|
resourceVersion |
Specifies the target ResourceVersion |
string |
uid |
Specifies the target UID. |
string |
v1.ResourceRequirements
ResourceRequirements describes the compute resource requirements.
| Name | Description | Schema |
|---|---|---|
limits |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
< string, resource.Quantity > map |
requests |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
< string, resource.Quantity > map |
v1.RootPaths
RootPaths lists the paths available at root. For example: "/healthz", "/apis".
| Name | Description | Schema |
|---|---|---|
paths |
paths are the paths available at root. |
< string > array |
v1.ServerAddressByClientCIDR
ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
| Name | Description | Schema |
|---|---|---|
clientCIDR |
The CIDR with which clients can match their IP to figure out the server address that they should use. |
string |
serverAddress |
Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port. |
string |
v1.Status
Status is a return value for calls that don’t return other objects.
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
code |
Suggested HTTP return code for this status, 0 if not set. |
integer (int32) |
details |
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 |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
message |
A human-readable description of the status of this operation. |
string |
metadata |
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
reason |
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. |
string |
status |
Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
string |
v1.StatusCause
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
| Name | Description | Schema |
|---|---|---|
field |
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" |
string |
message |
A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
string |
reason |
A machine-readable description of the cause of the error. If this value is empty there is no information available. |
string |
v1.StatusDetails
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.
| Name | Description | Schema |
|---|---|---|
causes |
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
< v1.StatusCause > array |
group |
The group attribute of the resource associated with the status StatusReason. |
string |
kind |
The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
name |
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
string |
retryAfterSeconds |
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. |
integer (int32) |
uid |
UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
string |
v1.Time
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
Type : string (date-time)
v1.TypedLocalObjectReference
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
| Name | Description | Schema |
|---|---|---|
apiGroup |
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. |
string |
kind |
Kind is the type of resource being referenced |
string |
name |
Name is the name of resource being referenced |
string |
v1.WatchEvent
Event represents a single event to a watched resource.
| Name | Description | Schema |
|---|---|---|
object |
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 |
string |
v1beta1.CDI
CDI is the CDI Operator CRD
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
metadata |
||
spec |
||
status |
v1beta1.CDIConfig
CDIConfig provides a user configuration for CDI
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
metadata |
||
spec |
||
status |
v1beta1.CDIConfigList
CDIConfigList provides the needed parameters to do request a list of CDIConfigs from the system
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
items |
Items provides a list of CDIConfigs |
< v1beta1.CDIConfig > array |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
metadata |
v1beta1.CDIConfigSpec
CDIConfigSpec defines specification for user configuration
| Name | Schema |
|---|---|
podResourceRequirements |
|
scratchSpaceStorageClass |
string |
uploadProxyURLOverride |
string |
v1beta1.CDIConfigStatus
CDIConfigStatus provides
| Name | Schema |
|---|---|
defaultPodResourceRequirements |
|
scratchSpaceStorageClass |
string |
uploadProxyURL |
string |
v1beta1.CDIList
CDIList provides the needed parameters to do request a list of CDIs from the system
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
items |
Items provides a list of CDIs |
< v1beta1.CDI > array |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
metadata |
v1beta1.CDISpec
CDISpec defines our specification for the CDI installation
| Name | Schema |
|---|---|
imagePullPolicy |
string |
uninstallStrategy |
string |
v1beta1.CDIStatus
CDIStatus defines the status of the CDI installation
| Name | Schema |
|---|---|
conditions |
< v1.Condition > array |
observedVersion |
string |
operatorVersion |
string |
phase |
string |
targetVersion |
string |
v1beta1.DataVolume
DataVolume provides a representation of our data volume
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
metadata |
||
spec |
||
status |
v1beta1.DataVolumeBlankImage
DataVolumeBlankImage provides the parameters to create a new raw blank image for the PVC
Type : object
v1beta1.DataVolumeCondition
DataVolumeCondition represents the state of a data volume condition.
| Name | Schema |
|---|---|
lastHeartBeatTime |
|
message |
string |
reason |
string |
status |
string |
type |
string |
v1beta1.DataVolumeList
DataVolumeList provides the needed parameters to do request a list of Data Volumes from the system
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
items |
Items provides a list of DataVolumes |
< v1beta1.DataVolume > array |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
metadata |
v1beta1.DataVolumeSource
DataVolumeSource represents the source for our Data Volume, this can be HTTP, Imageio, S3, Registry or an existing PVC
| Name | Schema |
|---|---|
blank |
|
http |
|
imageio |
|
pvc |
|
registry |
|
s3 |
|
upload |
v1beta1.DataVolumeSourceHTTP
DataVolumeSourceHTTP provides the parameters to create a Data Volume from an HTTP source
| Name | Description | Schema |
|---|---|---|
certConfigMap |
CertConfigMap provides a reference to the Registry certs |
string |
secretRef |
SecretRef provides the secret reference needed to access the HTTP source |
string |
url |
URL is the URL of the http source |
string |
v1beta1.DataVolumeSourceImageIO
DataVolumeSourceImageIO provides the parameters to create a Data Volume from an imageio source
| Name | Description | Schema |
|---|---|---|
certConfigMap |
CertConfigMap provides a reference to the CA cert |
string |
diskId |
DiskID provides id of a disk to be imported |
string |
secretRef |
SecretRef provides the secret reference needed to access the ovirt-engine |
string |
url |
URL is the URL of the ovirt-engine |
string |
v1beta1.DataVolumeSourcePVC
DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC
| Name | Schema |
|---|---|
name |
string |
namespace |
string |
v1beta1.DataVolumeSourceRegistry
DataVolumeSourceRegistry provides the parameters to create a Data Volume from an registry source
| Name | Description | Schema |
|---|---|---|
certConfigMap |
CertConfigMap provides a reference to the Registry certs |
string |
secretRef |
SecretRef provides the secret reference needed to access the Registry source |
string |
url |
URL is the url of the Registry source |
string |
v1beta1.DataVolumeSourceS3
DataVolumeSourceS3 provides the parameters to create a Data Volume from an S3 source
| Name | Description | Schema |
|---|---|---|
secretRef |
SecretRef provides the secret reference needed to access the S3 source |
string |
url |
URL is the url of the S3 source |
string |
v1beta1.DataVolumeSourceUpload
DataVolumeSourceUpload provides the parameters to create a Data Volume by uploading the source
Type : object
v1beta1.DataVolumeSpec
DataVolumeSpec defines our specification for a DataVolume type
| Name | Description | Schema |
|---|---|---|
contentType |
DataVolumeContentType options: "kubevirt", "archive" |
string |
pvc |
PVC is a pointer to the PVC Spec we want to use |
|
source |
Source is the src of the data for the requested DataVolume |
v1beta1.DataVolumeStatus
DataVolumeStatus provides the parameters to store the phase of the Data Volume
| Name | Description | Schema |
|---|---|---|
conditions |
< v1beta1.DataVolumeCondition > array |
|
phase |
Phase is the current phase of the data volume |
string |
progress |
string |
|
restartCount |
integer (int32) |
v1beta1.UploadTokenRequest
UploadTokenRequest is the CR used to initiate a CDI upload
| Name | Description | Schema |
|---|---|---|
apiVersion |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
string |
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
string |
metadata |
||
spec |
Spec contains the parameters of the request |
|
status |
Status contains the status of the request |
v1beta1.UploadTokenRequestSpec
UploadTokenRequestSpec defines the parameters of the token request
| Name | Description | Schema |
|---|---|---|
pvcName |
PvcName is the name of the PVC to upload to |
string |
v1beta1.UploadTokenRequestStatus
UploadTokenRequestStatus stores the status of a token request
| Name | Description | Schema |
|---|---|---|
token |
Token is a JWT token to be inserted in "Authentication Bearer header" |
string |