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

package api

import "github.com/igm/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 helpers.go meta.go ref.go register.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 = ""
    // 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"
    StatusWorking = "Working"
)

Values of Status.Status

Variables

var Codec = runtime.CodecFor(Scheme, "")

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

var ErrNilObject = errors.New("Can't reference a nil object")

ErrNilObject indicates an error that the obj passed to GetReference is nil.

var Scheme = runtime.NewScheme()

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

func FillObjectMetaSystemFields Uses

func FillObjectMetaSystemFields(ctx Context, meta *ObjectMeta)

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

func HasObjectMetaSystemFieldValues Uses

func HasObjectMetaSystemFieldValues(meta *ObjectMeta) bool

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

func IsPullAlways Uses

func IsPullAlways(p PullPolicy) bool

func IsPullIfNotPresent Uses

func IsPullIfNotPresent(p PullPolicy) bool

func IsPullNever Uses

func IsPullNever(p PullPolicy) bool

func Namespace Uses

func Namespace(ctx Context) string

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

func NamespaceFrom Uses

func NamespaceFrom(ctx Context) (string, bool)

NamespaceFrom returns the value of the namespace 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" yaml:"versions"`
}

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

type Binding Uses

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

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

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

func (*Binding) IsAnAPIObject Uses

func (*Binding) IsAnAPIObject()

type BoundPod Uses

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

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

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

func (*BoundPod) IsAnAPIObject Uses

func (*BoundPod) IsAnAPIObject()

type BoundPods Uses

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

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

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

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

func (*BoundPods) IsAnAPIObject Uses

func (*BoundPods) IsAnAPIObject()

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, Success, or Working).

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

type 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" yaml:"name"`
    // Required.
    Image string `json:"image" yaml:"image"`
    // Optional: Defaults to whatever is defined in the image.
    Command []string `json:"command,omitempty" yaml:"command,omitempty"`
    // Optional: Defaults to Docker's default.
    WorkingDir string   `json:"workingDir,omitempty" yaml:"workingDir,omitempty"`
    Ports      []Port   `json:"ports,omitempty" yaml:"ports,omitempty"`
    Env        []EnvVar `json:"env,omitempty" yaml:"env,omitempty"`
    // Optional: Defaults to unlimited.
    Memory int `json:"memory,omitempty" yaml:"memory,omitempty"`
    // Optional: Defaults to unlimited.
    CPU           int            `json:"cpu,omitempty" yaml:"cpu,omitempty"`
    VolumeMounts  []VolumeMount  `json:"volumeMounts,omitempty" yaml:"volumeMounts,omitempty"`
    LivenessProbe *LivenessProbe `json:"livenessProbe,omitempty" yaml:"livenessProbe,omitempty"`
    Lifecycle     *Lifecycle     `json:"lifecycle,omitempty" yaml:"lifecycle,omitempty"`
    // Optional: Defaults to /dev/termination-log
    TerminationMessagePath string `json:"terminationMessagePath,omitempty" yaml:"terminationMessagePath,omitempty"`
    // Optional: Default to false.
    Privileged bool `json:"privileged,omitempty" yaml:"privileged,omitempty"`
    // Optional: Policy for pulling images for this container
    ImagePullPolicy PullPolicy `json:"imagePullPolicy" yaml:"imagePullPolicy"`
}

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 `yaml:"version" json:"version"`
    // Required: This must be a DNS_SUBDOMAIN.
    // TODO: ID on Manifest is deprecated and will be removed in the future.
    ID  string `yaml:"id" 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          string        `yaml:"uuid,omitempty" json:"uuid,omitempty"`
    Volumes       []Volume      `yaml:"volumes" json:"volumes"`
    Containers    []Container   `yaml:"containers" json:"containers"`
    RestartPolicy RestartPolicy `json:"restartPolicy,omitempty" yaml:"restartPolicy,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 BoundPod

func (*ContainerManifest) IsAnAPIObject Uses

func (*ContainerManifest) IsAnAPIObject()

type ContainerManifestList Uses

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

    Items []ContainerManifest `json:"items" yaml:"items,omitempty"`
}

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

func (*ContainerManifestList) IsAnAPIObject Uses

func (*ContainerManifestList) IsAnAPIObject()

type ContainerState Uses

type ContainerState struct {
    Waiting     *ContainerStateWaiting    `json:"waiting,omitempty" yaml:"waiting,omitempty"`
    Running     *ContainerStateRunning    `json:"running,omitempty" yaml:"running,omitempty"`
    Termination *ContainerStateTerminated `json:"termination,omitempty" yaml:"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 time.Time `json:"startedAt,omitempty" yaml:"startedAt,omitempty"`
}

type ContainerStateTerminated Uses

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

type ContainerStateWaiting Uses

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

type ContainerStatus Uses

type ContainerStatus struct {
    // TODO(dchen1107): Should we rename PodStatus to a more generic name or have a separate states
    // defined for container?
    State ContainerState `json:"state,omitempty" yaml:"state,omitempty"`
    // 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" yaml:"restartCount"`
    // TODO(dchen1107): Deprecated this soon once we pull entire PodStatus from node,
    // not just PodInfo. Now we need this to remove docker.Container from API
    PodIP string `json:"podIP,omitempty" yaml:"podIP,omitempty"`
    // TODO(dchen1107): Need to decide how to represent this in v1beta3
    Image string `yaml:"image" json:"image"`
}

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

type EmptyDir struct{}

type Endpoints Uses

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

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

Endpoints is a collection of endpoints that implement the actual service, for example: Name: "mysql", Endpoints: ["10.10.1.1:1909", "10.10.2.2:8834"]

func (*Endpoints) IsAnAPIObject Uses

func (*Endpoints) IsAnAPIObject()

type EndpointsList Uses

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

    Items []Endpoints `json:"items" yaml:"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" yaml:"name"`
    // Optional: defaults to "".
    Value string `json:"value,omitempty" yaml:"value,omitempty"`
}

EnvVar represents an environment variable present in a Container.

type Event Uses

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

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

    // Should be a short, machine understandable string that describes the current status
    // of the referred object. This should not give the reason for being in this state.
    // Examples: "running", "cantStart", "cantSchedule", "deleted".
    // It's OK for components to make up statuses to report here, but the same string should
    // always be used for the same status.
    // TODO: define a way of making sure these are consistent and don't collide.
    // TODO: provide exact specification for format.
    Status string `json:"status,omitempty" yaml:"status,omitempty"`

    // Optional; this should be a short, machine understandable string that gives the reason
    // for the transition into the object's current status. For example, if ObjectStatus is
    // "cantStart", StatusReason might be "imageNotFound".
    // TODO: provide exact specification for format.
    Reason string `json:"reason,omitempty" yaml:"reason,omitempty"`

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

    // Optional. The component reporting this event. Should be a short machine understandable string.
    // TODO: provide exact specification for format.
    Source string `json:"source,omitempty" yaml:"source,omitempty"`

    // The time at which the client recorded the event. (Time of server receipt is in TypeMeta.)
    Timestamp util.Time `json:"timestamp,omitempty" yaml:"timestamp,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 `yaml:",inline" json:",inline"`
    ListMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

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

EventList is a list of events.

func (*EventList) IsAnAPIObject Uses

func (*EventList) IsAnAPIObject()

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

ExecAction describes a "run in container" action.

type GCEPersistentDisk Uses

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

GCEPersistentDisk represents a Persistent Disk resource in Google Compute Engine.

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

type GitRepo Uses

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

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

type HTTPGetAction Uses

type HTTPGetAction struct {
    // Optional: Path to access on the HTTP server.
    Path string `json:"path,omitempty" yaml:"path,omitempty"`
    // Required: Name or number of the port to access on the container.
    Port util.IntOrString `json:"port,omitempty" yaml:"port,omitempty"`
    // Optional: Host name to connect to, defaults to the pod IP.
    Host string `json:"host,omitempty" yaml:"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" yaml:"exec,omitempty"`
    // HTTPGet specifies the http request to perform.
    HTTPGet *HTTPGetAction `json:"httpGet,omitempty" yaml:"httpGet,omitempty"`
}

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

type HostDir Uses

type HostDir struct {
    Path string `json:"path" yaml:"path"`
}

HostDir represents bare host directory volume.

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" yaml:"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 `yaml:"preStop,omitempty" 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 ListMeta Uses

type ListMeta struct {
    // SelfLink is a URL representing this object.
    SelfLink string `json:"selfLink,omitempty" yaml:"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" yaml:"resourceVersion,omitempty"`
}

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

type LivenessProbe Uses

type LivenessProbe struct {
    // HTTPGetProbe parameters, required if Type == 'http'
    HTTPGet *HTTPGetAction `yaml:"httpGet,omitempty" json:"httpGet,omitempty"`
    // TCPSocketProbe parameter, required if Type == 'tcp'
    TCPSocket *TCPSocketAction `yaml:"tcpSocket,omitempty" json:"tcpSocket,omitempty"`
    // ExecProbe parameter, required if Type == 'exec'
    Exec *ExecAction `yaml:"exec,omitempty" json:"exec,omitempty"`
    // Length of time before health checking is activated.  In seconds.
    InitialDelaySeconds int64 `yaml:"initialDelaySeconds,omitempty" json:"initialDelaySeconds,omitempty"`
}

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

type Minion Uses

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

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

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

Minion is a worker node in Kubernetenes The name of the minion according to etcd is in ObjectMeta.Name. TODO: Rename to Node

func (*Minion) IsAnAPIObject Uses

func (*Minion) IsAnAPIObject()

type MinionList Uses

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

    Items []Minion `json:"items" yaml:"items"`
}

MinionList is a list of minions.

func (*MinionList) IsAnAPIObject Uses

func (*MinionList) IsAnAPIObject()

type NodeResources Uses

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

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

type NodeSpec Uses

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

NodeSpec describes the attributes that a node is created with.

type NodeStatus Uses

type NodeStatus struct {
    // Queried from cloud provider, if available.
    HostIP string `json:"hostIP,omitempty" yaml:"hostIP,omitempty"`
}

NodeStatus is information about the current status of a node.

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

    // SelfLink is a URL representing this object.
    SelfLink string `json:"selfLink,omitempty" yaml:"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 string `json:"uid,omitempty" yaml:"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" yaml:"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" yaml:"creationTimestamp,omitempty"`

    // Labels are key value pairs that may be used to scope and select individual resources.
    // TODO: replace map[string]string with labels.LabelSet type
    Labels map[string]string `json:"labels,omitempty" yaml:"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.
    Annotations map[string]string `json:"annotations,omitempty" yaml:"annotations,omitempty"`
}

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. A resource may have only one of {ObjectMeta, ListMeta}.

type ObjectReference Uses

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

    // Optional. If referring to a piece of an object instead of an entire object, this string
    // should contain a valid field access statement. For example,
    // if the object reference is to a container within a pod, this would take on a value like:
    // "desiredState.manifest.containers[2]". Such statements are valid language constructs in
    // both go and JavaScript. This is 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" yaml:"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.

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

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

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

    // Status represents the current information about a pod. This data may not be up
    // to date.
    Status PodStatus `json:"status,omitempty" yaml:"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 PodInfo Uses

type PodInfo map[string]ContainerStatus

PodInfo contains one entry for every container with available info.

type PodList Uses

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

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

PodList is a list of Pods.

func (*PodList) IsAnAPIObject Uses

func (*PodList) 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"
)

These are the valid statuses of pods.

type PodSpec Uses

type PodSpec struct {
    Volumes       []Volume      `json:"volumes" yaml:"volumes"`
    Containers    []Container   `json:"containers" yaml:"containers"`
    RestartPolicy RestartPolicy `json:"restartPolicy,omitempty" yaml:"restartPolicy,omitempty"`
    // NodeSelector is a selector which must be true for the pod to fit on a node
    NodeSelector map[string]string `json:"nodeSelector,omitempty" yaml:"nodeSelector,omitempty"`
}

PodSpec is a description of a pod

type PodState Uses

type PodState struct {
    Manifest ContainerManifest `json:"manifest,omitempty" yaml:"manifest,omitempty"`
    Status   PodPhase          `json:"status,omitempty" yaml:"status,omitempty"`
    // A human readable message indicating details about why the pod is in this state.
    Message string `json:"message,omitempty" yaml:"message,omitempty"`
    Host    string `json:"host,omitempty" yaml:"host,omitempty"`
    HostIP  string `json:"hostIP,omitempty" yaml:"hostIP,omitempty"`
    PodIP   string `json:"podIP,omitempty" yaml:"podIP,omitempty"`

    // The key of this map is the *name* of the container within the manifest; it has one
    // entry per container in the manifest. The value of this map is currently the output
    // of `docker inspect`. This output format is *not* final and should not be relied
    // upon.
    // TODO: Make real decisions about what our info should look like. Re-enable fuzz test
    // when we have done this.
    Info PodInfo `json:"info,omitempty" yaml:"info,omitempty"`
}

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

type PodStatus Uses

type PodStatus struct {
    Phase PodPhase `json:"phase,omitempty" yaml:"phase,omitempty"`

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

    // The key of this map is the *name* of the container within the manifest; it has one
    // entry per container in the manifest. The value of this map is currently the output
    // of `docker inspect`. This output format is *not* final and should not be relied
    // upon.
    // TODO: Make real decisions about what our info should look like. Re-enable fuzz test
    // when we have done this.
    Info PodInfo `json:"info,omitempty" yaml:"info,omitempty"`
}

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

type PodTemplate Uses

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

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

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

type PodTemplateList Uses

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

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

PodTemplateList is a list of PodTemplates.

type PodTemplateSpec Uses

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

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

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

type Port Uses

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

Port represents a network port in a single 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 = "PullAlways"
    // PullNever means that kubelet never pulls an image, but only uses a local image.  Container will fail if the image isn't present
    PullNever PullPolicy = "PullNever"
    // PullIfNotPresent means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
    PullIfNotPresent PullPolicy = "PullIfNotPresent"
)

type ReplicationController Uses

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

    // Spec defines the desired behavior of this replication controller.
    Spec ReplicationControllerSpec `json:"spec,omitempty" yaml:"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" yaml:"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" yaml:",inline"`
    ListMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

    Items []ReplicationController `json:"items" yaml:"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" yaml:"replicas"`

    // Selector is a label query over pods that should match the Replicas count.
    Selector map[string]string `json:"selector" yaml:"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" yaml:"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" yaml:"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" yaml:"replicas"`
}

ReplicationControllerStatus represents the current status of a replication controller.

type ResourceList Uses

type ResourceList map[ResourceName]util.IntOrString

type ResourceName Uses

type ResourceName string

type RestartPolicy Uses

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

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

type RestartPolicyAlways Uses

type RestartPolicyAlways struct{}

type RestartPolicyNever Uses

type RestartPolicyNever struct{}

type RestartPolicyOnFailure Uses

type RestartPolicyOnFailure struct{}

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

type ServerOp Uses

type ServerOp struct {
    TypeMeta   `yaml:",inline" json:",inline"`
    ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
}

ServerOp is an operation delivered to API clients.

func (*ServerOp) IsAnAPIObject Uses

func (*ServerOp) IsAnAPIObject()

type ServerOpList Uses

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

    Items []ServerOp `yaml:"items" json:"items"`
}

ServerOpList is a list of operations, as delivered to API clients.

func (*ServerOpList) IsAnAPIObject Uses

func (*ServerOpList) IsAnAPIObject()

type Service Uses

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

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

    // Status represents the current status of a service.
    Status ServiceStatus `json:"status,omitempty" yaml:"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" yaml:",inline"`
    ListMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

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

ServiceList holds a list of services.

func (*ServiceList) IsAnAPIObject Uses

func (*ServiceList) IsAnAPIObject()

type ServiceSpec Uses

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

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

    // This service will route traffic to pods having labels matching this selector.
    Selector map[string]string `json:"selector,omitempty" yaml:"selector,omitempty"`

    // PortalIP is usually assigned by the master.  If specified by the user
    // we will try to respect it or else fail the request.  This field can
    // not be changed by updates.
    PortalIP string `json:"portalIP,omitempty" yaml:"portalIP,omitempty"`

    // ProxyPort is assigned by the master.  If 0, the proxy will choose an ephemeral port.
    // TODO: This is awkward - if we had a BoundService, it would be better factored.
    ProxyPort int `json:"proxyPort,omitempty" yaml:"proxyPort,omitempty"`

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

    // ContainerPort is the name of the port on the container to direct traffic to.
    // Optional, if unspecified use the first port on the container.
    ContainerPort util.IntOrString `json:"containerPort,omitempty" yaml:"containerPort,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" yaml:",inline"`
    ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

    // One of: "Success", "Failure", "Working" (for operations not yet completed)
    Status string `json:"status,omitempty" yaml:"status,omitempty"`
    // A human-readable description of the status of this operation.
    Message string `json:"message,omitempty" yaml:"message,omitempty"`
    // A machine-readable description of why this operation is in the
    // "Failure" or "Working" 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" yaml:"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" yaml:"details,omitempty"`
    // Suggested HTTP return code for this status, 0 if not set.
    Code int `json:"code,omitempty" yaml:"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" yaml:"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" yaml:"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" yaml:"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" yaml:"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" yaml:"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" yaml:"causes,omitempty"`
}

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

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

    // StatusReasonWorking means the server is processing this request and will complete
    // at a future time.
    // Details (optional):
    //   "kind" string - the name of the resource being referenced ("operation" today)
    //   "id"   string - the identifier of the Operation resource where updates
    //                   will be returned
    // Headers (optional):
    //   "Location" - HTTP header populated with a URL that can retrieved the final
    //                status of this operation.
    // Status code 202
    StatusReasonWorking StatusReason = "Working"

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

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

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

type TCPSocketAction Uses

type TCPSocketAction struct {
    // Required: Port to connect to.
    Port util.IntOrString `json:"port,omitempty" yaml:"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" yaml:"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" yaml:"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" yaml:"name"`
    // Source represents the location and type of a volume to mount.
    // This is optional for now. If not specified, the Volume is implied to be an EmptyDir.
    // This implied behavior is deprecated and will be removed in a future version.
    Source *VolumeSource `json:"source" yaml:"source"`
}

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

VolumeMount describes a mounting of a Volume within a container.

type VolumeSource Uses

type VolumeSource struct {
    // HostDir represents a pre-existing directory on the host machine that is directly
    // exposed to the container. This is generally used for system agents or other privileged
    // things that are allowed to see the host machine. Most containers will NOT need this.
    // TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not
    // mount host directories as read/write.
    HostDir *HostDir `json:"hostDir" yaml:"hostDir"`
    // EmptyDir represents a temporary directory that shares a pod's lifetime.
    EmptyDir *EmptyDir `json:"emptyDir" yaml:"emptyDir"`
    // GCEPersistentDisk represents a GCE Disk resource that is attached to a
    // kubelet's host machine and then exposed to the pod.
    GCEPersistentDisk *GCEPersistentDisk `json:"persistentDisk" yaml:"persistentDisk"`
    // GitRepo represents a git repository at a particular revision.
    GitRepo *GitRepo `json:"gitRepo" yaml:"gitRepo"`
}

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

Directories

PathSynopsis
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
testapiPackage testapi provides a helper for retrieving the KUBE_API_VERSION environment variable.
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 10 packages (graph). Updated 2018-04-17. Refresh now. Tools for package owners.