package
0.4.3
Repository: https://github.com/sub-mod/kubernetes.git
Documentation: pkg.go.dev

# Packages

Package errors provides detailed error types for api field validation.
Package latest defines the default output serializations that code should use and imports the required schemas.
Package testapi provides a helper for retrieving the KUBE_API_VERSION environment variable.
Package v1beta1 is the v1beta1 version of the API.
Package v1beta2 is the v1beta2 version of the API.
Package v1beta3 is the v1beta3 version of the API.
Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.

# Functions

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.
No description provided by the author
No description provided by the author
No description provided by the author
NamespaceFrom returns the value of the namespace key on the ctx.
NewContext instantiates a base context object for request flows.
NewDefaultContext instantiates a base context object for request flows in the default namespace.
ValidNamespace returns false if the namespace on the context differs from the resource.
WithNamespace returns a copy of parent in which the namespace value is set.
WithValue returns a copy of parent in which the value associated with key is val.

# Constants

CauseTypeFieldValueDuplicate is used to report collisions of values that must be unique (e.g.
CauseTypeFieldValueInvalid is used to report malformed values (e.g.
CauseTypeFieldValueNotFound is used to report failure to find a requested value (e.g.
CauseTypeFieldValueNotSupported is used to report valid (as per formatting rules) values that can not be handled (e.g.
CauseTypeFieldValueInvalid is used to report required values that are not provided (e.g.
NamespaceAll is the default argument to specify on a context when you want to list or filter resources across all namespaces.
NamespaceDefault means the object is in the default namespace which is applied when not specified by clients.
PodRunning means that the pod is up and running.
PodTerminated means that the pod has stopped.
PodWaiting means that we're waiting for the pod to begin running.
ProtocolTCP is the TCP protocol.
ProtocolUDP is the UDP protocol.
Always attempt to pull the latest image.
Pull if the image isn't present on disk.
Never pull an image, only use a local image.
Values of Status.Status.
StatusReasonAlreadyExists means the resource you are creating already exists.
StatusReasonConflict means the requested update operation cannot be completed due to a conflict in the operation.
StatusReasonInvalid means the requested create or update operation cannot be completed due to invalid data provided as part of the request.
StatusReasonNotFound means one or more resources required for this operation could not be found.
StatusReasonUnknown means the server has declined to indicate a specific reason.
StatusReasonWorking means the server is processing this request and will complete at a future time.
Values of Status.Status.
Values of Status.Status.

# Variables

Codec is the identity codec for this package - it can only convert itself to itself.
No description provided by the author

# Structs

Binding is written by a scheduler to cause a pod to be bound to a host.
BoundPod is a collection of containers that should be run on a host.
BoundPods is a list of Pods bound to a common server.
Container represents a single container that is expected to be run on the host.
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.
ContainerManifestList is used to communicate container manifests to kubelet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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"].
EndpointsList is a list of endpoints.
EnvVar represents an environment variable present in a Container.
Event is a report of an event somewhere in the cluster.
EventList is a list of events.
ExecAction describes a "run in container" action.
GCEPersistent Disk resource.
Handler defines a specific action that should be taken TODO: pass structured data to these actions, and document that data here.
HostDir represents bare host directory volume.
HTTPGetAction describes an action based on HTTP Get requests.
Lifecycle describes actions that the management system should take in response to container lifecycle events.
LivenessProbe describes a liveness probe to be examined to the container.
Minion is a worker node in Kubernetenes.
MinionList is a list of minions.
NodeResources represents resources on a Kubernetes system node see https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/resources.md for more details.
ObjectReference contains enough information to let you inspect or modify the referred object.
Pod is a collection of containers, used as either input (create, update) or as output (list, get).
PodList is a list of Pods.
PodSpec is a description of a pod.
PodState is the state of a pod, used as either input (desired state) or output (current state).
PodTemplate holds the information used for creating pods.
Port represents a network port in a single container.
ReplicationController represents the configuration of a replication controller.
ReplicationControllerList is a collection of replication controllers.
ReplicationControllerState is the state of a replication controller, either input (create, update) or as output (list, get).
No description provided by the author
No description provided by the author
No description provided by the author
TODO(dchen1107): Define what kinds of failures should restart.
ServerOp is an operation delivered to API clients.
ServerOpList is a list of operations, as delivered to API clients.
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.
ServiceList holds a list of services.
Status is a return value for calls that don't return other objects.
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response.
TCPSocketAction describes an action based on opening a socket.
TypeMeta is shared by all objects sent to, or returned from the client.
Volume represents a named volume in a pod that may be accessed by any containers in the pod.
VolumeMount describes a mounting of a Volume within a container.
No description provided by the author

# Interfaces

Context carries values across API boundaries.

# Type aliases

CauseType is a machine readable value providing more detail about what occured in a status response.
PodInfo contains one entry for every container with available info.
PodStatus represents a status of a pod.
Protocol defines network protocols supported for things like conatiner ports.
PullPolicy describes a policy for if/when to pull a container image.
TODO Replace this with a more complete "Quantity" struct.
No description provided by the author
StatusReason is an enumeration of possible failure causes.