Module models

Source

Structs§

Affinity
AppConfig
goland:noinspection GoDeprecation
AuthConfig
AuthConfig contains authorization information for connecting to a Registry
AuthResponseBody
AuthenticateOkBody
AuthenticateOKBody authenticate o k body
AuthorizationRequest
AuthorizationRequest is the authorization request used after some authentication methods (e.g. kerberos) to determine whether users are allowed to access the service
AwsElasticBlockStoreVolumeSource
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.
AzureDataDiskCachingMode
+enum
AzureDataDiskKind
+enum
AzureDiskVolumeSource
AzureFileVolumeSource
Backend
BinaryMetadataValue
BindOptions
Capabilities
Capability
Capability represent POSIX capabilities type
CephFsVolumeSource
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
CgroupSpec
CgroupnsMode
CgroupnsMode represents the cgroup namespace mode of the container
CinderVolumeSource
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.
CipherSuite
CommandConfig
Config
It should hold only portable information about the container. Here, "portable" means "independent from the host we are running on". Non-portable information should appear in HostConfig. All fields added to this struct must be marked omitempty to keep getting predictable hashes from the old v1Compatibility configuration.
ConfigMapEnvSource
The contents of the target ConfigMap’s Data field will represent the key-value pairs as environment variables.
ConfigMapKeySelector
+structType=atomic
ConfigMapProjection
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.
ConfigMapVolumeSource
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.
ConfigRequest
ConfigResponseBody
ConnectionAuthPendingMetadata
ConnectionAuthPendingMetadata is a variant of ConnectionMetadata which is used when the client has already provided a Username, but the authentication has not completed yet.
ConnectionAuthenticatedMetadata
ConnectionAuthenticatedMetadata is a variant of ConnectionMetadata which is used once the authentication has been completed. It contains the AuthenticatedUsername provided by the authentication system.
ConnectionMetadata
ConnectionMetadata holds a metadata structure passed around with a metadata. Its main purpose is to allow an authentication or authorization module to configure data exposed to the configuration server or the backend.
Consistency
Container
ContainerChangeResponseItem
ContainerChangeResponseItem change item in response to ContainerChanges operation
ContainerCreateCreatedBody
ContainerCreateCreatedBody OK response to ContainerCreate operation
ContainerPort
ContainerTopOkBody
ContainerTopOKBody OK response to ContainerTop operation
ContainerUpdateOkBody
ContainerUpdateOKBody OK response to ContainerUpdate operation
ContainerWaitOkBody
ContainerWaitOKBody OK response to ContainerWait operation
ContainerWaitOkBodyError
ContainerWaitOKBodyError container waiting error, if any
CsiVolumeSource
Represents a source location of a volume to mount, managed by an external CSI driver
DeviceMapping
DeviceRequest
Used by GPU device drivers.
DnsPolicy
+enum
DockerConfig
DockerConnectionConfig
DockerExecutionConfig
goland:noinspection GoVetStructTag
DockerExecutionMode
DockerExecutionModeConnection launches one container per SSH connection (default), while DockerExecutionModeSession launches one container per SSH session.
DockerImagePullPolicy
ImagePullPolicyAlways means that the container image will be pulled on every connection. ImagePullPolicyIfNotPresent means the image will be pulled if the image is not present locally, an empty tag, or the "latest" tag was specified. ImagePullPolicyNever means that the image will never be pulled, and if the image is not available locally the connection will fail.
DockerLaunchConfig
DockerTimeoutConfig
DownwardApiProjection
Note that this is identical to a downwardAPI volume source without the default mode.
DownwardApiVolumeFile
DownwardAPIVolumeFile represents information to create the file containing the pod field
DownwardApiVolumeSource
Downward API volumes support ownership management and SELinux relabeling.
Driver
Duration
A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.
EcdhCurve
EmptyDirVolumeSource
Empty directory volumes support ownership management and SELinux relabeling.
EndpointIpamConfig
EndpointIPAMConfig represents IPAM configurations for the endpoint
EndpointSettings
EndpointSettings stores the network endpoint details
EnvFromSource
EnvFromSource represents the source of a set of ConfigMaps
EnvVar
EnvVarSource
EphemeralContainer
To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted. This is a beta feature available on clusters that haven’t disabled the EphemeralContainers feature gate.
EphemeralContainerCommon
EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer. This separate type allows easy conversion from EphemeralContainer to Container and allows separate documentation for the fields of EphemeralContainer. When a new field is added to Container it must be added here as well.
EphemeralVolumeSource
ErrorResponse
ExecAction
FcVolumeSource
Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
FileMode
The bits have the same definition on all systems, so that information about files can be moved from one system to another portably. Not all bits apply to all systems. The only required bit is ModeDir for directories.
FlexVolumeSource
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
FlockerVolumeSource
One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
ForwardingConfig
GcePersistentDiskVolumeSource
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.
GitRepoVolumeSource
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.
GlusterfsVolumeSource
Glusterfs volumes do not support ownership management or SELinux relabeling.
GraphDriverData
GrpcAction
HealthConfig
HistoryResponseItem
HistoryResponseItem individual image layer information in response to ImageHistory operation
HostAlias
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod’s hosts file.
HostConfig
Here, "non-portable" means "dependent of the host we are running on". Portable information should appear in Config.
HostPathType
+enum
HostPathVolumeSource
Host path volumes do not support ownership management or SELinux relabeling.
HttpClientConfiguration
HTTPClientConfiguration is the configuration structure for HTTP clients
HttpGetAction
HttpHeader
HTTPHeader describes a custom header to be used in HTTP probes
HttpServerConfiguration
goland:noinspection GoVetStructTag
IdResponse
IDResponse Response to an API call that returns just an Id
ImageDeleteResponseItem
ImageDeleteResponseItem image delete response item
ImageSummary
ImageSummary image summary
IntOrString
+protobuf=true +protobuf.options.(gogoproto.goproto_stringer)=false +k8s:openapi-gen=true
IpcMode
IscsiVolumeSource
ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
Isolation
Isolation represents the isolation technology of a container. The supported values are platform specific
KeyToPath
KubernetesConfig
KubernetesConfig is the base configuration structure for Kubernetes
KubernetesConnectionConfig
goland:noinspection GoVetStructTag
KubernetesExecutionMode
KubernetesExecutionModeConnection launches one container per SSH connection (default), while KubernetesExecutionModeSession launches one container per SSH session.
KubernetesPodConfig
goland:noinspection GoVetStructTag
KubernetesTimeoutConfig
LabelSelector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic
LabelSelectorOperator
LabelSelectorRequirement
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Lifecycle
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.
LifecycleHandler
LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.
LocalObjectReference
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. +structType=atomic
LogConfig
ManagedFieldsEntry
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
ManagedFieldsOperationType
MetadataValue
Mount
MountPropagationMode
+enum
NetworkMode
NetworkingConfig
NetworkingConfig represents the container’s networking configuration for each of its interfaces Carries the networking configs specified in the docker run and docker network connect commands
NfsVolumeSource
NFS volumes do not support ownership management or SELinux relabeling.
NodeAffinity
NodeSelector
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. +structType=atomic
NodeSelectorOperator
A node selector operator is the set of operators that can be used in a node selector requirement. +enum
NodeSelectorRequirement
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
NodeSelectorTerm
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. +structType=atomic
ObjectFieldSelector
+structType=atomic
ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
OsName
OwnerReference
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. +structType=atomic
PasswordAuthRequest
PersistentVolumeAccessMode
+enum
PersistentVolumeClaimSpec
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
PersistentVolumeClaimTemplate
PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
PersistentVolumeClaimVolumeSource
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).
PersistentVolumeMode
+enum
PhotonPersistentDiskVolumeSource
PidMode
Platform
Plugin
Plugin A plugin for the Engine API
PluginConfig
PluginConfigArgs
PluginConfigArgs plugin config args
PluginConfigInterface
PluginConfigInterface The interface between Docker and the plugin
PluginConfigLinux
PluginConfigLinux plugin config linux
PluginConfigNetwork
PluginConfigNetwork plugin config network
PluginConfigRootfs
PluginConfigRootfs plugin config rootfs
PluginConfigUser
PluginConfigUser plugin config user
PluginDevice
PluginDevice plugin device
PluginEnv
PluginEnv plugin env
PluginInterfaceType
PluginInterfaceType plugin interface type
PluginMount
PluginMount plugin mount
PluginSettings
PodAffinity
PodAffinityTerm
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 matches that of any node on which a pod of the set of pods is running
PodAntiAffinity
PodConditionType
PodConditionType is a valid value for PodCondition.Type +enum
PodDnsConfig
PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
PodDnsConfigOption
PodFsGroupChangePolicy
PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume when volume is mounted. +enum
PodOs
PodReadinessGate
PodReadinessGate contains the reference to a pod condition
PodSecurityContext
Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
PodSpec
Port
Port An open port on a container
PortBinding
PortBinding represents a binding between a Host IP address and a Host Port
PortworxVolumeSource
PreemptionPolicy
+enum
PreferredSchedulingTerm
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).
Probe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ProbeHandler
One and only one of the fields must be specified.
ProcMountType
+enum
ProjectedVolumeSource
Represents a projected volume source
Propagation
Protocol
+enum
PublicKey
PublicKeyAuthRequest
PullPolicy
PullPolicy describes a policy for if/when to pull a container image +enum
Quantity
QuobyteVolumeSource
Quobyte volumes do not support ownership management or SELinux relabeling.
RbdVolumeSource
RBD volumes support ownership management and SELinux relabeling.
ResourceFieldSelector
ResourceFieldSelector represents container resources (cpu, memory) and their output format +structType=atomic
ResourceRequirements
Resources
Resources contains container’s resources (cgroups config, ulimits…)
RestartPolicy
Only one of the following restart policies may be specified. If none of the following policies is specified, the default one is RestartPolicyAlways. +enum
ScaleIoVolumeSource
ScaleIOVolumeSource represents a persistent ScaleIO volume
SeLinuxOptions
SELinuxOptions are the labels to be applied to the container
SeccompProfile
Only one profile source may be set. +union
SeccompProfileType
+enum
SecretEnvSource
The contents of the target Secret’s Data field will represent the key-value pairs as environment variables.
SecretKeySelector
+structType=atomic
SecretProjection
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.
SecretVolumeSource
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.
SecurityConfig
SecurityContext
Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
SecurityEnvConfig
SecurityExecutionPolicy
SecurityShellConfig
SecuritySignalConfig
SecurityTtyConfig
ServiceAccountTokenProjection
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).
ServiceUpdateResponse
ServiceUpdateResponse service update response
SshCipher
SSHCipher is the SSH cipher
SshKex
SSHKex are the SSH key exchange algorithms
SshKeyAlgo
SshProxyClientVersion
SshProxyConfig
Sshmac
StorageMedium
StorageOsVolumeSource
SubsystemConfig
Sysctl
Sysctl defines a kernel parameter to be set
TaintEffect
+enum
TcpSocketAction
TCPSocketAction describes an action based on opening a socket
TerminationMessagePolicy
+enum
ThrottleDevice
ThrottleDevice is a structure that holds device:rate_per_second pair
TlsVersion
TmpfsOptions
Toleration
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
TolerationOperator
+enum
TopologySpreadConstraint
Type
TypedLocalObjectReference
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. +structType=atomic
Uid
UID is a type that holds unique ID values, including UUIDs. Because we don’t ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.
Ulimit
UnsatisfiableConstraintAction
+enum
UriScheme
URIScheme identifies the scheme used for connection to a host for Get actions +enum
UsernsMode
UtsMode
Volume
VolumeCreateBody
VolumeCreateBody Volume configuration
VolumeDevice
VolumeListOkBody
VolumeListOKBody Volume list response
VolumeMount
VolumeOptions
VolumeProjection
Projection that may be projected along with other supported volume types
VolumeSource
Only one of its members may be specified.
VolumeUsageData
VolumeUsageData Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints.
VsphereVirtualDiskVolumeSource
WeightDevice
WeightDevice is a structure that holds device:weight pair
WeightedPodAffinityTerm
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
WindowsSecurityContextOptions