kubernetes: github.com/erimatnor/kubernetes/pkg/api Index | Files | Directories

package api

import "github.com/erimatnor/kubernetes/pkg/api"

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

Package Files

context.go conversion.go doc.go generate.go helpers.go meta.go ref.go register.go requestcontext.go resource_helpers.go types.go unversioned.go

Constants

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"
)
const (
    StatusSuccess = "Success"
    StatusFailure = "Failure"
)

Values of Status.Status

const (
    // Enable stdin for remote command execution
    ExecStdinParam = "input"
    // Enable stdout for remote command execution
    ExecStdoutParam = "output"
    // Enable stderr for remote command execution
    ExecStderrParam = "error"
    // Enable TTY for remote command execution
    ExecTTYParam = "tty"
    // Command to run for remote command execution
    ExecCommandParamm = "command"

    StreamType       = "streamType"
    StreamTypeStdin  = "stdin"
    StreamTypeStdout = "stdout"
    StreamTypeStderr = "stderr"
    StreamTypeData   = "data"
    StreamTypeError  = "error"

    PortHeader = "port"
)

These constants are for remote command execution and port forwarding and are used by both the client side and server side components.

This is probably not the ideal place for them, but it didn't seem worth it to create pkg/exec and pkg/portforward just to contain a single file with constants in it. Suggestions for more appropriate alternatives are definitely welcome!

const MaxSecretSize = 1 * 1024 * 1024
const (
    // PortalIPNone - do not assign a portal IP
    // no proxying required and no environment variables should be created for pods
    PortalIPNone = "None"
)

Variables

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")
)
var Codec = runtime.CodecFor(Scheme, "")

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

var ForTesting_ReferencesAllowBlankSelfLinks = false

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

var Scheme = runtime.NewScheme()

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

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
    },
    func(a, b util.Time) bool {
        return a.UTC() == b.UTC()
    },
    func(a, b labels.Selector) bool {
        return a.String() == b.String()
    },
    func(a, b fields.Selector) bool {
        return a.String() == b.String()
    },
)

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

func AddToNodeAddresses Uses

func AddToNodeAddresses(addresses *[]NodeAddress, addAddresses ...NodeAddress)

AddToNodeAddresses appends the NodeAddresses to the passed-by-pointer slice, only if they do not already exist

func FieldSelectorQueryParam Uses

func FieldSelectorQueryParam(version string) string

TODO: remove me when watch is refactored

func FillObjectMetaSystemFields Uses

func FillObjectMetaSystemFields(ctx Context, meta *ObjectMeta)

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

func GenerateName Uses

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 Uses

func HasObjectMetaSystemFieldValues(meta *ObjectMeta) bool

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

func IsEmpty Uses

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 IsPodReady Uses

func IsPodReady(pod *Pod) bool

IsPodReady retruns true if a pod is ready; false otherwise.

func IsServiceIPRequested Uses

func IsServiceIPRequested(service *Service) bool

this function aims to check if the service portal IP is requested or not

func IsServiceIPSet Uses

func IsServiceIPSet(service *Service) bool

this function aims to check if the service portal IP is set or not the objective is not to perform validation here

func IsStandardFinalizerName Uses

func IsStandardFinalizerName(str string) bool

func IsStandardResourceName Uses

func IsStandardResourceName(str string) bool

func LabelSelectorQueryParam Uses

func LabelSelectorQueryParam(version string) string

TODO: remove me when watch is refactored

func NamespaceFrom Uses

func NamespaceFrom(ctx Context) (string, bool)

NamespaceFrom returns the value of the namespace key on the ctx

func NamespaceValue Uses

func NamespaceValue(ctx Context) string

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

func NewRequestContextFilter Uses

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 PreV1Beta3 Uses

func PreV1Beta3(version string) bool

preV1Beta3 returns true if the provided API version is an API introduced before v1beta3.

func UserFrom Uses

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

UserFrom returns the value of the user key on the ctx

func ValidNamespace Uses

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.

type APIVersions Uses

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

func (APIVersions) GoString Uses

func (apiVersions APIVersions) GoString() string

func (APIVersions) String Uses

func (apiVersions APIVersions) String() string

String returns available api versions as a human-friendly version string.

type AWSElasticBlockStoreVolumeSource Uses

type AWSElasticBlockStoreVolumeSource struct {
    // Unique id of the persistent disk resource. Used to identify the disk in AWS
    VolumeID string `json:"volumeID"`
    // 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"`
}

AWSElasticBlockStoreVolumeSource represents a Persistent Disk resource in AWS.

An AWS EBS disk 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 EBS disk can only be mounted as read/write once.

type AccessModeType Uses

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 Uses

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 Uses

type Binding struct {
    TypeMeta `json:",inline"`
    // ObjectMeta describes the object that is being bound.
    ObjectMeta `json:"metadata,omitempty"`

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

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

func (*Binding) IsAnAPIObject Uses

func (*Binding) IsAnAPIObject()

type Capabilities Uses

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 Uses

type CapabilityType string

CapabilityType represent POSIX capabilities type

type CauseType Uses

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"
    // CauseTypeUnexpectedServerResponse is used to report when the server responded to the client
    // without the expected return type. The presence of this cause indicates the error may be
    // due to an intervening proxy or the server software malfunctioning.
    CauseTypeUnexpectedServerResponse CauseType = "UnexpectedServerResponse"
)

type ComponentCondition Uses

type ComponentCondition struct {
    Type    ComponentConditionType `json:"type"`
    Status  ConditionStatus        `json:"status"`
    Message string                 `json:"message,omitempty"`
    Error   string                 `json:"error,omitempty"`
}

type ComponentConditionType Uses

type ComponentConditionType string

Type and constants for component health validation.

const (
    ComponentHealthy ComponentConditionType = "Healthy"
)

These are the valid conditions for the component.

type ComponentStatus Uses

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

    Conditions []ComponentCondition `json:"conditions,omitempty"`
}

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

func (*ComponentStatus) IsAnAPIObject Uses

func (*ComponentStatus) IsAnAPIObject()

type ComponentStatusList Uses

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

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

func (*ComponentStatusList) IsAnAPIObject Uses

func (*ComponentStatusList) IsAnAPIObject()

type ConditionStatus Uses

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

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

type Container Uses

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: The docker image's entrypoint is used if this is not provided; cannot be updated.
    Command []string `json:"command,omitempty"`
    // Optional: The docker image's cmd is used if this is not provided; cannot be updated.
    Args []string `json:"args,omitempty"`
    // Optional: Defaults to Docker's default.
    WorkingDir string          `json:"workingDir,omitempty"`
    Ports      []ContainerPort `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"`
    // Required.
    TerminationMessagePath string `json:"terminationMessagePath,omitempty"`
    // Required: Policy for pulling images for this container
    ImagePullPolicy PullPolicy `json:"imagePullPolicy"`
    // Optional: SecurityContext defines the security options the pod should be run with
    SecurityContext *SecurityContext `json:"securityContext,omitempty" description:"security options the pod should run with"`
}

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

type ContainerManifest Uses

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"`
    TerminationGracePeriodSeconds *int64        `json:"terminationGracePeriodSeconds,omitempty"`
    // Required: Set DNS policy.
    DNSPolicy   DNSPolicy `json:"dnsPolicy"`
    HostNetwork bool      `json:"hostNetwork,omitempty"`
}

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 Uses

func (*ContainerManifest) IsAnAPIObject()

type ContainerManifestList Uses

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 Pods

func (*ContainerManifestList) IsAnAPIObject Uses

func (*ContainerManifestList) IsAnAPIObject()

type ContainerPort Uses

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 `json:"name,omitempty"`
    // 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"`
    // Required: This must be a valid port number, 0 < x < 65536.
    ContainerPort int `json:"containerPort"`
    // Required: Supports "TCP" and "UDP".
    Protocol Protocol `json:"protocol,omitempty"`
    // Optional: What host IP to bind the external port to.
    HostIP string `json:"hostIP,omitempty"`
}

ContainerPort represents a network port in a single container

type ContainerState Uses

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 Uses

type ContainerStateRunning struct {
    StartedAt util.Time `json:"startedAt,omitempty"`
}

type ContainerStateTerminated Uses

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"`
    ContainerID string    `json:"containerID,omitempty"`
}

type ContainerStateWaiting Uses

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

type ContainerStatus Uses

type ContainerStatus struct {
    // Each container in a pod must have a unique name.
    Name string `name of the container; must be a DNS_LABEL and unique within the pod; cannot be updated"`
    // TODO(dchen1107): Should we rename PodStatus to a more generic name or have a separate states
    // defined for container?
    State                ContainerState `json:"state,omitempty"`
    LastTerminationState ContainerState `json:"lastState,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): Need to decide how to represent this in v1beta3
    Image       string `json:"image"`
    ImageID     string `json:"imageID"`
    ContainerID string `json:"containerID,omitempty"`
}

func GetContainerStatus Uses

func GetContainerStatus(statuses []ContainerStatus, name string) (ContainerStatus, bool)

func GetExistingContainerStatus Uses

func GetExistingContainerStatus(statuses []ContainerStatus, name string) ContainerStatus

type Context Uses

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

Context carries values across API boundaries.

func NewContext Uses

func NewContext() Context

NewContext instantiates a base context object for request flows.

func NewDefaultContext Uses

func NewDefaultContext() Context

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

func WithNamespace Uses

func WithNamespace(parent Context, namespace string) Context

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

func WithNamespaceDefaultIfNone Uses

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 Uses

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

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

func WithValue Uses

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 Uses

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

Conversion error conveniently packages up errors in conversions.

func (*ConversionError) Error Uses

func (c *ConversionError) Error() string

Return a helpful string about the error

type DNSPolicy Uses

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 Uses

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 `json:"gracePeriodSeconds"`
}

DeleteOptions may be provided when deleting an API object

func NewDeleteOptions Uses

func NewDeleteOptions(grace int64) *DeleteOptions

NewDeleteOptions returns a DeleteOptions indicating the resource should be deleted within the specified grace period. Use zero to indicate immediate deletion. If you would prefer to use the default grace period, use &api.DeleteOptions{} directly.

func (*DeleteOptions) IsAnAPIObject Uses

func (*DeleteOptions) IsAnAPIObject()

type EmptyDirVolumeSource Uses

type EmptyDirVolumeSource struct {
    // TODO: Longer term we want to represent the selection of underlying
    // media more like a scheduling problem - user says what traits they
    // need, we give them a backing store that satisifies that.  For now
    // this will cover the most common needs.
    // 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"`
}

EmptyDirVolumeSource represents an empty directory for a pod.

type EndpointAddress Uses

type EndpointAddress struct {
    // The IP of this endpoint.
    // TODO: This should allow hostname or IP, see #4447.
    IP  string

    // Optional: The kubernetes object related to the entry point.
    TargetRef *ObjectReference
}

EndpointAddress is a tuple that describes single IP address.

type EndpointPort Uses

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

    // The port number.
    Port int

    // The IP protocol for this port.
    Protocol Protocol
}

EndpointPort is a tuple that describes a single port.

type EndpointSubset Uses

type EndpointSubset struct {
    Addresses []EndpointAddress
    Ports     []EndpointPort
}

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 Uses

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

    // The set of all endpoints is the union of all subsets.
    Subsets []EndpointSubset
}

Endpoints is a collection of endpoints that implement the actual service. Example:

 Name: "mysvc",
 Subsets: [
   {
     Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
     Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
   },
   {
     Addresses: [{"ip": "10.10.3.3"}],
     Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
   },
]

func (*Endpoints) IsAnAPIObject Uses

func (*Endpoints) IsAnAPIObject()

type EndpointsList Uses

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

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

EndpointsList is a list of endpoints.

func (*EndpointsList) IsAnAPIObject Uses

func (*EndpointsList) IsAnAPIObject()

type EnvVar Uses

type EnvVar struct {
    // Required: This must be a C_IDENTIFIER.
    Name string `json:"name"`
    // Optional: no more than one of the following may be specified.
    // Optional: Defaults to "".
    Value string `json:"value,omitempty"`
    // Optional: Specifies a source the value of this var should come from.
    ValueFrom *EnvVarSource `json:"valueFrom,omitempty"`
}

EnvVar represents an environment variable present in a Container.

type EnvVarSource Uses

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

EnvVarSource represents a source for the value of an EnvVar.

type Event Uses

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 Uses

func (*Event) IsAnAPIObject()

type EventList Uses

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

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

EventList is a list of events.

func (*EventList) IsAnAPIObject Uses

func (*EventList) IsAnAPIObject()

type EventSource Uses

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 Uses

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 FinalizerName Uses

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

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

type GCEPersistentDiskVolumeSource Uses

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

GCEPersistentDiskVolumeSource represents a Persistent Disk resource in Google Compute Engine.

A GCE PD must exist and be formatted before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once.

type GitRepoVolumeSource Uses

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

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

type GlusterfsVolumeSource Uses

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

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

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

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

type HTTPGetAction Uses

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 Uses

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 HostPathVolumeSource Uses

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

HostPathVolumeSource represents a host directory mapped into a pod.

type ISCSIVolumeSource Uses

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"`
    // Required:  target iSCSI Qualified Name
    IQN string `json:"iqn,omitempty"`
    // Required: iSCSI target lun number
    Lun int `json:"lun,omitempty"`
    // 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: Defaults to false (read/write). ReadOnly here will force
    // the ReadOnly setting in VolumeMounts.
    ReadOnly bool `json:"readOnly,omitempty"`
}

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

type Lifecycle Uses

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 Uses

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 Uses

func (*LimitRange) IsAnAPIObject()

type LimitRangeItem Uses

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"`
    // Default usage constraints on this kind by resource name
    Default ResourceList `json:"default,omitempty"`
}

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

type LimitRangeList Uses

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 Uses

func (*LimitRangeList) IsAnAPIObject()

type LimitRangeSpec Uses

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 Uses

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 Uses

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 Uses

func (*List) IsAnAPIObject()

type ListMeta Uses

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

func ListMetaFor Uses

func ListMetaFor(obj runtime.Object) (*ListMeta, error)

ListMetaFor returns a pointer to a provided object's ListMeta, or an error if the object does not have that pointer. TODO: allow runtime.Unknown to extract this object

type ListOptions Uses

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

    // A selector based on labels
    LabelSelector labels.Selector
    // A selector based on fields
    FieldSelector fields.Selector
    // If true, watch for changes to this list
    Watch bool
    // The resource version to watch (no effect on list yet)
    ResourceVersion string
}

ListOptions is the query options to a standard REST list call, and has future support for watch calls.

func (*ListOptions) IsAnAPIObject Uses

func (*ListOptions) IsAnAPIObject()

type NFSVolumeSource Uses

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

    // Path is the exported NFS share
    Path string `json:"path"`

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

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

type NameGenerator Uses

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 Uses

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 Uses

func (*Namespace) IsAnAPIObject()

type NamespaceList Uses

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

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

NamespaceList is a list of Namespaces.

func (*NamespaceList) IsAnAPIObject Uses

func (*NamespaceList) IsAnAPIObject()

type NamespacePhase Uses

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 Uses

type NamespaceSpec struct {
    // Finalizers is an opaque list of values that must be empty to permanently remove object from storage
    Finalizers []FinalizerName
}

NamespaceSpec describes the attributes on a Namespace

type NamespaceStatus Uses

type NamespaceStatus struct {
    // Phase is the current lifecycle phase of the namespace.
    Phase NamespacePhase `json:"phase,omitempty"`
}

NamespaceStatus is information about the current status of a Namespace.

type Node Uses

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 Kubernetes The name of the node according to etcd is in ObjectMeta.Name.

func (*Node) IsAnAPIObject Uses

func (*Node) IsAnAPIObject()

type NodeAddress Uses

type NodeAddress struct {
    Type    NodeAddressType `json:"type"`
    Address string          `json:"address"`
}

type NodeAddressType Uses

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

These are valid address types of node. NodeLegacyHostIP is used to transit from out-dated HostIP field to NodeAddress.

type NodeCondition Uses

type NodeCondition struct {
    Type               NodeConditionType `json:"type"`
    Status             ConditionStatus   `json:"status"`
    LastHeartbeatTime  util.Time         `json:"lastHeartbeatTime,omitempty"`
    LastTransitionTime util.Time         `json:"lastTransitionTime,omitempty"`
    Reason             string            `json:"reason,omitempty"`
    Message            string            `json:"message,omitempty"`
}

type NodeConditionType Uses

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

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

type NodeList Uses

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

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

NodeList is a list of nodes.

func (*NodeList) IsAnAPIObject Uses

func (*NodeList) IsAnAPIObject()

type NodePhase Uses

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 Uses

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 http://docs.k8s.io/resources.md for more details.

type NodeSpec Uses

type NodeSpec struct {
    // PodCIDR represents the pod IP range assigned to the node
    // Note: assigning IP ranges to nodes might need to be revisited when we support migratable IPs.
    PodCIDR string `json:"podCIDR,omitempty"`

    // External ID of the node assigned by some machine database (e.g. a cloud provider)
    ExternalID string `json:"externalID,omitempty"`

    // Unschedulable controls node schedulability of new pods. By default node is schedulable.
    Unschedulable bool `json:"unschedulable,omitempty"`
}

NodeSpec describes the attributes that a node is created with.

type NodeStatus Uses

type NodeStatus struct {
    // Capacity represents the available resources of a node.
    Capacity ResourceList `json:"capacity,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"`
    // Queried from cloud provider, if available.
    Addresses []NodeAddress `json:"addresses,omitempty"`
    // NodeSystemInfo is a set of ids/uuids to uniquely identify the node
    NodeInfo NodeSystemInfo `json:"nodeInfo,omitempty"`
}

NodeStatus is information about the current status of a node.

type NodeSystemInfo Uses

type NodeSystemInfo struct {
    // MachineID is the machine-id reported by the node
    MachineID string `json:"machineID"`
    // SystemUUID is the system-uuid reported by the node
    SystemUUID string `json:"systemUUID"`
    // BootID is the boot-id reported by the node
    BootID string `json:"bootID"`
    // Kernel version reported by the node
    KernelVersion string `json:"kernelVersion""`
    // OS image used reported by the node
    OsImage string `json:"osImage"`
    // Container runtime version reported by the node
    ContainerRuntimeVersion string `json:"containerRuntimeVersion"`
    // Kubelet version reported by the node
    KubeletVersion string `json:"kubeletVersion"`
    // Kube-proxy version reported by the node
    KubeProxyVersion string `json:"kubeProxyVersion"`
}

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

type ObjectFieldSelector Uses

type ObjectFieldSelector struct {
    // Required: Version of the schema the FieldPath is written in terms of.
    // If no value is specified, it will be defaulted to the APIVersion of the
    // enclosing object.
    APIVersion string `json:"apiVersion"`
    // Required: Path of the field to select in the specified API version
    FieldPath string `json:"fieldPath"`
}

ObjectFieldSelector selects an APIVersioned field of an object.

type ObjectMeta Uses

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

    // 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 `json:"deletionTimestamp,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 Uses

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

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

type ObjectReference Uses

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 Uses

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

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

func GetReference Uses

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. TODO: should take a meta.Interface see https://github.com/GoogleCloudPlatform/kubernetes/issues/7127

func (*ObjectReference) IsAnAPIObject Uses

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 PatchType Uses

type PatchType string

Similarly to above, these are constants to support HTTP PATCH utilized by both the client and server that didn't make sense for a whole package to be dedicated to.

const (
    JSONPatchType           PatchType = "application/json-patch+json"
    MergePatchType          PatchType = "application/merge-patch+json"
    StrategicMergePatchType PatchType = "application/strategic-merge-patch+json"
)

type PersistentVolume Uses

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

    //Spec defines a persistent volume owned by the cluster
    Spec PersistentVolumeSpec `json:"spec,omitempty"`

    // Status represents the current information about persistent volume.
    Status PersistentVolumeStatus `json:"status,omitempty"`
}

func (*PersistentVolume) IsAnAPIObject Uses

func (*PersistentVolume) IsAnAPIObject()

type PersistentVolumeClaim Uses

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

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

    // Status represents the current information about a claim
    Status PersistentVolumeClaimStatus `json:"status,omitempty"`
}

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

func (*PersistentVolumeClaim) IsAnAPIObject Uses

func (*PersistentVolumeClaim) IsAnAPIObject()

type PersistentVolumeClaimList Uses

type PersistentVolumeClaimList struct {
    TypeMeta `json:",inline"`
    ListMeta `json:"metadata,omitempty"`
    Items    []PersistentVolumeClaim `json:"items,omitempty"`
}

func (*PersistentVolumeClaimList) IsAnAPIObject Uses

func (*PersistentVolumeClaimList) IsAnAPIObject()

type PersistentVolumeClaimPhase Uses

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 Uses

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

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

type PersistentVolumeClaimStatus Uses

type PersistentVolumeClaimStatus struct {
    // Phase represents the current phase of PersistentVolumeClaim
    Phase PersistentVolumeClaimPhase `json:"phase,omitempty"`
    // AccessModes contains all ways the volume backing the PVC can be mounted
    AccessModes []AccessModeType `json:"accessModes,omitempty`
    // Represents the actual resources of the underlying volume
    Capacity ResourceList `json:"capacity,omitempty"`
    // VolumeRef is a reference to the PersistentVolume bound to the PersistentVolumeClaim
    VolumeRef *ObjectReference `json:"volumeRef,omitempty"`
}

type PersistentVolumeClaimVolumeSource Uses

type PersistentVolumeClaimVolumeSource struct {
    // ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume
    ClaimName string `json:"claimName,omitempty" description:"the name of the claim in the same namespace to be mounted as a volume"`
    // Optional: Defaults to false (read/write).  ReadOnly here
    // will force the ReadOnly setting in VolumeMounts
    ReadOnly bool `json:"readOnly,omitempty"`
}

type PersistentVolumeList Uses

type PersistentVolumeList struct {
    TypeMeta `json:",inline"`
    ListMeta `json:"metadata,omitempty"`
    Items    []PersistentVolume `json:"items,omitempty"`
}

func (*PersistentVolumeList) IsAnAPIObject Uses

func (*PersistentVolumeList) IsAnAPIObject()

type PersistentVolumePhase Uses

type PersistentVolumePhase string
const (
    // used for PersistentVolumes that are not available
    VolumePending PersistentVolumePhase = "Pending"
    // 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 Uses

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:"gcePersistentDisk"`
    // AWSElasticBlockStore represents an AWS EBS disk that is attached to a
    // kubelet's host machine and then exposed to the pod.
    AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore"`
    // 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"`
    // Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod
    Glusterfs *GlusterfsVolumeSource `json:"glusterfs"`
}

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

type PersistentVolumeSpec Uses

type PersistentVolumeSpec struct {
    // Resources represents the actual resources of the volume
    Capacity ResourceList `json:"capacity`
    // Source represents the location and type of a volume to mount.
    PersistentVolumeSource `json:",inline"`
    // AccessModes contains all ways the volume can be mounted
    AccessModes []AccessModeType `json:"accessModes,omitempty"`
    // holds the binding reference to a PersistentVolumeClaim
    ClaimRef *ObjectReference `json:"claimRef,omitempty"`
}

type PersistentVolumeStatus Uses

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

type Pod Uses

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 Uses

func (*Pod) IsAnAPIObject()

type PodCondition Uses

type PodCondition struct {
    Type   PodConditionType `json:"type"`
    Status ConditionStatus  `json:"status"`
}

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

type PodConditionType Uses

type PodConditionType 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 PodConditionType = "Ready"
)

These are valid conditions of pod.

type PodContainerInfo Uses

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

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

type PodExecOptions Uses

type PodExecOptions struct {
    TypeMeta

    // Stdin if true indicates that stdin is to be redirected for the exec call
    Stdin bool

    // Stdout if true indicates that stdout is to be redirected for the exec call
    Stdout bool

    // Stderr if true indicates that stderr is to be redirected for the exec call
    Stderr bool

    // TTY if true indicates that a tty will be allocated for the exec call
    TTY bool

    // Container in which to execute the command.
    Container string

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

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

func (*PodExecOptions) IsAnAPIObject Uses

func (*PodExecOptions) IsAnAPIObject()

type PodList Uses

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

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

PodList is a list of Pods.

func (*PodList) IsAnAPIObject Uses

func (*PodList) IsAnAPIObject()

type PodLogOptions Uses

type PodLogOptions struct {
    TypeMeta

    // Container for which to return logs
    Container string

    // If true, follow the logs for the pod
    Follow bool
}

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

func (*PodLogOptions) IsAnAPIObject Uses

func (*PodLogOptions) IsAnAPIObject()

type PodPhase Uses

type PodPhase string

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

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

These are the valid statuses of pods.

type PodProxyOptions Uses

type PodProxyOptions struct {
    TypeMeta

    // Path is the URL path to use for the current proxy request
    Path string
}

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

func (*PodProxyOptions) IsAnAPIObject Uses

func (*PodProxyOptions) IsAnAPIObject()

type PodSpec Uses

type PodSpec struct {
    Volumes []Volume `json:"volumes"`
    // Required: there must be at least one container in a pod.
    Containers    []Container   `json:"containers"`
    RestartPolicy RestartPolicy `json:"restartPolicy,omitempty"`
    // Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.
    // Value must be non-negative integer. The value zero indicates delete immediately.
    // If this value is nil, the default grace period will be used instead.
    // The grace period is the duration in seconds after the processes running in the pod are sent
    // a termination signal and the time when the processes are forcibly halted with a kill signal.
    // Set this value longer than the expected cleanup time for your process.
    TerminationGracePeriodSeconds *int64 `json:"terminationGracePeriodSeconds,omitempty"`
    // Required: Set DNS policy.
    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"`
    // 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"`
}

PodSpec is a description of a pod

type PodStatus Uses

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

    HostIP string `json:"hostIP,omitempty"`
    PodIP  string `json:"podIP,omitempty"`

    // The list has one entry per container in the manifest. Each entry 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.
    ContainerStatuses []ContainerStatus `json:"containerStatuses,omitempty"`
}

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

type PodStatusResult Uses

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 Uses

func (*PodStatusResult) IsAnAPIObject()

type PodTemplate Uses

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

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

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

func (*PodTemplate) IsAnAPIObject Uses

func (*PodTemplate) IsAnAPIObject()

type PodTemplateList Uses

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

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

PodTemplateList is a list of PodTemplates.

func (*PodTemplateList) IsAnAPIObject Uses

func (*PodTemplateList) IsAnAPIObject()

type PodTemplateSpec Uses

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 Probe Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (*ReplicationController) IsAnAPIObject()

type ReplicationControllerList Uses

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

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

ReplicationControllerList is a collection of replication controllers.

func (*ReplicationControllerList) IsAnAPIObject Uses

func (*ReplicationControllerList) IsAnAPIObject()

type ReplicationControllerSpec Uses

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 Uses

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 Uses

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 Uses

func NewRequestContextMapper() RequestContextMapper

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

type ResourceList Uses

type ResourceList map[ResourceName]resource.Quantity

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

func (*ResourceList) Cpu Uses

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

Returns the CPU limit if specified.

func (*ResourceList) Memory Uses

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

Returns the Memory limit if specified.

type ResourceName Uses

type ResourceName string

ResourceName is the name identifying various resources in a ResourceList.

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

The following identify resource constants for Kubernetes object types

func (ResourceName) String Uses

func (self ResourceName) String() string

Returns string version of ResourceName.

type ResourceQuota Uses

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 Uses

func (*ResourceQuota) IsAnAPIObject()

type ResourceQuotaList Uses

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 Uses

func (*ResourceQuotaList) IsAnAPIObject()

type ResourceQuotaSpec Uses

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 Uses

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 ResourceRequirements Uses

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

ResourceRequirements describes the compute resource requirements.

type RestartPolicy Uses

type RestartPolicy string

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

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

type RootPaths Uses

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

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

type SELinuxOptions Uses

type SELinuxOptions struct {
    // SELinux user label
    User string `json:"user,omitempty" description:"the user label to apply to the container"`

    // SELinux role label
    Role string `json:"role,omitempty" description:"the role label to apply to the container"`

    // SELinux type label
    Type string `json:"type,omitempty" description:"the type label to apply to the container"`

    // SELinux level label.
    Level string `json:"level,omitempty" description:"the level label to apply to the container"`
}

SELinuxOptions are the labels to be applied to the container.

type Secret Uses

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

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

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

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

func (*Secret) IsAnAPIObject Uses

func (*Secret) IsAnAPIObject()

type SecretList Uses

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

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

func (*SecretList) IsAnAPIObject Uses

func (*SecretList) IsAnAPIObject()

type SecretType Uses

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

type SecretVolumeSource Uses

type SecretVolumeSource struct {
    // Name of the secret in the pod's namespace to use
    SecretName string `json:"secretName"`
}

SecretVolumeSource adapts a Secret into a VolumeSource.

The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.

type SecurityContext Uses

type SecurityContext struct {
    // Capabilities are the capabilities to add/drop when running the container
    Capabilities *Capabilities `json:"capabilities,omitempty" description:"the linux capabilites that should be added or removed"`

    // Run the container in privileged mode
    Privileged *bool `json:"privileged,omitempty" description:"run the container in privileged mode"`

    // SELinuxOptions are the labels to be applied to the container
    // and volumes
    SELinuxOptions *SELinuxOptions `json:"seLinuxOptions,omitempty" description:"options that control the SELinux labels applied"`

    // RunAsUser is the UID to run the entrypoint of the container process.
    RunAsUser *int64 `json:"runAsUser,omitempty" description:"the user id that runs the first process in the container"`
}

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

type SerializedReference Uses

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

func (*SerializedReference) IsAnAPIObject Uses

func (*SerializedReference) IsAnAPIObject()

type Service Uses

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 Uses

func (*Service) IsAnAPIObject()

type ServiceList Uses

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

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

ServiceList holds a list of services.

func (*ServiceList) IsAnAPIObject Uses

func (*ServiceList) IsAnAPIObject()

type ServicePort Uses

type ServicePort struct {
    // Optional if only one ServicePort is defined on this service: The
    // name of this port within the service.  This must be a DNS_LABEL.
    // All ports within a ServiceSpec must have unique names.  This maps to
    // the 'Name' field in EndpointPort objects.
    Name string `json:"name"`

    // The IP protocol for this port.  Supports "TCP" and "UDP".
    Protocol Protocol `json:"protocol"`

    // The port that will be exposed on the service.
    Port int `json:"port"`

    // Optional: The target port on pods selected by this service.  If this
    // is a string, it will be looked up as a named port in the target
    // Pod's container ports.  If this is not specified, the first port on
    // the destination pod will be used.  This behavior is deprecated.  As
    // of v1beta3 the default value is the sames as the Port field (an
    // identity map).
    TargetPort util.IntOrString `json:"targetPort"`
}

type ServiceSpec Uses

type ServiceSpec struct {
    // Required: The list of ports that are exposed by this service.
    Ports []ServicePort `json:"ports"`

    // 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.
    // 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 `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, or can be set by
    // users to handle external traffic that arrives at a node.
    // For load balancers, the publicIP will usually be the IP address of the load balancer,
    // but some load balancers (notably AWS ELB) use a hostname instead of an IP address.
    // For hostnames, the user will use a CNAME record (instead of using an A record with the IP)
    PublicIPs []string `json:"publicIPs,omitempty"`

    // Required: 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 Uses

type ServiceStatus struct{}

ServiceStatus represents the current status of a service

type Status Uses

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 Uses

func (*Status) IsAnAPIObject()

type StatusCause Uses

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 Uses

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"`
    // If specified, the time in seconds before the operation should be retried.
    RetryAfterSeconds int `json:"retryAfterSeconds,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 Uses

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

    // StatusReasonUnauthorized means the server can be reached and understood the request, but requires
    // the user to present appropriate authorization credentials (identified by the WWW-Authenticate header)
    // in order for the action to be completed. If the user has specified credentials on the request, the
    // server considers them insufficient.
    // Status code 401
    StatusReasonUnauthorized StatusReason = "Unauthorized"

    // 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.
    //   "retryAfterSeconds" int - the number of seconds before the operation should be retried
    // 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,
    // or if the server cannot complete the operation within a reasonable amount of time.
    // The request might succeed with an increased value of timeout param. The client *should*
    // wait at least the number of seconds specified by the retryAfterSeconds field.
    // Details (optional):
    //   "retryAfterSeconds" int - the number of seconds before the operation should be retried
    // 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 StorageType Uses

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 Uses

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 Uses

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 Uses

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

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

type VolumeMount Uses

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 Uses

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 *HostPathVolumeSource `json:"hostPath"`
    // EmptyDir represents a temporary directory that shares a pod's lifetime.
    EmptyDir *EmptyDirVolumeSource `json:"emptyDir"`
    // GCEPersistentDisk represents a GCE Disk resource that is attached to a
    // kubelet's host machine and then exposed to the pod.
    GCEPersistentDisk *GCEPersistentDiskVolumeSource `json:"gcePersistentDisk"`
    // AWSElasticBlockStore represents an AWS EBS disk that is attached to a
    // kubelet's host machine and then exposed to the pod.
    AWSElasticBlockStore *AWSElasticBlockStoreVolumeSource `json:"awsElasticBlockStore"`
    // GitRepo represents a git repository at a particular revision.
    GitRepo *GitRepoVolumeSource `json:"gitRepo"`
    // Secret represents a secret that should populate this volume.
    Secret *SecretVolumeSource `json:"secret"`
    // NFS represents an NFS mount on the host that shares a pod's lifetime
    NFS *NFSVolumeSource `json:"nfs"`
    // ISCSIVolumeSource represents an ISCSI Disk resource that is attached to a
    // kubelet's host machine and then exposed to the pod.
    ISCSI *ISCSIVolumeSource `json:"iscsi"`
    // Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime
    Glusterfs *GlusterfsVolumeSource `json:"glusterfs"`
    // PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace
    PersistentVolumeClaimVolumeSource *PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty"`
}

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

Directories

PathSynopsis
endpoints
errorsPackage errors provides detailed error types for api field validation.
errors/etcdPackage etcd provides conversion of etcd errors to API errors.
latestPackage latest defines the default output serializations that code should use and imports the required schemas.
metaPackage meta provides functions for retrieving API metadata from objects belonging to the Kubernetes API
resource
restPackage rest defines common logic around changes to Kubernetes resources.
rest/resttest
testapiPackage testapi provides a helper for retrieving the KUBE_API_VERSION environment variable.
testing
v1Package v1 is the v1 version of the API.
v1beta1Package v1beta1 is the v1beta1 version of the API.
v1beta2Package v1beta2 is the v1beta2 version of the API.
v1beta3Package v1beta3 is the v1beta3 version of the API.
validationPackage validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.

Package api imports 19 packages (graph). Updated 2017-05-11. Refresh now. Tools for package owners.