Module

Kubernetes.Api.Core.V1

Package
purescript-kubernetes
Repository
hoodunit/purescript-kubernetes

#AWSElasticBlockStoreVolumeSource Source

newtype AWSElasticBlockStoreVolumeSource

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.

Fields:

Constructors

Instances

#Affinity Source

newtype Affinity

Affinity is a group of affinity scheduling rules.

Fields:

  • nodeAffinity: Describes node affinity scheduling rules for the pod.
  • podAffinity: Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
  • podAntiAffinity: Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Constructors

Instances

#AttachedVolume Source

newtype AttachedVolume

AttachedVolume describes a volume attached to a node

Fields:

  • devicePath: DevicePath represents the device path where the volume should be available
  • name: Name of the attached volume

Constructors

Instances

#AzureDiskVolumeSource Source

newtype AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Fields:

  • cachingMode: Host Caching mode: None, Read Only, Read Write.
  • diskName: The Name of the data disk in the blob storage
  • diskURI: The URI the data disk in the blob storage
  • fsType: 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.
  • kind: 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
  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

Constructors

Instances

#AzureFilePersistentVolumeSource Source

newtype AzureFilePersistentVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Fields:

  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretName: the name of secret that contains Azure Storage Account Name and Key
  • secretNamespace: the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
  • shareName: Share Name

Constructors

Instances

#AzureFileVolumeSource Source

newtype AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Fields:

  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretName: the name of secret that contains Azure Storage Account Name and Key
  • shareName: Share Name

Constructors

Instances

#Binding Source

newtype Binding

Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.

Fields:

Constructors

Instances

#CSIPersistentVolumeSource Source

newtype CSIPersistentVolumeSource

Represents storage that is managed by an external CSI volume driver

Fields:

  • driver: Driver is the name of the driver to use for this volume. Required.
  • readOnly: Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).
  • volumeHandle: VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.

Constructors

Instances

#Capabilities Source

newtype Capabilities

Adds and removes POSIX capabilities from running containers.

Fields:

  • add: Added capabilities
  • drop: Removed capabilities

Constructors

Instances

#CephFSPersistentVolumeSource Source

newtype CephFSPersistentVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Fields:

Constructors

Instances

#CephFSVolumeSource Source

newtype CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Fields:

Constructors

Instances

#CinderVolumeSource Source

newtype CinderVolumeSource

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.

Fields:

Constructors

Instances

#ClientIPConfig Source

newtype ClientIPConfig

ClientIPConfig represents the configurations of Client IP based session affinity.

Fields:

  • timeoutSeconds: 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).

Constructors

Instances

#ComponentCondition Source

newtype ComponentCondition

Information about the condition of a component.

Fields:

  • _type: Type of condition for a component. Valid value: "Healthy"
  • error: Condition error code for a component. For example, a health check error code.
  • message: Message about the condition for a component. For example, information about a health check.
  • status: Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

Constructors

Instances

#ComponentStatus Source

newtype ComponentStatus

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

Fields:

Constructors

Instances

#ComponentStatusList Source

newtype ComponentStatusList

Status of all the conditions for the component as a list of ComponentStatus objects.

Fields:

Constructors

Instances

#ConfigMap Source

newtype ConfigMap

ConfigMap holds configuration data for pods to consume.

Fields:

Constructors

Instances

#ConfigMapEnvSource Source

newtype ConfigMapEnvSource

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.

Fields:

Constructors

Instances

#ConfigMapKeySelector Source

newtype ConfigMapKeySelector

Selects a key from a ConfigMap.

Fields:

Constructors

Instances

#ConfigMapList Source

newtype ConfigMapList

ConfigMapList is a resource containing a list of ConfigMap objects.

Fields:

Constructors

Instances

#ConfigMapProjection Source

newtype ConfigMapProjection

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.

Fields:

  • items: 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: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  • optional: Specify whether the ConfigMap or it's keys must be defined

Constructors

Instances

#ConfigMapVolumeSource Source

newtype ConfigMapVolumeSource

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.

Fields:

  • defaultMode: 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: 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: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  • optional: Specify whether the ConfigMap or it's keys must be defined

Constructors

Instances

#Container Source

newtype Container

A single application container that you want to run within a pod.

Fields:

  • args: 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
  • command: 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
  • env: List of environment variables to set in the container. Cannot be updated.
  • envFrom: 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.
  • image: 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.
  • imagePullPolicy: 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: Actions that the management system should take in response to container lifecycle events. Cannot be updated.
  • livenessProbe: 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: Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
  • ports: 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.
  • readinessProbe: 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
  • resources: Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
  • securityContext: 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/
  • stdin: 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.
  • stdinOnce: 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
  • terminationMessagePath: 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.
  • terminationMessagePolicy: 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.
  • tty: Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
  • volumeDevices: volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.
  • volumeMounts: Pod volumes to mount into the container's filesystem. Cannot be updated.
  • workingDir: 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.

Constructors

Instances

#ContainerImage Source

newtype ContainerImage

Describe a container image

Fields:

  • names: Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
  • sizeBytes: The size of the image in bytes.

Constructors

Instances

#ContainerPort Source

newtype ContainerPort

ContainerPort represents a network port in a single container.

Fields:

  • containerPort: Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
  • hostIP: What host IP to bind the external port to.
  • hostPort: 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.
  • name: 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: Protocol for port. Must be UDP or TCP. Defaults to "TCP".

Constructors

Instances

#ContainerState Source

newtype ContainerState

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.

Fields:

  • running: Details about a running container
  • terminated: Details about a terminated container
  • waiting: Details about a waiting container

Constructors

Instances

#ContainerStateRunning Source

newtype ContainerStateRunning

ContainerStateRunning is a running state of a container.

Fields:

  • startedAt: Time at which the container was last (re-)started

Constructors

Instances

#ContainerStateTerminated Source

newtype ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.

Fields:

  • containerID: Container's ID in the format 'docker://<container_id>'
  • exitCode: Exit status from the last termination of the container
  • finishedAt: Time at which the container last terminated
  • message: Message regarding the last termination of the container
  • reason: (brief) reason from the last termination of the container
  • signal: Signal from the last termination of the container
  • startedAt: Time at which previous execution of the container started

Constructors

Instances

#ContainerStateWaiting Source

newtype ContainerStateWaiting

ContainerStateWaiting is a waiting state of a container.

Fields:

  • message: Message regarding why the container is not yet running.
  • reason: (brief) reason the container is not yet running.

Constructors

Instances

#ContainerStatus Source

newtype ContainerStatus

ContainerStatus contains details for the current status of this container.

Fields:

  • containerID: Container's ID in the format 'docker://<container_id>'.
  • image: The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images
  • imageID: ImageID of the container's image.
  • lastState: Details about the container's last termination condition.
  • name: This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
  • ready: Specifies whether the container has passed its readiness probe.
  • restartCount: The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
  • state: Details about the container's current condition.

Constructors

Instances

#DaemonEndpoint Source

newtype DaemonEndpoint

DaemonEndpoint contains information about a single Daemon endpoint.

Fields:

  • _Port: Port number of the given endpoint.

Constructors

Instances

#DownwardAPIProjection Source

newtype DownwardAPIProjection

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

Fields:

  • items: Items is a list of DownwardAPIVolume file

Constructors

Instances

#DownwardAPIVolumeFile Source

newtype DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Fields:

  • fieldRef: Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
  • mode: 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.
  • path: 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 '..'
  • resourceFieldRef: Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Constructors

Instances

#DownwardAPIVolumeSource Source

newtype DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Fields:

  • defaultMode: 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: Items is a list of downward API volume file

Constructors

Instances

#EmptyDirVolumeSource Source

newtype EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Fields:

  • medium: 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
  • sizeLimit: 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

Constructors

Instances

#EndpointAddress Source

newtype EndpointAddress

EndpointAddress is a tuple that describes single IP address.

Fields:

  • hostname: The Hostname of this endpoint
  • ip: 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.
  • nodeName: Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
  • targetRef: Reference to object providing the endpoint.

Constructors

Instances

#EndpointPort Source

newtype EndpointPort

EndpointPort is a tuple that describes a single port.

Fields:

  • name: The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.
  • port: The port number of the endpoint.
  • protocol: The IP protocol for this port. Must be UDP or TCP. Default is TCP.

Constructors

Instances

#EndpointSubset Source

newtype EndpointSubset

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 ]

Fields:

  • addresses: 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.
  • notReadyAddresses: 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.
  • ports: Port numbers available on the related IP addresses.

Constructors

Instances

#Endpoints Source

newtype Endpoints

Endpoints is a collection of endpoints that implement the actual service. Example: Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]

Fields:

  • metadata: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  • subsets: The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

Constructors

Instances

#EndpointsList Source

newtype EndpointsList

EndpointsList is a list of endpoints.

Fields:

Constructors

Instances

#EnvFromSource Source

newtype EnvFromSource

EnvFromSource represents the source of a set of ConfigMaps

Fields:

  • configMapRef: The ConfigMap to select from
  • prefix: An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
  • secretRef: The Secret to select from

Constructors

Instances

#EnvVar Source

newtype EnvVar

EnvVar represents an environment variable present in a Container.

Fields:

  • name: Name of the environment variable. Must be a C_IDENTIFIER.
  • value: 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 "".
  • valueFrom: Source for the environment variable's value. Cannot be used if value is not empty.

Constructors

Instances

#EnvVarSource Source

newtype EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Fields:

  • configMapKeyRef: Selects a key of a ConfigMap.
  • fieldRef: Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
  • resourceFieldRef: 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.
  • secretKeyRef: Selects a key of a secret in the pod's namespace

Constructors

Instances

#Event Source

newtype Event

Event is a report of an event somewhere in the cluster.

Fields:

  • _type: Type of this event (Normal, Warning), new types could be added in the future
  • action: What action was taken/failed regarding to the Regarding object.
  • count: The number of times this event has occurred.
  • eventTime: Time when this Event was first observed.
  • firstTimestamp: The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
  • involvedObject: The object that this event is about.
  • lastTimestamp: The time at which the most recent occurrence of this event was recorded.
  • message: A human-readable description of the status of this operation.
  • metadata: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  • reason: This should be a short, machine understandable string that gives the reason for the transition into the object's current status.
  • related: Optional secondary object for more complex actions.
  • reportingComponent: Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
  • reportingInstance: ID of the controller instance, e.g. kubelet-xyzf.
  • series: Data about the Event series this event represents or nil if it's a singleton Event.
  • source: The component reporting this event. Should be a short machine understandable string.

Constructors

Instances

#EventList Source

newtype EventList

EventList is a list of events.

Fields:

Constructors

Instances

#EventSeries Source

newtype EventSeries

EventSeries contain information on series of events, i.e. thing that was/is happening continously for some time.

Fields:

  • count: Number of occurrences in this series up to the last heartbeat time
  • lastObservedTime: Time of the last occurence observed
  • state: State of this Series: Ongoing or Finished

Constructors

Instances

#EventSource Source

newtype EventSource

EventSource contains information for an event.

Fields:

  • component: Component from which the event is generated.
  • host: Node name on which the event is generated.

Constructors

Instances

#ExecAction Source

newtype ExecAction

ExecAction describes a "run in container" action.

Fields:

  • command: 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.

Constructors

Instances

#FCVolumeSource Source

newtype FCVolumeSource

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.

Fields:

  • fsType: 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.
  • lun: Optional: FC target lun number
  • readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • targetWWNs: Optional: FC target worldwide names (WWNs)
  • wwids: Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

Constructors

Instances

#FlexPersistentVolumeSource Source

newtype FlexPersistentVolumeSource

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

Fields:

  • driver: Driver is the name of the driver to use for this volume.
  • fsType: 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.
  • options: Optional: Extra command options if any.
  • readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretRef: 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.

Constructors

Instances

#FlexVolumeSource Source

newtype FlexVolumeSource

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Fields:

  • driver: Driver is the name of the driver to use for this volume.
  • fsType: 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.
  • options: Optional: Extra command options if any.
  • readOnly: Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretRef: 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.

Constructors

Instances

#FlockerVolumeSource Source

newtype FlockerVolumeSource

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.

Fields:

  • datasetName: Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
  • datasetUUID: UUID of the dataset. This is unique identifier of a Flocker dataset

Constructors

Instances

#GCEPersistentDiskVolumeSource Source

newtype GCEPersistentDiskVolumeSource

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.

Fields:

Constructors

Instances

#GitRepoVolumeSource Source

newtype GitRepoVolumeSource

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.

Fields:

  • directory: 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: Repository URL
  • revision: Commit hash for the specified revision.

Constructors

Instances

#GlusterfsVolumeSource Source

newtype GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Fields:

Constructors

Instances

#HTTPGetAction Source

newtype HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Fields:

  • host: Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
  • httpHeaders: Custom headers to set in the request. HTTP allows repeated headers.
  • path: Path to access on the HTTP server.
  • port: 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: Scheme to use for connecting to the host. Defaults to HTTP.

Constructors

Instances

#HTTPHeader Source

newtype HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Fields:

  • name: The header field name
  • value: The header field value

Constructors

Instances

#Handler Source

newtype Handler

Handler defines a specific action that should be taken

Fields:

  • exec: One and only one of the following should be specified. Exec specifies the action to take.
  • httpGet: HTTPGet specifies the http request to perform.
  • tcpSocket: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

Constructors

Instances

#HostAlias Source

newtype HostAlias

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Fields:

  • hostnames: Hostnames for the above IP address.
  • ip: IP address of the host file entry.

Constructors

Instances

#HostPathVolumeSource Source

newtype HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Fields:

Constructors

Instances

#ISCSIPersistentVolumeSource Source

newtype ISCSIPersistentVolumeSource

ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Fields:

  • chapAuthDiscovery: whether support iSCSI Discovery CHAP authentication
  • chapAuthSession: whether support iSCSI Session CHAP authentication
  • fsType: 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
  • initiatorName: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
  • iqn: Target iSCSI Qualified Name.
  • iscsiInterface: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
  • lun: iSCSI Target Lun number.
  • portals: 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: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
  • secretRef: CHAP Secret for iSCSI target and initiator authentication
  • targetPortal: 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).

Constructors

Instances

#ISCSIVolumeSource Source

newtype ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Fields:

  • chapAuthDiscovery: whether support iSCSI Discovery CHAP authentication
  • chapAuthSession: whether support iSCSI Session CHAP authentication
  • fsType: 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
  • initiatorName: Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
  • iqn: Target iSCSI Qualified Name.
  • iscsiInterface: iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
  • lun: iSCSI Target Lun number.
  • portals: 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: ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
  • secretRef: CHAP Secret for iSCSI target and initiator authentication
  • targetPortal: 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).

Constructors

Instances

#KeyToPath Source

newtype KeyToPath

Maps a string key to a path within a volume.

Fields:

  • key: The key to project.
  • mode: 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.
  • path: 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 '..'.

Constructors

Instances

#Lifecycle Source

newtype 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.

Fields:

Constructors

Instances

#LimitRange Source

newtype LimitRange

LimitRange sets resource usage limits for each kind of resource in a Namespace.

Fields:

Constructors

Instances

#LimitRangeItem Source

newtype LimitRangeItem

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

Fields:

  • _default: Default resource requirement limit value by resource name if resource limit is omitted.
  • _type: Type of resource that this limit applies to.
  • defaultRequest: DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
  • max: Max usage constraints on this kind by resource name.
  • maxLimitRequestRatio: 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: Min usage constraints on this kind by resource name.

Constructors

Instances

#LimitRangeList Source

newtype LimitRangeList

LimitRangeList is a list of LimitRange items.

Fields:

Constructors

Instances

#LimitRangeSpec Source

newtype LimitRangeSpec

LimitRangeSpec defines a min/max usage limit for resources that match on kind.

Fields:

  • limits: Limits is the list of LimitRangeItem objects that are enforced.

Constructors

Instances

#LoadBalancerIngress Source

newtype LoadBalancerIngress

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

Fields:

  • hostname: Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
  • ip: IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)

Constructors

Instances

#LoadBalancerStatus Source

newtype LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.

Fields:

  • ingress: Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

Constructors

Instances

#LocalObjectReference Source

newtype LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Fields:

Constructors

Instances

#LocalVolumeSource Source

newtype LocalVolumeSource

Local represents directly-attached storage with node affinity

Fields:

  • path: The full path to the volume on the node For alpha, this path must be a directory Once block as a source is supported, then this path can point to a block device

Constructors

Instances

#NFSVolumeSource Source

newtype NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Fields:

Constructors

Instances

#Namespace Source

newtype Namespace

Namespace provides a scope for Names. Use of multiple namespaces is optional.

Fields:

Constructors

Instances

#NamespaceList Source

newtype NamespaceList

NamespaceList is a list of Namespaces.

Fields:

Constructors

Instances

#NamespaceSpec Source

newtype NamespaceSpec

NamespaceSpec describes the attributes on a Namespace.

Fields:

Constructors

Instances

#NamespaceStatus Source

newtype NamespaceStatus

NamespaceStatus is information about the current status of a Namespace.

Fields:

Constructors

Instances

#Node Source

newtype Node

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

Fields:

Constructors

Instances

#NodeAddress Source

newtype NodeAddress

NodeAddress contains information for the node's address.

Fields:

  • _type: Node address type, one of Hostname, ExternalIP or InternalIP.
  • address: The node address.

Constructors

Instances

#NodeAffinity Source

newtype NodeAffinity

Node affinity is a group of node affinity scheduling rules.

Fields:

  • preferredDuringSchedulingIgnoredDuringExecution: 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.
  • requiredDuringSchedulingIgnoredDuringExecution: 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.

Constructors

Instances

#NodeCondition Source

newtype NodeCondition

NodeCondition contains condition information for a node.

Fields:

  • _type: Type of node condition.
  • lastHeartbeatTime: Last time we got an update on a given condition.
  • lastTransitionTime: Last time the condition transit from one status to another.
  • message: Human readable message indicating details about last transition.
  • reason: (brief) reason for the condition's last transition.
  • status: Status of the condition, one of True, False, Unknown.

Constructors

Instances

#NodeConfigSource Source

newtype NodeConfigSource

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

Fields:

  • configMapRef

Constructors

Instances

#NodeDaemonEndpoints Source

newtype NodeDaemonEndpoints

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Fields:

  • kubeletEndpoint: Endpoint on which Kubelet is listening.

Constructors

Instances

#NodeList Source

newtype NodeList

NodeList is the whole list of all Nodes which have been registered with master.

Fields:

Constructors

Instances

#NodeSelector Source

newtype 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.

Fields:

  • nodeSelectorTerms: Required. A list of node selector terms. The terms are ORed.

Constructors

Instances

#NodeSelectorRequirement Source

newtype NodeSelectorRequirement

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

Fields:

  • key: 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, DoesNotExist. Gt, and Lt.
  • values: 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.

Constructors

Instances

#NodeSelectorTerm Source

newtype NodeSelectorTerm

A null or empty node selector term matches no objects.

Fields:

  • matchExpressions: Required. A list of node selector requirements. The requirements are ANDed.

Constructors

Instances

#NodeSpec Source

newtype NodeSpec

NodeSpec describes the attributes that a node is created with.

Fields:

  • configSource: If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field
  • externalID: External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.
  • podCIDR: PodCIDR represents the pod IP range assigned to the node.
  • providerID: ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
  • taints: If specified, the node's taints.
  • unschedulable: Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

Constructors

Instances

#NodeStatus Source

newtype NodeStatus

NodeStatus is information about the current status of a node.

Fields:

Constructors

Instances

#NodeSystemInfo Source

newtype NodeSystemInfo

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Fields:

  • architecture: The Architecture reported by the node
  • bootID: Boot ID reported by the node.
  • containerRuntimeVersion: ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
  • kernelVersion: Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
  • kubeProxyVersion: KubeProxy Version reported by the node.
  • kubeletVersion: Kubelet Version reported by the node.
  • machineID: 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
  • operatingSystem: The Operating System reported by the node
  • osImage: OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
  • systemUUID: 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

Constructors

Instances

#ObjectFieldSelector Source

newtype ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Fields:

  • apiVersion: Version of the schema the FieldPath is written in terms of, defaults to "v1".
  • fieldPath: Path of the field to select in the specified API version.

Constructors

Instances

#ObjectReference Source

newtype ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

Fields:

Constructors

Instances

#PersistentVolume Source

newtype PersistentVolume

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

Fields:

Constructors

Instances

#PersistentVolumeClaim Source

newtype PersistentVolumeClaim

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Fields:

Constructors

Instances

#PersistentVolumeClaimCondition Source

newtype PersistentVolumeClaimCondition

PersistentVolumeClaimCondition contails details about state of pvc

Fields:

  • _type
  • lastProbeTime: Last time we probed the condition.
  • lastTransitionTime: Last time the condition transitioned from one status to another.
  • message: Human-readable message indicating details about last transition.
  • reason: 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.
  • status

Constructors

Instances

#PersistentVolumeClaimSpec Source

newtype PersistentVolumeClaimSpec

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Fields:

Constructors

Instances

#PersistentVolumeClaimStatus Source

newtype PersistentVolumeClaimStatus

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Fields:

  • accessModes: 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
  • capacity: Represents the actual resources of the underlying volume.
  • conditions: Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
  • phase: Phase represents the current phase of PersistentVolumeClaim.

Constructors

Instances

#PersistentVolumeClaimVolumeSource Source

newtype PersistentVolumeClaimVolumeSource

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).

Fields:

Constructors

Instances

#PersistentVolumeSpec Source

newtype PersistentVolumeSpec

PersistentVolumeSpec is the specification of a persistent volume.

Fields:

  • accessModes: AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
  • awsElasticBlockStore: 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: AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
  • azureFile: AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
  • capacity: A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
  • cephfs: CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
  • cinder: Cinder represents a cinder volume attached and mounted on kubelets host machine More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
  • claimRef: 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: CSI represents storage that handled by an external CSI driver
  • fc: FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
  • flexVolume: FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
  • flocker: 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: 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: Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
  • hostPath: 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: 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: Local represents directly-attached storage with node affinity
  • mountOptions: 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: NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
  • persistentVolumeReclaimPolicy: What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
  • photonPersistentDisk: PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
  • portworxVolume: PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
  • quobyte: Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
  • rbd: RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md
  • scaleIO: ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
  • storageClassName: Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
  • storageos: StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md
  • volumeMode: 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. This is an alpha feature and may change in the future.
  • vsphereVolume: VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Constructors

Instances

#PersistentVolumeStatus Source

newtype PersistentVolumeStatus

PersistentVolumeStatus is the current status of a persistent volume.

Fields:

  • message: A human-readable message indicating details about why the volume is in this state.
  • phase: Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
  • reason: Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

Constructors

Instances

#PhotonPersistentDiskVolumeSource Source

newtype PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Fields:

  • fsType: 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.
  • pdID: ID that identifies Photon Controller persistent disk

Constructors

Instances

#Pod Source

newtype Pod

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

Fields:

Constructors

Instances

#PodAffinity Source

newtype PodAffinity

Pod affinity is a group of inter pod affinity scheduling rules.

Fields:

  • preferredDuringSchedulingIgnoredDuringExecution: 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.
  • requiredDuringSchedulingIgnoredDuringExecution: 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.

Constructors

Instances

#PodAffinityTerm Source

newtype 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 <topologyKey> matches that of any node on which a pod of the set of pods is running

Fields:

  • labelSelector: A label query over a set of resources, in this case pods.
  • namespaces: namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"
  • topologyKey: 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.

Constructors

Instances

#PodAntiAffinity Source

newtype PodAntiAffinity

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Fields:

  • preferredDuringSchedulingIgnoredDuringExecution: 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.
  • requiredDuringSchedulingIgnoredDuringExecution: 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.

Constructors

Instances

#PodCondition Source

newtype PodCondition

PodCondition contains details for the current condition of this pod.

Fields:

Constructors

Instances

#PodDNSConfig Source

newtype PodDNSConfig

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Fields:

  • nameservers: A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
  • options: 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.
  • searches: 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.

Constructors

Instances

#PodDNSConfigOption Source

newtype PodDNSConfigOption

PodDNSConfigOption defines DNS resolver options of a pod.

Fields:

  • name: Required.
  • value

Constructors

Instances

#PodList Source

newtype PodList

PodList is a list of Pods.

Fields:

Constructors

Instances

#PodSecurityContext Source

newtype PodSecurityContext

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.

Fields:

  • fsGroup: 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.

  • runAsNonRoot: 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.

  • runAsUser: 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.

  • seLinuxOptions: 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.

  • supplementalGroups: 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.

Constructors

Instances

#PodSpec Source

newtype PodSpec

PodSpec is a description of a pod.

Fields:

  • activeDeadlineSeconds: 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.
  • affinity: If specified, the pod's scheduling constraints
  • automountServiceAccountToken: AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
  • containers: 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.
  • dnsConfig: Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. This is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
  • 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'. Note that 'None' policy is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.
  • hostAliases: 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.
  • hostIPC: Use the host's ipc namespace. Optional: Default to false.
  • hostNetwork: 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.
  • hostPID: Use the host's pid namespace. Optional: Default to false.
  • hostname: Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
  • imagePullSecrets: 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
  • initContainers: 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, or Liveness 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: 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: 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/
  • priority: 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.
  • priorityClassName: If specified, indicates the pod's priority. "SYSTEM" is a special keyword which indicates 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.
  • restartPolicy: 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
  • schedulerName: If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
  • securityContext: SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
  • serviceAccount: DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
  • serviceAccountName: 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/
  • subdomain: 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.
  • terminationGracePeriodSeconds: 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.
  • tolerations: If specified, the pod's tolerations.
  • volumes: List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

Constructors

Instances

#PodStatus Source

newtype PodStatus

PodStatus represents information about the status of a pod. Status may trail the actual state of a system.

Fields:

Constructors

Instances

#PodTemplate Source

newtype PodTemplate

PodTemplate describes a template for creating copies of a predefined pod.

Fields:

Constructors

Instances

#PodTemplateList Source

newtype PodTemplateList

PodTemplateList is a list of PodTemplates.

Fields:

Constructors

Instances

#PodTemplateSpec Source

newtype PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template

Fields:

Constructors

Instances

#PortworxVolumeSource Source

newtype PortworxVolumeSource

PortworxVolumeSource represents a Portworx volume resource.

Fields:

  • fsType: 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.
  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • volumeID: VolumeID uniquely identifies a Portworx volume

Constructors

Instances

#PreferredSchedulingTerm Source

newtype 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).

Fields:

  • preference: A node selector term, associated with the corresponding weight.
  • weight: Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

Constructors

Instances

#Probe Source

newtype Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Fields:

  • exec: One and only one of the following should be specified. Exec specifies the action to take.
  • failureThreshold: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
  • httpGet: HTTPGet specifies the http request to perform.
  • initialDelaySeconds: 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
  • periodSeconds: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
  • successThreshold: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
  • tcpSocket: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
  • timeoutSeconds: 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

Constructors

Instances

#ProjectedVolumeSource Source

newtype ProjectedVolumeSource

Represents a projected volume source

Fields:

  • defaultMode: 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.
  • sources: list of volume projections

Constructors

Instances

#QuobyteVolumeSource Source

newtype QuobyteVolumeSource

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Fields:

  • group: Group to map volume access to Default is no group
  • readOnly: ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
  • registry: 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
  • user: User to map volume access to Defaults to serivceaccount user
  • volume: Volume is a string that references an already created Quobyte volume by name.

Constructors

Instances

#RBDPersistentVolumeSource Source

newtype RBDPersistentVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Fields:

Constructors

Instances

#RBDVolumeSource Source

newtype RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Fields:

Constructors

Instances

#ReplicationController Source

newtype ReplicationController

ReplicationController represents the configuration of a replication controller.

Fields:

Constructors

Instances

#ReplicationControllerCondition Source

newtype ReplicationControllerCondition

ReplicationControllerCondition describes the state of a replication controller at a certain point.

Fields:

  • _type: Type of replication controller condition.
  • lastTransitionTime: The last time the condition transitioned from one status to another.
  • message: A human readable message indicating details about the transition.
  • reason: The reason for the condition's last transition.
  • status: Status of the condition, one of True, False, Unknown.

Constructors

Instances

#ReplicationControllerSpec Source

newtype ReplicationControllerSpec

ReplicationControllerSpec is the specification of a replication controller.

Fields:

Constructors

Instances

#ReplicationControllerStatus Source

newtype ReplicationControllerStatus

ReplicationControllerStatus represents the current status of a replication controller.

Fields:

  • availableReplicas: The number of available replicas (ready for at least minReadySeconds) for this replication controller.
  • conditions: Represents the latest available observations of a replication controller's current state.
  • fullyLabeledReplicas: The number of pods that have labels matching the labels of the pod template of the replication controller.
  • observedGeneration: ObservedGeneration reflects the generation of the most recently observed replication controller.
  • readyReplicas: The number of ready replicas for this replication controller.
  • replicas: Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

Constructors

Instances

#ResourceFieldSelector Source

newtype ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Fields:

  • containerName: Container name: required for volumes, optional for env vars
  • divisor: Specifies the output format of the exposed resources, defaults to "1"
  • resource: Required: resource to select

Constructors

Instances

#ResourceQuota Source

newtype ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace

Fields:

Constructors

Instances

#ResourceQuotaList Source

newtype ResourceQuotaList

ResourceQuotaList is a list of ResourceQuota items.

Fields:

Constructors

Instances

#ResourceQuotaSpec Source

newtype ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Fields:

Constructors

Instances

#ResourceQuotaStatus Source

newtype ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.

Fields:

Constructors

Instances

#ResourceRequirements Source

newtype ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Fields:

Constructors

Instances

#SELinuxOptions Source

newtype SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Fields:

  • _type: Type is a SELinux type label that applies to the container.
  • level: Level is SELinux level label that applies to the container.
  • role: Role is a SELinux role label that applies to the container.
  • user: User is a SELinux user label that applies to the container.

Constructors

Instances

#ScaleIOPersistentVolumeSource Source

newtype ScaleIOPersistentVolumeSource

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

Fields:

  • fsType: 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.
  • gateway: The host address of the ScaleIO API Gateway.
  • protectionDomain: The name of the ScaleIO Protection Domain for the configured storage.
  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretRef: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
  • sslEnabled: Flag to enable/disable SSL communication with Gateway, default false
  • storageMode: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
  • storagePool: The ScaleIO Storage Pool associated with the protection domain.
  • system: The name of the storage system as configured in ScaleIO.
  • volumeName: The name of a volume already created in the ScaleIO system that is associated with this volume source.

Constructors

Instances

#ScaleIOVolumeSource Source

newtype ScaleIOVolumeSource

ScaleIOVolumeSource represents a persistent ScaleIO volume

Fields:

  • fsType: 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.
  • gateway: The host address of the ScaleIO API Gateway.
  • protectionDomain: The name of the ScaleIO Protection Domain for the configured storage.
  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretRef: SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
  • sslEnabled: Flag to enable/disable SSL communication with Gateway, default false
  • storageMode: Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
  • storagePool: The ScaleIO Storage Pool associated with the protection domain.
  • system: The name of the storage system as configured in ScaleIO.
  • volumeName: The name of a volume already created in the ScaleIO system that is associated with this volume source.

Constructors

Instances

#Secret Source

newtype Secret

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

Fields:

  • _data: Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4
  • _type: Used to facilitate programmatic handling of secret data.
  • metadata: Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  • stringData: stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.

Constructors

Instances

#SecretEnvSource Source

newtype SecretEnvSource

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.

Fields:

Constructors

Instances

#SecretKeySelector Source

newtype SecretKeySelector

SecretKeySelector selects a key of a Secret.

Fields:

Constructors

Instances

#SecretList Source

newtype SecretList

SecretList is a list of Secret.

Fields:

Constructors

Instances

#SecretProjection Source

newtype SecretProjection

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.

Fields:

  • items: 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: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  • optional: Specify whether the Secret or its key must be defined

Constructors

Instances

#SecretReference Source

newtype SecretReference

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

Fields:

  • name: Name is unique within a namespace to reference a secret resource.
  • namespace: Namespace defines the space within which the secret name must be unique.

Constructors

Instances

#SecretVolumeSource Source

newtype SecretVolumeSource

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.

Fields:

  • defaultMode: 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: 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 '..'.
  • optional: Specify whether the Secret or it's keys must be defined
  • secretName: Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Constructors

Instances

#SecurityContext Source

newtype SecurityContext

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.

Fields:

  • allowPrivilegeEscalation: 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
  • capabilities: The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
  • privileged: Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
  • readOnlyRootFilesystem: Whether this container has a read-only root filesystem. Default is false.
  • runAsNonRoot: 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.
  • runAsUser: 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.
  • seLinuxOptions: 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.

Constructors

Instances

#Service Source

newtype Service

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Fields:

Constructors

Instances

#ServiceAccount Source

newtype ServiceAccount

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

Fields:

Constructors

Instances

#ServiceList Source

newtype ServiceList

ServiceList holds a list of services.

Fields:

Constructors

Instances

#ServicePort Source

newtype ServicePort

ServicePort contains information on service's port.

Fields:

  • name: The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.
  • nodePort: 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
  • port: The port that will be exposed by this service.
  • protocol: The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.
  • targetPort: 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

Constructors

Instances

#ServiceSpec Source

newtype ServiceSpec

ServiceSpec describes the attributes that a user creates on a service.

Fields:

  • _type: type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types
  • clusterIP: clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
  • externalIPs: externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.
  • externalName: externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.
  • externalTrafficPolicy: externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
  • healthCheckNodePort: healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.
  • loadBalancerIP: Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
  • loadBalancerSourceRanges: If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
  • ports: The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
  • publishNotReadyAddresses: publishNotReadyAddresses, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery. This field will replace the service.alpha.kubernetes.io/tolerate-unready-endpoints when that annotation is deprecated and all clients have been converted to use this field.
  • selector: Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/
  • sessionAffinity: Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
  • sessionAffinityConfig: sessionAffinityConfig contains the configurations of session affinity.

Constructors

Instances

#ServiceStatus Source

newtype ServiceStatus

ServiceStatus represents the current status of a service.

Fields:

  • loadBalancer: LoadBalancer contains the current status of the load-balancer, if one is present.

Constructors

Instances

#SessionAffinityConfig Source

newtype SessionAffinityConfig

SessionAffinityConfig represents the configurations of session affinity.

Fields:

  • clientIP: clientIP contains the configurations of Client IP based session affinity.

Constructors

Instances

#StorageOSPersistentVolumeSource Source

newtype StorageOSPersistentVolumeSource

Represents a StorageOS persistent volume resource.

Fields:

  • fsType: 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.
  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretRef: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
  • volumeName: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
  • volumeNamespace: 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.

Constructors

Instances

#StorageOSVolumeSource Source

newtype StorageOSVolumeSource

Represents a StorageOS persistent volume resource.

Fields:

  • fsType: 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.
  • readOnly: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
  • secretRef: SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
  • volumeName: VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
  • volumeNamespace: 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.

Constructors

Instances

#TCPSocketAction Source

newtype TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Fields:

  • host: Optional: Host name to connect to, defaults to the pod IP.
  • port: 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.

Constructors

Instances

#Taint Source

newtype Taint

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

Fields:

  • effect: Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
  • key: Required. The taint key to be applied to a node.
  • timeAdded: TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
  • value: Required. The taint value corresponding to the taint key.

Constructors

Instances

#Toleration Source

newtype Toleration

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

Fields:

  • effect: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
  • key: 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: 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: 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: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

Constructors

Instances

#Volume Source

newtype Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Fields:

Constructors

Instances

#VolumeDevice Source

newtype VolumeDevice

volumeDevice describes a mapping of a raw block device within a container.

Fields:

  • devicePath: devicePath is the path inside of the container that the device will be mapped to.
  • name: name must match the name of a persistentVolumeClaim in the pod

Constructors

Instances

#VolumeMount Source

newtype