api

package
v0.3.3 Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2015 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package api contains the latest (or "internal") version of the Kubernetes API objects. This is the API objects as represented in memory. The contract presented to clients is located in the versioned packages, which are sub-directories. The first one is "v1beta1". Those packages describe how a particular version is serialized to storage/network.

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 = ""
	// NamespaceNone is the argument for a context when there is no namespace.
	NamespaceNone string = ""
	// TerminationMessagePathDefault means the default path to capture the application termination message running in a container
	TerminationMessagePathDefault string = "/dev/termination-log"
)
View Source 
const (
	StatusSuccess = "Success"
	StatusFailure = "Failure"
)

Values of Status.Status

Variables

View Source 
var (
	// Errors that could be returned by GetReference.
	ErrNilObject  = errors.New("can't reference a nil object")
	ErrNoSelfLink = errors.New("selfLink was empty, can't make reference")
)
View Source 
var Codec = runtime.CodecFor(Scheme, "")

Codec is the identity codec for this package - it can only convert itself to itself.

View Source 
var ForTesting_ReferencesAllowBlankSelfLinks = false

ForTesting_ReferencesAllowBlankSelfLinks can be set to true in tests to avoid "ErrNoSelfLink" errors.

View Source 
var Scheme = runtime.NewScheme()

Scheme is the default instance of runtime.Scheme to which types in the Kubernetes API are already registered.

View Source 
var Semantic = conversion.EqualitiesOrDie(
	func(a, b resource.Quantity) bool {

		if a.Amount == nil && b.MilliValue() == 0 {
			return true
		}
		if b.Amount == nil && a.MilliValue() == 0 {
			return true
		}
		if a.Amount == nil || b.Amount == nil {
			return false
		}
		return a.Amount.Cmp(b.Amount) == 0
	},
)

Semantic can do semantic deep equality checks for api objects. Example: api.Semantic.DeepEqual(aPod, aPodWithNonNilButEmptyMaps) == true

Functions

func FillObjectMetaSystemFields added in v0.2.1 

func FillObjectMetaSystemFields(ctx Context, meta *ObjectMeta)

FillObjectMetaSystemFields populates fields that are managed by the system on ObjectMeta.

func GenerateName added in v0.3.1 

func GenerateName(u NameGenerator, meta *ObjectMeta)

GenerateName will resolve the object name of the provided ObjectMeta to a generated version if necessary. It expects that validation for ObjectMeta has already completed (that Base is a valid name) and that the NameGenerator generates a name that is also valid.

func HasObjectMetaSystemFieldValues added in v0.2.1 

func HasObjectMetaSystemFieldValues(meta *ObjectMeta) bool

HasObjectMetaSystemFieldValues returns true if fields that are managed by the system on ObjectMeta have values.

func IsEmpty added in v0.3.2 

func IsEmpty(requestsToContexts RequestContextMapper) (bool, error)

IsEmpty returns true if there are no contexts registered, or an error if it could not be determined. Intended for use by tests.

func IsStandardResourceName added in v0.2.2 

func IsStandardResourceName(str string) bool

func NamespaceFrom 

func NamespaceFrom(ctx Context) (string, bool)

NamespaceFrom returns the value of the namespace key on the ctx

func NamespaceValue added in v0.3.2 

func NamespaceValue(ctx Context) string

NamespaceValue returns the value of the namespace key on the ctx, or the empty string if none

func NewRequestContextFilter added in v0.3.2 

func NewRequestContextFilter(mapper RequestContextMapper, handler http.Handler) (http.Handler, error)

NewRequestContextFilter ensures there is a Context object associated with the request before calling the passed handler. After the passed handler runs, the context is cleaned up.

func UserFrom added in v0.3.2 

func UserFrom(ctx Context) (user.Info, bool)

UserFrom returns the value of the user key on the ctx

func ValidNamespace 

func ValidNamespace(ctx Context, resource *ObjectMeta) bool

ValidNamespace returns false if the namespace on the context differs from the resource. If the resource has no namespace, it is set to the value in the context.

Types

type APIVersions added in v0.2.1 

type APIVersions struct {
	Versions []string `json:"versions"`
}

APIVersions lists the api versions that are available, to allow version negotiation. APIVersions isn't just an unnamed array of strings in order to allow for future evolution, though unversioned

type AffinityType added in v0.2.1 

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"`
	ObjectMeta `json:"metadata,omitempty"`

	PodID string `json:"podID"`
	Host  string `json:"host"`
}

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

func (*Binding) IsAnAPIObject 

func (*Binding) IsAnAPIObject()

type BoundPod 

type BoundPod struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a pod.
	Spec PodSpec `json:"spec,omitempty"`
}

BoundPod is a collection of containers that should be run on a host. A BoundPod defines how a Pod may change after a Binding is created. A Pod is a request to execute a pod, whereas a BoundPod is the specification that would be run on a server.

func (*BoundPod) IsAnAPIObject 

func (*BoundPod) IsAnAPIObject()

type BoundPods 

type BoundPods struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Host is the name of a node that these pods were bound to.
	Host string `json:"host"`

	// Items is the list of all pods bound to a given host.
	Items []BoundPod `json:"items"`
}

BoundPods is a list of Pods bound to a common server. The resource version of the pod list is guaranteed to only change when the list of bound pods changes.

func (*BoundPods) IsAnAPIObject 

func (*BoundPods) IsAnAPIObject()

type Capabilities added in v0.2.2 

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

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

type CapabilityType added in v0.2.2 

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

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"`
	// Required.
	Image string `json:"image"`
	// Optional: Defaults to whatever is defined in the image.
	Command []string `json:"command,omitempty"`
	// Optional: Defaults to Docker's default.
	WorkingDir string   `json:"workingDir,omitempty"`
	Ports      []Port   `json:"ports,omitempty"`
	Env        []EnvVar `json:"env,omitempty"`
	// Compute resource requirements.
	Resources      ResourceRequirements `json:"resources,omitempty"`
	VolumeMounts   []VolumeMount        `json:"volumeMounts,omitempty"`
	LivenessProbe  *Probe               `json:"livenessProbe,omitempty"`
	ReadinessProbe *Probe               `json:"readinessProbe,omitempty"`
	Lifecycle      *Lifecycle           `json:"lifecycle,omitempty"`
	// Optional: Defaults to /dev/termination-log
	TerminationMessagePath string `json:"terminationMessagePath,omitempty"`
	// Optional: Default to false.
	Privileged bool `json:"privileged,omitempty"`
	// Optional: Policy for pulling images for this container
	ImagePullPolicy PullPolicy `json:"imagePullPolicy"`
	// Optional: Capabilities for container.
	Capabilities Capabilities `json:"capabilities,omitempty"`
}

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"`
	// Required: This must be a DNS_SUBDOMAIN.
	// TODO: ID on Manifest is deprecated and will be removed in the future.
	ID string `json:"id"`
	// TODO: UUID on Manifest is deprecated in the future once we are done
	// with the API refactoring. It is required for now to determine the instance
	// of a Pod.
	UUID          types.UID     `json:"uuid,omitempty"`
	Volumes       []Volume      `json:"volumes"`
	Containers    []Container   `json:"containers"`
	RestartPolicy RestartPolicy `json:"restartPolicy,omitempty"`
	// Optional: Set DNS policy.  Defaults to "ClusterFirst"
	DNSPolicy DNSPolicy `json:"dnsPolicy"`
}

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 BoundPod

func (*ContainerManifest) IsAnAPIObject 

func (*ContainerManifest) IsAnAPIObject()

type ContainerManifestList 

type ContainerManifestList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	Items []ContainerManifest `json:"items"`
}

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

func (*ContainerManifestList) IsAnAPIObject 

func (*ContainerManifestList) IsAnAPIObject()

type ContainerState 

type ContainerState struct {
	Waiting     *ContainerStateWaiting    `json:"waiting,omitempty"`
	Running     *ContainerStateRunning    `json:"running,omitempty"`
	Termination *ContainerStateTerminated `json:"termination,omitempty"`
}

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

type ContainerStateTerminated 

type ContainerStateTerminated struct {
	ExitCode   int       `json:"exitCode"`
	Signal     int       `json:"signal,omitempty"`
	Reason     string    `json:"reason,omitempty"`
	Message    string    `json:"message,omitempty"`
	StartedAt  util.Time `json:"startedAt,omitempty"`
	FinishedAt util.Time `json:"finishedAt,omitempty"`
}

type ContainerStateWaiting 

type ContainerStateWaiting struct {
	// Reason could be pulling image,
	Reason string `json:"reason,omitempty"`
}

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"`
	// Ready specifies whether the conatiner has passed its readiness check.
	Ready bool `json:"ready"`
	// 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 `json:"restartCount"`
	// TODO(dchen1107): Deprecated this soon once we pull entire PodStatus from node,
	// not just PodInfo. Now we need this to remove docker.Container from API
	PodIP string `json:"podIP,omitempty"`
	// TODO(dchen1107): Need to decide how to represent this in v1beta3
	Image       string `json:"image"`
	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 Context 

type Context interface {
	Value(key interface{}) interface{}
}

Context carries values across API boundaries.

func NewContext 

func NewContext() Context

NewContext instantiates a base context object for request flows.

func NewDefaultContext 

func NewDefaultContext() Context

NewDefaultContext instantiates a base context object for request flows in the default namespace

func WithNamespace 

func WithNamespace(parent Context, namespace string) Context

WithNamespace returns a copy of parent in which the namespace value is set

func WithNamespaceDefaultIfNone 

func WithNamespaceDefaultIfNone(parent Context) Context

WithNamespaceDefaultIfNone returns a context whose namespace is the default if and only if the parent context has no namespace value

func WithUser added in v0.3.2 

func WithUser(parent Context, user user.Info) Context

WithUser returns a copy of parent in which the user value is set

func WithValue 

func WithValue(parent Context, key interface{}, val interface{}) Context

WithValue returns a copy of parent in which the value associated with key is val.

type ConversionError added in v0.2.1 

type ConversionError struct {
	In, Out interface{}
	Message string
}

Conversion error conveniently packages up errors in conversions.

func (*ConversionError) Error added in v0.2.1 

func (c *ConversionError) Error() string

Return a helpful string about the error

type DNSPolicy added in v0.2.1 

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 EmptyDir 

type EmptyDir struct{}

type Endpoints 

type Endpoints struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	Endpoints []string `json:"endpoints,omitempty"`
}

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"`
	ListMeta `json:"metadata,omitempty"`

	Items []Endpoints `json:"items"`
}

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"`
	// Optional: defaults to "".
	Value string `json:"value,omitempty"`
}

EnvVar represents an environment variable present in a Container.

type Event 

type Event struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

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

	// Optional; this should be a short, machine understandable string that gives the reason
	// for this event being generated. For example, if the event is reporting that a container
	// can't start, the Reason might be "ImageNotFound".
	// TODO: provide exact specification for format.
	Reason string `json:"reason,omitempty"`

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

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

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

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

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

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 `json:"metadata,omitempty"`

	Items []Event `json:"items"`
}

EventList is a list of events.

func (*EventList) IsAnAPIObject 

func (*EventList) IsAnAPIObject()

type EventSource added in v0.2.1 

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

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 `json:"command,omitempty"`
}

ExecAction describes a "run in container" action.

type GCEPersistentDisk 

type GCEPersistentDisk struct {
	// Unique name of the PD resource. Used to identify the disk in GCE
	PDName string `json:"pdName"`
	// 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"`
	// 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 `json:"partition,omitempty"`
	// Optional: Defaults to false (read/write). ReadOnly here will force
	// the ReadOnly setting in VolumeMounts.
	ReadOnly bool `json:"readOnly,omitempty"`
}

GCEPersistentDisk 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 GitRepo added in v0.2.1 

type GitRepo struct {
	// Repository URL
	Repository string `json:"repository"`
	// Commit hash, this is optional
	Revision string `json:"revision"`
}

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

type HTTPGetAction 

type HTTPGetAction struct {
	// Optional: Path to access on the HTTP server.
	Path string `json:"path,omitempty"`
	// Required: Name or number of the port to access on the container.
	Port util.IntOrString `json:"port,omitempty"`
	// Optional: Host name to connect to, defaults to the pod IP.
	Host string `json:"host,omitempty"`
}

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"`
	// HTTPGet specifies the http request to perform.
	HTTPGet *HTTPGetAction `json:"httpGet,omitempty"`
	// TCPSocket specifies an action involving a TCP port.
	// TODO: implement a realistic TCP lifecycle hook
	TCPSocket *TCPSocketAction `json:"tcpSocket,omitempty"`
}

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

type HostPath added in v0.2.2 

type HostPath struct {
	Path string `json:"path"`
}

HostPath represents bare host directory volume.

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 `json:"postStart,omitempty"`
	// 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 `json:"preStop,omitempty"`
}

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

type LimitRange struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

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

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

func (*LimitRange) IsAnAPIObject added in v0.2.2 

func (*LimitRange) IsAnAPIObject()

type LimitRangeItem added in v0.2.2 

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

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

type LimitRangeList added in v0.2.2 

type LimitRangeList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

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

LimitRangeList is a list of LimitRange items.

func (*LimitRangeList) IsAnAPIObject added in v0.2.2 

func (*LimitRangeList) IsAnAPIObject()

type LimitRangeSpec added in v0.2.2 

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

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

type LimitType added in v0.2.2 

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

type List struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	Items []runtime.Object `json:"items"`
}

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

func (*List) IsAnAPIObject added in v0.2.1 

func (*List) IsAnAPIObject()

type ListMeta added in v0.2.1 

type ListMeta struct {
	// SelfLink is a URL representing this object.
	SelfLink string `json:"selfLink,omitempty"`

	// 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 `json:"resourceVersion,omitempty"`
}

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

type NameGenerator added in v0.3.1 

type NameGenerator interface {
	// GenerateName generates a valid name from the base name, adding a random suffix to the
	// the base. If base is valid, the returned name must also be valid. The generator is
	// responsible for knowing the maximum valid name length.
	GenerateName(base string) string
}

NameGenerator generates names for objects. Some backends may have more information available to guide selection of new names and this interface hides those details. 

var SimpleNameGenerator NameGenerator = simpleNameGenerator{}

SimpleNameGenerator is a generator that returns the name plus a random suffix of five alphanumerics when a name is requested. The string is guaranteed to not exceed the length of a standard Kubernetes name (63 characters)

type Namespace 

type Namespace struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

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

	// Status describes the current status of a Namespace
	Status NamespaceStatus `json:"status,omitempty"`
}

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

func (*Namespace) IsAnAPIObject added in v0.3.2 

func (*Namespace) IsAnAPIObject()

type NamespaceList added in v0.3.2 

type NamespaceList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	Items []Namespace `json:"items"`
}

NamespaceList is a list of Namespaces.

func (*NamespaceList) IsAnAPIObject added in v0.3.2 

func (*NamespaceList) IsAnAPIObject()

type NamespaceSpec added in v0.3.2 

type NamespaceSpec struct {
}

NamespaceSpec describes the attributes on a Namespace

type NamespaceStatus added in v0.3.2 

type NamespaceStatus struct {
}

NamespaceStatus is information about the current status of a Namespace.

type Node added in v0.2.1 

type Node struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a node.
	Spec NodeSpec `json:"spec,omitempty"`

	// Status describes the current status of a Node
	Status NodeStatus `json:"status,omitempty"`
}

Node is a worker node in Kubernetenes The name of the node according to etcd is in ObjectMeta.Name.

func (*Node) IsAnAPIObject added in v0.2.1 

func (*Node) IsAnAPIObject()

type NodeCondition added in v0.2.1 

type NodeCondition struct {
	Kind               NodeConditionKind `json:"kind"`
	Status             ConditionStatus   `json:"status"`
	LastProbeTime      util.Time         `json:"lastProbeTime,omitempty"`
	LastTransitionTime util.Time         `json:"lastTransitionTime,omitempty"`
	Reason             string            `json:"reason,omitempty"`
	Message            string            `json:"message,omitempty"`
}

type NodeConditionKind added in v0.2.1 

type NodeConditionKind string
const (
	// NodeReachable means the node can be reached (in the sense of HTTP connection) from node controller.
	NodeReachable NodeConditionKind = "Reachable"
	// NodeReady means the node returns StatusOK for HTTP health check.
	NodeReady NodeConditionKind = "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 added in v0.2.1 

type NodeList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	Items []Node `json:"items"`
}

NodeList is a list of minions.

func (*NodeList) IsAnAPIObject added in v0.2.1 

func (*NodeList) IsAnAPIObject()

type NodePhase added in v0.2.1 

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 NodeResources 

type NodeResources struct {
	// Capacity represents the available resources of a node
	Capacity ResourceList `json:"capacity,omitempty"`
}

NodeResources is an object for conveying resource information about a node. see https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/resources.md for more details. TODO: Use ResourceList instead?

type NodeSpec added in v0.2.1 

type NodeSpec struct {
	// Capacity represents the available resources of a node
	Capacity ResourceList `json:"capacity,omitempty"`
}

NodeSpec describes the attributes that a node is created with.

type NodeStatus added in v0.2.1 

type NodeStatus struct {
	// Queried from cloud provider, if available.
	HostIP string `json:"hostIP,omitempty"`
	// NodePhase is the current lifecycle phase of the node.
	Phase NodePhase `json:"phase,omitempty"`
	// Conditions is an array of current node conditions.
	Conditions []NodeCondition `json:"conditions,omitempty"`
}

NodeStatus is information about the current status of a node.

type ObjectMeta added in v0.2.1 

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 `json:"name,omitempty"`

	// 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 `json:"generateName,omitempty"`

	// 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 `json:"namespace,omitempty"`

	// SelfLink is a URL representing this object.
	SelfLink string `json:"selfLink,omitempty"`

	// 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 `json:"uid,omitempty"`

	// 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 `json:"resourceVersion,omitempty"`

	// 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 `json:"creationTimestamp,omitempty"`

	// Labels are key value pairs that may be used to scope and select individual resources.
	// Label keys are of the form:
	//     label-key ::= prefixed-name | name
	//     prefixed-name ::= prefix '/' name
	//     prefix ::= DNS_SUBDOMAIN
	//     name ::= DNS_LABEL
	// The prefix is optional.  If the prefix is not specified, the key is assumed to be private
	// to the user.  Other system components that wish to use labels must specify a prefix.  The
	// "kubernetes.io/" prefix is reserved for use by kubernetes components.
	// TODO: replace map[string]string with labels.LabelSet type
	Labels map[string]string `json:"labels,omitempty"`

	// 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.  Annotation keys have the same formatting restrictions as Label keys. See the
	// comments on Labels for details.
	Annotations map[string]string `json:"annotations,omitempty"`
}

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

func ObjectMetaFor added in v0.3.1 

func ObjectMetaFor(obj runtime.Object) (*ObjectMeta, error)

GetObjectMetaPtr returns a pointer to a provided object's ObjectMeta. TODO: allow runtime.Unknown to extract this object

type ObjectReference 

type ObjectReference struct {
	Kind            string    `json:"kind,omitempty"`
	Namespace       string    `json:"namespace,omitempty"`
	Name            string    `json:"name,omitempty"`
	UID             types.UID `json:"uid,omitempty"`
	APIVersion      string    `json:"apiVersion,omitempty"`
	ResourceVersion string    `json:"resourceVersion,omitempty"`

	// 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 `json:"fieldPath,omitempty"`
}

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

func GetPartialReference added in v0.2.1 

func GetPartialReference(obj runtime.Object, fieldPath string) (*ObjectReference, error)

GetPartialReference is exactly like GetReference, but allows you to set the FieldPath.

func GetReference 

func GetReference(obj runtime.Object) (*ObjectReference, error)

GetReference returns an ObjectReference which refers to the given object, or an error if the object doesn't follow the conventions that would allow this.

func (*ObjectReference) IsAnAPIObject added in v0.2.1 

func (*ObjectReference) IsAnAPIObject()

IsAnAPIObject allows clients to preemptively get a reference to an API object and pass it to places that intend only to get a reference to that object. This simplifies the event recording interface.

type Pod 

type Pod struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a pod.
	Spec PodSpec `json:"spec,omitempty"`

	// Status represents the current information about a pod. This data may not be up
	// to date.
	Status PodStatus `json:"status,omitempty"`
}

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

func (*Pod) IsAnAPIObject 

func (*Pod) IsAnAPIObject()

type PodCondition added in v0.3.2 

type PodCondition struct {
	Kind   PodConditionKind `json:"kind"`
	Status ConditionStatus  `json:"status"`
}

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

type PodConditionKind added in v0.3.2 

type PodConditionKind string
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 added in v0.2.1 

type PodContainerInfo struct {
	TypeMeta      `json:",inline"`
	ObjectMeta    `json:"metadata,omitempty"`
	ContainerInfo PodInfo `json:"containerInfo"`
}

PodContainerInfo is a wrapper for PodInfo that can be encode/decoded DEPRECATED: Replaced with PodStatusResult

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"`
	ListMeta `json:"metadata,omitempty"`

	Items []Pod `json:"items"`
}

PodList is a list of Pods.

func (*PodList) IsAnAPIObject 

func (*PodList) IsAnAPIObject()

type PodPhase added in v0.2.1 

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 PodSpec 

type PodSpec struct {
	Volumes       []Volume      `json:"volumes"`
	Containers    []Container   `json:"containers"`
	RestartPolicy RestartPolicy `json:"restartPolicy,omitempty"`
	// Optional: Set DNS policy.  Defaults to "ClusterFirst"
	DNSPolicy DNSPolicy `json:"dnsPolicy,omitempty"`
	// NodeSelector is a selector which must be true for the pod to fit on a node
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`

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

PodSpec is a description of a pod

type PodStatus 

type PodStatus struct {
	Phase      PodPhase       `json:"phase,omitempty"`
	Conditions []PodCondition `json:"Condition,omitempty"`
	// A human readable message indicating details about why the pod is in this state.
	Message string `json:"message,omitempty"`

	// Host is the name of the node that this Pod is currently bound to, or empty if no
	// assignment has been done.
	Host   string `json:"host,omitempty"`
	HostIP string `json:"hostIP,omitempty"`
	PodIP  string `json:"podIP,omitempty"`

	// 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 currently the output
	// of `docker inspect`. This output format is *not* final and should not be relied
	// upon.
	// TODO: Make real decisions about what our info should look like. Re-enable fuzz test
	// when we have done this.
	Info PodInfo `json:"info,omitempty"`
}

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

type PodStatusResult added in v0.2.2 

type PodStatusResult struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`
	// Status represents the current information about a pod. This data may not be up
	// to date.
	Status PodStatus `json:"status,omitempty"`
}

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

func (*PodStatusResult) IsAnAPIObject added in v0.2.2 

func (*PodStatusResult) IsAnAPIObject()

type PodTemplate 

type PodTemplate struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the pods that will be created from this template
	Spec PodTemplateSpec `json:"spec,omitempty"`
}

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

type PodTemplateList added in v0.2.1 

type PodTemplateList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	Items []PodTemplate `json:"items"`
}

PodTemplateList is a list of PodTemplates.

type PodTemplateSpec added in v0.2.1 

type PodTemplateSpec struct {
	// Metadata of the pods created from this template.
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a pod.
	Spec PodSpec `json:"spec,omitempty"`
}

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

type Port 

type Port struct {
	// Optional: If specified, this must be a DNS_LABEL.  Each named port
	// in a pod must have a unique name.
	Name string `json:"name,omitempty"`
	// Optional: If specified, this must be a valid port number, 0 < x < 65536.
	HostPort int `json:"hostPort,omitempty"`
	// Required: This must be a valid port number, 0 < x < 65536.
	ContainerPort int `json:"containerPort"`
	// Optional: Supports "TCP" and "UDP".  Defaults to "TCP".
	Protocol Protocol `json:"protocol,omitempty"`
	// Optional: What host IP to bind the external port to.
	HostIP string `json:"hostIP,omitempty"`
}

Port represents a network port in a single container

type Probe added in v0.2.2 

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 `json:"initialDelaySeconds,omitempty"`
	// Length of time before health checking times out.  In seconds.
	TimeoutSeconds int64 `json:"timeoutSeconds,omitempty"`
}

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 ReplicationController 

type ReplicationController struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the desired behavior of this replication controller.
	Spec ReplicationControllerSpec `json:"spec,omitempty"`

	// Status is the current status of this replication controller. This data may be
	// out of date by some window of time.
	Status ReplicationControllerStatus `json:"status,omitempty"`
}

ReplicationController represents the configuration of a replication controller.

func (*ReplicationController) IsAnAPIObject 

func (*ReplicationController) IsAnAPIObject()

type ReplicationControllerList 

type ReplicationControllerList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	Items []ReplicationController `json:"items"`
}

ReplicationControllerList is a collection of replication controllers.

func (*ReplicationControllerList) IsAnAPIObject 

func (*ReplicationControllerList) IsAnAPIObject()

type ReplicationControllerSpec added in v0.2.1 

type ReplicationControllerSpec struct {
	// Replicas is the number of desired replicas.
	Replicas int `json:"replicas"`

	// Selector is a label query over pods that should match the Replicas count.
	Selector map[string]string `json:"selector"`

	// TemplateRef is a reference to an object that describes the pod that will be created if
	// insufficient replicas are detected. This reference is ignored if a Template is set.
	// Must be set before converting to a v1beta3 API object
	TemplateRef *ObjectReference `json:"templateRef,omitempty"`

	// Template is the object that describes the pod that will be created if
	// insufficient replicas are detected. Internally, this takes precedence over a
	// TemplateRef.
	// Must be set before converting to a v1beta1 or v1beta2 API object.
	Template *PodTemplateSpec `json:"template,omitempty"`
}

ReplicationControllerSpec is the specification of a replication controller. As the internal representation of a replication controller, it may have either a TemplateRef or a Template set.

type ReplicationControllerStatus added in v0.2.1 

type ReplicationControllerStatus struct {
	// Replicas is the number of actual replicas.
	Replicas int `json:"replicas"`
}

ReplicationControllerStatus represents the current status of a replication controller.

type RequestContextMapper added in v0.3.2 

type RequestContextMapper interface {
	// Get returns the context associated with the given request (if any), and true if the request has an associated context, and false if it does not.
	Get(req *http.Request) (Context, bool)
	// Update maps the request to the given context. If no context was previously associated with the request, an error is returned.
	// Update should only be called with a descendant context of the previously associated context.
	// Updating to an unrelated context may return an error in the future.
	// The context associated with a request should only be updated by a limited set of callers.
	// Valid examples include the authentication layer, or an audit/tracing layer.
	Update(req *http.Request, context Context) error
}

RequestContextMapper keeps track of the context associated with a particular request

func NewRequestContextMapper added in v0.3.2 

func NewRequestContextMapper() RequestContextMapper

NewRequestContextMapper returns a new RequestContextMapper. The returned mapper must be added as a request filter using NewRequestContextFilter.

type ResourceList 

type ResourceList map[ResourceName]resource.Quantity

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

func (*ResourceList) Cpu added in v0.3.1 

func (self *ResourceList) Cpu() *resource.Quantity

Returns the CPU limit if specified.

func (ResourceList) Get added in v0.2.1 

func (rl ResourceList) Get(name ResourceName) *resource.Quantity

Get is a convenience function, which returns a 0 quantity if the resource list is nil, empty, or lacks a value for the requested resource. Treat as read only!

func (*ResourceList) Memory added in v0.3.1 

func (self *ResourceList) Memory() *resource.Quantity

Returns the Memory limit if specified.

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

func (ResourceName) String added in v0.3.1 

func (self ResourceName) String() string

Returns string version of ResourceName.

type ResourceQuota added in v0.2.2 

type ResourceQuota struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the desired quota
	Spec ResourceQuotaSpec `json:"spec,omitempty"`

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

ResourceQuota sets aggregate quota restrictions enforced per namespace

func (*ResourceQuota) IsAnAPIObject added in v0.2.2 

func (*ResourceQuota) IsAnAPIObject()

type ResourceQuotaList added in v0.2.2 

type ResourceQuotaList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

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

ResourceQuotaList is a list of ResourceQuota items

func (*ResourceQuotaList) IsAnAPIObject added in v0.2.2 

func (*ResourceQuotaList) IsAnAPIObject()

type ResourceQuotaSpec added in v0.2.2 

type ResourceQuotaSpec struct {
	// Hard is the set of desired hard limits for each named resource
	Hard ResourceList `json:"hard,omitempty"`
}

ResourceQuotaSpec defines the desired hard limits to enforce for Quota

type ResourceQuotaStatus added in v0.2.2 

type ResourceQuotaStatus struct {
	// Hard is the set of enforced hard limits for each named resource
	Hard ResourceList `json:"hard,omitempty"`
	// Used is the current observed total usage of the resource in the namespace
	Used ResourceList `json:"used,omitempty"`
}

ResourceQuotaStatus defines the enforced hard limits and observed use

type ResourceQuotaUsage added in v0.2.2 

type ResourceQuotaUsage struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

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

ResourceQuotaUsage captures system observed quota status per namespace It is used to enforce atomic updates of a backing ResourceQuota.Status field in storage

func (*ResourceQuotaUsage) IsAnAPIObject added in v0.2.2 

func (*ResourceQuotaUsage) IsAnAPIObject()

type ResourceRequirements added in v0.3.2 

type ResourceRequirements struct {
	// Limits describes the maximum amount of compute resources required.
	Limits ResourceList `json:"limits,omitempty"`
}

ResourceRequirements describes the compute resource requirements.

type RestartPolicy 

type RestartPolicy struct {
	Always    *RestartPolicyAlways    `json:"always,omitempty"`
	OnFailure *RestartPolicyOnFailure `json:"onFailure,omitempty"`
	Never     *RestartPolicyNever     `json:"never,omitempty"`
}

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.

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

type RootPaths struct {
	Paths []string `json:"paths"`
}

RootPaths lists the paths available at root. For example: "/healthz", "/api".

type Service 

type Service struct {
	TypeMeta   `json:",inline"`
	ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a service.
	Spec ServiceSpec `json:"spec,omitempty"`

	// Status represents the current status of a service.
	Status ServiceStatus `json:"status,omitempty"`
}

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 ServiceList 

type ServiceList struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	Items []Service `json:"items"`
}

ServiceList holds a list of services.

func (*ServiceList) IsAnAPIObject 

func (*ServiceList) IsAnAPIObject()

type ServiceSpec added in v0.2.1 

type ServiceSpec struct {
	// Port is the TCP or UDP port that will be made available to each pod for connecting to the pods
	// proxied by this service.
	Port int `json:"port"`

	// Optional: Supports "TCP" and "UDP".  Defaults to "TCP".
	Protocol Protocol `json:"protocol,omitempty"`

	// This service will route traffic to pods having labels matching this selector. If empty or not present,
	// the service is assumed to have endpoints set by an external process and Kubernetes will not modify
	// those endpoints.
	Selector map[string]string `json:"selector"`

	// 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.
	PortalIP string `json:"portalIP,omitempty"`

	// CreateExternalLoadBalancer indicates whether a load balancer should be created for this service.
	CreateExternalLoadBalancer bool `json:"createExternalLoadBalancer,omitempty"`
	// PublicIPs are used by external load balancers.
	PublicIPs []string `json:"publicIPs,omitempty"`

	// 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 `json:"containerPort,omitempty"`

	// Optional: Supports "ClientIP" and "None".  Used to maintain session affinity.
	SessionAffinity AffinityType `json:"sessionAffinity,omitempty"`
}

ServiceSpec describes the attributes that a user creates on a service

type ServiceStatus added in v0.2.1 

type ServiceStatus struct{}

ServiceStatus represents the current status of a service

type Status 

type Status struct {
	TypeMeta `json:",inline"`
	ListMeta `json:"metadata,omitempty"`

	// One of: "Success" or "Failure"
	Status string `json:"status,omitempty"`
	// A human-readable description of the status of this operation.
	Message string `json:"message,omitempty"`
	// 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 `json:"reason,omitempty"`
	// 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 `json:"details,omitempty"`
	// Suggested HTTP return code for this status, 0 if not set.
	Code int `json:"code,omitempty"`
}

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 `json:"reason,omitempty"`
	// A human-readable description of the cause of the error.  This field may be
	// presented as-is to a reader.
	Message string `json:"message,omitempty"`
	// 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 `json:"field,omitempty"`
}

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).
	// TODO: replace with Name with v1beta3
	ID string `json:"id,omitempty"`
	// The kind attribute of the resource associated with the status StatusReason.
	// On some operations may differ from the requested resource Kind.
	Kind string `json:"kind,omitempty"`
	// The Causes array includes more details associated with the StatusReason
	// failure. Not all StatusReasons may provide detailed causes.
	Causes []StatusCause `json:"causes,omitempty"`
}

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

	// StatusReasonForbidden means the server can be reached and understood the request, but refuses
	// to take any further action.  It is the result of the server being configured to deny access for some reason
	// to the requested resource by the client.
	// Details (optional):
	//   "kind" string - the kind attribute of the forbidden resource
	//                   on some operations may differ from the requested
	//                   resource.
	//   "id"   string - the identifier of the forbidden resource
	// Status code 403
	StatusReasonForbidden StatusReason = "Forbidden"

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

	// StatusReasonTimeout means that the request could not be completed within the given time.
	// Clients can get this response only when they specified a timeout param in the request.
	// The request might succeed with an increased value of timeout param.
	// Status code 504
	StatusReasonTimeout StatusReason = "Timeout"

	// StatusReasonBadRequest means that the request itself was invalid, because the request
	// doesn't make any sense, for example deleting a read-only object.  This is different than
	// StatusReasonInvalid above which indicates that the API call could possibly succeed, but the
	// data was invalid.  API calls that return BadRequest can never succeed.
	StatusReasonBadRequest StatusReason = "BadRequest"

	// StatusReasonMethodNotAllowed means that the action the client attempted to perform on the
	// resource was not supported by the code - for instance, attempting to delete a resource that
	// can only be created. API calls that return MethodNotAllowed can never succeed.
	StatusReasonMethodNotAllowed StatusReason = "MethodNotAllowed"

	// StatusReasonInternalError indicates that an internal error occurred, it is unexpected
	// and the outcome of the call is unknown.
	// Details (optional):
	//   "causes" - The original error
	// Status code 500
	StatusReasonInternalError = "InternalError"
)

type TCPSocketAction 

type TCPSocketAction struct {
	// Required: Port to connect to.
	Port util.IntOrString `json:"port,omitempty"`
}

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 `json:"kind,omitempty"`

	// 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 `json:"apiVersion,omitempty"`
}

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 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"`
	// 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 `json:"source,omitempty"`
}

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"`
	// Optional: Defaults to false (read-write).
	ReadOnly bool `json:"readOnly,omitempty"`
	// Required.
	MountPath string `json:"mountPath"`
}

VolumeMount describes a mounting of a Volume within a container.

type VolumeSource 

type VolumeSource struct {
	// HostPath represents 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 *HostPath `json:"hostPath"`
	// EmptyDir represents a temporary directory that shares a pod's lifetime.
	EmptyDir *EmptyDir `json:"emptyDir"`
	// GCEPersistentDisk represents a GCE Disk resource that is attached to a
	// kubelet's host machine and then exposed to the pod.
	GCEPersistentDisk *GCEPersistentDisk `json:"persistentDisk"`
	// GitRepo represents a git repository at a particular revision.
	GitRepo *GitRepo `json:"gitRepo"`
}

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

Source Files

View all Source files

Directories

Path Synopsis
Package errors provides detailed error types for api field validation.
 Package errors provides detailed error types for api field validation.
etcd
Package etcd provides conversion of etcd errors to API errors.
 Package etcd provides conversion of etcd errors to API errors.
Package latest defines the default output serializations that code should use and imports the required schemas.
 Package latest defines the default output serializations that code should use and imports the required schemas.
Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API
 Package meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API
Package rest defines common logic around changes to Kubernetes resources.
 Package rest defines common logic around changes to Kubernetes resources.
resttest
Package testapi provides a helper for retrieving the KUBE_API_VERSION environment variable.
 Package testapi provides a helper for retrieving the KUBE_API_VERSION environment variable.
Package v1beta1 is the v1beta1 version of the API.
 Package v1beta1 is the v1beta1 version of the API.
Package v1beta2 is the v1beta2 version of the API.
 Package v1beta2 is the v1beta2 version of the API.
Package v1beta3 is the v1beta3 version of the API.
 Package v1beta3 is the v1beta3 version of the API.
Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.
 Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.

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.