runtime.TypeMeta `json:",inline"`
MyPlugin runtime.Object `json:"myPlugin"`
} type PluginA struct {
AOption string `json:"aOption"`
}
×
Common object reference
- Affinity [core/v1]
- AggregationRule [rbac.authorization.k8s.io/v1]
- AlertmanagerList [monitoring.coreos.com/v1]
- APIServerList [config.openshift.io/v1]
- APIServiceList [apiregistration.k8s.io/v1]
- AppliedClusterResourceQuotaList [quota.openshift.io/v1]
- AttachedVolume [core/v1]
- AuthenticationList [config.openshift.io/v1]
- AuthenticationList [operator.openshift.io/v1]
- AWSelasticBlockStoreVolumeSource [core/v1]
- AzureDiskVolumeSource [core/v1]
- AzureFilePersistentVolumeSource [core/v1]
- AzureFileVolumeSource [core/v1]
- BrokerTemplateInstanceList [template.openshift.io/v1]
- BuildConfigList [build.openshift.io/v1]
- BuildList [build.openshift.io/v1]
- BuildList [config.openshift.io/v1]
- BuildLog [build.openshift.io/v1]
- BuildRequest [build.openshift.io/v1]
- Capabilities [core/v1]
- CatalogSourceList [operators.coreos.com/v1alpha1]
- CephFSPersistentVolumeSource [core/v1]
- CephFSVolumeSource [core/v1]
- CertificateSigningRequestList [certificates.k8s.io/v1beta1]
- CinderPersistentVolumeSource [core/v1]
- CinderVolumeSource [core/v1]
- ClientIPConfig [core/v1]
- ClusterAutoscalerList [autoscaling.openshift.io/v1]
- ClusterNetworkList [network.openshift.io/v1]
- ClusterOperatorList [config.openshift.io/v1]
- ClusterResourceQuotaList [quota.openshift.io/v1]
- ClusterRoleBindingList [authorization.openshift.io/v1]
- ClusterRoleBindingList [rbac.authorization.k8s.io/v1]
- ClusterRoleList [authorization.openshift.io/v1]
- ClusterRoleList [rbac.authorization.k8s.io/v1]
- ClusterServiceVersionList [operators.coreos.com/v1alpha1]
- ClusterVersionList [config.openshift.io/v1]
- ComponentCondition [core/v1]
- ComponentStatusList [core/v1]
- ConfigList [imageregistry.operator.openshift.io/v1]
- ConfigList [operator.openshift.io/v1]
- ConfigList [samples.operator.openshift.io/v1]
- ConfigMapenvSource [core/v1]
- ConfigMapKeySelector [core/v1]
- ConfigMapList [core/v1]
- ConfigMapNodeConfigSource [core/v1]
- ConfigMapProjection [core/v1]
- ConfigMapVolumeSource [core/v1]
- ConsoleCLIDownloadList [console.openshift.io/v1]
- ConsoleexternalLogLinkList [console.openshift.io/v1]
- ConsoleLinkList [console.openshift.io/v1]
- ConsoleList [config.openshift.io/v1]
- ConsoleList [operator.openshift.io/v1]
- ConsoleNotificationList [console.openshift.io/v1]
- ConsoleYAMLSampleList [console.openshift.io/v1]
- Container [core/v1]
- ContainerImage [core/v1]
- ContainerPort [core/v1]
- ContainerRuntimeConfigList [machineconfiguration.openshift.io/v1]
- ContainerState [core/v1]
- ContainerStateRunning [core/v1]
- ContainerStateTerminated [core/v1]
- ContainerStateWaiting [core/v1]
- ControllerConfigList [machineconfiguration.openshift.io/v1]
- ControllerRevisionList [apps/v1]
- CredentialsRequestList [cloudcredential.openshift.io/v1]
- CronJobList [batch/v1beta1]
- CSIDriverList [storage.k8s.io/v1]
- CSINodeList [storage.k8s.io/v1]
- CSIPersistentVolumeSource [core/v1]
- CSISnapshotControllerList [operator.openshift.io/v1]
- CSIVolumeSource [core/v1]
- CustomResourceDefinitionList [apiextensions.k8s.io/v1]
- Daemonendpoint [core/v1]
- DaemonSetList [apps/v1]
- DeleteOptions [meta/v1]
- DeploymentConfigList [apps.openshift.io/v1]
- DeploymentConfigRollback [apps.openshift.io/v1]
- DeploymentList [apps/v1]
- DeploymentLog [apps.openshift.io/v1]
- DeploymentRequest [apps.openshift.io/v1]
- DNSList [config.openshift.io/v1]
- DNSList [operator.openshift.io/v1]
- DNSRecordList [ingress.operator.openshift.io/v1]
- DownwardAPIProjection [core/v1]
- DownwardAPIVolumeFile [core/v1]
- DownwardAPIVolumeSource [core/v1]
- egressNetworkPolicyList [network.openshift.io/v1]
- emptyDirVolumeSource [core/v1]
- endpointAddress [core/v1]
- endpointPort [core/v1]
- endpointSliceList [discovery.k8s.io/v1beta1]
- endpointsList [core/v1]
- endpointSubset [core/v1]
- envFromSource [core/v1]
- envVar [core/v1]
- envVarSource [core/v1]
- ephemeralContainer [core/v1]
- etcdList [operator.openshift.io/v1]
- eventList [core/v1]
- eventList [events.k8s.io/v1beta1]
- eventSeries [core/v1]
- eventSource [core/v1]
- eviction [policy/v1beta1]
- execAction [core/v1]
- FCVolumeSource [core/v1]
- FeatureGateList [config.openshift.io/v1]
- FieldsV1 [meta/v1]
- FlexPersistentVolumeSource [core/v1]
- FlexVolumeSource [core/v1]
- FlockerVolumeSource [core/v1]
- GCePersistentDiskVolumeSource [core/v1]
- GitRepoVolumeSource [core/v1]
- GlusterfsPersistentVolumeSource [core/v1]
- GlusterfsVolumeSource [core/v1]
- GroupList [user.openshift.io/v1]
- GroupVersionKind [meta/v1]
- Handler [core/v1]
- HorizontalPodAutoscalerList [autoscaling/v1]
- HostAlias [core/v1]
- HostPathVolumeSource [core/v1]
- HostSubnetList [network.openshift.io/v1]
- HTTPGetAction [core/v1]
- HTTPHeader [core/v1]
- IdentityList [user.openshift.io/v1]
- ImageContentSourcePolicyList [operator.openshift.io/v1alpha1]
- ImageList [config.openshift.io/v1]
- ImageList [image.openshift.io/v1]
- ImagePrunerList [imageregistry.operator.openshift.io/v1]
- ImageStreamLayers [image.openshift.io/v1]
- ImageStreamList [image.openshift.io/v1]
- ImageStreamTagList [image.openshift.io/v1]
- ImageTagList [image.openshift.io/v1]
- InfrastructureList [config.openshift.io/v1]
- IngressClassList [networking.k8s.io/v1beta1]
- IngressControllerList [operator.openshift.io/v1]
- IngressList [config.openshift.io/v1]
- IngressList [networking.k8s.io/v1beta1]
- InstallPlanList [operators.coreos.com/v1alpha1]
- IntOrString [util/intstr]
- ISCSIPersistentVolumeSource [core/v1]
- ISCSIVolumeSource [core/v1]
- JobList [batch/v1]
- KeyToPath [core/v1]
- KubeAPIServerList [operator.openshift.io/v1]
- KubeControllerManagerList [operator.openshift.io/v1]
- KubeletConfigList [machineconfiguration.openshift.io/v1]
- KubeSchedulerList [operator.openshift.io/v1]
- KubeStorageVersionMigratorList [operator.openshift.io/v1]
- LabelSelector [meta/v1]
- LabelSelectorRequirement [meta/v1]
- LeaseList [coordination.k8s.io/v1]
- Lifecycle [core/v1]
- LimitRangeItem [core/v1]
- LimitRangeList [core/v1]
- ListMeta [meta/v1]
- LoadBalancerIngress [core/v1]
- LoadBalancerStatus [core/v1]
- LocalObjectReference [core/v1]
- LocalVolumeSource [core/v1]
- MachineAutoscalerList [autoscaling.openshift.io/v1beta1]
- MachineConfigList [machineconfiguration.openshift.io/v1]
- MachineConfigPoolList [machineconfiguration.openshift.io/v1]
- MachineHealthCheckList [machine.openshift.io/v1beta1]
- MachineList [machine.openshift.io/v1beta1]
- MachineSetList [machine.openshift.io/v1beta1]
- ManagedFieldsentry [meta/v1]
- MicroTime [meta/v1]
- MutatingWebhookConfigurationList [admissionregistration.k8s.io/v1]
- NamespaceCondition [core/v1]
- NamespaceList [core/v1]
- NetNamespaceList [network.openshift.io/v1]
- NetworkAttachmentDefinitionList [k8s.cni.cncf.io/v1]
- NetworkList [config.openshift.io/v1]
- NetworkList [operator.openshift.io/v1]
- NetworkPolicyList [networking.k8s.io/v1]
- NFSVolumeSource [core/v1]
- NodeAddress [core/v1]
- NodeAffinity [core/v1]
- NodeCondition [core/v1]
- NodeConfigSource [core/v1]
- NodeDaemonendpoints [core/v1]
- NodeList [core/v1]
- NodeSelector [core/v1]
- NodeSelectorRequirement [core/v1]
- NodeSelectorTerm [core/v1]
- NodeSystemInfo [core/v1]
- OAuthAccessTokenList [oauth.openshift.io/v1]
- OAuthAuthorizeTokenList [oauth.openshift.io/v1]
- OAuthClientAuthorizationList [oauth.openshift.io/v1]
- OAuthClientList [oauth.openshift.io/v1]
- OAuthList [config.openshift.io/v1]
- ObjectFieldSelector [core/v1]
- ObjectMeta [meta/v1]
- ObjectReference [core/v1]
- OpenShiftAPIServerList [operator.openshift.io/v1]
- OpenShiftControllerManagerList [operator.openshift.io/v1]
- OperatorGroupList [operators.coreos.com/v1]
- OperatorHubList [config.openshift.io/v1]
- OperatorSourceList [operators.coreos.com/v1]
- OwnerReference [meta/v1]
- PackageManifestList [packages.operators.coreos.com/v1]
- Patch [meta/v1]
- PersistentVolumeClaim [core/v1]
- PersistentVolumeClaimCondition [core/v1]
- PersistentVolumeClaimList [core/v1]
- PersistentVolumeClaimVolumeSource [core/v1]
- PersistentVolumeList [core/v1]
- PersistentVolumeSpec [core/v1]
- PhotonPersistentDiskVolumeSource [core/v1]
- PodAffinity [core/v1]
- PodAffinityTerm [core/v1]
- PodAntiAffinity [core/v1]
- PodCondition [core/v1]
- PodDisruptionBudgetList [policy/v1beta1]
- PodDNSConfig [core/v1]
- PodDNSConfigOption [core/v1]
- PodIP [core/v1]
- PodList [core/v1]
- PodMonitorList [monitoring.coreos.com/v1]
- PodReadinessGate [core/v1]
- PodSecurityContext [core/v1]
- PodSpec [core/v1]
- PodTemplateList [core/v1]
- PodTemplateSpec [core/v1]
- PortworxVolumeSource [core/v1]
- PreferredSchedulingTerm [core/v1]
- PriorityClassList [scheduling.k8s.io/v1]
- Probe [core/v1]
- ProfileList [tuned.openshift.io/v1]
- ProjectedVolumeSource [core/v1]
- ProjectList [config.openshift.io/v1]
- ProjectList [project.openshift.io/v1]
- PrometheusList [monitoring.coreos.com/v1]
- PrometheusRuleList [monitoring.coreos.com/v1]
- ProxyList [config.openshift.io/v1]
- Quantity [api/resource]
- QuobyteVolumeSource [core/v1]
- RangeAllocationList [security.openshift.io/v1]
- Rawextension [pkg/runtime]
- RBDPersistentVolumeSource [core/v1]
- RBDVolumeSource [core/v1]
- ReplicaSetList [apps/v1]
- ReplicationControllerCondition [core/v1]
- ReplicationControllerList [core/v1]
- ResourceFieldSelector [core/v1]
- ResourceQuotaList [core/v1]
- ResourceQuotaSpec [core/v1]
- ResourceQuotaStatus [core/v1]
- ResourceRequirements [core/v1]
- RoleBindingList [authorization.openshift.io/v1]
- RoleBindingList [rbac.authorization.k8s.io/v1]
- RoleBindingRestrictionList [authorization.openshift.io/v1]
- RoleList [authorization.openshift.io/v1]
- RoleList [rbac.authorization.k8s.io/v1]
- RouteList [route.openshift.io/v1]
- RuntimeClassList [node.k8s.io/v1beta1]
- Scale [autoscaling/v1]
- Scale [extensions/v1beta1]
- ScaleIOPersistentVolumeSource [core/v1]
- ScaleIOVolumeSource [core/v1]
- SchedulerList [config.openshift.io/v1]
- ScopedResourceSelectorRequirement [core/v1]
- ScopeSelector [core/v1]
- SecretenvSource [core/v1]
- SecretKeySelector [core/v1]
- SecretList [core/v1]
- SecretProjection [core/v1]
- SecretReference [core/v1]
- SecretVolumeSource [core/v1]
- SecurityContext [core/v1]
- SecurityContextConstraintsList [security.openshift.io/v1]
- SeLinuxOptions [core/v1]
- ServiceAccountList [core/v1]
- ServiceAccountTokenProjection [core/v1]
- ServiceCAList [operator.openshift.io/v1]
- ServiceList [core/v1]
- ServiceMonitorList [monitoring.coreos.com/v1]
- ServicePort [core/v1]
- SessionAffinityConfig [core/v1]
- StatefulSetList [apps/v1]
- Status [meta/v1]
- StatusCause [meta/v1]
- StatusDetails [meta/v1]
- StorageClassList [storage.k8s.io/v1]
- StorageOSPersistentVolumeSource [core/v1]
- StorageOSVolumeSource [core/v1]
- SubscriptionList [operators.coreos.com/v1alpha1]
- Sysctl [core/v1]
- Taint [core/v1]
- TCPSocketAction [core/v1]
- TemplateInstanceList [template.openshift.io/v1]
- ThanosRulerList [monitoring.coreos.com/v1]
- Time [meta/v1]
- TokenRequest [authentication.k8s.io/v1]
- Toleration [core/v1]
- TopologySelectorLabelRequirement [core/v1]
- TopologySelectorTerm [core/v1]
- TopologySpreadConstraint [core/v1]
- TunedList [tuned.openshift.io/v1]
- TypedLocalObjectReference [core/v1]
- UserList [user.openshift.io/v1]
- ValidatingWebhookConfigurationList [admissionregistration.k8s.io/v1]
- Volume [core/v1]
- VolumeAttachmentList [storage.k8s.io/v1]
- VolumeDevice [core/v1]
- VolumeMount [core/v1]
- VolumeNodeAffinity [core/v1]
- VolumeProjection [core/v1]
- VolumeSnapshotClassList [snapshot.storage.k8s.io/v1beta1]
- VolumeSnapshotContentList [snapshot.storage.k8s.io/v1beta1]
- VolumeSnapshotList [snapshot.storage.k8s.io/v1beta1]
- VsphereVirtualDiskVolumeSource [core/v1]
- WeightedPodAffinityTerm [core/v1]
- WindowsSecurityContextOptions [core/v1]
Affinity [core/v1]
- Description
-
Affinity is a group of affinity scheduling rules.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Describes node affinity scheduling rules for the pod. |
|
|
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
|
|
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
AggregationRule [rbac.authorization.k8s.io/v1]
- Description
-
AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole’s permissions will be added |
AlertmanagerList [monitoring.coreos.com/v1]
- Description
-
AlertmanagerList is a list of Alertmanager
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of alertmanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
APIServerList [config.openshift.io/v1]
- Description
-
APIServerList is a list of APIServer
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of apiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
APIServiceList [apiregistration.k8s.io/v1]
- Description
-
APIServiceList is a list of APIService objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
||
|
|
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 |
|
AppliedClusterResourceQuotaList [quota.openshift.io/v1]
- Description
-
AppliedClusterResourceQuotaList is a collection of AppliedClusterResourceQuotas
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of AppliedClusterResourceQuota |
|
|
|
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 |
|
AttachedVolume [core/v1]
- Description
-
AttachedVolume describes a volume attached to a node
- Type
-
object - Required
-
-
name -
devicePath
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
DevicePath represents the device path where the volume should be available |
|
|
Name of the attached volume |
AuthenticationList [config.openshift.io/v1]
- Description
-
AuthenticationList is a list of Authentication
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
AuthenticationList [operator.openshift.io/v1]
- Description
-
AuthenticationList is a list of Authentication
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of authentications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
AWSelasticBlockStoreVolumeSource [core/v1]
- Description
-
Represents a Persistent Disk resource in AWS.
An AWS eBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS eBS disk can only be mounted as read/write once. AWS eBS volumes support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
volumeID
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type of the volume that you want to mount. Tip: ensure that the filesystem type is supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). |
|
|
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
Unique ID of the persistent disk resource in AWS (Amazon eBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
AzureDiskVolumeSource [core/v1]
- Description
-
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- Type
-
object - Required
-
-
diskName -
diskURI
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Host Caching mode: None, Read Only, Read Write. |
|
|
The Name of the data disk in the blob storage |
|
|
The URI the data disk in the blob storage |
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
AzureFilePersistentVolumeSource [core/v1]
- Description
-
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
- Type
-
object - Required
-
-
secretName -
shareName
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
the name of secret that contains Azure Storage Account Name and Key |
|
|
the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod |
|
|
Share Name |
AzureFileVolumeSource [core/v1]
- Description
-
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
- Type
-
object - Required
-
-
secretName -
shareName
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
the name of secret that contains Azure Storage Account Name and Key |
|
|
Share Name |
BrokerTemplateInstanceList [template.openshift.io/v1]
- Description
-
BrokerTemplateInstanceList is a list of BrokerTemplateInstance objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is a list of BrokerTemplateInstances |
|
|
|
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 |
|
BuildConfigList [build.openshift.io/v1]
- Description
-
BuildConfigList is a collection of BuildConfigs.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is a list of build configs |
|
|
|
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 |
|
BuildList [build.openshift.io/v1]
- Description
-
BuildList is a collection of Builds.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is a list of builds |
|
|
|
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 |
|
BuildList [config.openshift.io/v1]
- Description
-
BuildList is a list of Build
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of builds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
BuildLog [build.openshift.io/v1]
- Description
-
BuildLog is the (unused) resource associated with the build log redirector
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
BuildRequest [build.openshift.io/v1]
- Description
-
BuildRequest is the resource used to pass parameters to build generator
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
binary indicates a request to build from a binary provided to the builder |
|
|
DockerStrategyOptions contains additional docker-strategy specific options for the build |
|
|
env contains additional environment variables you want to pass into a builder container. |
|
|
from is the reference to the ImageStreamTag that triggered the build. |
|
|
|
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 |
|
|
lastVersion (optional) is the LastVersion of the BuildConfig that was used to generate the build. If the BuildConfig in the generator doesn’t match, a build will not be generated. |
|
||
|
revision is the information from the source for a specific repo snapshot. |
|
|
SourceStrategyOptions contains additional source-strategy specific options for the build |
|
|
triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers. |
|
|
triggeredByImage is the Image that triggered this build. |
Capabilities [core/v1]
- Description
-
Adds and removes POSIX capabilities from running containers.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Added capabilities |
|
|
Removed capabilities |
CatalogSourceList [operators.coreos.com/v1alpha1]
- Description
-
CatalogSourceList is a list of CatalogSource
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of catalogsources. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
CephFSPersistentVolumeSource [core/v1]
- Description
-
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SeLinux relabeling.
- Type
-
object - Required
-
-
monitors
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
|
Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
CephFSVolumeSource [core/v1]
- Description
-
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SeLinux relabeling.
- Type
-
object - Required
-
-
monitors
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
|
|
|
Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/ReADMe.md#how-to-use-it |
CertificateSigningRequestList [certificates.k8s.io/v1beta1]
- Description
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
|
|
|
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 |
|
CinderPersistentVolumeSource [core/v1]
- Description
-
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
volumeID
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
Optional: points to a secret object containing parameters used to connect to OpenStack. |
|
|
|
volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
CinderVolumeSource [core/v1]
- Description
-
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
volumeID
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
Optional: points to a secret object containing parameters used to connect to OpenStack. |
|
|
|
volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
ClientIPConfig [core/v1]
- Description
-
ClientIPConfig represents the configurations of Client IP based session affinity.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && ⇐86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). |
ClusterAutoscalerList [autoscaling.openshift.io/v1]
- Description
-
ClusterAutoscalerList is a list of ClusterAutoscaler
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of clusterautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ClusterNetworkList [network.openshift.io/v1]
- Description
-
ClusterNetworkList is a list of ClusterNetwork
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of clusternetworks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ClusterOperatorList [config.openshift.io/v1]
- Description
-
ClusterOperatorList is a list of ClusterOperator
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of clusteroperators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ClusterResourceQuotaList [quota.openshift.io/v1]
- Description
-
ClusterResourceQuotaList is a list of ClusterResourceQuota
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of clusterresourcequotas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ClusterRoleBindingList [authorization.openshift.io/v1]
- Description
-
ClusterRoleBindingList is a collection of ClusterRoleBindings
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of ClusterRoleBindings |
|
|
|
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 |
|
ClusterRoleBindingList [rbac.authorization.k8s.io/v1]
- Description
-
ClusterRoleBindingList is a collection of ClusterRoleBindings
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of ClusterRoleBindings |
|
|
|
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 |
|
Standard object’s metadata. |
ClusterRoleList [authorization.openshift.io/v1]
- Description
-
ClusterRoleList is a collection of ClusterRoles
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of ClusterRoles |
|
|
|
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 |
|
ClusterRoleList [rbac.authorization.k8s.io/v1]
- Description
-
ClusterRoleList is a collection of ClusterRoles
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of ClusterRoles |
|
|
|
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 |
|
Standard object’s metadata. |
ClusterServiceVersionList [operators.coreos.com/v1alpha1]
- Description
-
ClusterServiceVersionList is a list of ClusterServiceVersion
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of clusterserviceversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ClusterVersionList [config.openshift.io/v1]
- Description
-
ClusterVersionList is a list of ClusterVersion
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of clusterversions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ComponentCondition [core/v1]
- Description
-
Information about the condition of a component.
- Type
-
object - Required
-
-
type -
status
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Condition error code for a component. For example, a health check error code. |
|
|
Message about the condition for a component. For example, information about a health check. |
|
|
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". |
|
|
Type of condition for a component. Valid value: "Healthy" |
ComponentStatusList [core/v1]
- Description
-
Status of all the conditions for the component as a list of ComponentStatus objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of ComponentStatus objects. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
ConfigList [imageregistry.operator.openshift.io/v1]
- Description
-
ConfigList is a list of Config
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConfigList [operator.openshift.io/v1]
- Description
-
ConfigList is a list of Config
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConfigList [samples.operator.openshift.io/v1]
- Description
-
ConfigList is a list of Config
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of configs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConfigMapenvSource [core/v1]
- Description
-
ConfigMapenvSource selects a ConfigMap to populate the environment variables with.
The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap must be defined |
ConfigMapKeySelector [core/v1]
- Description
-
Selects a key from a ConfigMap.
- Type
-
object - Required
-
-
key
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The key to select. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its key must be defined |
ConfigMapList [core/v1]
- Description
-
ConfigMapList is a resource containing a list of ConfigMap objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of ConfigMaps. |
|
|
|
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 |
|
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
ConfigMapNodeConfigSource [core/v1]
- Description
-
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.
- Type
-
object - Required
-
-
namespace -
name -
kubeletConfigKey
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. |
|
|
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. |
|
|
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. |
|
|
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
|
|
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. |
ConfigMapProjection [core/v1]
- Description
-
Adapts a ConfigMap into a projected volume.
The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its keys must be defined |
ConfigMapVolumeSource [core/v1]
- Description
-
Adapts a ConfigMap into a volume.
The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SeLinux relabeling.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the ConfigMap or its keys must be defined |
ConsoleCLIDownloadList [console.openshift.io/v1]
- Description
-
ConsoleCLIDownloadList is a list of ConsoleCLIDownload
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of consoleclidownloads. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConsoleexternalLogLinkList [console.openshift.io/v1]
- Description
-
ConsoleexternalLogLinkList is a list of ConsoleexternalLogLink
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of consoleexternalloglinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConsoleLinkList [console.openshift.io/v1]
- Description
-
ConsoleLinkList is a list of ConsoleLink
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of consolelinks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConsoleList [config.openshift.io/v1]
- Description
-
ConsoleList is a list of Console
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConsoleList [operator.openshift.io/v1]
- Description
-
ConsoleList is a list of Console
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of consoles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConsoleNotificationList [console.openshift.io/v1]
- Description
-
ConsoleNotificationList is a list of ConsoleNotification
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of consolenotifications. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ConsoleYAMLSampleList [console.openshift.io/v1]
- Description
-
ConsoleYAMLSampleList is a list of ConsoleYAMLSample
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of consoleyamlsamples. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
Container [core/v1]
- Description
-
A single application container that you want to run within a pod.
- Type
-
object - Required
-
-
name
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAMe) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAMe) syntax can be escaped with a double , ie: (VAR_NAMe). escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
|
entrypoint array. Not executed within a shell. The docker image’s eNTRYPOINT is used if this is not provided. Variable references $(VAR_NAMe) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAMe) syntax can be escaped with a double , ie: (VAR_NAMe). escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
List of environment variables to set in the container. Cannot be updated. |
|
|
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDeNTIFIeR. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an env with a duplicate key will take precedence. Cannot be updated. |
|
|
|
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. |
|
|
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
|
|
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
|
Name of the container specified as a DNS_LABeL. each container in a pod must have a unique name (DNS_LABeL). Cannot be updated. |
|
List of ports to expose from the container. exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOeS NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. |
|
|
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
|
Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
|
StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. This is a beta feature enabled by the StartupProbe feature flag. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
|
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in eOF. Default is false. |
|
|
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an eOF. Default is false |
|
|
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnerror will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
volumeDevices is the list of block devices to be used by the container. |
|
|
Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
|
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
ContainerImage [core/v1]
- Description
-
Describe a container image
- Type
-
object - Required
-
-
names
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] |
|
|
The size of the image in bytes. |
ContainerPort [core/v1]
- Description
-
ContainerPort represents a network port in a single container.
- Type
-
object - Required
-
-
containerPort
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
|
|
What host IP to bind the external port to. |
|
|
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
|
|
If specified, this must be an IANA_SVC_NAMe and unique within the pod. each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
|
|
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". |
ContainerRuntimeConfigList [machineconfiguration.openshift.io/v1]
- Description
-
ContainerRuntimeConfigList is a list of ContainerRuntimeConfig
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of containerruntimeconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ContainerState [core/v1]
- Description
-
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Details about a running container |
|
|
Details about a terminated container |
|
|
Details about a waiting container |
ContainerStateRunning [core/v1]
- Description
-
ContainerStateRunning is a running state of a container.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Time at which the container was last (re-)started |
ContainerStateTerminated [core/v1]
- Description
-
ContainerStateTerminated is a terminated state of a container.
- Type
-
object - Required
-
-
exitCode
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Container’s ID in the format 'docker://<container_id>' |
|
|
exit status from the last termination of the container |
|
Time at which the container last terminated |
|
|
|
Message regarding the last termination of the container |
|
|
(brief) reason from the last termination of the container |
|
|
Signal from the last termination of the container |
|
Time at which previous execution of the container started |
ContainerStateWaiting [core/v1]
- Description
-
ContainerStateWaiting is a waiting state of a container.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Message regarding why the container is not yet running. |
|
|
(brief) reason the container is not yet running. |
ControllerConfigList [machineconfiguration.openshift.io/v1]
- Description
-
ControllerConfigList is a list of ControllerConfig
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of controllerconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ControllerRevisionList [apps/v1]
- Description
-
ControllerRevisionList is a resource containing a list of ControllerRevision objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of ControllerRevisions |
|
|
|
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 |
|
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
CredentialsRequestList [cloudcredential.openshift.io/v1]
- Description
-
CredentialsRequestList is a list of CredentialsRequest
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of credentialsrequests. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
CronJobList [batch/v1beta1]
- Description
-
CronJobList is a collection of cron jobs.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is the list of CronJobs. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
CSIDriverList [storage.k8s.io/v1]
- Description
-
CSIDriverList is a collection of CSIDriver objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is the list of CSIDriver |
|
|
|
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 |
|
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
CSINodeList [storage.k8s.io/v1]
- Description
-
CSINodeList is a collection of CSINode objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is the list of CSINode |
|
|
|
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 |
|
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
CSIPersistentVolumeSource [core/v1]
- Description
-
Represents storage that is managed by an external CSI volume driver (Beta feature)
- Type
-
object - Required
-
-
driver -
volumeHandle
-
Specification
| Property | Type | Description |
|---|---|---|
|
ControllerexpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerexpandVolume call. This is an alpha field and requires enabling expandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. |
|
|
ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. |
|
|
|
Driver is the name of the driver to use for this volume. Required. |
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". |
|
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. |
|
|
NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. |
|
|
|
Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). |
|
|
Attributes of the volume to publish. |
|
|
VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. |
CSISnapshotControllerList [operator.openshift.io/v1]
- Description
-
CSISnapshotControllerList is a list of CSISnapshotController
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of csisnapshotcontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
CSIVolumeSource [core/v1]
- Description
-
Represents a source location of a volume to mount, managed by an external CSI driver
- Type
-
object - Required
-
-
driver
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. |
|
|
Filesystem type to mount. ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. |
|
NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. |
|
|
|
Specifies a read-only configuration for the volume. Defaults to false (read/write). |
|
|
VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver’s documentation for supported values. |
CustomResourceDefinitionList [apiextensions.k8s.io/v1]
- Description
-
CustomResourceDefinitionList is a list of CustomResourceDefinition objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items list individual CustomResourceDefinition objects |
|
|
|
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 |
|
Daemonendpoint [core/v1]
- Description
-
Daemonendpoint contains information about a single Daemon endpoint.
- Type
-
object - Required
-
-
Port
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Port number of the given endpoint. |
DaemonSetList [apps/v1]
- Description
-
DaemonSetList is a collection of daemon sets.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
A list of daemon sets. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
DeleteOptions [meta/v1]
- Description
-
DeleteOptions may be provided when deleting an API object.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
|
|
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 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 |
|
|
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. |
|
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
|
|
|
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. |
DeploymentConfigList [apps.openshift.io/v1]
- Description
-
DeploymentConfigList is a collection of deployment configs.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of deployment configs |
|
|
|
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 |
|
DeploymentConfigRollback [apps.openshift.io/v1]
- Description
-
DeploymentConfigRollback provides the input to rollback generation.
- Type
-
object - Required
-
-
name -
spec
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
|
|
Name of the deployment config that will be rolled back. |
|
Spec defines the options to rollback generation. |
|
|
|
UpdatedAnnotations is a set of new annotations that will be added in the deployment config. |
DeploymentList [apps/v1]
- Description
-
DeploymentList is a list of Deployments.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of Deployments. |
|
|
|
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 |
|
Standard list metadata. |
DeploymentLog [apps.openshift.io/v1]
- Description
-
DeploymentLog represents the logs for a deployment
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
DeploymentRequest [apps.openshift.io/v1]
- Description
-
DeploymentRequest is a request to a deployment config for a new deployment.
- Type
-
object - Required
-
-
name -
latest -
force
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
excludeTriggers instructs the instantiator to avoid processing the specified triggers. This field overrides the triggers from latest and allows clients to control specific logic. This field is ignored if not specified. |
|
|
Force will try to force a new deployment to run. If the deployment config is paused, then setting this to true will return an Invalid error. |
|
|
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 |
|
|
Latest will update the deployment config with the latest state from all triggers. |
|
|
Name of the deployment config for requesting a new deployment. |
DNSList [config.openshift.io/v1]
- Description
-
DNSList is a list of DNS
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
DNSList [operator.openshift.io/v1]
- Description
-
DNSList is a list of DNS
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of dnses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
DNSRecordList [ingress.operator.openshift.io/v1]
- Description
-
DNSRecordList is a list of DNSRecord
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of dnsrecords. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
DownwardAPIProjection [core/v1]
- Description
-
Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Items is a list of DownwardAPIVolume file |
DownwardAPIVolumeFile [core/v1]
- Description
-
DownwardAPIVolumeFile represents information to create the file containing the pod field
- Type
-
object - Required
-
-
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
|
|
|
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
|
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
DownwardAPIVolumeSource [core/v1]
- Description
-
DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SeLinux relabeling.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
Items is a list of downward API volume file |
egressNetworkPolicyList [network.openshift.io/v1]
- Description
-
egressNetworkPolicyList is a list of egressNetworkPolicy
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of egressnetworkpolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
emptyDirVolumeSource [core/v1]
- Description
-
Represents an empty directory for a pod. empty directory volumes support ownership management and SeLinux relabeling.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
Total amount of local storage required for this emptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium emptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |
endpointAddress [core/v1]
- Description
-
endpointAddress is a tuple that describes single IP address.
- Type
-
object - Required
-
-
ip
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The Hostname of this endpoint |
|
|
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. |
|
|
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. |
|
Reference to object providing the endpoint. |
endpointPort [core/v1]
- Description
-
endpointPort is a tuple that describes a single port.
- Type
-
object - Required
-
-
port
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. Field can be enabled with ServiceAppProtocol feature gate. |
|
|
The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABeL. Optional only if one port is defined. |
|
|
The port number of the endpoint. |
|
|
The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. |
endpointSliceList [discovery.k8s.io/v1beta1]
- Description
-
endpointSliceList represents a list of endpoint slices
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of endpoint slices |
|
|
|
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 |
|
Standard list metadata. |
endpointsList [core/v1]
- Description
-
endpointsList is a list of endpoints.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of endpoints. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
endpointSubset [core/v1]
- Description
-
endpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. |
|
|
IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. |
|
|
Port numbers available on the related IP addresses. |
envFromSource [core/v1]
- Description
-
envFromSource represents the source of a set of ConfigMaps
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
The ConfigMap to select from |
|
|
|
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDeNTIFIeR. |
|
The Secret to select from |
envVar [core/v1]
- Description
-
envVar represents an environment variable present in a Container.
- Type
-
object - Required
-
-
name
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Name of the environment variable. Must be a C_IDeNTIFIeR. |
|
|
Variable references $(VAR_NAMe) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAMe) syntax can be escaped with a double , ie: (VAR_NAMe). escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
|
Source for the environment variable’s value. Cannot be used if value is not empty. |
envVarSource [core/v1]
- Description
-
envVarSource represents a source for the value of an envVar.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Selects a key of a ConfigMap. |
|
|
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
|
|
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
Selects a key of a secret in the pod’s namespace |
ephemeralContainer [core/v1]
- Description
-
An ephemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the ephemeralContainers feature flag.
- Type
-
object - Required
-
-
name
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAMe) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAMe) syntax can be escaped with a double , ie: (VAR_NAMe). escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
|
entrypoint array. Not executed within a shell. The docker image’s eNTRYPOINT is used if this is not provided. Variable references $(VAR_NAMe) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAMe) syntax can be escaped with a double , ie: (VAR_NAMe). escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
List of environment variables to set in the container. Cannot be updated. |
|
|
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDeNTIFIeR. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an env with a duplicate key will take precedence. Cannot be updated. |
|
|
|
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images |
|
|
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
Lifecycle is not allowed for ephemeral containers. |
|
|
Probes are not allowed for ephemeral containers. |
|
|
|
Name of the ephemeral container specified as a DNS_LABeL. This name must be unique among all containers, init containers and ephemeral containers. |
|
Ports are not allowed for ephemeral containers. |
|
|
Probes are not allowed for ephemeral containers. |
|
|
Resources are not allowed for ephemeral containers. ephemeral containers use spare resources already allocated to the pod. |
|
|
SecurityContext is not allowed for ephemeral containers. |
|
|
Probes are not allowed for ephemeral containers. |
|
|
|
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in eOF. Default is false. |
|
|
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an eOF. Default is false |
|
|
If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. |
|
|
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
|
|
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnerror will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
|
|
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
|
volumeDevices is the list of block devices to be used by the container. |
|
|
Pod volumes to mount into the container’s filesystem. Cannot be updated. |
|
|
|
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
etcdList [operator.openshift.io/v1]
- Description
-
etcdList is a list of etcd
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of etcds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
eventList [core/v1]
- Description
-
eventList is a list of events.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of events |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
eventList [events.k8s.io/v1beta1]
- Description
-
eventList is a list of event objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of schema objects. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
eventSeries [core/v1]
- Description
-
eventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Number of occurrences in this series up to the last heartbeat time |
|
Time of the last occurrence observed |
|
|
|
State of this Series: Ongoing or Finished Deprecated. Planned removal for 1.18 |
eventSource [core/v1]
- Description
-
eventSource contains information for an event.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Component from which the event is generated. |
|
|
Node name on which the event is generated. |
eviction [policy/v1beta1]
- Description
-
eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/<pod name>/evictions.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
DeleteOptions may be provided |
|
|
|
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 |
|
ObjectMeta describes the pod that is being evicted. |
execAction [core/v1]
- Description
-
execAction describes a "run in container" action.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
FCVolumeSource [core/v1]
- Description
-
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SeLinux relabeling.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
Optional: FC target lun number |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
Optional: FC target worldwide names (WWNs) |
|
|
Optional: FC volume world wide identifiers (wwids) either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. |
FeatureGateList [config.openshift.io/v1]
- Description
-
FeatureGateList is a list of FeatureGate
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of featuregates. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
FieldsV1 [meta/v1]
- Description
-
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
FlexPersistentVolumeSource [core/v1]
- Description
-
FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.
- Type
-
object - Required
-
-
driver
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Driver is the name of the driver to use for this volume. |
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
|
|
Optional: extra command options if any. |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
FlexVolumeSource [core/v1]
- Description
-
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
- Type
-
object - Required
-
-
driver
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Driver is the name of the driver to use for this volume. |
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
|
|
Optional: extra command options if any. |
|
|
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
FlockerVolumeSource [core/v1]
- Description
-
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SeLinux relabeling.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
|
|
UUID of the dataset. This is unique identifier of a Flocker dataset |
GCePersistentDiskVolumeSource [core/v1]
- Description
-
Represents a Persistent Disk resource in Google Compute engine.
A GCe PD must exist before mounting to a container. The disk must also be in the same GCe project and zone as the kubelet. A GCe PD can only be mounted as read/write once or read-only many times. GCe PDs support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
pdName
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type of the volume that you want to mount. Tip: ensure that the filesystem type is supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
Unique name of the PD resource in GCe. Used to identify the disk in GCe. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
GitRepoVolumeSource [core/v1]
- Description
-
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SeLinux relabeling.
DePReCATeD: GitRepo is deprecated. To provision a container with a git repo, mount an emptyDir into an InitContainer that clones the repo using git, then mount the emptyDir into the Pod's container.
- Type
-
object - Required
-
-
repository
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
|
|
Repository URL |
|
|
Commit hash for the specified revision. |
GlusterfsPersistentVolumeSource [core/v1]
- Description
-
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SeLinux relabeling.
- Type
-
object - Required
-
-
endpoints -
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
endpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
|
|
endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the endpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
|
|
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
|
|
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
GlusterfsVolumeSource [core/v1]
- Description
-
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SeLinux relabeling.
- Type
-
object - Required
-
-
endpoints -
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
endpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
|
|
Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
|
|
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md#create-a-pod |
GroupList [user.openshift.io/v1]
- Description
-
GroupList is a collection of Groups
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of groups |
|
|
|
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 |
|
GroupVersionKind [meta/v1]
- Description
-
GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
- Type
-
object - Required
-
-
group -
version -
kind
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
|
|
|
|
|
|
Handler [core/v1]
- Description
-
Handler defines a specific action that should be taken
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
HTTPGet specifies the http request to perform. |
|
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
HorizontalPodAutoscalerList [autoscaling/v1]
- Description
-
list of horizontal pod autoscaler objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
list of horizontal pod autoscaler objects. |
|
|
|
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 |
|
Standard list metadata. |
HostAlias [core/v1]
- Description
-
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Hostnames for the above IP address. |
|
|
IP address of the host file entry. |
HostPathVolumeSource [core/v1]
- Description
-
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SeLinux relabeling.
- Type
-
object - Required
-
-
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
HostSubnetList [network.openshift.io/v1]
- Description
-
HostSubnetList is a list of HostSubnet
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of hostsubnets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
HTTPGetAction [core/v1]
- Description
-
HTTPGetAction describes an action based on HTTP Get requests.
- Type
-
object - Required
-
-
port
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
|
Custom headers to set in the request. HTTP allows repeated headers. |
|
|
|
Path to access on the HTTP server. |
|
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
|
|
|
Scheme to use for connecting to the host. Defaults to HTTP. |
HTTPHeader [core/v1]
- Description
-
HTTPHeader describes a custom header to be used in HTTP probes
- Type
-
object - Required
-
-
name -
value
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The header field name |
|
|
The header field value |
IdentityList [user.openshift.io/v1]
- Description
-
IdentityList is a collection of Identities
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of identities |
|
|
|
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 |
|
ImageContentSourcePolicyList [operator.openshift.io/v1alpha1]
- Description
-
ImageContentSourcePolicyList is a list of ImageContentSourcePolicy
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of imagecontentsourcepolicies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ImageList [config.openshift.io/v1]
- Description
-
ImageList is a list of Image
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of images. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ImageList [image.openshift.io/v1]
- Description
-
ImageList is a list of Image objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of images |
|
|
|
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 |
|
ImagePrunerList [imageregistry.operator.openshift.io/v1]
- Description
-
ImagePrunerList is a list of ImagePruner
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of imagepruners. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ImageStreamLayers [image.openshift.io/v1]
- Description
-
ImageStreamLayers describes information about the layers referenced by images in this image stream.
- Type
-
object - Required
-
-
blobs -
images
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
blobs is a map of blob name to metadata about the blob. |
|
|
images is a map between an image name and the names of the blobs and config that comprise the image. |
|
|
|
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 |
|
ImageStreamList [image.openshift.io/v1]
- Description
-
ImageStreamList is a list of ImageStream objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of imageStreams |
|
|
|
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 |
|
ImageStreamTagList [image.openshift.io/v1]
- Description
-
ImageStreamTagList is a list of ImageStreamTag objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of image stream tags |
|
|
|
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 |
|
ImageTagList [image.openshift.io/v1]
- Description
-
ImageTagList is a list of ImageTag objects. When listing image tags, the image field is not populated. Tags are returned in alphabetical order by image stream and then tag.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of image stream tags |
|
|
|
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 |
|
InfrastructureList [config.openshift.io/v1]
- Description
-
InfrastructureList is a list of Infrastructure
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of infrastructures. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
IngressClassList [networking.k8s.io/v1beta1]
- Description
-
IngressClassList is a collection of IngressClasses.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of IngressClasses. |
|
|
|
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 |
|
Standard list metadata. |
IngressControllerList [operator.openshift.io/v1]
- Description
-
IngressControllerList is a list of IngressController
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of ingresscontrollers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
IngressList [config.openshift.io/v1]
- Description
-
IngressList is a list of Ingress
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of ingresses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
IngressList [networking.k8s.io/v1beta1]
- Description
-
IngressList is a collection of Ingress.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of Ingress. |
|
|
|
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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
InstallPlanList [operators.coreos.com/v1alpha1]
- Description
-
InstallPlanList is a list of InstallPlan
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of installplans. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
IntOrString [util/intstr]
- Description
-
IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.
- Type
-
string
ISCSIPersistentVolumeSource [core/v1]
- Description
-
ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
targetPortal -
iqn -
lun
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
whether support iSCSI Discovery CHAP authentication |
|
|
whether support iSCSI Session CHAP authentication |
|
|
Filesystem type of the volume that you want to mount. Tip: ensure that the filesystem type is supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
|
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. |
|
|
Target iSCSI Qualified Name. |
|
|
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
|
|
iSCSI Target Lun number. |
|
|
iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
|
|
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
|
CHAP Secret for iSCSI target and initiator authentication |
|
|
|
iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
ISCSIVolumeSource [core/v1]
- Description
-
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
targetPortal -
iqn -
lun
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
whether support iSCSI Discovery CHAP authentication |
|
|
whether support iSCSI Session CHAP authentication |
|
|
Filesystem type of the volume that you want to mount. Tip: ensure that the filesystem type is supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
|
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. |
|
|
Target iSCSI Qualified Name. |
|
|
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). |
|
|
iSCSI Target Lun number. |
|
|
iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
|
|
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
|
CHAP Secret for iSCSI target and initiator authentication |
|
|
|
iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
JobList [batch/v1]
- Description
-
JobList is a collection of jobs.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is the list of Jobs. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
KeyToPath [core/v1]
- Description
-
Maps a string key to a path within a volume.
- Type
-
object - Required
-
-
key -
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The key to project. |
|
|
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
|
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
KubeAPIServerList [operator.openshift.io/v1]
- Description
-
KubeAPIServerList is a list of KubeAPIServer
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of kubeapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
KubeControllerManagerList [operator.openshift.io/v1]
- Description
-
KubeControllerManagerList is a list of KubeControllerManager
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of kubecontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
KubeletConfigList [machineconfiguration.openshift.io/v1]
- Description
-
KubeletConfigList is a list of KubeletConfig
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of kubeletconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
KubeSchedulerList [operator.openshift.io/v1]
- Description
-
KubeSchedulerList is a list of KubeScheduler
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of kubeschedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
KubeStorageVersionMigratorList [operator.openshift.io/v1]
- Description
-
KubeStorageVersionMigratorList is a list of KubeStorageVersionMigrator
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of kubestorageversionmigrators. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
LabelSelector [meta/v1]
- Description
-
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.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
matchexpressions is a list of label selector requirements. The requirements are ANDed. |
|
|
|
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 [meta/v1]
- Description
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
-
key -
operator
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
key is the label key that the selector applies to. |
|
|
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist. |
|
|
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. |
LeaseList [coordination.k8s.io/v1]
- Description
-
LeaseList is a list of Lease objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of schema objects. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
Lifecycle [core/v1]
- Description
-
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
|
PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod’s termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
LimitRangeItem [core/v1]
- Description
-
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
- Type
-
object - Required
-
-
type
-
Specification
| Property | Type | Description |
|---|---|---|
|
Default resource requirement limit value by resource name if resource limit is omitted. |
|
|
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. |
|
|
Max usage constraints on this kind by resource name. |
|
|
MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. |
|
|
Min usage constraints on this kind by resource name. |
|
|
|
Type of resource that this limit applies to. |
LimitRangeList [core/v1]
- Description
-
LimitRangeList is a list of LimitRange items.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
ListMeta [meta/v1]
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
LoadBalancerIngress [core/v1]
- Description
-
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) |
|
|
IP is set for load-balancer ingress points that are IP based (typically GCe or OpenStack load-balancers) |
LoadBalancerStatus [core/v1]
- Description
-
LoadBalancerStatus represents the status of a load-balancer.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
LocalObjectReference [core/v1]
- Description
-
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
LocalVolumeSource [core/v1]
- Description
-
Local represents directly-attached storage with node affinity (Beta feature)
- Type
-
object - Required
-
-
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. |
|
|
The full path to the volume on the node. It can be either a directory or block device (disk, partition, …). |
MachineAutoscalerList [autoscaling.openshift.io/v1beta1]
- Description
-
MachineAutoscalerList is a list of MachineAutoscaler
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of machineautoscalers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
MachineConfigList [machineconfiguration.openshift.io/v1]
- Description
-
MachineConfigList is a list of MachineConfig
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of machineconfigs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
MachineConfigPoolList [machineconfiguration.openshift.io/v1]
- Description
-
MachineConfigPoolList is a list of MachineConfigPool
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of machineconfigpools. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
MachineHealthCheckList [machine.openshift.io/v1beta1]
- Description
-
MachineHealthCheckList is a list of MachineHealthCheck
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of machinehealthchecks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
MachineList [machine.openshift.io/v1beta1]
- Description
-
MachineList is a list of Machine
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of machines. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
MachineSetList [machine.openshift.io/v1beta1]
- Description
-
MachineSetList is a list of MachineSet
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of machinesets. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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 [meta/v1]
- Description
-
ManagedFieldsentry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" |
|
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. |
|
|
|
Manager is an identifier of the workflow managing these fields. |
|
|
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 is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' |
MicroTime [meta/v1]
- Description
-
MicroTime is version of Time with microsecond level precision.
- Type
-
string
MutatingWebhookConfigurationList [admissionregistration.k8s.io/v1]
- Description
-
MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of MutatingWebhookConfiguration. |
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
NamespaceCondition [core/v1]
- Description
-
NamespaceCondition contains details about state of namespace.
- Type
-
object - Required
-
-
type -
status
-
Specification
| Property | Type | Description |
|---|---|---|
|
||
|
|
|
|
|
|
|
|
Status of the condition, one of True, False, Unknown. |
|
|
Type of namespace controller condition. |
NamespaceList [core/v1]
- Description
-
NamespaceList is a list of Namespaces.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
NetNamespaceList [network.openshift.io/v1]
- Description
-
NetNamespaceList is a list of NetNamespace
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of netnamespaces. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
NetworkAttachmentDefinitionList [k8s.cni.cncf.io/v1]
- Description
-
NetworkAttachmentDefinitionList is a list of NetworkAttachmentDefinition
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of network-attachment-definitions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
NetworkList [config.openshift.io/v1]
- Description
-
NetworkList is a list of Network
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
NetworkList [operator.openshift.io/v1]
- Description
-
NetworkList is a list of Network
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of networks. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
NetworkPolicyList [networking.k8s.io/v1]
- Description
-
NetworkPolicyList is a list of NetworkPolicy objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of schema objects. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
NFSVolumeSource [core/v1]
- Description
-
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SeLinux relabeling.
- Type
-
object - Required
-
-
server -
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
NodeAddress [core/v1]
- Description
-
NodeAddress contains information for the node's address.
- Type
-
object - Required
-
-
type -
address
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The node address. |
|
|
Node address type, one of Hostname, externalIP or InternalIP. |
NodeAffinity [core/v1]
- Description
-
Node affinity is a group of node affinity scheduling rules.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchexpressions; the node(s) with the highest sum are the most preferred. |
|
|
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
NodeCondition [core/v1]
- Description
-
NodeCondition contains condition information for a node.
- Type
-
object - Required
-
-
type -
status
-
Specification
| Property | Type | Description |
|---|---|---|
|
Last time we got an update on a given condition. |
|
|
Last time the condition transit from one status to another. |
|
|
|
Human readable message indicating details about last transition. |
|
|
(brief) reason for the condition’s last transition. |
|
|
Status of the condition, one of True, False, Unknown. |
|
|
Type of node condition. |
NodeConfigSource [core/v1]
- Description
-
NodeConfigSource specifies a source of node configuration. exactly one subfield (excluding metadata) must be non-nil.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
ConfigMap is a reference to a Node’s ConfigMap |
NodeDaemonendpoints [core/v1]
- Description
-
NodeDaemonendpoints lists ports opened by daemons running on the Node.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
endpoint on which Kubelet is listening. |
NodeList [core/v1]
- Description
-
NodeList is the whole list of all Nodes which have been registered with master.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of nodes |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
NodeSelector [core/v1]
- Description
-
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
- Type
-
object - Required
-
-
nodeSelectorTerms
-
Specification
| Property | Type | Description |
|---|---|---|
|
Required. A list of node selector terms. The terms are ORed. |
NodeSelectorRequirement [core/v1]
- Description
-
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
- Type
-
object - Required
-
-
key -
operator
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The label key that the selector applies to. |
|
|
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. Gt, and Lt. |
|
|
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. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
NodeSelectorTerm [core/v1]
- Description
-
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
A list of node selector requirements by node’s labels. |
|
|
A list of node selector requirements by node’s fields. |
NodeSystemInfo [core/v1]
- Description
-
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
- Type
-
object - Required
-
-
machineID -
systemUUID -
bootID -
kernelVersion -
osImage -
containerRuntimeVersion -
kubeletVersion -
kubeProxyVersion -
operatingSystem -
architecture
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The Architecture reported by the node |
|
|
Boot ID reported by the node. |
|
|
ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). |
|
|
Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). |
|
|
KubeProxy Version reported by the node. |
|
|
Kubelet Version reported by the node. |
|
|
MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html |
|
|
The Operating System reported by the node |
|
|
OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). |
|
|
SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html |
OAuthAccessTokenList [oauth.openshift.io/v1]
- Description
-
OAuthAccessTokenList is a collection of OAuth access tokens
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of OAuth access tokens |
|
|
|
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 |
|
OAuthAuthorizeTokenList [oauth.openshift.io/v1]
- Description
-
OAuthAuthorizeTokenList is a collection of OAuth authorization tokens
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of OAuth authorization tokens |
|
|
|
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 |
|
OAuthClientAuthorizationList [oauth.openshift.io/v1]
- Description
-
OAuthClientAuthorizationList is a collection of OAuth client authorizations
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of OAuth client authorizations |
|
|
|
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 |
|
OAuthClientList [oauth.openshift.io/v1]
- Description
-
OAuthClientList is a collection of OAuth clients
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of OAuth clients |
|
|
|
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 |
|
OAuthList [config.openshift.io/v1]
- Description
-
OAuthList is a list of OAuth
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of oauths. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ObjectFieldSelector [core/v1]
- Description
-
ObjectFieldSelector selects an APIVersioned field of an object.
- Type
-
object - Required
-
-
fieldPath
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
|
|
Path of the field to select in the specified API version. |
ObjectMeta [meta/v1]
- Description
-
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
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 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 |
|
|
|
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 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 |
|
|
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
|
|
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 |
|
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 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 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 |
|
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. |
|
|
|
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 |
|
|
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 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 |
ObjectReference [core/v1]
- Description
-
ObjectReference contains enough information to let you inspect or modify the referred object.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
API version of the referent. |
|
|
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. |
|
|
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
OpenShiftAPIServerList [operator.openshift.io/v1]
- Description
-
OpenShiftAPIServerList is a list of OpenShiftAPIServer
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of openshiftapiservers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
OpenShiftControllerManagerList [operator.openshift.io/v1]
- Description
-
OpenShiftControllerManagerList is a list of OpenShiftControllerManager
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of openshiftcontrollermanagers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
OperatorGroupList [operators.coreos.com/v1]
- Description
-
OperatorGroupList is a list of OperatorGroup
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of operatorgroups. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
OperatorHubList [config.openshift.io/v1]
- Description
-
OperatorHubList is a list of OperatorHub
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of operatorhubs. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
OperatorSourceList [operators.coreos.com/v1]
- Description
-
OperatorSourceList is a list of OperatorSource
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of operatorsources. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
OwnerReference [meta/v1]
- Description
-
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.
- Type
-
object - Required
-
-
apiVersion -
kind -
name -
uid
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
API version of the referent. |
|
|
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. |
|
|
If true, this reference points to the managing controller. |
|
|
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
|
|
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
PackageManifestList [packages.operators.coreos.com/v1]
- Description
-
PackageManifestList is a list of PackageManifest objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
||
|
|
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 |
|
Patch [meta/v1]
- Description
-
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
- Type
-
object
PersistentVolumeClaim [core/v1]
- Description
-
PersistentVolumeClaim is a user's request for and claim to a persistent volume
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes |
|
|
PersistentVolumeClaimStatus is the current status of a persistent volume claim. |
.spec
- Description
-
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot - Beta) * An existing PVC (PersistentVolumeClaim) * An existing custom resource/object that implements data population (Alpha) In order to use VolumeSnapshot object types, the appropriate feature gate must be enabled (VolumeSnapshotDataSource or AnyVolumeDataSource) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the specified data source is not supported, the 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 represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
|
A label query over volumes to consider for binding. |
|
|
|
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
|
volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
|
|
VolumeName is the binding reference to the PersistentVolume backing this claim. |
.status
- Description
-
PersistentVolumeClaimStatus is the current status of a persistent volume claim.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
|
Represents the actual resources of the underlying volume. |
|
|
Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. |
|
|
|
Phase represents the current phase of PersistentVolumeClaim. |
PersistentVolumeClaimCondition [core/v1]
- Description
-
PersistentVolumeClaimCondition contails details about state of pvc
- Type
-
object - Required
-
-
type -
status
-
Specification
| Property | Type | Description |
|---|---|---|
|
Last time we probed the condition. |
|
|
Last time the condition transitioned from one status to another. |
|
|
|
Human-readable message indicating details about last transition. |
|
|
Unique, this should be a short, machine understandable string that gives the reason for condition’s last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. |
|
|
|
|
|
PersistentVolumeClaimList [core/v1]
- Description
-
PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
PersistentVolumeClaimVolumeSource [core/v1]
- Description
-
PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
- Type
-
object - Required
-
-
claimName
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
Will force the ReadOnly setting in VolumeMounts. Default false. |
PersistentVolumeList [core/v1]
- Description
-
PersistentVolumeList is a list of PersistentVolume items.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
PersistentVolumeSpec [core/v1]
- Description
-
PersistentVolumeSpec is the specification of a persistent volume.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
|
AWSelasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
|
|
AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
|
|
A description of the persistent volume’s resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
|
|
CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
|
|
Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
|
ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding |
|
|
CSI represents storage that is handled by an external CSI driver (Beta feature). |
|
|
FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
|
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
|
|
Flocker represents a Flocker volume attached to a kubelet’s host machine and exposed to the pod for its usage. This depends on the Flocker control service being running |
|
|
GCePersistentDisk represents a GCe Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md |
|
|
HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. |
|
|
Local represents directly-attached storage with node affinity |
|
|
|
A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
|
NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. |
|
|
|
What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming |
|
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
|
|
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
|
|
Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
|
|
RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md |
|
|
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
|
|
|
Name of StorageClass to which this persistent volume belongs. empty value means that this volume does not belong to any StorageClass. |
|
StorageOS represents a StorageOS volume that is attached to the kubelet’s host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/ReADMe.md |
|
|
|
volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. |
|
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
PhotonPersistentDiskVolumeSource [core/v1]
- Description
-
Represents a Photon Controller persistent disk resource.
- Type
-
object - Required
-
-
pdID
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
ID that identifies Photon Controller persistent disk |
PodAffinity [core/v1]
- Description
-
Pod affinity is a group of inter pod affinity scheduling rules.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
|
|
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
PodAffinityTerm [core/v1]
- Description
-
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running
- Type
-
object - Required
-
-
topologyKey
-
Specification
| Property | Type | Description |
|---|---|---|
|
A label query over a set of resources, in this case pods. |
|
|
|
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod’s namespace" |
|
|
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. empty topologyKey is not allowed. |
PodAntiAffinity [core/v1]
- Description
-
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
|
|
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. |
PodCondition [core/v1]
- Description
-
PodCondition contains details for the current condition of this pod.
- Type
-
object - Required
-
-
type -
status
-
Specification
| Property | Type | Description |
|---|---|---|
|
Last time we probed the condition. |
|
|
Last time the condition transitioned from one status to another. |
|
|
|
Human-readable message indicating details about last transition. |
|
|
Unique, one-word, CamelCase reason for the condition’s last transition. |
|
|
Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
|
|
Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
PodDisruptionBudgetList [policy/v1beta1]
- Description
-
PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
||
|
|
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 |
|
PodDNSConfig [core/v1]
- Description
-
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. |
|
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. |
|
|
|
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. |
PodDNSConfigOption [core/v1]
- Description
-
PodDNSConfigOption defines DNS resolver options of a pod.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Required. |
|
|
PodIP [core/v1]
- Description
-
IP address information for entries in the (plural) PodIPs field. each entry includes: IP: An IP address allocated to the pod. Routable at least within the cluster.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
ip is an IP address (IPv4 or IPv6) assigned to the pod |
PodList [core/v1]
- Description
-
PodList is a list of Pods.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
PodMonitorList [monitoring.coreos.com/v1]
- Description
-
PodMonitorList is a list of PodMonitor
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of podmonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
PodReadinessGate [core/v1]
- Description
-
PodReadinessGate contains the reference to a pod condition
- Type
-
object - Required
-
-
conditionType
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
ConditionType refers to a condition in the pod’s condition list with matching type. |
PodSecurityContext [core/v1]
- Description
-
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. |
|
|
fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified defaults to "Always". |
|
|
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
|
|
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
|
The SeLinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SeLinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
|
|
|
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container. |
|
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. |
|
|
The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
PodSpec [core/v1]
- Description
-
PodSpec is a description of a pod.
- Type
-
object - Required
-
-
containers
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
|
If specified, the pod’s scheduling constraints |
|
|
|
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
|
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. |
|
|
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
|
|
|
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. |
|
|
enableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true. |
|
List of ephemeral containers run in this pod. ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod’s ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the ephemeralContainers feature. |
|
|
HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods. |
|
|
|
Use the host’s ipc namespace. Optional: Default to false. |
|
|
Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false. |
|
|
Use the host’s pid namespace. Optional: Default to false. |
|
|
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value. |
|
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
|
|
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
|
|
|
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. |
|
|
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
|
Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. |
|
|
|
PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. |
|
|
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. |
|
|
If specified, indicates the pod’s priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. |
|
If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md |
|
|
|
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy |
|
|
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. |
|
|
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
|
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
|
|
|
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
|
|
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
|
|
Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. |
|
|
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
|
|
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
|
If specified, the pod’s tolerations. |
|
|
TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. This field is only honored by clusters that enable the evenPodsSpread feature. All topologySpreadConstraints are ANDed. |
|
|
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes |
PodTemplateList [core/v1]
- Description
-
PodTemplateList is a list of PodTemplates.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of pod templates |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
PodTemplateSpec [core/v1]
- Description
-
PodTemplateSpec describes the data a pod should have when created from a template
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
PortworxVolumeSource [core/v1]
- Description
-
PortworxVolumeSource represents a Portworx volume resource.
- Type
-
object - Required
-
-
volumeID
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
|
VolumeID uniquely identifies a Portworx volume |
PreferredSchedulingTerm [core/v1]
- Description
-
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
- Type
-
object - Required
-
-
weight -
preference
-
Specification
| Property | Type | Description |
|---|---|---|
|
A node selector term, associated with the corresponding weight. |
|
|
|
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
PriorityClassList [scheduling.k8s.io/v1]
- Description
-
PriorityClassList is a collection of priority classes.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is the list of PriorityClasses |
|
|
|
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 |
|
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
Probe [core/v1]
- Description
-
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
One and only one of the following should be specified. exec specifies the action to take. |
|
|
|
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
|
HTTPGet specifies the http request to perform. |
|
|
|
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
|
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
|
|
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
|
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
|
|
|
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
ProfileList [tuned.openshift.io/v1]
- Description
-
ProfileList is a list of Profile
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of profiles. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ProjectedVolumeSource [core/v1]
- Description
-
Represents a projected volume source
- Type
-
object - Required
-
-
sources
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
list of volume projections |
ProjectList [config.openshift.io/v1]
- Description
-
ProjectList is a list of Project
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of projects. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ProjectList [project.openshift.io/v1]
- Description
-
ProjectList is a list of Project objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of projects |
|
|
|
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 |
|
PrometheusList [monitoring.coreos.com/v1]
- Description
-
PrometheusList is a list of Prometheus
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of prometheuses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
PrometheusRuleList [monitoring.coreos.com/v1]
- Description
-
PrometheusRuleList is a list of PrometheusRule
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of prometheusrules. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ProxyList [config.openshift.io/v1]
- Description
-
ProxyList is a list of Proxy
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of proxies. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
Quantity [api/resource]
- Description
-
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
QuobyteVolumeSource [core/v1]
- Description
-
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SeLinux relabeling.
- Type
-
object - Required
-
-
registry -
volume
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Group to map volume access to Default is no group |
|
|
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
|
|
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
|
|
Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin |
|
|
User to map volume access to Defaults to serivceaccount user |
|
|
Volume is a string that references an already created Quobyte volume by name. |
RangeAllocationList [security.openshift.io/v1]
- Description
-
RangeAllocationList is a list of RangeAllocations objects
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of RangeAllocations. |
|
|
|
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 |
|
Rawextension [pkg/runtime]
- Description
-
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.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
RBDPersistentVolumeSource [core/v1]
- Description
-
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
monitors -
image
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type of the volume that you want to mount. Tip: ensure that the filesystem type is supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
|
The rados image name. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
|
The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
RBDVolumeSource [core/v1]
- Description
-
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SeLinux relabeling.
- Type
-
object - Required
-
-
monitors -
image
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type of the volume that you want to mount. Tip: ensure that the filesystem type is supported by the host operating system. examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
|
The rados image name. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
|
|
|
The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md#how-to-use-it |
ReplicaSetList [apps/v1]
- Description
-
ReplicaSetList is a collection of ReplicaSets.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
ReplicationControllerCondition [core/v1]
- Description
-
ReplicationControllerCondition describes the state of a replication controller at a certain point.
- Type
-
object - Required
-
-
type -
status
-
Specification
| Property | Type | Description |
|---|---|---|
|
The last time the condition transitioned from one status to another. |
|
|
|
A human readable message indicating details about the transition. |
|
|
The reason for the condition’s last transition. |
|
|
Status of the condition, one of True, False, Unknown. |
|
|
Type of replication controller condition. |
ReplicationControllerList [core/v1]
- Description
-
ReplicationControllerList is a collection of replication controllers.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
ResourceFieldSelector [core/v1]
- Description
-
ResourceFieldSelector represents container resources (cpu, memory) and their output format
- Type
-
object - Required
-
-
resource
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Container name: required for volumes, optional for env vars |
|
Specifies the output format of the exposed resources, defaults to "1" |
|
|
|
Required: resource to select |
ResourceQuotaList [core/v1]
- Description
-
ResourceQuotaList is a list of ResourceQuota items.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
ResourceQuotaSpec [core/v1]
- Description
-
ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
|
|
scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. |
|
|
|
A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |
ResourceQuotaStatus [core/v1]
- Description
-
ResourceQuotaStatus defines the enforced hard limits and observed use.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
|
|
Used is the current observed total usage of the resource in the namespace. |
ResourceRequirements [core/v1]
- Description
-
ResourceRequirements describes the compute resource requirements.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
|
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/ |
RoleBindingList [authorization.openshift.io/v1]
- Description
-
RoleBindingList is a collection of RoleBindings
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of RoleBindings |
|
|
|
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 |
|
RoleBindingList [rbac.authorization.k8s.io/v1]
- Description
-
RoleBindingList is a collection of RoleBindings
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of RoleBindings |
|
|
|
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 |
|
Standard object’s metadata. |
RoleBindingRestrictionList [authorization.openshift.io/v1]
- Description
-
RoleBindingRestrictionList is a list of RoleBindingRestriction
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of rolebindingrestrictions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
RoleList [authorization.openshift.io/v1]
- Description
-
RoleList is a collection of Roles
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of Roles |
|
|
|
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 |
|
RoleList [rbac.authorization.k8s.io/v1]
- Description
-
RoleList is a collection of Roles
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of Roles |
|
|
|
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 |
|
Standard object’s metadata. |
RouteList [route.openshift.io/v1]
- Description
-
RouteList is a collection of Routes.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is a list of routes |
|
|
|
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 |
|
RuntimeClassList [node.k8s.io/v1beta1]
- Description
-
RuntimeClassList is a list of RuntimeClass objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of schema objects. |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
Scale [autoscaling/v1]
- Description
-
Scale represents a scaling request for a resource.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
|
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
|
|
defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. |
|
|
current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. |
Scale [extensions/v1beta1]
- Description
-
represents a scaling request for a resource.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
|
Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
|
|
defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. |
|
|
current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. |
ScaleIOPersistentVolumeSource [core/v1]
- Description
-
ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
- Type
-
object - Required
-
-
gateway -
system -
secretRef
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Default is "xfs" |
|
|
The host address of the ScaleIO API Gateway. |
|
|
The name of the ScaleIO Protection Domain for the configured storage. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
|
|
Flag to enable/disable SSL communication with Gateway, default false |
|
|
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
|
|
The ScaleIO Storage Pool associated with the protection domain. |
|
|
The name of the storage system as configured in ScaleIO. |
|
|
The name of a volume already created in the ScaleIO system that is associated with this volume source. |
ScaleIOVolumeSource [core/v1]
- Description
-
ScaleIOVolumeSource represents a persistent ScaleIO volume
- Type
-
object - Required
-
-
gateway -
system -
secretRef
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Default is "xfs". |
|
|
The host address of the ScaleIO API Gateway. |
|
|
The name of the ScaleIO Protection Domain for the configured storage. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
|
|
|
Flag to enable/disable SSL communication with Gateway, default false |
|
|
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. |
|
|
The ScaleIO Storage Pool associated with the protection domain. |
|
|
The name of the storage system as configured in ScaleIO. |
|
|
The name of a volume already created in the ScaleIO system that is associated with this volume source. |
SchedulerList [config.openshift.io/v1]
- Description
-
SchedulerList is a list of Scheduler
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of schedulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ScopedResourceSelectorRequirement [core/v1]
- Description
-
A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.
- Type
-
object - Required
-
-
scopeName -
operator
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Represents a scope’s relationship to a set of values. Valid operators are In, NotIn, exists, DoesNotexist. |
|
|
The name of the scope that the selector applies to. |
|
|
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. |
ScopeSelector [core/v1]
- Description
-
A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
A list of scope selector requirements by scope of the resources. |
SecretenvSource [core/v1]
- Description
-
SecretenvSource selects a Secret to populate the environment variables with.
The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret must be defined |
SecretKeySelector [core/v1]
- Description
-
SecretKeySelector selects a key of a Secret.
- Type
-
object - Required
-
-
key
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The key of the secret to select from. Must be a valid secret key. |
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
SecretList [core/v1]
- Description
-
SecretList is a list of Secret.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
SecretProjection [core/v1]
- Description
-
Adapts a secret into a projected volume.
The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Specify whether the Secret or its key must be defined |
SecretReference [core/v1]
- Description
-
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Name is unique within a namespace to reference a secret resource. |
|
|
Namespace defines the space within which the secret name must be unique. |
SecretVolumeSource [core/v1]
- Description
-
Adapts a Secret into a volume.
The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SeLinux relabeling.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
|
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
|
|
|
Specify whether the Secret or its keys must be defined |
|
|
Name of the secret in the pod’s namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
SecurityContext [core/v1]
- Description
-
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
AllowPrivilegeescalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeescalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
|
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
|
|
|
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
|
|
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. |
|
|
Whether this container has a read-only root filesystem. Default is false. |
|
|
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
The SeLinux context to be applied to the container. If unspecified, the container runtime will allocate a random SeLinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
|
|
The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
SecurityContextConstraintsList [security.openshift.io/v1]
- Description
-
SecurityContextConstraintsList is a list of SecurityContextConstraints
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of securitycontextconstraints. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
SeLinuxOptions [core/v1]
- Description
-
SeLinuxOptions are the labels to be applied to the container
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Level is SeLinux level label that applies to the container. |
|
|
Role is a SeLinux role label that applies to the container. |
|
|
Type is a SeLinux type label that applies to the container. |
|
|
User is a SeLinux user label that applies to the container. |
ServiceAccountList [core/v1]
- Description
-
ServiceAccountList is a list of ServiceAccount objects
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
ServiceAccountTokenProjection [core/v1]
- Description
-
ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).
- Type
-
object - Required
-
-
path
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. |
|
|
expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. |
|
|
Path is the path relative to the mount point of the file to project the token into. |
ServiceCAList [operator.openshift.io/v1]
- Description
-
ServiceCAList is a list of ServiceCA
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of servicecas. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ServiceList [core/v1]
- Description
-
ServiceList holds a list of services.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of services |
|
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
ServiceMonitorList [monitoring.coreos.com/v1]
- Description
-
ServiceMonitorList is a list of ServiceMonitor
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of servicemonitors. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
ServicePort [core/v1]
- Description
-
ServicePort contains information on service's port.
- Type
-
object - Required
-
-
port
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. Field can be enabled with ServiceAppProtocol feature gate. |
|
|
The name of this port within the service. This must be a DNS_LABeL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the endpointPort. Optional if only one ServicePort is defined on this service. |
|
|
The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport |
|
|
The port that will be exposed by this service. |
|
|
The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. |
|
Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service |
SessionAffinityConfig [core/v1]
- Description
-
SessionAffinityConfig represents the configurations of session affinity.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
clientIP contains the configurations of Client IP based session affinity. |
StatefulSetList [apps/v1]
- Description
-
StatefulSetList is a collection of StatefulSets.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
||
|
|
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 |
|
Status [meta/v1]
- Description
-
Status is a return value for calls that don't return other objects.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
Suggested HTTP return code for this status, 0 if not set. |
|
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 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 |
|
|
A human-readable description of the status of this operation. |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
|
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 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 |
StatusCause [meta/v1]
- Description
-
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
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" |
|
|
A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
|
|
A machine-readable description of the cause of the error. If this value is empty there is no information available. |
StatusDetails [meta/v1]
- Description
-
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.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
|
|
|
The group attribute of the resource associated with the status StatusReason. |
|
|
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 |
|
|
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
|
|
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 of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
StorageClassList [storage.k8s.io/v1]
- Description
-
StorageClassList is a collection of storage classes.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of StorageClasses |
|
|
|
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 |
|
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
StorageOSPersistentVolumeSource [core/v1]
- Description
-
Represents a StorageOS persistent volume resource.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
|
|
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
|
|
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
StorageOSVolumeSource [core/v1]
- Description
-
Represents a StorageOS persistent volume resource.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
|
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. |
|
|
|
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. |
|
|
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod’s namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. |
SubscriptionList [operators.coreos.com/v1alpha1]
- Description
-
SubscriptionList is a list of Subscription
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of subscriptions. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
Sysctl [core/v1]
- Description
-
Sysctl defines a kernel parameter to be set
- Type
-
object - Required
-
-
name -
value
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Name of a property to set |
|
|
Value of a property to set |
Taint [core/v1]
- Description
-
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
- Type
-
object - Required
-
-
key -
effect
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and Noexecute. |
|
|
Required. The taint key to be applied to a node. |
|
TimeAdded represents the time at which the taint was added. It is only written for Noexecute taints. |
|
|
|
The taint value corresponding to the taint key. |
TCPSocketAction [core/v1]
- Description
-
TCPSocketAction describes an action based on opening a socket
- Type
-
object - Required
-
-
port
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Optional: Host name to connect to, defaults to the pod IP. |
|
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAMe. |
TemplateInstanceList [template.openshift.io/v1]
- Description
-
TemplateInstanceList is a list of TemplateInstance objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
items is a list of Templateinstances |
|
|
|
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 |
|
ThanosRulerList [monitoring.coreos.com/v1]
- Description
-
ThanosRulerList is a list of ThanosRuler
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of thanosrulers. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
Time [meta/v1]
- Description
-
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
TokenRequest [authentication.k8s.io/v1]
- Description
-
TokenRequest requests a token for a given service account.
- Type
-
object - Required
-
-
spec
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
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 |
|
||
|
||
|
Toleration [core/v1]
- Description
-
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
effect indicates the taint effect to match. empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and Noexecute. |
|
|
Key is the taint key that the toleration applies to. empty means match all taint keys. If the key is empty, operator must be exists; this combination means to match all values and all keys. |
|
|
Operator represents a key’s relationship to the value. Valid operators are exists and equal. Defaults to equal. exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
|
|
TolerationSeconds represents the period of time the toleration (which must be of effect Noexecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
|
|
Value is the taint value the toleration matches to. If the operator is exists, the value should be empty, otherwise just a regular string. |
TopologySelectorLabelRequirement [core/v1]
- Description
-
A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.
- Type
-
object - Required
-
-
key -
values
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
The label key that the selector applies to. |
|
|
An array of string values. One value must match the label to be selected. each entry in Values is ORed. |
TopologySelectorTerm [core/v1]
- Description
-
A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
A list of topology selector requirements by labels. |
TopologySpreadConstraint [core/v1]
- Description
-
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
- Type
-
object - Required
-
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
Specification
| Property | Type | Description |
|---|---|---|
|
LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. |
|
|
|
MaxSkew describes the degree to which pods may be unevenly distributed. It’s the maximum permitted difference between the number of matching pods in any two topology domains of a given topology type. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. It’s a required field. Default value is 1 and 0 is not allowed. |
|
|
TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It’s a required field. |
|
|
WhenUnsatisfiable indicates how to deal with a pod if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it - ScheduleAnyway tells the scheduler to still schedule it It’s considered as "Unsatisfiable" if and only if placing incoming pod on any topology violates "MaxSkew". For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won’t make it more imbalanced. It’s a required field. |
TunedList [tuned.openshift.io/v1]
- Description
-
TunedList is a list of Tuned
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of tuneds. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
TypedLocalObjectReference [core/v1]
- Description
-
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
- Type
-
object - Required
-
-
kind -
name
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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. |
|
|
Kind is the type of resource being referenced |
|
|
Name is the name of resource being referenced |
UserList [user.openshift.io/v1]
- Description
-
UserList is a collection of Users
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of users |
|
|
|
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 |
|
ValidatingWebhookConfigurationList [admissionregistration.k8s.io/v1]
- Description
-
ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of ValidatingWebhookConfiguration. |
|
|
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 |
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
Volume [core/v1]
- Description
-
Volume represents a named volume in a pod that may be accessed by any container in the pod.
- Type
-
object - Required
-
-
name
-
Specification
| Property | Type | Description |
|---|---|---|
|
AWSelasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
|
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
|
|
AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
|
|
CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
|
|
Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/ReADMe.md |
|
|
ConfigMap represents a configMap that should populate this volume |
|
|
CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature). |
|
|
DownwardAPI represents downward API about the pod that should populate this volume |
|
|
emptyDir represents a temporary directory that shares a pod’s lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
|
FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
|
|
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
|
|
Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running |
|
|
GCePersistentDisk represents a GCe Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
|
GitRepo represents a git repository at a particular revision. DePReCATeD: GitRepo is deprecated. To provision a container with a git repo, mount an emptyDir into an InitContainer that clones the repo using git, then mount the emptyDir into the Pod’s container. |
|
|
Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/ReADMe.md |
|
|
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
|
ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/ReADMe.md |
|
|
|
Volume’s name. Must be a DNS_LABeL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
NFS represents an NFS mount on the host that shares a pod’s lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
|
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
|
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
|
|
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
|
|
Items for all in one resources secrets, configmaps, and downward API |
|
|
Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
|
|
RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: https://examples.k8s.io/volumes/rbd/ReADMe.md |
|
|
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
|
|
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
|
StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. |
|
|
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
VolumeAttachmentList [storage.k8s.io/v1]
- Description
-
VolumeAttachmentList is a collection of VolumeAttachment objects.
- Type
-
object - Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
Items is the list of VolumeAttachments |
|
|
|
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 |
|
Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
VolumeDevice [core/v1]
- Description
-
volumeDevice describes a mapping of a raw block device within a container.
- Type
-
object - Required
-
-
name -
devicePath
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
devicePath is the path inside of the container that the device will be mapped to. |
|
|
name must match the name of a persistentVolumeClaim in the pod |
VolumeMount [core/v1]
- Description
-
VolumeMount describes a mounting of a Volume within a container.
- Type
-
object - Required
-
-
name -
mountPath
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Path within the container at which the volume should be mounted. Must not contain ':'. |
|
|
mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. |
|
|
This must match the Name of a Volume. |
|
|
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
|
|
Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
|
|
expanded path within the volume from which the container’s volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAMe) are expanded using the container’s environment. Defaults to "" (volume’s root). SubPathexpr and SubPath are mutually exclusive. |
VolumeNodeAffinity [core/v1]
- Description
-
VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
Required specifies hard node constraints that must be met. |
VolumeProjection [core/v1]
- Description
-
Projection that may be projected along with other supported volume types
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
information about the configMap data to project |
|
|
information about the downwardAPI data to project |
|
|
information about the secret data to project |
|
|
information about the serviceAccountToken data to project |
VolumeSnapshotClassList [snapshot.storage.k8s.io/v1beta1]
- Description
-
VolumeSnapshotClassList is a list of VolumeSnapshotClass
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of volumesnapshotclasses. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
VolumeSnapshotContentList [snapshot.storage.k8s.io/v1beta1]
- Description
-
VolumeSnapshotContentList is a list of VolumeSnapshotContent
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
|
List of volumesnapshotcontents. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
VolumeSnapshotList [snapshot.storage.k8s.io/v1beta1]
- Description
-
VolumeSnapshotList is a list of VolumeSnapshot
- Type
-
``
- Required
-
-
items
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
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 |
|
List of volumesnapshots. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
|
|
|
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 |
|
|
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. |
.metadata
- Description
-
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
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 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. |
|
|
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 |
|
|
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. |
VsphereVirtualDiskVolumeSource [core/v1]
- Description
-
Represents a vSphere volume resource.
- Type
-
object - Required
-
-
volumePath
-
Specification
| Property | Type | Description |
|---|---|---|
|
|
Filesystem type to mount. Must be a filesystem type supported by the host operating system. ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
|
|
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. |
|
|
Storage Policy Based Management (SPBM) profile name. |
|
|
Path that identifies vSphere volume vmdk |
WeightedPodAffinityTerm [core/v1]
- Description
-
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
- Type
-
object - Required
-
-
weight -
podAffinityTerm
-
Specification
| Property | Type | Description |
|---|---|---|
|
Required. A pod affinity term, associated with the corresponding weight. |
|
|
|
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
WindowsSecurityContextOptions [core/v1]
- Description
-
WindowsSecurityContextOptions contain Windows-specific options and credentials.
- Type
-
object
Specification
| Property | Type | Description |
|---|---|---|
|
|
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
|
|
GMSACredentialSpecName is the name of the GMSA credential spec to use. |
|
|
The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |