v1beta2

package
v0.13.0 Latest Latest
Warning

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

 Go to latest Published: May 29, 2015 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package v1beta2 is the v1beta2 version of the API.

Index

Constants

View Source 
const (
	StatusSuccess = "Success"
	StatusFailure = "Failure"
)

Values of Status.Status

View Source 
const Dependency = true

Dependency does nothing but give a hook for other packages to force a compile-time error when this API version is eventually removed. This is useful, for example, to clean up things that are implicitly tied to semantics of older APIs.

View Source 
const MaxSecretSize = 1 * 1024 * 1024
View Source 
const (
	// PortalIPNone - do not assign a portal IP
	// no proxying required and no environment variables should be created for pods
	PortalIPNone = "None"
)
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, "v1beta2")

Codec encodes internal objects to the v1beta2 scheme

Functions

This section is empty.

Types

type AWSElasticBlockStoreVolumeSource added in v0.11.0 

type AWSElasticBlockStoreVolumeSource struct {
	// Unique id of the PD resource. Used to identify the disk in AWS
	VolumeID string `json:"volumeID" description:"unique id of the PD resource in AWS"`
	// 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
	// TODO: why omitempty if required?
	FSType string `json:"fsType,omitempty" description:"file system type to mount, such as ext4, xfs, ntfs"`
	// 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 `` /* 164-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:"read-only if true, read-write otherwise (false or unspecified)"`
}

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 AccessModeType added in v0.11.0 

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

type AffinityType 

type AffinityType string

Session Affinity Type string 

const (
	// AffinityTypeClientIP is the Client IP based.
	AffinityTypeClientIP AffinityType = "ClientIP"

	// AffinityTypeNone - no session affinity.
	AffinityTypeNone AffinityType = "None"
)

type Binding 

type Binding struct {
	TypeMeta `json:",inline"`
	PodID    string `json:"podID" description:"name of the pod to bind"`
	Host     string `json:"host" description:"host to which to bind the specified pod"`
}

Binding is written by a scheduler to cause a pod to be bound to a host.

func (*Binding) IsAnAPIObject 

func (*Binding) IsAnAPIObject()

type Capabilities 

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

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

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/containers.md#capabilities

type CapabilityType 

type CapabilityType string

CapabilityType 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 ConditionStatus 

type ConditionStatus string
const (
	ConditionFull    ConditionStatus = "Full"
	ConditionNone    ConditionStatus = "None"
	ConditionUnknown ConditionStatus = "Unknown"
)

These are valid condition statuses. "ConditionFull" means a resource is in the condition; "ConditionNone" 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"`
	// Required.
	Image string `json:"image" description:"Docker image name"`
	// Optional: The image's entrypoint is used if this is not provided; cannot be updated.
	Entrypoint []string `` /* 162-byte string literal not displayed */
	// Optional: The image's cmd is used if this is not provided; cannot be updated.
	Command []string `` /* 154-byte string literal not displayed */
	// Optional: Docker's default is used if this is not provided.
	WorkingDir string               `json:"workingDir,omitempty" description:"container's working directory; defaults to image's default; cannot be updated"`
	Ports      []ContainerPort      `json:"ports,omitempty" description:"list of ports to expose from the container; cannot be updated"`
	Env        []EnvVar             `json:"env,omitempty" description:"list of environment variables to set in the container; cannot be updated"`
	Resources  ResourceRequirements `json:"resources,omitempty" description:"Compute Resources required by this container; cannot be updated"`
	// Optional: Defaults to unlimited.
	CPU int `json:"cpu,omitempty" description:"CPU share in thousandths of a core; cannot be updated"`
	// Optional: Defaults to unlimited.
	Memory         int64          `json:"memory,omitempty" description:"memory limit in bytes; defaults to unlimited; cannot be updated"`
	VolumeMounts   []VolumeMount  `json:"volumeMounts,omitempty" description:"pod volumes to mount into the container's filesystem; cannot be updated"`
	LivenessProbe  *LivenessProbe `` /* 148-byte string literal not displayed */
	ReadinessProbe *LivenessProbe `` /* 179-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: Default to false.
	Privileged bool `` /* 137-byte string literal not displayed */
	// Optional: Policy for pulling images for this container
	ImagePullPolicy PullPolicy `` /* 204-byte string literal not displayed */
	// Optional: Capabilities for container.
	Capabilities Capabilities `json:"capabilities,omitempty" description:"capabilities for container; cannot be updated"`
}

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

type ContainerManifest 

type ContainerManifest struct {
	// Required: This must be a supported version string, such as "v1beta1".
	Version string `json:"version" description:"manifest version; must be v1beta1"`
	// Required: This must be a DNS_SUBDOMAIN.
	// TODO: ID on Manifest is deprecated and will be removed in the future.
	ID string `json:"id" description:"manifest name; must be a DNS_SUBDOMAIN; cannot be updated"`
	// TODO: UUID on Manifext is deprecated in the future once we are done
	// with the API refactory. It is required for now to determine the instance
	// of a Pod.
	UUID          types.UID     `json:"uuid,omitempty" description:"manifest UUID; cannot be updated"`
	Volumes       []Volume      `json:"volumes" description:"list of volumes that can be mounted by containers belonging to the pod"`
	Containers    []Container   `` /* 139-byte string literal not displayed */
	RestartPolicy RestartPolicy `` /* 165-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'"`
	// 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"`
}

ContainerManifest corresponds to the Container Manifest format, documented at: https://developers.google.com/compute/docs/containers/container_vms#container_manifest This is used as the representation of Kubernetes workloads. DEPRECATED: Replaced with Pod

func (*ContainerManifest) IsAnAPIObject 

func (*ContainerManifest) IsAnAPIObject()

type ContainerManifestList 

type ContainerManifestList struct {
	TypeMeta `json:",inline"`
	Items    []ContainerManifest `json:"items" description:"list of pod container manifests"`
}

ContainerManifestList is used to communicate container manifests to kubelet. DEPRECATED: Replaced with PodList

func (*ContainerManifestList) IsAnAPIObject 

func (*ContainerManifestList) IsAnAPIObject()

type ContainerPort 

type ContainerPort struct {
	// Optional: If specified, this must be a DNS_LABEL.  Each named port
	// in a pod must have a unique name.
	Name string `` /* 137-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"`
	Termination *ContainerStateTerminated `json:"termination,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 {
	// 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): Need to decide how to reprensent this in v1beta3
	Image       string `json:"image" description:"image of the container"`
	ImageID     string `json:"imageID" description:"ID of the container's image"`
	ContainerID string `json:"containerID,omitempty" description:"container's ID in the format 'docker://<container_id>'"`
}

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 StorageType `json:"medium" description:"type of storage used to back the volume; must be an empty string (default) or Memory"`
}

Represents an empty directory volume.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/volumes.md#emptydir

type EndpointAddress added in v0.11.0 

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 EndpointObjectReference 

type EndpointObjectReference struct {
	Endpoint        string `json:"endpoint" description:"endpoint exposed by the referenced object"`
	ObjectReference `json:"targetRef" description:"reference to the object providing the entry point"`
}

EndpointObjectReference is a reference to an object exposing the endpoint

type EndpointPort added in v0.11.0 

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 added in v0.11.0 

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"`

	// These fields are retained for backwards compatibility.  For
	// multi-port services, use the Subsets field instead.  Upon a create or
	// update operation, the following logic applies:
	//   * If Subsets is specified, Protocol, Endpoints, and TargetRefs will
	//     be overwritten by data from Subsets.
	//   * If Subsets is not specified, Protocol, Endpoints, and TargetRefs
	//     will be used to generate Subsets.
	Protocol  Protocol `` /* 127-byte string literal not displayed */
	Endpoints []string `` /* 130-byte string literal not displayed */
	// Optional: The kubernetes objects related to the first set of entry points.
	TargetRefs []EndpointObjectReference `json:"targetRefs,omitempty" description:"list of references to objects providing the endpoints"`

	// The set of all endpoints is the union of all subsets.  If this field
	// is not empty it must include the backwards-compatible protocol and
	// endpoints.
	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, for example: Name: "mysql", Endpoints: ["10.10.1.1:1909", "10.10.2.2:8834"]

func (*Endpoints) IsAnAPIObject 

func (*Endpoints) IsAnAPIObject()

type EndpointsList 

type EndpointsList struct {
	TypeMeta `json:",inline"`
	Items    []Endpoints `json:"items" description:"list of service endpoint lists"`
}

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: defaults to "".
	Value string `json:"value,omitempty" description:"value of the environment variable; defaults to empty string"`
}

EnvVar represents an environment variable present in a Container.

type Event 

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

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

	// Should be a short, machine understandable string that describes the current status
	// of the referred object. This should not give the reason for being in this state.
	// Examples: "Running", "CantStart", "CantSchedule", "Deleted".
	// It's OK for components to make up statuses to report here, but the same string should
	// always be used for the same status.
	// TODO: define a way of making sure these are consistent and don't collide.
	// TODO: provide exact specification for format.
	// DEPRECATED: Status (a.k.a Condition) value will be ignored.
	Status string `` /* 131-byte string literal not displayed */

	// Optional; this should be a short, machine understandable string that gives the reason
	// for the transition into the object's current status. For example, if ObjectStatus is
	// "CantStart", Reason might be "ImageNotFound".
	// 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.
	// TODO: provide exact specification for format.
	Source string `json:"source,omitempty" description:"component reporting this event; short machine understandable string"`

	// Host name on which the event is generated.
	Host string `json:"host,omitempty" description:"host name on which this event was generated"`

	// The time at which the client recorded the event. (Time of server receipt is in TypeMeta.)
	// Deprecated: Use InitialTimeStamp/LastSeenTimestamp/Count instead.
	// For backwards compatability, this will map to IntialTimestamp.
	Timestamp util.Time `json:"timestamp,omitempty" description:"time at which the client recorded the 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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/pod-states.md#events

func (*Event) IsAnAPIObject 

func (*Event) IsAnAPIObject()

type EventList 

type EventList struct {
	TypeMeta `json:",inline"`
	Items    []Event `json:"items" description:"list of events"`
}

EventList is a list of events.

func (*EventList) IsAnAPIObject 

func (*EventList) IsAnAPIObject()

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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/container-environment.md#hook-handler-implementations

type FinalizerName added in v0.11.0 

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 `json:"pdName" description:"unique name of the PD resource in GCE"`
	// 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
	// TODO: why omitempty if required?
	FSType string `json:"fsType,omitempty" description:"file system type to mount, such as ext4, xfs, ntfs"`
	// 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 `` /* 164-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:"read-only if true, read-write otherwise (false or unspecified)"`
}

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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/volumes.md#gcepersistentdisk

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 added in v0.11.0 

type GlusterfsVolumeSource struct {
	// Required: EndpointsName is the endpoint name that details Glusterfs topology
	EndpointsName string `json:"endpoints" description:"gluster hosts endpoints name"`

	// Required: Path is the Glusterfs volume path
	Path string `json:"path" description:"path to gluster volume"`

	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the Glusterfs volume to be mounted with read-only permissions
	ReadOnly bool `json:"readOnly,omitempty" description:"glusterfs volume to be mounted with read-only permissions"`
}

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 `json:"port,omitempty" description:"number or name of the port to access on the container"`
	// 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"`
}

HTTPGetAction describes an action based on HTTP Get requests.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/container-environment.md#hook-handler-implementations

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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/container-environment.md#hook-handler-implementations

type HostPathVolumeSource 

type HostPathVolumeSource struct {
	Path string `json:"path" description:"path of the directory on the host"`
}

HostPathVolumeSource represents bare host directory volume.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/volumes.md#hostdir

type ISCSIVolumeSource added in v0.11.0 

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,omitempty" description:"iSCSI target portal"`
	// Required:  target iSCSI Qualified Name
	IQN string `json:"iqn,omitempty" description:"iSCSI Qualified Name"`
	// Required: iSCSI target lun number
	Lun int `json:"lun,omitempty" 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,omitempty" 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 `` /* 252-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 `` /* 202-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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/container-environment.md#hook-details

type LimitRange 

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

	// Spec defines the limits enforced
	Spec LimitRangeSpec `json:"spec,omitempty" description:"spec defines the limits enforced"`
}

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"`

	// Items is a list of LimitRange objects
	Items []LimitRange `json:"items" description:"items is a list of LimitRange objects"`
}

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"`
	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 ListOptions added in v0.11.0 

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

	// A selector based on labels
	LabelSelector string `json:"labels" description:"a selector to restrict the list of returned objects by their labels; defaults to everything"`
	// A selector based on fields
	FieldSelector string `json:"fields" description:"a selector to restrict the list of returned objects by their fields; defaults to everything"`
	// If true, watch for changes to the selected resources
	Watch bool `` /* 165-byte string literal not displayed */
	// The desired resource version to watch
	ResourceVersion string `` /* 190-byte string literal not displayed */
}

ListOptions is the query options to a standard REST list call

func (*ListOptions) IsAnAPIObject added in v0.11.0 

func (*ListOptions) IsAnAPIObject()

type LivenessProbe 

type LivenessProbe struct {
	// HTTPGetProbe parameters, required if Type == 'http'
	HTTPGet *HTTPGetAction `json:"httpGet,omitempty" description:"parameters for HTTP-based liveness probe"`
	// TCPSocketProbe parameter, required if Type == 'tcp'
	TCPSocket *TCPSocketAction `json:"tcpSocket,omitempty" description:"parameters for TCP-based liveness probe"`
	// ExecProbe parameter, required if Type == 'exec'
	Exec *ExecAction `json:"exec,omitempty" description:"parameters for exec-based liveness probe"`
	// Length of time before health checking is activated.  In seconds.
	InitialDelaySeconds int64 `` /* 137-byte string literal not displayed */
	// Length of time before health checking times out.  In seconds.
	TimeoutSeconds int64 `json:"timeoutSeconds,omitempty" description:"number of seconds after which liveness probes timeout; defaults to 1 second"`
}

LivenessProbe describes a liveness probe to be examined to the container. TODO: pass structured data to the actions, and document that data here.

type Minion 

type Minion struct {
	TypeMeta `json:",inline"`
	// DEPRECATED: Use Status.Addresses instead.
	// Queried from cloud provider, if available.
	HostIP string `json:"hostIP,omitempty" description:"IP address of the node"`
	// Resources available on the node
	NodeResources NodeResources `json:"resources,omitempty" description:"characterization of node resources"`
	// Pod IP range assigned to the node
	PodCIDR string `json:"podCIDR,omitempty" description:"IP range assigned to the node"`
	// Unschedulable controls node schedulability of new pods. By default node is schedulable.
	Unschedulable bool `json:"unschedulable,omitempty" description:"disable pod scheduling on the node"`
	// Status describes the current status of a node
	Status NodeStatus `json:"status,omitempty" description:"current status of node"`
	// Labels for the node
	Labels map[string]string `` /* 209-byte string literal not displayed */
	// External ID of the node
	ExternalID string `` /* 158-byte string literal not displayed */
}

Minion is a worker node in Kubernetenes. The name of the minion according to etcd is in ID.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/node.md#node-condition

func (*Minion) IsAnAPIObject 

func (*Minion) IsAnAPIObject()

type MinionList 

type MinionList struct {
	TypeMeta `json:",inline"`
	Items    []Minion `json:"items" description:"list of nodes"`
}

MinionList is a list of minions.

func (*MinionList) IsAnAPIObject 

func (*MinionList) IsAnAPIObject()

type NFSVolumeSource 

type NFSVolumeSource struct {
	// Server is the hostname or IP address of the NFS server
	Server string `json:"server" description:"the hostname or IP address of the NFS server"`

	// Path is the exported NFS share
	Path string `json:"path" description:"the path that is exported by the NFS server"`

	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the NFS export to be mounted with read-only permissions
	ReadOnly bool `json:"readOnly,omitempty" description:"forces the NFS export to be mounted with read-only permissions"`
}

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

type Namespace 

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

	// Labels
	Labels map[string]string `json:"labels,omitempty" description:"map of string keys and values that can be used to organize and categorize namespaces"`

	// Spec defines the behavior of the Namespace.
	Spec NamespaceSpec `json:"spec,omitempty" description:"spec defines the behavior of the Namespace"`

	// Status describes the current status of a Namespace
	Status NamespaceStatus `json:"status,omitempty" description:"status describes the current status of a Namespace; read-only"`
}

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

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/namespaces.md

func (*Namespace) IsAnAPIObject 

func (*Namespace) IsAnAPIObject()

type NamespaceList 

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

	// Items is the list of Namespace objects in the list
	Items []Namespace `json:"items"  description:"items is the list of Namespace objects in the list"`
}

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 `` /* 127-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 `json:"phase,omitempty" description:"phase is the current lifecycle phase of the namespace"`
}

NamespaceStatus is information about the current status of a Namespace.

type NodeAddress 

type NodeAddress struct {
	Type    NodeAddressType `json:"type" description:"type of the node address, e.g. external ip, internal ip, hostname, etc"`
	Address string          `json:"address" description:"string representation of the address"`
}

type NodeAddressType 

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

These are valid address types of node.

type NodeCondition 

type NodeCondition struct {
	Kind               NodeConditionKind `json:"kind" description:"kind of the condition, one of Reachable, Ready, Schedulable"`
	Status             ConditionStatus   `json:"status" description:"status of the condition, one of Full, None, Unknown"`
	LastProbeTime      util.Time         `json:"lastProbeTime,omitempty" description:"last time the condition was probed"`
	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"`
}

Described the conditions of a running node.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/node.md#node-condition

type NodeConditionKind 

type NodeConditionKind string

Describes the condition of a running node.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/node.md#node-condition 

const (
	// NodeReachable means the node can be reached (in the sense of HTTP connection) within cluster.
	NodeReachable NodeConditionKind = "Reachable"
	// NodeReady means kubelet is healthy and ready to accept pods.
	NodeReady NodeConditionKind = "Ready"
	// NodeSchedulable means the node is ready to accept new pods.
	// DEPRECATED: this kind of condition is unused and has no effect even if present.
	NodeSchedulable NodeConditionKind = "Schedulable"
)

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 NodeInfo 

type NodeInfo struct {
	TypeMeta `json:",inline"`
	// Capacity represents the available resources.
	Capacity ResourceList `` /* 129-byte string literal not displayed */
	// NodeSystemInfo is a set of ids/uuids to uniquely identify the node
	NodeSystemInfo `json:",inline,omitempty" description:"node identity is a set of ids/uuids to uniquely identify the node"`
}

NodeInfo is the information collected on the node.

func (*NodeInfo) IsAnAPIObject 

func (*NodeInfo) IsAnAPIObject()

type NodePhase 

type NodePhase string

Described the current lifecycle phase of a node.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/node.md#node-phase 

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 NodeResources 

type NodeResources struct {
	// Capacity represents the available resources.
	Capacity ResourceList `` /* 129-byte string literal not displayed */
}

NodeResources represents resources on a Kubernetes system node

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/resources.md

type NodeStatus 

type NodeStatus struct {
	// NodePhase is the current lifecycle phase of the node.
	Phase NodePhase `json:"phase,omitempty" description:"node phase is the current lifecycle phase of the node"`
	// Conditions is an array of current node conditions.
	Conditions []NodeCondition `json:"conditions,omitempty" description:"conditions is an array of current node conditions"`
	// Queried from cloud provider, if available.
	Addresses []NodeAddress `json:"addresses,omitempty" description:"list of addresses reachable to the node"`
	// NodeSystemInfo is a set of ids/uuids to uniquely identify the node
	NodeInfo NodeSystemInfo `json:"nodeInfo,omitempty" description:"node identity is a set of ids/uuids to uniquely identify the node"`
}

NodeStatus is information about the current status of a node.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/node.md#node-status

type NodeSystemInfo 

type NodeSystemInfo struct {
	// MachineID is the machine-id reported by the node
	MachineID string `json:"machineID" description:"machine id is the machine-id reported by the node"`
	// SystemUUID is the system-uuid reported by the node
	SystemUUID string `json:"systemUUID" description:"system uuid is the 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 ObjectReference 

type ObjectReference struct {
	Kind            string    `json:"kind,omitempty" description:"kind of the referent"`
	Namespace       string    `json:"namespace,omitempty" description:"namespace of the referent"`
	ID              string    `json:"name,omitempty" description:"id of the referent"`
	UID             types.UID `json:"uid,omitempty" description:"uid of the referent"`
	APIVersion      string    `json:"apiVersion,omitempty" description:"API version of the referent"`
	ResourceVersion string    `` /* 234-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 added in v0.11.0 

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

	//Spec defines a persistent volume owned by the cluster
	Spec PersistentVolumeSpec `json:"spec,omitempty" description:"specification of a persistent volume as provisioned by an administrator"`

	// Status represents the current information about persistent volume.
	Status PersistentVolumeStatus `json:"status,omitempty" description:"current status of a persistent volume; populated by the system, read-only"`
}

func (*PersistentVolume) IsAnAPIObject added in v0.11.0 

func (*PersistentVolume) IsAnAPIObject()

type PersistentVolumeClaim added in v0.11.0 

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

	// Spec defines the volume requested by a pod author
	Spec PersistentVolumeClaimSpec `json:"spec,omitempty" description: "the desired characteristics of a volume"`

	// Status represents the current information about a claim
	Status PersistentVolumeClaimStatus `json:"status,omitempty" description:"the current status of a persistent volume claim; read-only"`
}

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

func (*PersistentVolumeClaim) IsAnAPIObject added in v0.11.0 

func (*PersistentVolumeClaim) IsAnAPIObject()

type PersistentVolumeClaimList added in v0.11.0 

type PersistentVolumeClaimList struct {
	TypeMeta `json:",inline"`
	Items    []PersistentVolumeClaim `json:"items,omitempty" description: "a list of persistent volume claims"`
}

func (*PersistentVolumeClaimList) IsAnAPIObject added in v0.11.0 

func (*PersistentVolumeClaimList) IsAnAPIObject()

type PersistentVolumeClaimPhase added in v0.11.0 

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 added in v0.11.0 

type PersistentVolumeClaimSpec struct {
	// Contains the types of access modes required
	AccessModes []AccessModeType `json:"accessModes,omitempty" description:"the desired access modes the volume should have"`
	// Resources represents the minimum resources required
	Resources ResourceRequirements `json:"resources,omitempty" description:"the desired resources the volume should have"`
}

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

type PersistentVolumeClaimStatus added in v0.11.0 

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 []AccessModeType `json:"accessModes,omitempty" description:"the actual access modes the volume has"`
	// Represents the actual resources of the underlying volume
	Capacity ResourceList `json:"capacity,omitempty" description:"the actual resources the volume has"`
	// VolumeRef is a reference to the PersistentVolume bound to the PersistentVolumeClaim
	VolumeRef *ObjectReference `json:"volumeRef,omitempty" description:"a reference to the backing persistent volume, when bound"`
}

type PersistentVolumeList added in v0.11.0 

type PersistentVolumeList struct {
	TypeMeta `json:",inline"`
	Items    []PersistentVolume `json:"items,omitempty" description:"list of persistent volumes"`
}

func (*PersistentVolumeList) IsAnAPIObject added in v0.11.0 

func (*PersistentVolumeList) IsAnAPIObject()

type PersistentVolumePhase added in v0.11.0 

type PersistentVolumePhase string
const (
	// used for PersistentVolumes that are not yet bound
	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
	VolumeReleased PersistentVolumePhase = "Released"
)

type PersistentVolumeSource added in v0.11.0 

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 `json:"persistentDisk" description:"GCE disk resource provisioned by an admin"`
	// AWSElasticBlockStore represents an AWS Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore" description:"AWS disk resource provisioned by an admin"`
	// 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 `json:"hostPath" description:"a HostPath provisioned by a developer or tester; for develment use only"`
	// Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod
	Glusterfs *GlusterfsVolumeSource `json:"glusterfs" description:"Glusterfs volume 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 added in v0.11.0 

type PersistentVolumeSpec struct {
	// Resources represents the actual resources of the volume
	Capacity ResourceList `json:"capacity,omitempty" description:"a description of the persistent volume's resources and capacity"`
	// 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 []AccessModeType `json:"accessModes,omitempty" description:"all ways the volume can be mounted"`
	// holds the binding reference to a PersistentVolumeClaim
	ClaimRef *ObjectReference `json:"claimRef,omitempty" description:"the binding reference to a persistent volume claim"`
}

type PersistentVolumeStatus added in v0.11.0 

type PersistentVolumeStatus struct {
	// Phase indicates if a volume is available, bound to a claim, or released by a claim
	Phase PersistentVolumePhase `json:"phase,omitempty" description:"the current phase of a persistent volume"`
}

type Pod 

type Pod struct {
	TypeMeta     `json:",inline"`
	Labels       map[string]string `` /* 177-byte string literal not displayed */
	DesiredState PodState          `json:"desiredState,omitempty" description:"specification of the desired state of the pod"`
	CurrentState PodState          `json:"currentState,omitempty" description:"current state of the pod; populated by the system, read-only"`
	// NodeSelector is a selector which must be true for the pod to fit on a node
	NodeSelector map[string]string `` /* 126-byte string literal not displayed */
}

Pod is a collection of containers, used as either input (create, update) or as output (list, get).

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/pods.md

func (*Pod) IsAnAPIObject 

func (*Pod) IsAnAPIObject()

type PodCondition 

type PodCondition struct {
	// Kind is the kind of the condition
	Kind PodConditionKind `json:"kind" description:"kind of the condition, currently only Ready"`
	// Status is the status of the condition
	Status ConditionStatus `json:"status" description:"status of the condition, one of Full, None, Unknown"`
}

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

type PodConditionKind 

type PodConditionKind string

PodConditionKind is a valid value for PodCondition.Kind 

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

These are valid conditions of pod.

type PodContainerInfo 

type PodContainerInfo struct {
	TypeMeta      `json:",inline"`
	ContainerInfo PodInfo `json:"containerInfo" description:"information about each container in this pod"`
}

PodContainerInfo is a wrapper for PodInfo that can be encode/decoded

type PodInfo 

type PodInfo map[string]ContainerStatus

PodInfo contains one entry for every container with available info.

type PodList 

type PodList struct {
	TypeMeta `json:",inline"`
	Items    []Pod `json:"items" description:"list of pods"`
}

PodList is a list of Pods.

func (*PodList) IsAnAPIObject 

func (*PodList) IsAnAPIObject()

type PodLogOptions added in v0.11.0 

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"`
}

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

func (*PodLogOptions) IsAnAPIObject added in v0.11.0 

func (*PodLogOptions) IsAnAPIObject()

type PodSpec 

type PodSpec struct {
	Volumes []Volume `json:"volumes" description:"list of volumes that can be mounted by containers belonging to the pod"`
	// Required: there must be at least one container in a pod.
	Containers    []Container   `` /* 167-byte string literal not displayed */
	RestartPolicy RestartPolicy `` /* 165-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 `` /* 126-byte string literal not displayed */

	// Host is a request to schedule this pod onto a specific host.  If it is non-empty,
	// the the scheduler simply schedules this pod onto that host, assuming that it fits
	// resource requirements.
	Host string `json:"host,omitempty" description:"host 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"`
}

PodSpec is a description of a pod

type PodState 

type PodState struct {
	Manifest   ContainerManifest `json:"manifest,omitempty" description:"manifest of containers and volumes comprising the pod"`
	Status     PodStatus         `json:"status,omitempty" description:"current condition of the pod, Waiting, Running, or Terminated"`
	Conditions []PodCondition    `json:"Condition,omitempty" description:"current service state of pod"`
	// 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"`
	Host    string `json:"host,omitempty" description:"host to which the pod is assigned; empty if not yet scheduled; cannot be updated"`
	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 */

	// The key of this map is the *name* of the container within the manifest; it has one
	// entry per container in the manifest. The value of this map is ContainerStatus for
	// the container.
	Info PodInfo `json:"info,omitempty" description:"map of container name to container status"`
}

PodState is the state of a pod, used as either input (desired state) or output (current state).

type PodStatus 

type PodStatus string

PodStatus represents a status of a pod.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/pod-states.md 

const (
	// PodWaiting means that we're waiting for the pod to begin running.
	PodWaiting PodStatus = "Waiting"
	// PodRunning means that the pod is up and running.
	PodRunning PodStatus = "Running"
	// PodTerminated means that the pod has stopped.
	PodTerminated PodStatus = "Terminated"
	// PodUnknown means that we failed to obtain info about the pod.
	PodUnknown PodStatus = "Unknown"
	// PodSucceeded means that the pod has stopped without error(s)
	PodSucceeded PodStatus = "Succeeded"
)

These are the valid statuses of pods.

type PodStatusResult 

type PodStatusResult struct {
	TypeMeta `json:",inline"`
	State    PodState `json:"state,omitempty" description:"current state of the pod"`
}

func (*PodStatusResult) IsAnAPIObject 

func (*PodStatusResult) IsAnAPIObject()

type PodTemplate 

type PodTemplate struct {
	DesiredState PodState          `json:"desiredState,omitempty" description:"specification of the desired state of pods created from this template"`
	NodeSelector map[string]string `json:"nodeSelector,omitempty" description:"a selector which must be true for the pod to fit on a node"`
	Labels       map[string]string `` /* 264-byte string literal not displayed */
	Annotations  map[string]string `` /* 187-byte string literal not displayed */
}

PodTemplate holds the information used for creating pods.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/replication-controller.md#pod-template

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

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/images.md#preloading-images 

const (
	// PullAlways means that kubelet always attempts to pull the latest image.  Container will fail If the pull fails.
	PullAlways PullPolicy = "PullAlways"
	// 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 = "PullNever"
	// 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 = "PullIfNotPresent"
)

type ReplicationController 

type ReplicationController struct {
	TypeMeta     `json:",inline"`
	DesiredState ReplicationControllerState `json:"desiredState,omitempty" description:"specification of the desired state of the replication controller"`
	CurrentState ReplicationControllerState `json:"currentState,omitempty" description:"current state of the replication controller; populated by the system, read-only"`
	Labels       map[string]string          `` /* 135-byte string literal not displayed */
}

ReplicationController represents the configuration of a replication controller.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/replication-controller.md

func (*ReplicationController) IsAnAPIObject 

func (*ReplicationController) IsAnAPIObject()

type ReplicationControllerList 

type ReplicationControllerList struct {
	TypeMeta `json:",inline"`
	Items    []ReplicationController `json:"items" description:"list of replication controllers"`
}

ReplicationControllerList is a collection of replication controllers.

func (*ReplicationControllerList) IsAnAPIObject 

func (*ReplicationControllerList) IsAnAPIObject()

type ReplicationControllerState 

type ReplicationControllerState struct {
	Replicas        int               `json:"replicas" description:"number of replicas (desired or observed, as appropriate)"`
	ReplicaSelector map[string]string `` /* 141-byte string literal not displayed */
	PodTemplate     PodTemplate       `` /* 186-byte string literal not displayed */
}

ReplicationControllerState is the state of a replication controller, either input (create, update) or as output (list, get).

type ResourceList 

type ResourceList map[ResourceName]util.IntOrString

type ResourceName 

type ResourceName string
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"
)

The following identify resource constants for Kubernetes object types

type ResourceQuota 

type ResourceQuota struct {
	TypeMeta `json:",inline"`
	Labels   map[string]string `` /* 127-byte string literal not displayed */
	// Spec defines the desired quota
	Spec ResourceQuotaSpec `json:"spec,omitempty" description:"spec defines the desired quota"`

	// Status defines the actual enforced quota and its current usage
	Status ResourceQuotaStatus `json:"status,omitempty" description:"status defines the actual enforced quota and current usage"`
}

ResourceQuota sets aggregate quota restrictions enforced per namespace

func (*ResourceQuota) IsAnAPIObject 

func (*ResourceQuota) IsAnAPIObject()

type ResourceQuotaList 

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

	// Items is a list of ResourceQuota objects
	Items []ResourceQuota `json:"items" description:"items is a list of ResourceQuota objects"`
}

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 `json:"hard,omitempty" description:"hard is the set of desired hard limits for each named resource"`
}

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 `json:"hard,omitempty" description:"hard is the set of enforced hard limits for each named resource"`
	// 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 `json:"limits,omitempty" description:"Maximum amount of compute resources allowed"`
	// Requests describes the minimum amount of compute resources required.
	Requests ResourceList `json:"requests,omitempty" description:"Minimum amount of resources requested"`
}

type RestartPolicy 

type RestartPolicy struct {
	// Only one of the following restart policies may be specified.
	// If none of the following policies is specified, the default one
	// is RestartPolicyAlways.
	Always    *RestartPolicyAlways    `json:"always,omitempty" description:"always restart the container after termination"`
	OnFailure *RestartPolicyOnFailure `json:"onFailure,omitempty" description:"restart the container if it fails for any reason, but not if it succeeds (exit 0)"`
	Never     *RestartPolicyNever     `json:"never,omitempty" description:"never restart the container"`
}

type RestartPolicyAlways 

type RestartPolicyAlways struct{}

type RestartPolicyNever 

type RestartPolicyNever struct{}

type RestartPolicyOnFailure 

type RestartPolicyOnFailure struct{}

TODO(dchen1107): Define what kinds of failures should restart. TODO(dchen1107): Decide whether to support policy knobs, and, if so, which ones.

type Secret 

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

	// Data contains the secret data.  Each key must be a 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 `` /* 151-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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/design/secrets.md

func (*Secret) IsAnAPIObject 

func (*Secret) IsAnAPIObject()

type SecretList 

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

	Items []Secret `json:"items" description:"items is a list of secret objects"`
}

func (*SecretList) IsAnAPIObject 

func (*SecretList) IsAnAPIObject()

type SecretType 

type SecretType string
const (
	SecretTypeOpaque SecretType = "Opaque" // Default; arbitrary user-defined data
)

type SecretVolumeSource 

type SecretVolumeSource struct {
	// Reference to a Secret to use.  Only the ID field of this reference is used; a
	// secret can only be used by pods in its namespace.
	Target ObjectReference `json:"target" description:"target is a reference to a secret"`
}

SecretVolumeSource adapts a Secret into a VolumeSource

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/design/secrets.md

type Service 

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

	// Required.
	Port int `json:"port" description:"port exposed by the service"`
	// Optional: The name of the first port.
	PortName string `json:"portName,omitempty" description:"the name of the first port; optional"`
	// Optional: Defaults to "TCP".
	Protocol Protocol `json:"protocol,omitempty" description:"protocol for port; must be UDP or TCP; TCP if unspecified"`
	// ContainerPort is the name or number of the port on the container to direct traffic to.
	// This is useful if the containers the service points to have multiple open ports.
	// Optional: If unspecified, the first port on the container will be used.
	ContainerPort util.IntOrString `` /* 186-byte string literal not displayed */

	// This service's labels.
	Labels map[string]string `json:"labels,omitempty" description:"map of string keys and values that can be used to organize and categorize services"`

	// 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 `` /* 201-byte string literal not displayed */

	// An external load balancer should be set up via the cloud-provider
	CreateExternalLoadBalancer bool `json:"createExternalLoadBalancer,omitempty" description:"set up a cloud-provider-specific load balancer on an external IP"`

	// PublicIPs are used by external load balancers, or can be set by
	// users to handle external traffic that arrives at a node.
	PublicIPs []string `json:"publicIPs,omitempty" description:"externally visible IPs (e.g. load balancers) that should be proxied to this service"`

	// PortalIP 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
	PortalIP string `` /* 304-byte string literal not displayed */

	// DEPRECATED: has no implementation.
	ProxyPort int `` /* 172-byte string literal not displayed */

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

	// Optional: Ports to expose on the service.  If this field is
	// specified, the legacy fields (Port, PortName, Protocol, and
	// ContainerPort) will be overwritten by the first member of this
	// array.  If this field is not specified, it will be populated from
	// the legacy fields.
	Ports []ServicePort `` /* 285-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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/services.md

func (*Service) IsAnAPIObject 

func (*Service) IsAnAPIObject()

type ServiceList 

type ServiceList struct {
	TypeMeta `json:",inline"`
	Items    []Service `json:"items" description:"list of services"`
}

ServiceList holds a list of services.

func (*ServiceList) IsAnAPIObject 

func (*ServiceList) IsAnAPIObject()

type ServicePort added in v0.11.0 

type ServicePort struct {
	// Required: 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" 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" description:"the protocol used by this port; must be UDP or TCP; TCP if unspecified"`

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

	// Optional: The port number on the target pod to direct traffic to.
	// This is useful if the containers the service points to have multiple
	// open ports.  If this is a string, it will be looked up as a named
	// port in the target Pod's container ports.  If unspecified, the value
	// of Port is used (an identity map) - note this is a different default
	// than Service.ContainerPort.
	ContainerPort util.IntOrString `` /* 143-byte string literal not displayed */
}

type Status 

type Status struct {
	TypeMeta `json:",inline"`
	// One of: "Success" or "Failure"
	Status string `json:"status,omitempty" description:"status of the operation; either Success or Failure"`
	// 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. TODO: this could go in apiserver, but I'm including it here so clients needn't import both.

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 ID attribute of the resource associated with the status StatusReason
	// (when there is a single ID which can be described).
	ID string `` /* 157-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 `` /* 174-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 StorageType 

type StorageType string

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

const (
	StorageTypeDefault StorageType = ""       // use whatever the default is for the node
	StorageTypeMemory  StorageType = "Memory" // use memory (tmpfs)
)

type TCPSocketAction 

type TCPSocketAction struct {
	// Required: Port to connect to.
	Port util.IntOrString `json:"port,omitempty" description:"number of name of the port to access on the container"`
}

TCPSocketAction describes an action based on opening a socket

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/container-environment.md#hook-handler-implementations

type TypeMeta 

type TypeMeta struct {
	Kind              string    `json:"kind,omitempty" description:"kind of object, in CamelCase; cannot be updated"`
	ID                string    `` /* 191-byte string literal not displayed */
	UID               types.UID `json:"uid,omitempty" description:"unique UUID across space and time; populated by the system, read-only"`
	CreationTimestamp util.Time `` /* 155-byte string literal not displayed */
	SelfLink          string    `json:"selfLink,omitempty" description:"URL for the object; populated by the system, read-only"`
	ResourceVersion   uint64    `` /* 416-byte string literal not displayed */
	APIVersion        string    `json:"apiVersion,omitempty" description:"version of the schema the object should have"`
	Namespace         string    `` /* 144-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 `` /* 249-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 `` /* 190-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 `` /* 167-byte string literal not displayed */
}

TypeMeta is shared by all objects sent to, or returned from the client.

type Volume 

type Volume struct {
	// Required: This must be a DNS_LABEL.  Each volume in a pod must have
	// a unique name.
	Name string `json:"name" description:"volume name; must be a DNS_LABEL and unique within the pod"`
	// 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.
	Source VolumeSource `` /* 182-byte string literal not displayed */
}

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

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/volumes.md

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.

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/volumes.md

type VolumeSource 

type VolumeSource struct {
	// HostDir represents a pre-existing 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.
	HostDir *HostPathVolumeSource `` /* 138-byte string literal not displayed */
	// EmptyDir represents a temporary directory that shares a pod's lifetime.
	EmptyDir *EmptyDirVolumeSource `json:"emptyDir" description:"temporary directory that shares a pod's lifetime"`
	// A persistent disk that is mounted to the
	// kubelet's host machine and then exposed to the pod.
	GCEPersistentDisk *GCEPersistentDiskVolumeSource `json:"persistentDisk" description:"GCE disk resource attached to the host machine on demand"`
	// An AWS persistent disk that is mounted to the
	// kubelet's host machine and then exposed to the pod.
	AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore" description:"AWS disk resource attached to the host machine on demand"`
	// GitRepo represents a git repository at a particular revision.
	GitRepo *GitRepoVolumeSource `json:"gitRepo" description:"git repository at a particular revision"`
	// Secret is a secret to populate the volume with
	Secret *SecretVolumeSource `json:"secret" description:"secret to populate volume"`
	// NFS represents an NFS mount on the host that shares a pod's lifetime
	NFS *NFSVolumeSource `json:"nfs" description:"NFS volume that will be mounted in the host machine"`
	// 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" description:"iSCSI disk attached to host machine on demand"`
	// Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime
	Glusterfs *GlusterfsVolumeSource `json:"glusterfs" description:"Glusterfs volume that will be mounted on the host machine "`
}

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

https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/volumes.md#types-of-volumes

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.