v1

package
v1.0.6-v0.6.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 17, 2015 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package v1 is the v1 version of the API.

Index

Constants

View Source 
const (
	// NamespaceDefault means the object is in the default namespace which is applied when not specified by clients
	NamespaceDefault string = "default"
	// NamespaceAll is the default argument to specify on a context when you want to list or filter resources across all namespaces
	NamespaceAll string = ""
)
View Source 
const (
	StatusSuccess = "Success"
	StatusFailure = "Failure"
)

Values of Status.Status

View Source 
const (
	// SecretTypeOpaque is the default; arbitrary user-defined data
	SecretTypeOpaque SecretType = "Opaque"

	// SecretTypeServiceAccountToken contains a token that identifies a service account to the API
	//
	// Required fields:
	// - Secret.Annotations["kubernetes.io/service-account.name"] - the name of the ServiceAccount the token identifies
	// - Secret.Annotations["kubernetes.io/service-account.uid"] - the UID of the ServiceAccount the token identifies
	// - Secret.Data["token"] - a token that identifies the service account to the API
	SecretTypeServiceAccountToken SecretType = "kubernetes.io/service-account-token"

	// ServiceAccountNameKey is the key of the required annotation for SecretTypeServiceAccountToken secrets
	ServiceAccountNameKey = "kubernetes.io/service-account.name"
	// ServiceAccountUIDKey is the key of the required annotation for SecretTypeServiceAccountToken secrets
	ServiceAccountUIDKey = "kubernetes.io/service-account.uid"
	// ServiceAccountTokenKey is the key of the required data for SecretTypeServiceAccountToken secrets
	ServiceAccountTokenKey = "token"
	// ServiceAccountKubeconfigKey is the key of the optional kubeconfig data for SecretTypeServiceAccountToken secrets
	ServiceAccountKubeconfigKey = "kubernetes.kubeconfig"
	// ServiceAccountRootCAKey is the key of the optional root certificate authority for SecretTypeServiceAccountToken secrets
	ServiceAccountRootCAKey = "ca.crt"

	// SecretTypeDockercfg contains a dockercfg file that follows the same format rules as ~/.dockercfg
	//
	// Required fields:
	// - Secret.Data[".dockercfg"] - a serialized ~/.dockercfg file
	SecretTypeDockercfg SecretType = "kubernetes.io/dockercfg"

	// DockerConfigKey is the key of the required data for SecretTypeDockercfg secrets
	DockerConfigKey = ".dockercfg"
)
View Source 
const (
	// ClusterIPNone - do not assign a cluster IP
	// no proxying required and no environment variables should be created for pods
	ClusterIPNone = "None"
)
View Source 
const MaxSecretSize = 1 * 1024 * 1024
View Source 
const (
	// TerminationMessagePathDefault means the default path to capture the application termination message running in a container
	TerminationMessagePathDefault string = "/dev/termination-log"
)

Variables

View Source 
var Codec = runtime.CodecFor(api.Scheme, "v1")

Codec encodes internal objects to the v1 scheme

Functions

This section is empty.

Types

type AWSElasticBlockStoreVolumeSource 

type AWSElasticBlockStoreVolumeSource struct {
	// Unique id of the PD resource. Used to identify the disk in AWS
	VolumeID string `` /* 137-byte string literal not displayed */
	// Required: Filesystem type to mount.
	// Must be a filesystem type supported by the host operating system.
	// Ex. "ext4", "xfs", "ntfs"
	// TODO: how do we prevent errors in the filesystem from compromising the machine
	FSType string `` /* 150-byte string literal not displayed */
	// Optional: Partition on the disk to mount.
	// If omitted, kubelet will attempt to mount the device name.
	// Ex. For /dev/sda1, this field is "1", for /dev/sda, this field 0 or empty.
	Partition int `` /* 236-byte string literal not displayed */
	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the ReadOnly setting in VolumeMounts.
	ReadOnly bool `` /* 174-byte string literal not displayed */
}

AWSElasticBlockStoreVolumeSource represents a Persistent Disk resource in AWS.

An AWS PD must exist and be formatted before mounting to a container. The disk must also be in the same AWS zone as the kubelet. A AWS PD can only be mounted on a single machine.

type Binding 

type Binding struct {
	TypeMeta `json:",inline"`
	// ObjectMeta describes the object that is being bound.
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Target is the object to bind to.
	Target ObjectReference `json:"target" description:"an object to bind to"`
}

Binding ties one object to another - for example, a pod is bound to a node by a scheduler.

func (*Binding) IsAnAPIObject 

func (*Binding) IsAnAPIObject()

type Capabilities 

type Capabilities struct {
	// Added capabilities
	Add []Capability `json:"add,omitempty" description:"added capabilities"`
	// Removed capabilities
	Drop []Capability `json:"drop,omitempty" description:"droped capabilities"`
}

Capabilities represent POSIX capabilities that can be added or removed to a running container.

type Capability 

type Capability string

Capability represent POSIX capabilities type

type CauseType 

type CauseType string

CauseType is a machine readable value providing more detail about what occured in a status response. An operation may have multiple causes for a status (whether Failure or Success). 

const (
	// CauseTypeFieldValueNotFound is used to report failure to find a requested value
	// (e.g. looking up an ID).
	CauseTypeFieldValueNotFound CauseType = "FieldValueNotFound"
	// CauseTypeFieldValueRequired is used to report required values that are not
	// provided (e.g. empty strings, null values, or empty arrays).
	CauseTypeFieldValueRequired CauseType = "FieldValueRequired"
	// CauseTypeFieldValueDuplicate is used to report collisions of values that must be
	// unique (e.g. unique IDs).
	CauseTypeFieldValueDuplicate CauseType = "FieldValueDuplicate"
	// CauseTypeFieldValueInvalid is used to report malformed values (e.g. failed regex
	// match).
	CauseTypeFieldValueInvalid CauseType = "FieldValueInvalid"
	// CauseTypeFieldValueNotSupported is used to report valid (as per formatting rules)
	// values that can not be handled (e.g. an enumerated string).
	CauseTypeFieldValueNotSupported CauseType = "FieldValueNotSupported"
)

type ComponentCondition 

type ComponentCondition struct {
	Type    ComponentConditionType `json:"type" description:"type of component condition, currently only Healthy"`
	Status  ConditionStatus        `json:"status" description:"current status of this component condition, one of True, False, Unknown"`
	Message string                 `json:"message,omitempty" description:"health check message received from the component"`
	Error   string                 `json:"error,omitempty" description:"error code from health check attempt (if any)"`
}

type ComponentConditionType 

type ComponentConditionType string

Type and constants for component health validation. 

const (
	ComponentHealthy ComponentConditionType = "Healthy"
)

These are the valid conditions for the component.

type ComponentStatus 

type ComponentStatus struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	Conditions []ComponentCondition `json:"conditions,omitempty" description:"list of component conditions observed" patchStrategy:"merge" patchMergeKey:"type"`
}

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

func (*ComponentStatus) IsAnAPIObject 

func (*ComponentStatus) IsAnAPIObject()

type ComponentStatusList 

type ComponentStatusList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []ComponentStatus `json:"items" description:"list of component status objects"`
}

func (*ComponentStatusList) IsAnAPIObject 

func (*ComponentStatusList) IsAnAPIObject()

type ConditionStatus 

type ConditionStatus string
const (
	ConditionTrue    ConditionStatus = "True"
	ConditionFalse   ConditionStatus = "False"
	ConditionUnknown ConditionStatus = "Unknown"
)

These are valid condition statuses. "ConditionTrue" means a resource is in the condition; "ConditionFalse" means a resource is not in the condition; "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.

type Container 

type Container struct {
	// Required: This must be a DNS_LABEL.  Each container in a pod must
	// have a unique name.
	Name string `json:"name" description:"name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated"`
	// Optional.
	Image string `json:"image,omitempty" description:"Docker image name; see http://releases.k8s.io/v1.0.6/docs/images.md"`
	// Optional: The docker image's entrypoint is used if this is not provided; cannot be updated.
	// 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.
	Command []string `` /* 589-byte string literal not displayed */
	// Optional: The docker image's cmd is used if this is not provided; cannot be updated.
	// 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.
	Args []string `` /* 576-byte string literal not displayed */
	// Optional: Defaults to Docker's default.
	WorkingDir     string               `json:"workingDir,omitempty" description:"container's working directory; defaults to image's default; cannot be updated"`
	Ports          []ContainerPort      `` /* 150-byte string literal not displayed */
	Env            []EnvVar             `` /* 150-byte string literal not displayed */
	Resources      ResourceRequirements `` /* 165-byte string literal not displayed */
	VolumeMounts   []VolumeMount        `` /* 157-byte string literal not displayed */
	LivenessProbe  *Probe               `` /* 219-byte string literal not displayed */
	ReadinessProbe *Probe               `` /* 250-byte string literal not displayed */
	Lifecycle      *Lifecycle           `` /* 148-byte string literal not displayed */
	// Optional: Defaults to /dev/termination-log
	TerminationMessagePath string `` /* 325-byte string literal not displayed */
	// Optional: Policy for pulling images for this container
	ImagePullPolicy PullPolicy `` /* 260-byte string literal not displayed */
	// Optional: SecurityContext defines the security options the pod should be run with
	SecurityContext *SecurityContext `` /* 147-byte string literal not displayed */
}

Container represents a single container that is expected to be run on the host.

type ContainerPort 

type ContainerPort struct {
	// Optional: If specified, this must be an IANA_SVC_NAME  Each named port
	// in a pod must have a unique name.
	Name string `` /* 141-byte string literal not displayed */
	// Optional: If specified, this must be a valid port number, 0 < x < 65536.
	// If HostNetwork is specified, this must match ContainerPort.
	HostPort int `json:"hostPort,omitempty" description:"number of port to expose on the host; most containers do not need this"`
	// Required: This must be a valid port number, 0 < x < 65536.
	ContainerPort int `json:"containerPort" description:"number of port to expose on the pod's IP address"`
	// Optional: Defaults to "TCP".
	Protocol Protocol `json:"protocol,omitempty" description:"protocol for port; must be UDP or TCP; TCP if unspecified"`
	// Optional: What host IP to bind the external port to.
	HostIP string `json:"hostIP,omitempty" description:"host IP to bind the port to"`
}

ContainerPort represents a network port in a single container.

type ContainerState 

type ContainerState struct {
	Waiting    *ContainerStateWaiting    `json:"waiting,omitempty" description:"details about a waiting container"`
	Running    *ContainerStateRunning    `json:"running,omitempty" description:"details about a running container"`
	Terminated *ContainerStateTerminated `json:"terminated,omitempty" description:"details about a terminated container"`
}

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

type ContainerStateRunning 

type ContainerStateRunning struct {
	StartedAt util.Time `json:"startedAt,omitempty" description:"time at which the container was last (re-)started"`
}

type ContainerStateTerminated 

type ContainerStateTerminated struct {
	ExitCode    int       `json:"exitCode" description:"exit status from the last termination of the container"`
	Signal      int       `json:"signal,omitempty" description:"signal from the last termination of the container"`
	Reason      string    `json:"reason,omitempty" description:"(brief) reason from the last termination of the container"`
	Message     string    `json:"message,omitempty" description:"message regarding the last termination of the container"`
	StartedAt   util.Time `json:"startedAt,omitempty" description:"time at which previous execution of the container started"`
	FinishedAt  util.Time `json:"finishedAt,omitempty" description:"time at which the container last terminated"`
	ContainerID string    `json:"containerID,omitempty" description:"container's ID in the format 'docker://<container_id>'"`
}

type ContainerStateWaiting 

type ContainerStateWaiting struct {
	// Reason could be pulling image,
	Reason string `json:"reason,omitempty" description:"(brief) reason the container is not yet running, such as pulling its image"`
}

type ContainerStatus 

type ContainerStatus struct {
	// Required: This must be a DNS_LABEL.  Each container in a pod must have a unique name.
	Name string `json:"name" description:"name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated"`
	// TODO(dchen1107): Should we rename PodStatus to a more generic name or have a separate states
	// defined for container?
	State                ContainerState `json:"state,omitempty" description:"details about the container's current condition"`
	LastTerminationState ContainerState `json:"lastState,omitempty" description:"details about the container's last termination condition"`
	Ready                bool           `json:"ready" description:"specifies whether the container has passed its readiness probe"`
	// 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.
	RestartCount int `` /* 167-byte string literal not displayed */
	// TODO(dchen1107): Which image the container is running with?
	// The image the container is running
	Image       string `json:"image" description:"image of the container; see http://releases.k8s.io/v1.0.6/docs/images.md"`
	ImageID     string `json:"imageID" description:"ID of the container's image"`
	ContainerID string `` /* 184-byte string literal not displayed */
}

type DNSPolicy 

type DNSPolicy string

DNSPolicy defines how a pod's DNS will be configured. 

const (
	// DNSClusterFirst indicates that the pod should use cluster DNS
	// first, if it is available, then fall back on the default (as
	// determined by kubelet) DNS settings.
	DNSClusterFirst DNSPolicy = "ClusterFirst"

	// DNSDefault indicates that the pod should use the default (as
	// determined by kubelet) DNS settings.
	DNSDefault DNSPolicy = "Default"
)

type DeleteOptions 

type DeleteOptions struct {
	TypeMeta `json:",inline"`

	// Optional duration in seconds before the object should be deleted. Value must be non-negative integer.
	// The value zero indicates delete immediately. If this value is nil, the default grace period for the
	// specified type will be used.
	GracePeriodSeconds *int64 `` /* 179-byte string literal not displayed */
}

DeleteOptions may be provided when deleting an API object

func (*DeleteOptions) IsAnAPIObject 

func (*DeleteOptions) IsAnAPIObject()

type EmptyDirVolumeSource 

type EmptyDirVolumeSource struct {
	// Optional: what type of storage medium should back this directory.
	// The default is "" which means to use the node's default medium.
	Medium StorageMedium `` /* 182-byte string literal not displayed */
}

type EndpointAddress 

type EndpointAddress struct {
	// The IP of this endpoint.
	// TODO: This should allow hostname or IP, see #4447.
	IP string `json:"ip" description:"IP address of the endpoint"`

	// Optional: The kubernetes object related to the entry point.
	TargetRef *ObjectReference `json:"targetRef,omitempty" description:"reference to object providing the endpoint"`
}

EndpointAddress is a tuple that describes single IP address.

type EndpointPort 

type EndpointPort struct {
	// The name of this port (corresponds to ServicePort.Name).  Optional
	// if only one port is defined.  Must be a DNS_LABEL.
	Name string `json:"name,omitempty" description:"name of this port"`

	// The port number.
	Port int `json:"port" description:"port number of the endpoint"`

	// The IP protocol for this port.
	Protocol Protocol `json:"protocol,omitempty" description:"protocol for this port; must be UDP or TCP; TCP if unspecified"`
}

EndpointPort is a tuple that describes a single port.

type EndpointSubset 

type EndpointSubset struct {
	Addresses []EndpointAddress `json:"addresses,omitempty" description:"IP addresses which offer the related ports"`
	Ports     []EndpointPort    `json:"ports,omitempty" description:"port numbers available on the related IP addresses"`
}

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: 

{
  Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
  Ports:     [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
}

The resulting set of endpoints can be viewed as: 

a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
b: [ 10.10.1.1:309, 10.10.2.2:309 ]

type Endpoints 

type Endpoints struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// The set of all endpoints is the union of all subsets.
	Subsets []EndpointSubset `json:"subsets" description:"sets of addresses and ports that comprise a service"`
}

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}]
   },
]

func (*Endpoints) IsAnAPIObject 

func (*Endpoints) IsAnAPIObject()

type EndpointsList 

type EndpointsList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []Endpoints `json:"items" description:"list of endpoints"`
}

EndpointsList is a list of endpoints.

func (*EndpointsList) IsAnAPIObject 

func (*EndpointsList) IsAnAPIObject()

type EnvVar 

type EnvVar struct {
	// Required: This must be a C_IDENTIFIER.
	Name string `json:"name" description:"name of the environment variable; must be a C_IDENTIFIER"`
	// Optional: no more than one of the following may be specified.
	// Optional: Defaults to ""; 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.
	Value string `` /* 502-byte string literal not displayed */
	// Optional: Specifies a source the value of this var should come from.
	ValueFrom *EnvVarSource `json:"valueFrom,omitempty" description:"source for the environment variable's value; cannot be used if value is not empty"`
}

EnvVar represents an environment variable present in a Container.

type EnvVarSource 

type EnvVarSource struct {
	// Required: Selects a field of the pod; only name and namespace are supported.
	FieldRef *ObjectFieldSelector `json:"fieldRef" description:"selects a field of the pod; only name and namespace are supported"`
}

EnvVarSource represents a source for the value of an EnvVar.

type Event 

type Event struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata" description:"standard object metadata; see http://releases.k8s.io/v1.0.6/docs/api-conventions.md#metadata"`

	// Required. The object that this event is about.
	InvolvedObject ObjectReference `json:"involvedObject" description:"object this event is about"`

	// Optional; this should be a short, machine understandable string that gives the reason
	// for this event being generated.
	// TODO: provide exact specification for format.
	Reason string `` /* 148-byte string literal not displayed */

	// Optional. A human-readable description of the status of this operation.
	// TODO: decide on maximum length.
	Message string `json:"message,omitempty" description:"human-readable description of the status of this operation"`

	// Optional. The component reporting this event. Should be a short machine understandable string.
	Source EventSource `json:"source,omitempty" description:"component reporting this event"`

	// The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
	FirstTimestamp util.Time `json:"firstTimestamp,omitempty" description:"the time at which the event was first recorded"`

	// The time at which the most recent occurance of this event was recorded.
	LastTimestamp util.Time `json:"lastTimestamp,omitempty" description:"the time at which the most recent occurance of this event was recorded"`

	// The number of times this event has occurred.
	Count int `json:"count,omitempty" description:"the number of times this event has occurred"`
}

Event is a report of an event somewhere in the cluster. TODO: Decide whether to store these separately or with the object they apply to.

func (*Event) IsAnAPIObject 

func (*Event) IsAnAPIObject()

type EventList 

type EventList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []Event `json:"items" description:"list of events"`
}

EventList is a list of events.

func (*EventList) IsAnAPIObject 

func (*EventList) IsAnAPIObject()

type EventSource 

type EventSource struct {
	// Component from which the event is generated.
	Component string `json:"component,omitempty" description:"component that generated the event"`
	// Host name on which the event is generated.
	Host string `json:"host,omitempty" description:"name of the host where the event is generated"`
}

type ExecAction 

type ExecAction struct {
	// 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.
	Command []string `` /* 281-byte string literal not displayed */
}

ExecAction describes a "run in container" action.

type FinalizerName 

type FinalizerName string
const (
	FinalizerKubernetes FinalizerName = "kubernetes"
)

These are internal finalizer values to Kubernetes, must be qualified name unless defined here

type GCEPersistentDiskVolumeSource 

type GCEPersistentDiskVolumeSource struct {
	// Unique name of the PD resource. Used to identify the disk in GCE
	PDName string `` /* 134-byte string literal not displayed */
	// Required: Filesystem type to mount.
	// Must be a filesystem type supported by the host operating system.
	// Ex. "ext4", "xfs", "ntfs"
	// TODO: how do we prevent errors in the filesystem from compromising the machine
	FSType string `` /* 147-byte string literal not displayed */
	// Optional: Partition on the disk to mount.
	// If omitted, kubelet will attempt to mount the device name.
	// Ex. For /dev/sda1, this field is "1", for /dev/sda, this field is 0 or empty.
	Partition int `` /* 233-byte string literal not displayed */
	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the ReadOnly setting in VolumeMounts.
	ReadOnly bool `` /* 171-byte string literal not displayed */
}

GCEPersistentDiskVolumeSource represents a Persistent Disk resource in Google Compute Engine.

A GCE PD must exist and be formatted 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.

type GitRepoVolumeSource 

type GitRepoVolumeSource struct {
	// Repository URL
	Repository string `json:"repository" description:"repository URL"`
	// Commit hash, this is optional
	Revision string `json:"revision" description:"commit hash for the specified revision"`
}

GitRepoVolumeSource represents a volume that is pulled from git when the pod is created.

type GlusterfsVolumeSource 

type GlusterfsVolumeSource struct {
	// Required: EndpointsName is the endpoint name that details Glusterfs topology
	EndpointsName string `` /* 136-byte string literal not displayed */

	// Required: Path is the Glusterfs volume path
	Path string `json:"path" description:"path to gluster volume; see http://releases.k8s.io/v1.0.6/examples/glusterfs/README.md#create-a-pod"`

	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the Glusterfs volume to be mounted with read-only permissions
	ReadOnly bool `` /* 174-byte string literal not displayed */
}

GlusterfsVolumeSource represents a Glusterfs Mount that lasts the lifetime of a pod

type HTTPGetAction 

type HTTPGetAction struct {
	// Optional: Path to access on the HTTP server.
	Path string `json:"path,omitempty" description:"path to access on the HTTP server"`
	// Required: Name or number of the port to access on the container.
	Port util.IntOrString `` /* 150-byte string literal not displayed */
	// Optional: Host name to connect to, defaults to the pod IP.
	Host string `json:"host,omitempty" description:"hostname to connect to; defaults to pod IP"`
	// Optional: Scheme to use for connecting to the host, defaults to HTTP.
	Scheme URIScheme `json:"scheme,omitempty" description:"scheme to connect with, must be HTTP or HTTPS, defaults to HTTP"`
}

HTTPGetAction describes an action based on HTTP Get requests.

type Handler 

type Handler struct {
	// One and only one of the following should be specified.
	// Exec specifies the action to take.
	Exec *ExecAction `json:"exec,omitempty" description:"exec-based handler"`
	// HTTPGet specifies the http request to perform.
	HTTPGet *HTTPGetAction `json:"httpGet,omitempty" description:"HTTP-based handler"`
	// TCPSocket specifies an action involving a TCP port.
	// TODO: implement a realistic TCP lifecycle hook
	TCPSocket *TCPSocketAction `json:"tcpSocket,omitempty"  description:"TCP-based handler; TCP hooks not yet supported"`
}

Handler defines a specific action that should be taken TODO: pass structured data to these actions, and document that data here.

type HostPathVolumeSource 

type HostPathVolumeSource struct {
	Path string `json:"path" description:"path of the directory on the host; see http://releases.k8s.io/v1.0.6/docs/volumes.md#hostpath"`
}

HostPathVolumeSource represents bare host directory volume.

type ISCSIVolumeSource 

type ISCSIVolumeSource struct {
	// Required: iSCSI target portal
	// the portal is either an IP or ip_addr:port if port is other than default (typically TCP ports 860 and 3260)
	TargetPortal string `json:"targetPortal" description:"iSCSI target portal"`
	// Required:  target iSCSI Qualified Name
	IQN string `json:"iqn" description:"iSCSI Qualified Name"`
	// Required: iSCSI target lun number
	Lun int `json:"lun" description:"iscsi target lun number"`
	// Required: Filesystem type to mount.
	// Must be a filesystem type supported by the host operating system.
	// Ex. "ext4", "xfs", "ntfs"
	// TODO: how do we prevent errors in the filesystem from compromising the machine
	FSType string `json:"fsType" description:"file system type to mount, such as ext4, xfs, ntfs"`
	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the ReadOnly setting in VolumeMounts.
	ReadOnly bool `json:"readOnly,omitempty" description:"read-only if true, read-write otherwise (false or unspecified)"`
}

A ISCSI Disk can only be mounted as read/write once.

type Lifecycle 

type Lifecycle struct {
	// PostStart is called immediately after a container is created.  If the handler fails, the container
	// is terminated and restarted.
	PostStart *Handler `` /* 330-byte string literal not displayed */
	// PreStop is called immediately before a container is terminated.  The reason for termination is
	// passed to the handler.  Regardless of the outcome of the handler, the container is eventually terminated.
	PreStop *Handler `` /* 280-byte string literal not displayed */
}

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

type LimitRange 

type LimitRange struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the limits enforced
	Spec LimitRangeSpec `` /* 139-byte string literal not displayed */
}

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

func (*LimitRange) IsAnAPIObject 

func (*LimitRange) IsAnAPIObject()

type LimitRangeItem 

type LimitRangeItem struct {
	// Type of resource that this limit applies to
	Type LimitType `json:"type,omitempty" description:"type of resource that this limit applies to"`
	// Max usage constraints on this kind by resource name
	Max ResourceList `json:"max,omitempty" description:"max usage constraints on this kind by resource name"`
	// Min usage constraints on this kind by resource name
	Min ResourceList `json:"min,omitempty" description:"min usage constraints on this kind by resource name"`
	// Default usage constraints on this kind by resource name
	Default ResourceList `json:"default,omitempty" description:"default values on this kind by resource name if omitted"`
}

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

type LimitRangeList 

type LimitRangeList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	// Items is a list of LimitRange objects
	Items []LimitRange `` /* 144-byte string literal not displayed */
}

LimitRangeList is a list of LimitRange items.

func (*LimitRangeList) IsAnAPIObject 

func (*LimitRangeList) IsAnAPIObject()

type LimitRangeSpec 

type LimitRangeSpec struct {
	// Limits is the list of LimitRangeItem objects that are enforced
	Limits []LimitRangeItem `json:"limits" description:"limits is the list of LimitRangeItem objects that are enforced"`
}

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

type LimitType 

type LimitType string

A type of object that is limited 

const (
	// Limit that applies to all pods in a namespace
	LimitTypePod LimitType = "Pod"
	// Limit that applies to all containers in a namespace
	LimitTypeContainer LimitType = "Container"
)

type List 

type List struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []runtime.RawExtension `json:"items" description:"list of objects"`
}

List holds a list of objects, which may not be known by the server.

func (*List) IsAnAPIObject 

func (*List) IsAnAPIObject()

type ListMeta 

type ListMeta struct {
	// SelfLink is a URL representing this object.
	SelfLink string `json:"selfLink,omitempty" description:"URL for the object; populated by the system, read-only"`

	// An opaque value that represents the version of this response for use with optimistic
	// concurrency and change monitoring endpoints.  Clients must treat these values as opaque
	// and values may only be valid for a particular resource or set of resources. Only servers
	// will generate resource versions.
	ResourceVersion string `` /* 384-byte string literal not displayed */
}

ListMeta describes metadata that synthetic resources must have, including lists and various status objects.

type ListOptions 

type ListOptions struct {
	TypeMeta `json:",inline"`

	// A selector based on labels
	LabelSelector string `` /* 136-byte string literal not displayed */
	// A selector based on fields
	FieldSelector string `` /* 136-byte string literal not displayed */
	// If true, watch for changes to the selected resources
	Watch bool `` /* 175-byte string literal not displayed */
	// The desired resource version to watch
	ResourceVersion string `` /* 200-byte string literal not displayed */
}

ListOptions is the query options to a standard REST list call

func (*ListOptions) IsAnAPIObject 

func (*ListOptions) IsAnAPIObject()

type LoadBalancerIngress 

type LoadBalancerIngress struct {
	// IP is set for load-balancer ingress points that are IP based
	// (typically GCE or OpenStack load-balancers)
	IP string `json:"ip,omitempty" description:"IP address of ingress point"`

	// Hostname is set for load-balancer ingress points that are DNS based
	// (typically AWS load-balancers)
	Hostname string `json:"hostname,omitempty" description:"hostname of ingress point"`
}

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

type LoadBalancerStatus 

type LoadBalancerStatus struct {
	// Ingress is a list containing ingress points for the load-balancer;
	// traffic intended for the service should be sent to these ingress points.
	Ingress []LoadBalancerIngress `json:"ingress,omitempty" description:"load-balancer ingress points"`
}

LoadBalancerStatus represents the status of a load-balancer

type LocalObjectReference 

type LocalObjectReference struct {
	//TODO: Add other useful fields.  apiVersion, kind, uid?
	Name string `json:"name,omitempty" description:"name of the referent; see http://releases.k8s.io/v1.0.6/docs/identifiers.md#names"`
}

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

type NFSVolumeSource 

type NFSVolumeSource struct {
	// Server is the hostname or IP address of the NFS server
	Server string `` /* 127-byte string literal not displayed */

	// Path is the exported NFS share
	Path string `json:"path" description:"the path that is exported by the NFS server; see http://releases.k8s.io/v1.0.6/docs/volumes.md#nfs"`

	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the NFS export to be mounted with read-only permissions
	ReadOnly bool `` /* 157-byte string literal not displayed */
}

NFSVolumeSource represents an NFS mount that lasts the lifetime of a pod

type Namespace 

type Namespace struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the behavior of the Namespace.
	Spec NamespaceSpec `` /* 149-byte string literal not displayed */

	// Status describes the current status of a Namespace
	Status NamespaceStatus `` /* 159-byte string literal not displayed */
}

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

func (*Namespace) IsAnAPIObject 

func (*Namespace) IsAnAPIObject()

type NamespaceList 

type NamespaceList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	// Items is the list of Namespace objects in the list
	Items []Namespace `` /* 132-byte string literal not displayed */
}

NamespaceList is a list of Namespaces.

func (*NamespaceList) IsAnAPIObject 

func (*NamespaceList) IsAnAPIObject()

type NamespacePhase 

type NamespacePhase string
const (
	// NamespaceActive means the namespace is available for use in the system
	NamespaceActive NamespacePhase = "Active"
	// NamespaceTerminating means the namespace is undergoing graceful termination
	NamespaceTerminating NamespacePhase = "Terminating"
)

These are the valid phases of a namespace.

type NamespaceSpec 

type NamespaceSpec struct {
	// Finalizers is an opaque list of values that must be empty to permanently remove object from storage
	Finalizers []FinalizerName `` /* 199-byte string literal not displayed */
}

NamespaceSpec describes the attributes on a Namespace

type NamespaceStatus 

type NamespaceStatus struct {
	// Phase is the current lifecycle phase of the namespace.
	Phase NamespacePhase `` /* 158-byte string literal not displayed */
}

NamespaceStatus is information about the current status of a Namespace.

type Node 

type Node struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the behavior of a node.
	Spec NodeSpec `` /* 130-byte string literal not displayed */

	// Status describes the current status of a Node
	Status NodeStatus `` /* 186-byte string literal not displayed */
}

Node is a worker node in Kubernetes. The name of the node according to etcd is in ID.

func (*Node) IsAnAPIObject 

func (*Node) IsAnAPIObject()

type NodeAddress 

type NodeAddress struct {
	Type    NodeAddressType `json:"type" description:"node address type, one of Hostname, ExternalIP or InternalIP"`
	Address string          `json:"address" description:"the node address"`
}

type NodeAddressType 

type NodeAddressType string
const (
	NodeHostName   NodeAddressType = "Hostname"
	NodeExternalIP NodeAddressType = "ExternalIP"
	NodeInternalIP NodeAddressType = "InternalIP"
)

These are valid address type of node.

type NodeCondition 

type NodeCondition struct {
	Type               NodeConditionType `json:"type" description:"type of node condition, currently only Ready"`
	Status             ConditionStatus   `json:"status" description:"status of the condition, one of True, False, Unknown"`
	LastHeartbeatTime  util.Time         `json:"lastHeartbeatTime,omitempty" description:"last time we got an update on a given condition"`
	LastTransitionTime util.Time         `json:"lastTransitionTime,omitempty" description:"last time the condition transit from one status to another"`
	Reason             string            `json:"reason,omitempty" description:"(brief) reason for the condition's last transition"`
	Message            string            `json:"message,omitempty" description:"human readable message indicating details about last transition"`
}

type NodeConditionType 

type NodeConditionType string
const (
	// NodeReady means kubelet is healthy and ready to accept pods.
	NodeReady NodeConditionType = "Ready"
)

These are valid conditions of node. Currently, we don't have enough information to decide node condition. In the future, we will add more. The proposed set of conditions are: NodeReachable, NodeLive, NodeReady, NodeSchedulable, NodeRunnable.

type NodeList 

type NodeList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []Node `json:"items" description:"list of nodes"`
}

NodeList is a list of minions.

func (*NodeList) IsAnAPIObject 

func (*NodeList) IsAnAPIObject()

type NodePhase 

type NodePhase string
const (
	// NodePending means the node has been created/added by the system, but not configured.
	NodePending NodePhase = "Pending"
	// NodeRunning means the node has been configured and has Kubernetes components running.
	NodeRunning NodePhase = "Running"
	// NodeTerminated means the node has been removed from the cluster.
	NodeTerminated NodePhase = "Terminated"
)

These are the valid phases of node.

type NodeSpec 

type NodeSpec struct {
	// PodCIDR represents the pod IP range assigned to the node
	PodCIDR string `json:"podCIDR,omitempty" description:"pod IP range assigned to the node"`
	// External ID of the node assigned by some machine database (e.g. a cloud provider)
	ExternalID string `` /* 170-byte string literal not displayed */
	// ID of the node assigned by the cloud provider
	ProviderID string `` /* 144-byte string literal not displayed */
	// Unschedulable controls node schedulability of new pods. By default node is schedulable.
	Unschedulable bool `` /* 154-byte string literal not displayed */
}

NodeSpec describes the attributes that a node is created with.

type NodeStatus 

type NodeStatus struct {
	// Capacity represents the available resources of a node.
	// see http://releases.k8s.io/v1.0.6/docs/compute_resources.md for more details.
	Capacity ResourceList `` /* 138-byte string literal not displayed */
	// NodePhase is the current lifecycle phase of the node.
	Phase NodePhase `` /* 146-byte string literal not displayed */
	// Conditions is an array of current node conditions.
	Conditions []NodeCondition `` /* 180-byte string literal not displayed */
	// Queried from cloud provider, if available.
	Addresses []NodeAddress `` /* 186-byte string literal not displayed */
	// NodeSystemInfo is a set of ids/uuids to uniquely identify the node
	NodeInfo NodeSystemInfo `` /* 144-byte string literal not displayed */
}

NodeStatus is information about the current status of a node.

type NodeSystemInfo 

type NodeSystemInfo struct {
	// MachineID is the machine-id reported by the node
	MachineID string `json:"machineID" description:"machine-id reported by the node"`
	// SystemUUID is the system-uuid reported by the node
	SystemUUID string `json:"systemUUID" description:"system-uuid reported by the node"`
	// BootID is the boot-id reported by the node
	BootID string `json:"bootID" description:"boot id is the boot-id reported by the node"`
	// Kernel version reported by the node
	KernelVersion string `json:"kernelVersion" description:"Kernel version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64)"`
	// OS image used reported by the node
	OsImage string `json:"osImage" description:"OS image used reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy))"`
	// Container runtime version reported by the node
	ContainerRuntimeVersion string `` /* 140-byte string literal not displayed */
	// Kubelet version reported by the node
	KubeletVersion string `json:"kubeletVersion" description:"Kubelet version reported by the node"`
	// Kube-proxy version reported by the node
	KubeProxyVersion string `json:"kubeProxyVersion" description:"Kube-proxy version reported by the node"`
}

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

type ObjectFieldSelector 

type ObjectFieldSelector struct {
	// Optional: Version of the schema the FieldPath is written in terms of, defaults to "v1"
	APIVersion string `json:"apiVersion,omitempty" description:"version of the schema that fieldPath is written in terms of; defaults to v1"`
	// Required: Path of the field to select in the specified API version
	FieldPath string `json:"fieldPath" description:"path of the field to select in the specified API version"`
}

ObjectFieldSelector selects an APIVersioned field of an object.

type ObjectMeta 

type ObjectMeta struct {
	// Name is unique within a namespace.  Name is required when creating resources, although
	// some resources may allow a client to request the generation of an appropriate name
	// automatically. Name is primarily intended for creation idempotence and configuration
	// definition.
	Name string `` /* 183-byte string literal not displayed */

	// GenerateName indicates that the name should be made unique by the server prior to persisting
	// it. A non-empty value for the field indicates the name will be made unique (and the name
	// returned to the client will be different than the name passed). The value of this field will
	// be combined with a unique suffix on the server if the Name field has not been provided.
	// The provided value must be valid within the rules for Name, and may be truncated by the length
	// of the suffix required to make the value unique on the server.
	//
	// If this field is specified, and Name is not present, the server will NOT return a 409 if the
	// generated name exists - instead, it will either return 201 Created or 500 with Reason
	// ServerTimeout indicating a unique name could not be found in the time allotted, and the client
	// should retry (optionally after the time indicated in the Retry-After header).
	GenerateName string `` /* 261-byte string literal not displayed */

	// Namespace defines the space within which name must be unique. An empty namespace is
	// equivalent to the "default" namespace, but "default" is the canonical representation.
	// Not all objects are required to be scoped to a namespace - the value of this field for
	// those objects will be empty.
	Namespace string `` /* 158-byte string literal not displayed */

	// SelfLink is a URL representing this object.
	SelfLink string `json:"selfLink,omitempty" description:"URL for the object; populated by the system, read-only"`

	// UID is the unique in time and space value for this object. It is typically generated by
	// the server on successful creation of a resource and is not allowed to change on PUT
	// operations.
	UID types.UID `` /* 164-byte string literal not displayed */

	// An opaque value that represents the version of this resource. May be used for optimistic
	// concurrency, change detection, and the watch operation on a resource or set of resources.
	// Clients must treat these values as opaque and values may only be valid for a particular
	// resource or set of resources. Only servers will generate resource versions.
	ResourceVersion string `` /* 384-byte string literal not displayed */

	// A sequence number representing a specific generation of the desired state.
	// Currently only implemented by replication controllers.
	Generation int64 `` /* 151-byte string literal not displayed */

	// CreationTimestamp is a timestamp representing the server time when this object was
	// created. It is not guaranteed to be set in happens-before order across separate operations.
	// Clients may not set this value. It is represented in RFC3339 form and is in UTC.
	CreationTimestamp util.Time `` /* 223-byte string literal not displayed */

	// DeletionTimestamp is the time after which this resource will be deleted. This
	// field is set by the server when a graceful deletion is requested by the user, and is not
	// directly settable by a client. The resource will be deleted (no longer visible from
	// resource lists, and not reachable by name) after the time in this field. Once set, this
	// value may not be unset or be set further into the future, although it may be shortened
	// or the resource may be deleted prior to this time. For example, a user may request that
	// a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination
	// signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet
	// will send a hard termination signal to the container.
	DeletionTimestamp *util.Time `` /* 317-byte string literal not displayed */

	// Labels are key value pairs that may be used to scope and select individual resources.
	// TODO: replace map[string]string with labels.LabelSet type
	Labels map[string]string `` /* 230-byte string literal not displayed */

	// Annotations are unstructured key value data stored with a resource that may be set by
	// external tooling. They are not queryable and should be preserved when modifying
	// objects.
	Annotations map[string]string `` /* 219-byte string literal not displayed */
}

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

type ObjectReference 

type ObjectReference struct {
	Kind            string    `` /* 127-byte string literal not displayed */
	Namespace       string    `json:"namespace,omitempty" description:"namespace of the referent; see http://releases.k8s.io/v1.0.6/docs/namespaces.md"`
	Name            string    `json:"name,omitempty" description:"name of the referent; see http://releases.k8s.io/v1.0.6/docs/identifiers.md#names"`
	UID             types.UID `json:"uid,omitempty" description:"uid of the referent; see http://releases.k8s.io/v1.0.6/docs/identifiers.md#uids"`
	APIVersion      string    `json:"apiVersion,omitempty" description:"API version of the referent"`
	ResourceVersion string    `` /* 202-byte string literal not displayed */

	// Optional. If referring to a piece of an object instead of an entire object, this string
	// should contain information to identify the sub-object. For example, if the object
	// reference is to a container within a pod, this would take on a value like:
	// "spec.containers{name}" (where "name" refers to the name of the container that triggered
	// the event) or if no container name is specified "spec.containers[2]" (container with
	// index 2 in this pod). This syntax is chosen only to have some well-defined way of
	// referencing a part of an object.
	// TODO: this design is not final and this field is subject to change in the future.
	FieldPath string `` /* 217-byte string literal not displayed */
}

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

type PersistentVolume 

type PersistentVolume struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines a persistent volume owned by the cluster
	Spec PersistentVolumeSpec `` /* 188-byte string literal not displayed */

	// Status represents the current information about persistent volume.
	Status PersistentVolumeStatus `` /* 192-byte string literal not displayed */
}

func (*PersistentVolume) IsAnAPIObject 

func (*PersistentVolume) IsAnAPIObject()

type PersistentVolumeAccessMode 

type PersistentVolumeAccessMode string
const (
	// can be mounted read/write mode to exactly 1 host
	ReadWriteOnce PersistentVolumeAccessMode = "ReadWriteOnce"
	// can be mounted in read-only mode to many hosts
	ReadOnlyMany PersistentVolumeAccessMode = "ReadOnlyMany"
	// can be mounted in read/write mode to many hosts
	ReadWriteMany PersistentVolumeAccessMode = "ReadWriteMany"
)

type PersistentVolumeClaim 

type PersistentVolumeClaim struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the volume requested by a pod author
	Spec PersistentVolumeClaimSpec `` /* 160-byte string literal not displayed */

	// Status represents the current information about a claim
	Status PersistentVolumeClaimStatus `` /* 181-byte string literal not displayed */
}

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

func (*PersistentVolumeClaim) IsAnAPIObject 

func (*PersistentVolumeClaim) IsAnAPIObject()

type PersistentVolumeClaimList 

type PersistentVolumeClaimList struct {
	TypeMeta `json:",inline"`
	ListMeta ``                      /* 133-byte string literal not displayed */
	Items    []PersistentVolumeClaim `` /* 156-byte string literal not displayed */
}

func (*PersistentVolumeClaimList) IsAnAPIObject 

func (*PersistentVolumeClaimList) IsAnAPIObject()

type PersistentVolumeClaimPhase 

type PersistentVolumeClaimPhase string
const (
	// used for PersistentVolumeClaims that are not yet bound
	ClaimPending PersistentVolumeClaimPhase = "Pending"
	// used for PersistentVolumeClaims that are bound
	ClaimBound PersistentVolumeClaimPhase = "Bound"
)

type PersistentVolumeClaimSpec 

type PersistentVolumeClaimSpec struct {
	// Contains the types of access modes required
	AccessModes []PersistentVolumeAccessMode `` /* 167-byte string literal not displayed */
	// Resources represents the minimum resources required
	Resources ResourceRequirements `` /* 157-byte string literal not displayed */
	// VolumeName is the binding reference to the PersistentVolume backing this claim
	VolumeName string `json:"volumeName,omitempty" description:"the binding reference to the persistent volume backing this claim"`
}

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

type PersistentVolumeClaimStatus 

type PersistentVolumeClaimStatus struct {
	// Phase represents the current phase of PersistentVolumeClaim
	Phase PersistentVolumeClaimPhase `json:"phase,omitempty" description:"the current phase of the claim"`
	// AccessModes contains all ways the volume backing the PVC can be mounted
	AccessModes []PersistentVolumeAccessMode `` /* 158-byte string literal not displayed */
	// Represents the actual resources of the underlying volume
	Capacity ResourceList `json:"capacity,omitempty" description:"the actual resources the volume has"`
}

type PersistentVolumeClaimVolumeSource 

type PersistentVolumeClaimVolumeSource struct {
	// ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume
	ClaimName string `` /* 185-byte string literal not displayed */
	// Optional: Defaults to false (read/write).  ReadOnly here
	// will force the ReadOnly setting in VolumeMounts
	ReadOnly bool `json:"readOnly,omitempty" description:"mount volume as read-only when true; default false"`
}

type PersistentVolumeList 

type PersistentVolumeList struct {
	TypeMeta `json:",inline"`
	ListMeta ``                 /* 133-byte string literal not displayed */
	Items    []PersistentVolume `json:"items,omitempty" description:"list of persistent volumes; see http://releases.k8s.io/v1.0.6/docs/persistent-volumes.md"`
}

func (*PersistentVolumeList) IsAnAPIObject 

func (*PersistentVolumeList) IsAnAPIObject()

type PersistentVolumePhase 

type PersistentVolumePhase string
const (
	// used for PersistentVolumes that are not available
	VolumePending PersistentVolumePhase = "Pending"
	// used for PersistentVolumes that are not yet bound
	// Available volumes are held by the binder and matched to PersistentVolumeClaims
	VolumeAvailable PersistentVolumePhase = "Available"
	// used for PersistentVolumes that are bound
	VolumeBound PersistentVolumePhase = "Bound"
	// used for PersistentVolumes where the bound PersistentVolumeClaim was deleted
	// released volumes must be recycled before becoming available again
	// this phase is used by the persistent volume claim binder to signal to another process to reclaim the resource
	VolumeReleased PersistentVolumePhase = "Released"
	// used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim
	VolumeFailed PersistentVolumePhase = "Failed"
)

type PersistentVolumeReclaimPolicy 

type PersistentVolumeReclaimPolicy string

PersistentVolumeReclaimPolicy describes a policy for end-of-life maintenance of persistent volumes 

const (
	// PersistentVolumeReclaimRecycle means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim.
	// The volume plugin must support Recycling.
	PersistentVolumeReclaimRecycle PersistentVolumeReclaimPolicy = "Recycle"
	// PersistentVolumeReclaimDelete means the volume will be deleted from Kubernetes on release from its claim.
	// The volume plugin must support Deletion.
	// TODO: implement w/ DeletableVolumePlugin
	// PersistentVolumeReclaimDelete PersistentVolumeReclaimPolicy = "Delete"
	// PersistentVolumeReclaimRetain means the volume will left in its current phase (Released) for manual reclamation by the administrator.
	// The default policy is Retain.
	PersistentVolumeReclaimRetain PersistentVolumeReclaimPolicy = "Retain"
)

type PersistentVolumeSource 

type PersistentVolumeSource struct {
	// GCEPersistentDisk represents a GCE Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	GCEPersistentDisk *GCEPersistentDiskVolumeSource `` /* 159-byte string literal not displayed */
	// AWSElasticBlockStore represents an AWS Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `` /* 165-byte string literal not displayed */
	// HostPath represents a directory on the host.
	// This is useful for development and testing only.
	// on-host storage is not supported in any way.
	HostPath *HostPathVolumeSource `` /* 171-byte string literal not displayed */
	// Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod
	Glusterfs *GlusterfsVolumeSource `` /* 154-byte string literal not displayed */
	// NFS represents an NFS mount on the host
	NFS *NFSVolumeSource `` /* 133-byte string literal not displayed */
	// RBD represents a Rados Block Device mount on the host that shares a pod's lifetime
	RBD *RBDVolumeSource `` /* 152-byte string literal not displayed */
	// ISCSI represents an ISCSI Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	ISCSI *ISCSIVolumeSource `json:"iscsi,omitempty" description:"an iSCSI disk resource provisioned by an admin"`
}

Similar to VolumeSource but meant for the administrator who creates PVs. Exactly one of its members must be set.

type PersistentVolumeSpec 

type PersistentVolumeSpec struct {
	// Resources represents the actual resources of the volume
	Capacity ResourceList `` /* 175-byte string literal not displayed */
	// Source represents the location and type of a volume to mount.
	PersistentVolumeSource `json:",inline" description:"the actual volume backing the persistent volume"`
	// AccessModes contains all ways the volume can be mounted
	AccessModes []PersistentVolumeAccessMode `` /* 152-byte string literal not displayed */
	// ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
	// ClaimRef is expected to be non-nil when bound.
	// claim.VolumeName is the authoritative bind between PV and PVC.
	ClaimRef *ObjectReference `` /* 152-byte string literal not displayed */
	// Optional: what happens to a persistent volume when released from its claim.
	PersistentVolumeReclaimPolicy PersistentVolumeReclaimPolicy `` /* 325-byte string literal not displayed */
}

type PersistentVolumeStatus 

type PersistentVolumeStatus struct {
	// Phase indicates if a volume is available, bound to a claim, or released by a claim
	Phase PersistentVolumePhase `` /* 145-byte string literal not displayed */
	// A human-readable message indicating details about why the volume is in this state.
	Message string `json:"message,omitempty" description:"human-readable message indicating details about why the volume is in this state"`
	// Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI
	Reason string `json:"reason,omitempty" description:"(brief) reason the volume is not is not available"`
}

type Pod 

type Pod struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the behavior of a pod.
	Spec PodSpec `` /* 155-byte string literal not displayed */

	// Status represents the current information about a pod. This data may not be up
	// to date.
	Status PodStatus `` /* 185-byte string literal not displayed */
}

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

func (*Pod) IsAnAPIObject 

func (*Pod) IsAnAPIObject()

type PodCondition 

type PodCondition struct {
	// Type is the type of the condition
	Type PodConditionType `` /* 138-byte string literal not displayed */
	// Status is the status of the condition
	Status ConditionStatus `` /* 149-byte string literal not displayed */
}

TODO: add LastTransitionTime, Reason, Message to match NodeCondition api.

type PodConditionType 

type PodConditionType string

PodConditionType is a valid value for PodCondition.Type 

const (
	// PodReady means the pod is able to service requests and should be added to the
	// load balancing pools of all matching services.
	PodReady PodConditionType = "Ready"
)

These are valid conditions of pod.

type PodExecOptions 

type PodExecOptions struct {
	TypeMeta `json:",inline"`

	// Stdin if true indicates that stdin is to be redirected for the exec call
	Stdin bool `json:"stdin,omitempty" description:"redirect the standard input stream of the pod for this call; defaults to false"`

	// Stdout if true indicates that stdout is to be redirected for the exec call
	Stdout bool `json:"stdout,omitempty" description:"redirect the standard output stream of the pod for this call; defaults to true"`

	// Stderr if true indicates that stderr is to be redirected for the exec call
	Stderr bool `json:"stderr,omitempty" description:"redirect the standard error stream of the pod for this call; defaults to true"`

	// TTY if true indicates that a tty will be allocated for the exec call
	TTY bool `json:"tty,omitempty" description:"allocate a terminal for this exec call; defaults to false"`

	// Container in which to execute the command.
	Container string `` /* 157-byte string literal not displayed */

	// Command is the remote command to execute; argv array; not executed within a shell.
	Command []string `json:"command" description:"the command to execute; argv array; not executed within a shell"`
}

PodExecOptions is the query options to a Pod's remote exec call

func (*PodExecOptions) IsAnAPIObject 

func (*PodExecOptions) IsAnAPIObject()

type PodList 

type PodList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 133-byte string literal not displayed */

	Items []Pod `json:"items" description:"list of pods; see http://releases.k8s.io/v1.0.6/docs/pods.md"`
}

PodList is a list of Pods.

func (*PodList) IsAnAPIObject 

func (*PodList) IsAnAPIObject()

type PodLogOptions 

type PodLogOptions struct {
	TypeMeta `json:",inline"`

	// Container for which to return logs
	Container string `` /* 144-byte string literal not displayed */

	// If true, follow the logs for the pod
	Follow bool `json:"follow,omitempty" description:"follow the log stream of the pod; defaults to false"`

	//  If true, return previous terminated container logs
	Previous bool `json:"previous,omitempty" description:"return previous terminated container logs; defaults to false"`
}

PodLogOptions is the query options for a Pod's logs REST call

func (*PodLogOptions) IsAnAPIObject 

func (*PodLogOptions) IsAnAPIObject()

type PodPhase 

type PodPhase string

PodPhase is a label for the condition of a pod at the current time. 

const (
	// PodPending means the pod has been accepted by the system, but one or more of the containers
	// has not been started. This includes time before being bound to a node, as well as time spent
	// pulling images onto the host.
	PodPending PodPhase = "Pending"
	// PodRunning means the pod has been bound to a node and all of the containers have been started.
	// At least one container is still running or is in the process of being restarted.
	PodRunning PodPhase = "Running"
	// PodSucceeded means that all containers in the pod have voluntarily terminated
	// with a container exit code of 0, and the system is not going to restart any of these containers.
	PodSucceeded PodPhase = "Succeeded"
	// PodFailed means that all containers in the pod have terminated, and at least one container has
	// terminated in a failure (exited with a non-zero exit code or was stopped by the system).
	PodFailed PodPhase = "Failed"
	// PodUnknown means that for some reason the state of the pod could not be obtained, typically due
	// to an error in communicating with the host of the pod.
	PodUnknown PodPhase = "Unknown"
)

These are the valid statuses of pods.

type PodProxyOptions 

type PodProxyOptions struct {
	TypeMeta `json:",inline"`

	// Path is the URL path to use for the current proxy request
	Path string `json:"path,omitempty" description:"URL path to use in proxy request to pod"`
}

PodProxyOptions is the query options to a Pod's proxy call

func (*PodProxyOptions) IsAnAPIObject 

func (*PodProxyOptions) IsAnAPIObject()

type PodSpec 

type PodSpec struct {
	Volumes []Volume `` /* 203-byte string literal not displayed */
	// Required: there must be at least one container in a pod.
	Containers    []Container   `` /* 283-byte string literal not displayed */
	RestartPolicy RestartPolicy `` /* 214-byte string literal not displayed */
	// 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.
	TerminationGracePeriodSeconds *int64 `` /* 573-byte string literal not displayed */
	ActiveDeadlineSeconds         *int64 `` /* 255-byte string literal not displayed */
	// Optional: Set DNS policy.  Defaults to "ClusterFirst"
	DNSPolicy DNSPolicy `json:"dnsPolicy,omitempty" description:"DNS policy for containers within the pod; one of 'ClusterFirst' or 'Default'"`
	// NodeSelector is a selector which must be true for the pod to fit on a node
	NodeSelector map[string]string `` /* 195-byte string literal not displayed */

	// ServiceAccountName is the name of the ServiceAccount to use to run this pod
	ServiceAccountName string `` /* 159-byte string literal not displayed */
	// DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.
	DeprecatedServiceAccount string `json:"serviceAccount,omitempty" description:"deprecated; use serviceAccountName instead"`

	// 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.
	NodeName string `json:"nodeName,omitempty" description:"node requested for this pod"`
	// Uses the host's network namespace. If this option is set, the ports that will be
	// used must be specified.
	// Optional: Default to false.
	HostNetwork bool `json:"hostNetwork,omitempty" description:"host networking requested for this pod"`
	// 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.
	ImagePullSecrets []LocalObjectReference `` /* 273-byte string literal not displayed */
}

PodSpec is a description of a pod

type PodStatus 

type PodStatus struct {
	Phase      PodPhase       `` /* 129-byte string literal not displayed */
	Conditions []PodCondition `` /* 182-byte string literal not displayed */
	// A human readable message indicating details about why the pod is in this state.
	Message string `json:"message,omitempty" description:"human readable message indicating details about why the pod is in this condition"`
	// A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk'
	Reason string `json:"reason,omitempty" description:"(brief-CamelCase) reason indicating details about why the pod is in this condition"`

	HostIP string `json:"hostIP,omitempty" description:"IP address of the host to which the pod is assigned; empty if not yet scheduled"`
	PodIP  string `` /* 134-byte string literal not displayed */

	StartTime *util.Time `` /* 187-byte string literal not displayed */

	// The list has one entry per container in the manifest. Each entry is currently the output
	// of `docker inspect`.
	ContainerStatuses []ContainerStatus `` /* 148-byte string literal not displayed */
}

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

type PodStatusResult 

type PodStatusResult struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */
	// Status represents the current information about a pod. This data may not be up
	// to date.
	Status PodStatus `` /* 185-byte string literal not displayed */
}

PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded

func (*PodStatusResult) IsAnAPIObject 

func (*PodStatusResult) IsAnAPIObject()

type PodTemplate 

type PodTemplate struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Template defines the pods that will be created from this pod template
	Template PodTemplateSpec `` /* 158-byte string literal not displayed */
}

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

func (*PodTemplate) IsAnAPIObject 

func (*PodTemplate) IsAnAPIObject()

type PodTemplateList 

type PodTemplateList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []PodTemplate `json:"items" description:"list of pod templates"`
}

PodTemplateList is a list of PodTemplates.

func (*PodTemplateList) IsAnAPIObject 

func (*PodTemplateList) IsAnAPIObject()

type PodTemplateSpec 

type PodTemplateSpec struct {
	// Metadata of the pods created from this template.
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the behavior of a pod.
	Spec PodSpec `` /* 155-byte string literal not displayed */
}

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

type Probe 

type Probe struct {
	// The action taken to determine the health of a container
	Handler `json:",inline"`
	// Length of time before health checking is activated.  In seconds.
	InitialDelaySeconds int64 `` /* 208-byte string literal not displayed */
	// Length of time before health checking times out.  In seconds.
	TimeoutSeconds int64 `` /* 192-byte string literal not displayed */
}

Probe describes a liveness probe to be examined to the container.

type Protocol 

type Protocol string

Protocol defines network protocols supported for things like conatiner ports. 

const (
	// ProtocolTCP is the TCP protocol.
	ProtocolTCP Protocol = "TCP"
	// ProtocolUDP is the UDP protocol.
	ProtocolUDP Protocol = "UDP"
)

type PullPolicy 

type PullPolicy string

PullPolicy describes a policy for if/when to pull a container image 

const (
	// PullAlways means that kubelet always attempts to pull the latest image.  Container will fail If the pull fails.
	PullAlways PullPolicy = "Always"
	// PullNever means that kubelet never pulls an image, but only uses a local image.  Container will fail if the image isn't present
	PullNever PullPolicy = "Never"
	// PullIfNotPresent means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
	PullIfNotPresent PullPolicy = "IfNotPresent"
)

type RBDVolumeSource 

type RBDVolumeSource struct {
	// Required: CephMonitors is a collection of Ceph monitors
	CephMonitors []string `` /* 131-byte string literal not displayed */
	// Required: RBDImage is the rados image name
	RBDImage string `json:"image" description:"rados image name; see http://releases.k8s.io/v1.0.6/examples/rbd/README.md#how-to-use-it"`
	// Required: Filesystem type to mount.
	// Must be a filesystem type supported by the host operating system.
	// Ex. "ext4", "xfs", "ntfs"
	// TODO: how do we prevent errors in the filesystem from compromising the machine
	FSType string `` /* 160-byte string literal not displayed */
	// Optional: RadosPool is the rados pool name,default is rbd
	RBDPool string `` /* 139-byte string literal not displayed */
	// Optional: RBDUser is the rados user name, default is admin
	RadosUser string `` /* 141-byte string literal not displayed */
	// Optional: Keyring is the path to key ring for RBDUser, default is /etc/ceph/keyring
	Keyring string `` /* 187-byte string literal not displayed */
	// Optional: SecretRef is name of the authentication secret for RBDUser, default is empty.
	SecretRef *LocalObjectReference `` /* 189-byte string literal not displayed */
	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the ReadOnly setting in VolumeMounts.
	ReadOnly bool `` /* 164-byte string literal not displayed */
}

RBDVolumeSource represents a Rados Block Device Mount that lasts the lifetime of a pod

type RangeAllocation 

type RangeAllocation struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 130-byte string literal not displayed */

	Range string `json:"range" description:"a range string that identifies the range represented by 'data'; required"`
	Data  []byte `json:"data" description:"a bit array containing all allocated addresses in the previous segment"`
}

RangeAllocation is not a public type

func (*RangeAllocation) IsAnAPIObject 

func (*RangeAllocation) IsAnAPIObject()

type ReplicationController 

type ReplicationController struct {
	TypeMeta `json:",inline"`

	// If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages.
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the desired behavior of this replication controller.
	Spec ReplicationControllerSpec `` /* 174-byte string literal not displayed */

	// Status is the current status of this replication controller. This data may be
	// out of date by some window of time.
	Status ReplicationControllerStatus `` /* 204-byte string literal not displayed */
}

ReplicationController represents the configuration of a replication controller.

func (*ReplicationController) IsAnAPIObject 

func (*ReplicationController) IsAnAPIObject()

type ReplicationControllerList 

type ReplicationControllerList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []ReplicationController `json:"items" description:"list of replication controllers; see http://releases.k8s.io/v1.0.6/docs/replication-controller.md"`
}

ReplicationControllerList is a collection of replication controllers.

func (*ReplicationControllerList) IsAnAPIObject 

func (*ReplicationControllerList) IsAnAPIObject()

type ReplicationControllerSpec 

type ReplicationControllerSpec struct {
	// Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified.
	Replicas *int `` /* 180-byte string literal not displayed */

	// Selector is a label query over pods that should match the Replicas count.
	// If Selector is empty, it is defaulted to the labels present on the Pod template.
	Selector map[string]string `` /* 246-byte string literal not displayed */

	// Template is the object that describes the pod that will be created if
	// insufficient replicas are detected. This takes precedence over a
	// TemplateRef.
	Template *PodTemplateSpec `` /* 243-byte string literal not displayed */
}

ReplicationControllerSpec is the specification of a replication controller.

type ReplicationControllerStatus 

type ReplicationControllerStatus struct {
	// Replicas is the number of actual replicas.
	Replicas int `` /* 169-byte string literal not displayed */

	// ObservedGeneration is the most recent generation observed by the controller.
	ObservedGeneration int64 `` /* 126-byte string literal not displayed */
}

ReplicationControllerStatus represents the current status of a replication controller.

type ResourceList 

type ResourceList map[ResourceName]resource.Quantity

ResourceList is a set of (resource name, quantity) pairs.

type ResourceName 

type ResourceName string

ResourceName is the name identifying various resources in a ResourceList. 

const (
	// CPU, in cores. (500m = .5 cores)
	ResourceCPU ResourceName = "cpu"
	// Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
	ResourceMemory ResourceName = "memory"
	// Volume size, in bytes (e,g. 5Gi = 5GiB = 5 * 1024 * 1024 * 1024)
	ResourceStorage ResourceName = "storage"
)
const (
	// Pods, number
	ResourcePods ResourceName = "pods"
	// Services, number
	ResourceServices ResourceName = "services"
	// ReplicationControllers, number
	ResourceReplicationControllers ResourceName = "replicationcontrollers"
	// ResourceQuotas, number
	ResourceQuotas ResourceName = "resourcequotas"
	// ResourceSecrets, number
	ResourceSecrets ResourceName = "secrets"
	// ResourcePersistentVolumeClaims, number
	ResourcePersistentVolumeClaims ResourceName = "persistentvolumeclaims"
)

The following identify resource constants for Kubernetes object types

type ResourceQuota 

type ResourceQuota struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the desired quota
	Spec ResourceQuotaSpec `` /* 137-byte string literal not displayed */

	// Status defines the actual enforced quota and its current usage
	Status ResourceQuotaStatus `` /* 167-byte string literal not displayed */
}

ResourceQuota sets aggregate quota restrictions enforced per namespace

func (*ResourceQuota) IsAnAPIObject 

func (*ResourceQuota) IsAnAPIObject()

type ResourceQuotaList 

type ResourceQuotaList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	// Items is a list of ResourceQuota objects
	Items []ResourceQuota `` /* 188-byte string literal not displayed */
}

ResourceQuotaList is a list of ResourceQuota items

func (*ResourceQuotaList) IsAnAPIObject 

func (*ResourceQuotaList) IsAnAPIObject()

type ResourceQuotaSpec 

type ResourceQuotaSpec struct {
	// Hard is the set of desired hard limits for each named resource
	Hard ResourceList `` /* 219-byte string literal not displayed */
}

ResourceQuotaSpec defines the desired hard limits to enforce for Quota

type ResourceQuotaStatus 

type ResourceQuotaStatus struct {
	// Hard is the set of enforced hard limits for each named resource
	Hard ResourceList `` /* 220-byte string literal not displayed */
	// Used is the current observed total usage of the resource in the namespace
	Used ResourceList `json:"used,omitempty" description:"used is the current observed total usage of the resource in the namespace"`
}

ResourceQuotaStatus defines the enforced hard limits and observed use

type ResourceRequirements 

type ResourceRequirements struct {
	// Limits describes the maximum amount of compute resources required.
	Limits ResourceList `` /* 165-byte string literal not displayed */
	// Requests describes the minimum amount of compute resources required.
	// Note: 'Requests' are honored only for Persistent Volumes as of now.
	// TODO: Update the scheduler to use 'Requests' in addition to 'Limits'. If Request is omitted for a container,
	// it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value
	Requests ResourceList `` /* 221-byte string literal not displayed */
}

ResourceRequirements describes the compute resource requirements.

type RestartPolicy 

type RestartPolicy string

RestartPolicy describes how the container should be restarted. Only one of the following restart policies may be specified. If none of the following policies is specified, the default one is RestartPolicyAlways. 

const (
	RestartPolicyAlways    RestartPolicy = "Always"
	RestartPolicyOnFailure RestartPolicy = "OnFailure"
	RestartPolicyNever     RestartPolicy = "Never"
)

type SELinuxOptions 

type SELinuxOptions struct {
	// SELinux user label
	User string `` /* 126-byte string literal not displayed */

	// SELinux role label
	Role string `` /* 126-byte string literal not displayed */

	// SELinux type label
	Type string `` /* 126-byte string literal not displayed */

	// SELinux level label.
	Level string `` /* 128-byte string literal not displayed */
}

SELinuxOptions are the labels to be applied to the container

type Secret 

type Secret struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Data contains the secret data.  Each key must be a valid DNS_SUBDOMAIN
	// or leading dot followed by valid DNS_SUBDOMAIN.
	// The serialized form of the secret data is a base64 encoded string,
	// representing the arbitrary (possibly non-string) data value here.
	Data map[string][]byte `` /* 260-byte string literal not displayed */

	// Used to facilitate programmatic handling of secret data.
	Type SecretType `json:"type,omitempty" description:"type facilitates programmatic handling of secret data"`
}

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

func (*Secret) IsAnAPIObject 

func (*Secret) IsAnAPIObject()

type SecretList 

type SecretList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []Secret `json:"items" description:"items is a list of secret objects; see http://releases.k8s.io/v1.0.6/docs/secrets.md"`
}

func (*SecretList) IsAnAPIObject 

func (*SecretList) IsAnAPIObject()

type SecretType 

type SecretType string

type SecretVolumeSource 

type SecretVolumeSource struct {
	// Name of the secret in the pod's namespace to use
	SecretName string `` /* 148-byte string literal not displayed */
}

SecretVolumeSource adapts a Secret into a VolumeSource

http://releases.k8s.io/v1.0.6/docs/design/secrets.md

type SecurityContext 

type SecurityContext struct {
	// Capabilities are the capabilities to add/drop when running the container
	// Must match Container.Capabilities or be unset.  Will be defaulted to Container.Capabilities if left unset
	Capabilities *Capabilities `` /* 181-byte string literal not displayed */

	// Run the container in privileged mode
	// Must match Container.Privileged or be unset.  Will be defaulted to Container.Privileged if left unset
	Privileged *bool `` /* 162-byte string literal not displayed */

	// SELinuxOptions are the labels to be applied to the container
	// and volumes
	SELinuxOptions *SELinuxOptions `` /* 177-byte string literal not displayed */

	// RunAsUser is the UID to run the entrypoint of the container process.
	RunAsUser *int64 `` /* 181-byte string literal not displayed */
}

SecurityContext holds security configuration that will be applied to a container. SecurityContext contains duplication of some existing fields from the Container resource. These duplicate fields will be populated based on the Container configuration if they are not set. Defining them on both the Container AND the SecurityContext will result in an error.

type SerializedReference 

type SerializedReference struct {
	TypeMeta  `json:",inline"`
	Reference ObjectReference `json:"reference,omitempty" description:"the reference to an object in the system"`
}

func (*SerializedReference) IsAnAPIObject 

func (*SerializedReference) IsAnAPIObject()

type Service 

type Service struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Spec defines the behavior of a service.
	Spec ServiceSpec `` /* 159-byte string literal not displayed */

	// Status represents the current status of a service.
	Status ServiceStatus `` /* 189-byte string literal not displayed */
}

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.

func (*Service) IsAnAPIObject 

func (*Service) IsAnAPIObject()

type ServiceAccount 

type ServiceAccount struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `` /* 132-byte string literal not displayed */

	// Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount
	Secrets []ObjectReference `` /* 205-byte string literal not displayed */

	// ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images
	// in pods that reference this ServiceAccount.  ImagePullSecrets are distinct from Secrets because Secrets
	// can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet.
	ImagePullSecrets []LocalObjectReference `` /* 228-byte string literal not displayed */
}

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

func (*ServiceAccount) IsAnAPIObject 

func (*ServiceAccount) IsAnAPIObject()

type ServiceAccountList 

type ServiceAccountList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []ServiceAccount `` /* 127-byte string literal not displayed */
}

ServiceAccountList is a list of ServiceAccount objects

func (*ServiceAccountList) IsAnAPIObject 

func (*ServiceAccountList) IsAnAPIObject()

type ServiceAffinity 

type ServiceAffinity string

Session Affinity Type string 

const (
	// ServiceAffinityClientIP is the Client IP based.
	ServiceAffinityClientIP ServiceAffinity = "ClientIP"

	// ServiceAffinityNone - no session affinity.
	ServiceAffinityNone ServiceAffinity = "None"
)

type ServiceList 

type ServiceList struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	Items []Service `json:"items" description:"list of services"`
}

ServiceList holds a list of services.

func (*ServiceList) IsAnAPIObject 

func (*ServiceList) IsAnAPIObject()

type ServicePort 

type ServicePort struct {
	// Optional if only one ServicePort is defined on this service: 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.
	Name string `json:"name,omitempty" description:"the name of this port; optional if only one port is defined"`

	// Optional: The IP protocol for this port.  Supports "TCP" and "UDP",
	// default is TCP.
	Protocol Protocol `json:"protocol,omitempty" description:"the protocol used by this port; must be UDP or TCP; TCP if unspecified"`

	// Required: The port that will be exposed by this service.
	Port int `json:"port" description:"the port number that is exposed"`

	// Optional: The target port on pods selected by this service.
	// 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 Port is used (an identity map).
	TargetPort util.IntOrString `` /* 286-byte string literal not displayed */

	// The port on each node on which this service is exposed.
	// Default is to auto-allocate a port if the ServiceType of this Service requires one.
	NodePort int `` /* 321-byte string literal not displayed */
}

type ServiceSpec 

type ServiceSpec struct {
	// Required: The list of ports that are exposed by this service.
	Ports []ServicePort `` /* 139-byte string literal not displayed */

	// This service will route traffic to pods having labels matching this selector. If null, no endpoints will be automatically created. If empty, all pods will be selected.
	Selector map[string]string `` /* 272-byte string literal not displayed */

	// ClusterIP is usually assigned by the master.  If specified by the user
	// we will try to respect it or else fail the request.  This field can
	// not be changed by updates.
	// Valid values are None, empty string (""), or a valid IP address
	// None can be specified for headless services when proxying is not required
	ClusterIP string `` /* 382-byte string literal not displayed */

	// Type determines how the service will be exposed.  Valid options: ClusterIP, NodePort, LoadBalancer
	Type ServiceType `` /* 195-byte string literal not displayed */

	// Deprecated. PublicIPs are used by external load balancers, or can be set by
	// users to handle external traffic that arrives at a node.
	DeprecatedPublicIPs []string `` /* 146-byte string literal not displayed */

	// Optional: Supports "ClientIP" and "None".  Used to maintain session affinity.
	SessionAffinity ServiceAffinity `` /* 214-byte string literal not displayed */
}

ServiceSpec describes the attributes that a user creates on a service

type ServiceStatus 

type ServiceStatus struct {
	// LoadBalancer contains the current status of the load-balancer,
	// if one is present.
	LoadBalancer LoadBalancerStatus `json:"loadBalancer,omitempty" description:"status of load-balancer"`
}

ServiceStatus represents the current status of a service

type ServiceType 

type ServiceType string

Service Type string describes ingress methods for a service 

const (
	// ServiceTypeClusterIP means a service will only be accessible inside the
	// cluster, via the cluster IP.
	ServiceTypeClusterIP ServiceType = "ClusterIP"

	// ServiceTypeNodePort means a service will be exposed on one port of
	// every node, in addition to 'ClusterIP' type.
	ServiceTypeNodePort ServiceType = "NodePort"

	// ServiceTypeLoadBalancer means a service will be exposed via an
	// external load balancer (if the cloud provider supports it), in addition
	// to 'NodePort' type.
	ServiceTypeLoadBalancer ServiceType = "LoadBalancer"
)

type Status 

type Status struct {
	TypeMeta `json:",inline"`
	ListMeta `` /* 130-byte string literal not displayed */

	// One of: "Success" or "Failure"
	Status string `` /* 164-byte string literal not displayed */
	// A human-readable description of the status of this operation.
	Message string `json:"message,omitempty" description:"human-readable description of the status of this operation"`
	// A machine-readable description of why this operation is in the
	// "Failure" status. If this value is empty there
	// is no information available. A Reason clarifies an HTTP status
	// code but does not override it.
	Reason StatusReason `` /* 238-byte string literal not displayed */
	// Extended data associated with the reason.  Each reason may define its
	// own extended details. This field is optional and the data returned
	// is not guaranteed to conform to any schema except that defined by
	// the reason type.
	Details *StatusDetails `` /* 256-byte string literal not displayed */
	// Suggested HTTP return code for this status, 0 if not set.
	Code int `json:"code,omitempty" description:"suggested HTTP return code for this status; 0 if not set"`
}

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

func (*Status) IsAnAPIObject 

func (*Status) IsAnAPIObject()

type StatusCause 

type StatusCause struct {
	// A machine-readable description of the cause of the error. If this value is
	// empty there is no information available.
	Type CauseType `` /* 150-byte string literal not displayed */
	// A human-readable description of the cause of the error.  This field may be
	// presented as-is to a reader.
	Message string `` /* 138-byte string literal not displayed */
	// The field of the resource that has caused this error, as named by its JSON
	// serialization. May include dot and postfix notation for nested attributes.
	// Arrays are zero-indexed.  Fields may appear more than once in an array of
	// causes due to fields having multiple errors.
	// Optional.
	//
	// Examples:
	//   "name" - the field "name" on the current resource
	//   "items[0].name" - the field "name" on the first array entry in "items"
	Field string `` /* 299-byte string literal not displayed */
}

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

type StatusDetails 

type StatusDetails struct {
	// The name attribute of the resource associated with the status StatusReason
	// (when there is a single name which can be described).
	Name string `` /* 163-byte string literal not displayed */
	// The kind attribute of the resource associated with the status StatusReason.
	// On some operations may differ from the requested resource Kind.
	Kind string `` /* 245-byte string literal not displayed */
	// The Causes array includes more details associated with the StatusReason
	// failure. Not all StatusReasons may provide detailed causes.
	Causes []StatusCause `` /* 168-byte string literal not displayed */
	// If specified, the time in seconds before the operation should be retried.
	RetryAfterSeconds int `` /* 127-byte string literal not displayed */
}

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

type StatusReason 

type StatusReason string

StatusReason is an enumeration of possible failure causes. Each StatusReason must map to a single HTTP status code, but multiple reasons may map to the same HTTP status code. TODO: move to apiserver 

const (
	// StatusReasonUnknown means the server has declined to indicate a specific reason.
	// The details field may contain other information about this error.
	// Status code 500.
	StatusReasonUnknown StatusReason = ""

	// StatusReasonNotFound means one or more resources required for this operation
	// could not be found.
	// Details (optional):
	//   "kind" string - the kind attribute of the missing resource
	//                   on some operations may differ from the requested
	//                   resource.
	//   "id"   string - the identifier of the missing resource
	// Status code 404
	StatusReasonNotFound StatusReason = "NotFound"

	// StatusReasonAlreadyExists means the resource you are creating already exists.
	// Details (optional):
	//   "kind" string - the kind attribute of the conflicting resource
	//   "id"   string - the identifier of the conflicting resource
	// Status code 409
	StatusReasonAlreadyExists StatusReason = "AlreadyExists"

	// StatusReasonConflict means the requested update operation cannot be completed
	// due to a conflict in the operation. The client may need to alter the request.
	// Each resource may define custom details that indicate the nature of the
	// conflict.
	// Status code 409
	StatusReasonConflict StatusReason = "Conflict"

	// StatusReasonInvalid means the requested create or update operation cannot be
	// completed due to invalid data provided as part of the request. The client may
	// need to alter the request. When set, the client may use the StatusDetails
	// message field as a summary of the issues encountered.
	// Details (optional):
	//   "kind" string - the kind attribute of the invalid resource
	//   "id"   string - the identifier of the invalid resource
	//   "causes"      - one or more StatusCause entries indicating the data in the
	//                   provided resource that was invalid.  The code, message, and
	//                   field attributes will be set.
	// Status code 422
	StatusReasonInvalid StatusReason = "Invalid"

	// StatusReasonServerTimeout means the server can be reached and understood the request,
	// but cannot complete the action in a reasonable time. The client should retry the request.
	// This is may be due to temporary server load or a transient communication issue with
	// another server. Status code 500 is used because the HTTP spec provides no suitable
	// server-requested client retry and the 5xx class represents actionable errors.
	// Details (optional):
	//   "kind" string - the kind attribute of the resource being acted on.
	//   "id"   string - the operation that is being attempted.
	// Status code 500
	StatusReasonServerTimeout StatusReason = "ServerTimeout"
)

type StorageMedium 

type StorageMedium string

StorageMedium defines ways that storage can be allocated to a volume. 

const (
	StorageMediumDefault StorageMedium = ""       // use whatever the default is for the node
	StorageMediumMemory  StorageMedium = "Memory" // use memory (tmpfs)
)

type TCPSocketAction 

type TCPSocketAction struct {
	// Required: Port to connect to.
	Port util.IntOrString `` /* 150-byte string literal not displayed */
}

TCPSocketAction describes an action based on opening a socket

type TypeMeta 

type TypeMeta struct {
	// Kind is a string value representing the REST resource this object represents.
	// Servers may infer this from the endpoint the client submits requests to.
	Kind string `` /* 154-byte string literal not displayed */

	// APIVersion defines the versioned schema of this representation of an object.
	// Servers should convert recognized schemas to the latest internal value, and
	// may reject unrecognized values.
	APIVersion string `` /* 155-byte string literal not displayed */
}

TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.

type URIScheme 

type URIScheme string

URIScheme identifies the scheme used for connection to a host for Get actions 

const (
	// URISchemeHTTP means that the scheme used will be http://
	URISchemeHTTP URIScheme = "HTTP"
	// URISchemeHTTPS means that the scheme used will be https://
	URISchemeHTTPS URIScheme = "HTTPS"
)

type Volume 

type Volume struct {
	// Required: This must be a DNS_LABEL.  Each volume in a pod must have
	// a unique name.
	Name string `` /* 145-byte string literal not displayed */
	// Source represents the location and type of a volume to mount.
	// This is optional for now. If not specified, the Volume is implied to be an EmptyDir.
	// This implied behavior is deprecated and will be removed in a future version.
	VolumeSource `json:",inline"`
}

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

type VolumeMount 

type VolumeMount struct {
	// Required: This must match the Name of a Volume [above].
	Name string `json:"name" description:"name of the volume to mount"`
	// Optional: Defaults to false (read-write).
	ReadOnly bool `json:"readOnly,omitempty" description:"mounted read-only if true, read-write otherwise (false or unspecified)"`
	// Required.
	MountPath string `json:"mountPath" description:"path within the container at which the volume should be mounted"`
}

VolumeMount describes a mounting of a Volume within a container.

type VolumeSource 

type VolumeSource struct {
	// HostPath represents a pre-existing file or directory on the host
	// machine that is directly exposed to the container. This is generally
	// used for system agents or other privileged things that are allowed
	// to see the host machine. Most containers will NOT need this.
	// TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
	// mount host directories as read/write.
	HostPath *HostPathVolumeSource `` /* 209-byte string literal not displayed */
	// EmptyDir represents a temporary directory that shares a pod's lifetime.
	EmptyDir *EmptyDirVolumeSource `` /* 148-byte string literal not displayed */
	// GCEPersistentDisk represents a GCE Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	GCEPersistentDisk *GCEPersistentDiskVolumeSource `` /* 174-byte string literal not displayed */
	// AWSElasticBlockStore represents an AWS Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `` /* 180-byte string literal not displayed */
	// GitRepo represents a git repository at a particular revision.
	GitRepo *GitRepoVolumeSource `json:"gitRepo,omitempty" description:"git repository at a particular revision"`
	// Secret represents a secret that should populate this volume.
	Secret *SecretVolumeSource `json:"secret,omitempty" description:"secret to populate volume; see http://releases.k8s.io/v1.0.6/docs/volumes.md#secrets"`
	// NFS represents an NFS mount on the host that shares a pod's lifetime
	NFS *NFSVolumeSource `` /* 141-byte string literal not displayed */
	// ISCSI represents an ISCSI Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	ISCSI *ISCSIVolumeSource `` /* 142-byte string literal not displayed */
	// Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime
	Glusterfs *GlusterfsVolumeSource `` /* 162-byte string literal not displayed */
	// PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace
	PersistentVolumeClaim *PersistentVolumeClaimVolumeSource `` /* 198-byte string literal not displayed */
	// RBD represents a Rados Block Device mount on the host that shares a pod's lifetime
	RBD *RBDVolumeSource `` /* 152-byte string literal not displayed */
}

VolumeSource represents the source location of a volume to mount. Only one of its members may be specified.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.