Documentation ¶
Index ¶
- type APIVersion
- type DaemonSet
- type DaemonSetList
- type DaemonSetSpec
- type DaemonSetStatus
- type Deployment
- type DeploymentList
- type DeploymentSpec
- type DeploymentStatus
- type DeploymentStrategy
- type DeploymentStrategyType
- type HTTPIngressPath
- type HTTPIngressRuleValue
- type HorizontalPodAutoscaler
- type HorizontalPodAutoscalerList
- type HorizontalPodAutoscalerSpec
- type HorizontalPodAutoscalerStatus
- type Ingress
- type IngressBackend
- type IngressList
- type IngressRule
- type IngressRuleValue
- type IngressSpec
- type IngressStatus
- type Job
- type JobCondition
- type JobConditionType
- type JobList
- type JobSpec
- type JobStatus
- type ReplicationControllerDummy
- type ResourceConsumption
- type RollingUpdateDeployment
- type Scale
- type ScaleSpec
- type ScaleStatus
- type SubresourceReference
- type ThirdPartyResource
- type ThirdPartyResourceData
- type ThirdPartyResourceDataList
- type ThirdPartyResourceList
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIVersion ¶
type APIVersion struct { // Name of this version (e.g. 'v1'). Name string `json:"name,omitempty"` // The API group to add this object into, default 'experimental'. APIGroup string `json:"apiGroup,omitempty"` }
An APIVersion represents a single concrete version of an object model. TODO: we should consider merge this struct with GroupVersion in unversioned.go
type DaemonSet ¶
type DaemonSet struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata api.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired behavior of this daemon set. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status Spec DaemonSetSpec `json:"spec,omitempty"` // Status is the current status of this daemon set. This data may be // out of date by some window of time. // Populated by the system. // Read-only. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status Status DaemonSetStatus `json:"status,omitempty"` }
DaemonSet represents the configuration of a daemon set.
func (*DaemonSet) IsAnAPIObject ¶
func (*DaemonSet) IsAnAPIObject()
type DaemonSetList ¶
type DaemonSetList struct { unversioned.TypeMeta `json:",inline"` // Standard list metadata. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata unversioned.ListMeta `json:"metadata,omitempty"` // Items is a list of daemon sets. Items []DaemonSet `json:"items"` }
DaemonSetList is a collection of daemon sets.
func (*DaemonSetList) IsAnAPIObject ¶
func (*DaemonSetList) IsAnAPIObject()
type DaemonSetSpec ¶
type DaemonSetSpec struct { // Selector is a label query over pods that are managed by the daemon set. // Must match in order to be controlled. // If empty, defaulted to labels on Pod template. // More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors Selector map[string]string `json:"selector,omitempty"` // Template is the object that describes the pod that will be created. // The DaemonSet will create exactly one copy of this pod on every node // that matches the template's node selector (or on every node if no node // selector is specified). // More info: http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#pod-template Template *api.PodTemplateSpec `json:"template,omitempty"` }
DaemonSetSpec is the specification of a daemon set.
type DaemonSetStatus ¶
type DaemonSetStatus struct { // CurrentNumberScheduled is the number of nodes that are running exactly 1 // daemon pod and are supposed to run the daemon pod. CurrentNumberScheduled int `json:"currentNumberScheduled"` // NumberMisscheduled is the number of nodes that are running the daemon pod, but are // not supposed to run the daemon pod. NumberMisscheduled int `json:"numberMisscheduled"` // DesiredNumberScheduled is the total number of nodes that should be running the daemon // pod (including nodes correctly running the daemon pod). DesiredNumberScheduled int `json:"desiredNumberScheduled"` }
DaemonSetStatus represents the current status of a daemon set.
type Deployment ¶
type Deployment struct { unversioned.TypeMeta `json:",inline"` api.ObjectMeta `json:"metadata,omitempty"` // Specification of the desired behavior of the Deployment. Spec DeploymentSpec `json:"spec,omitempty"` // Most recently observed status of the Deployment. Status DeploymentStatus `json:"status,omitempty"` }
func (*Deployment) IsAnAPIObject ¶
func (*Deployment) IsAnAPIObject()
type DeploymentList ¶
type DeploymentList struct { unversioned.TypeMeta `json:",inline"` unversioned.ListMeta `json:"metadata,omitempty"` // Items is the list of deployments. Items []Deployment `json:"items"` }
func (*DeploymentList) IsAnAPIObject ¶
func (*DeploymentList) IsAnAPIObject()
type DeploymentSpec ¶
type DeploymentSpec struct { // Number of desired pods. This is a pointer to distinguish between explicit // zero and not specified. Defaults to 1. Replicas int `json:"replicas,omitempty"` // Label selector for pods. Existing ReplicationControllers whose pods are // selected by this will be scaled down. Selector map[string]string `json:"selector,omitempty"` // Template describes the pods that will be created. Template *api.PodTemplateSpec `json:"template,omitempty"` // The deployment strategy to use to replace existing pods with new ones. Strategy DeploymentStrategy `json:"strategy,omitempty"` // Key of the selector that is added to existing RCs (and label key that is // added to its pods) to prevent the existing RCs to select new pods (and old // pods being selected by new RC). // Users can set this to an empty string to indicate that the system should // not add any selector and label. If unspecified, system uses // "deployment.kubernetes.io/podTemplateHash". // Value of this key is hash of DeploymentSpec.PodTemplateSpec. // No label is added if this is set to empty string. UniqueLabelKey string `json:"uniqueLabelKey,omitempty"` }
type DeploymentStatus ¶
type DeploymentStrategy ¶
type DeploymentStrategy struct { // Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. Type DeploymentStrategyType `json:"type,omitempty"` // Rolling update config params. Present only if DeploymentStrategyType = // RollingUpdate. //--- // TODO: Update this to follow our convention for oneOf, whatever we decide it // to be. RollingUpdate *RollingUpdateDeployment `json:"rollingUpdate,omitempty"` }
type DeploymentStrategyType ¶
type DeploymentStrategyType string
const ( // Kill all existing pods before creating new ones. RecreateDeploymentStrategyType DeploymentStrategyType = "Recreate" // Replace the old RCs by new one using rolling update i.e gradually scale down the old RCs and scale up the new one. RollingUpdateDeploymentStrategyType DeploymentStrategyType = "RollingUpdate" )
type HTTPIngressPath ¶
type HTTPIngressPath struct { // Path is a extended POSIX regex as defined by IEEE Std 1003.1, // (i.e this follows the egrep/unix syntax, not the perl syntax) // matched against the path of an incoming request. Currently it can // contain characters disallowed from the conventional "path" // part of a URL as defined by RFC 3986. Paths must begin with // a '/'. Path string `json:"path,omitempty"` // Define the referenced service endpoint which the traffic will be // forwarded to. Backend IngressBackend `json:"backend"` }
IngressPath associates a path regex with an IngressBackend. Incoming urls matching the Path are forwarded to the Backend.
type HTTPIngressRuleValue ¶
type HTTPIngressRuleValue struct { // A collection of paths that map requests to IngressBackends. Paths []HTTPIngressPath `json:"paths"` }
HTTPIngressRuleValue is a list of http selectors pointing to IngressBackends. In the example: http://<host>/<path>?<searchpart> -> IngressBackend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.
type HorizontalPodAutoscaler ¶
type HorizontalPodAutoscaler struct { unversioned.TypeMeta `json:",inline"` api.ObjectMeta `json:"metadata,omitempty"` // Spec defines the behaviour of autoscaler. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Spec HorizontalPodAutoscalerSpec `json:"spec,omitempty"` // Status represents the current information about the autoscaler. Status HorizontalPodAutoscalerStatus `json:"status,omitempty"` }
HorizontalPodAutoscaler represents the configuration of a horizontal pod autoscaler.
func (*HorizontalPodAutoscaler) IsAnAPIObject ¶
func (*HorizontalPodAutoscaler) IsAnAPIObject()
type HorizontalPodAutoscalerList ¶
type HorizontalPodAutoscalerList struct { unversioned.TypeMeta `json:",inline"` unversioned.ListMeta `json:"metadata,omitempty"` // Items is the list of horizontal pod autoscalers. Items []HorizontalPodAutoscaler `json:"items"` }
HorizontalPodAutoscaler is a collection of pod autoscalers.
func (*HorizontalPodAutoscalerList) IsAnAPIObject ¶
func (*HorizontalPodAutoscalerList) IsAnAPIObject()
type HorizontalPodAutoscalerSpec ¶
type HorizontalPodAutoscalerSpec struct { // ScaleRef is a reference to Scale subresource. HorizontalPodAutoscaler will learn the current resource consumption from its status, // and will set the desired number of pods by modyfying its spec. ScaleRef *SubresourceReference `json:"scaleRef"` // MinReplicas is the lower limit for the number of pods that can be set by the autoscaler. MinReplicas int `json:"minReplicas"` // MaxReplicas is the upper limit for the number of pods that can be set by the autoscaler. It cannot be smaller than MinReplicas. MaxReplicas int `json:"maxReplicas"` // Target is the target average consumption of the given resource that the autoscaler will try to maintain by adjusting the desired number of pods. // Currently two types of resources are supported: "cpu" and "memory". Target ResourceConsumption `json:"target"` }
HorizontalPodAutoscalerSpec is the specification of a horizontal pod autoscaler.
type HorizontalPodAutoscalerStatus ¶
type HorizontalPodAutoscalerStatus struct { // TODO: Consider if it is needed. // CurrentReplicas is the number of replicas of pods managed by this autoscaler. CurrentReplicas int `json:"currentReplicas"` // DesiredReplicas is the desired number of replicas of pods managed by this autoscaler. DesiredReplicas int `json:"desiredReplicas"` // CurrentConsumption is the current average consumption of the given resource that the autoscaler will // try to maintain by adjusting the desired number of pods. // Two types of resources are supported: "cpu" and "memory". CurrentConsumption *ResourceConsumption `json:"currentConsumption"` // LastScaleTimestamp is the last time the HorizontalPodAutoscaler scaled the number of pods. // This is used by the autoscaler to controll how often the number of pods is changed. LastScaleTimestamp *unversioned.Time `json:"lastScaleTimestamp,omitempty"` }
HorizontalPodAutoscalerStatus contains the current status of a horizontal pod autoscaler
type Ingress ¶
type Ingress struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata api.ObjectMeta `json:"metadata,omitempty"` // Spec is the desired state of the Ingress. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status Spec IngressSpec `json:"spec,omitempty"` // Status is the current state of the Ingress. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status Status IngressStatus `json:"status,omitempty"` }
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
func (*Ingress) IsAnAPIObject ¶
func (*Ingress) IsAnAPIObject()
type IngressBackend ¶
type IngressBackend struct { // Specifies the name of the referenced service. ServiceName string `json:"serviceName"` // Specifies the port of the referenced service. ServicePort util.IntOrString `json:"servicePort"` }
IngressBackend describes all endpoints for a given Service and port.
type IngressList ¶
type IngressList struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata unversioned.ListMeta `json:"metadata,omitempty"` // Items is the list of Ingress. Items []Ingress `json:"items"` }
IngressList is a collection of Ingress.
func (*IngressList) IsAnAPIObject ¶
func (*IngressList) IsAnAPIObject()
type IngressRule ¶
type IngressRule struct { // Host is the fully qualified domain name of a network host, as defined // by RFC 3986. Note the following deviations from the "host" part of the // URI as defined in the RFC: // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the // IP in the Spec of the parent Ingress. // 2. The `:` delimiter is not respected because ports are not allowed. // Currently the port of an Ingress is implicitly :80 for http and // :443 for https. // Both these may change in the future. // Incoming requests are matched against the Host before the IngressRuleValue. Host string `json:"host,omitempty"` // IngressRuleValue represents a rule to route requests for this IngressRule. IngressRuleValue `json:",inline"` }
IngressRule represents the rules mapping the paths under a specified host to the related backend services.
type IngressRuleValue ¶
type IngressRuleValue struct { // Currently mixing different types of rules in a single Ingress is // disallowed, so exactly one of the following must be set. HTTP *HTTPIngressRuleValue `json:"http"` }
IngressRuleValue represents a rule to apply against incoming requests. If the rule is satisfied, the request is routed to the specified backend.
type IngressSpec ¶
type IngressSpec struct { // A default backend capable of servicing requests that don't match any // IngressRule. It is optional to allow the loadbalancer controller or // defaulting logic to specify a global default. Backend *IngressBackend `json:"backend,omitempty"` // A list of host rules used to configure the Ingress. Rules []IngressRule `json:"rules"` }
IngressSpec describes the Ingress the user wishes to exist.
type IngressStatus ¶
type IngressStatus struct { // LoadBalancer contains the current status of the load-balancer. LoadBalancer api.LoadBalancerStatus `json:"loadBalancer,omitempty"` }
IngressStatus describe the current state of the Ingress.
type Job ¶
type Job struct { unversioned.TypeMeta `json:",inline"` // Standard object's metadata. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata api.ObjectMeta `json:"metadata,omitempty"` // Spec is a structure defining the expected behavior of a job. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status Spec JobSpec `json:"spec,omitempty"` // Status is a structure describing current status of a job. // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status Status JobStatus `json:"status,omitempty"` }
Job represents the configuration of a single job.
func (*Job) IsAnAPIObject ¶
func (*Job) IsAnAPIObject()
type JobCondition ¶
type JobCondition struct { // Type of job condition, currently only Complete. Type JobConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status api.ConditionStatus `json:"status"` // Last time the condition was checked. LastProbeTime unversioned.Time `json:"lastProbeTime,omitempty"` // Last time the condition transit from one status to another. LastTransitionTime unversioned.Time `json:"lastTransitionTime,omitempty"` // (brief) reason for the condition's last transition. Reason string `json:"reason,omitempty"` // Human readable message indicating details about last transition. Message string `json:"message,omitempty"` }
JobCondition describes current state of a job.
type JobConditionType ¶
type JobConditionType string
const ( // JobComplete means the job has completed its execution. JobComplete JobConditionType = "Complete" )
These are valid conditions of a job.
type JobList ¶
type JobList struct { unversioned.TypeMeta `json:",inline"` // Standard list metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata unversioned.ListMeta `json:"metadata,omitempty"` // Items is the list of Job. Items []Job `json:"items"` }
JobList is a collection of jobs.
func (*JobList) IsAnAPIObject ¶
func (*JobList) IsAnAPIObject()
type JobSpec ¶
type JobSpec struct { // Parallelism specifies the maximum desired number of pods the job should // run at any given time. The actual number of pods running in steady state will // be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), // i.e. when the work left to do is less than max parallelism. Parallelism *int `json:"parallelism,omitempty"` // Completions specifies the desired number of successfully finished pods the // job should be run with. Defaults to 1. Completions *int `json:"completions,omitempty"` // Selector is a label query over pods that should match the pod count. Selector map[string]string `json:"selector"` // Template is the object that describes the pod that will be created when // executing a job. Template *api.PodTemplateSpec `json:"template"` }
JobSpec describes how the job execution will look like.
type JobStatus ¶
type JobStatus struct { // Conditions represent the latest available observations of an object's current state. Conditions []JobCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` // StartTime represents time when the job was acknowledged by the Job Manager. // It is not guaranteed to be set in happens-before order across separate operations. // It is represented in RFC3339 form and is in UTC. StartTime *unversioned.Time `json:"startTime,omitempty"` // CompletionTime represents time when the job was completed. It is not guaranteed to // be set in happens-before order across separate operations. // It is represented in RFC3339 form and is in UTC. CompletionTime *unversioned.Time `json:"completionTime,omitempty"` // Active is the number of actively running pods. Active int `json:"active,omitempty"` // Successful is the number of pods which reached Phase Succeeded. Successful int `json:"successful,omitempty"` // Unsuccessful is the number of pods failures, this applies only to jobs // created with RestartPolicyNever, otherwise this value will always be 0. Unsuccessful int `json:"unsuccessful,omitempty"` }
JobStatus represents the current state of a Job.
type ReplicationControllerDummy ¶
type ReplicationControllerDummy struct {
unversioned.TypeMeta `json:",inline"`
}
Dummy definition
func (*ReplicationControllerDummy) IsAnAPIObject ¶
func (*ReplicationControllerDummy) IsAnAPIObject()
type ResourceConsumption ¶
type ResourceConsumption struct { Resource api.ResourceName `json:"resource,omitempty"` Quantity resource.Quantity `json:"quantity,omitempty"` }
ResourceConsumption is an object for specifying average resource consumption of a particular resource.
type RollingUpdateDeployment ¶
type RollingUpdateDeployment struct { // Value can be an absolute number (ex: 5) or a percentage of total pods at the start of update (ex: 10%). // Absolute number is calculated from percentage by rounding up. // This can not be 0 if MaxSurge is 0. // By default, a fixed value of 1 is used. // Example: when this is set to 30%, the old RC can be scaled down by 30% // immediately when the rolling update starts. Once new pods are ready, old RC // can be scaled down further, followed by scaling up the new RC, ensuring // that at least 70% of original number of pods are available at all times // during the update. MaxUnavailable util.IntOrString `json:"maxUnavailable,omitempty"` // The maximum number of pods that can be scheduled above the original number of // pods. // Value can be an absolute number (ex: 5) or a percentage of total pods at // the start of the update (ex: 10%). This can not be 0 if MaxUnavailable is 0. // Absolute number is calculated from percentage by rounding up. // By default, a value of 1 is used. // Example: when this is set to 30%, the new RC can be scaled up by 30% // immediately when the rolling update starts. Once old pods have been killed, // new RC can be scaled up further, ensuring that total number of pods running // at any time during the update is atmost 130% of original pods. MaxSurge util.IntOrString `json:"maxSurge,omitempty"` // Minimum number of seconds for which a newly created pod should be ready // without any of its container crashing, for it to be considered available. // Defaults to 0 (pod will be considered available as soon as it is ready) MinReadySeconds int `json:"minReadySeconds,omitempty"` }
Spec to control the desired behavior of rolling update.
type Scale ¶
type Scale struct { unversioned.TypeMeta `json:",inline"` // Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata. api.ObjectMeta `json:"metadata,omitempty"` // Spec defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Spec ScaleSpec `json:"spec,omitempty"` // Status represents the current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only. Status ScaleStatus `json:"status,omitempty"` }
Scale subresource, applicable to ReplicationControllers and (in future) Deployment.
func (*Scale) IsAnAPIObject ¶
func (*Scale) IsAnAPIObject()
type ScaleSpec ¶
type ScaleSpec struct { // Replicas is the number of desired replicas. More info: http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller" Replicas int `json:"replicas,omitempty"` }
ScaleSpec describes the attributes a Scale subresource
type ScaleStatus ¶
type ScaleStatus struct { // Replicas is the number of actual replicas. More info: http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller Replicas int `json:"replicas"` // Selector is a label query over pods that should match the replicas count. If it is empty, it is defaulted to labels on Pod template; More info: http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors Selector map[string]string `json:"selector,omitempty"` }
ScaleStatus represents the current status of a Scale subresource.
type SubresourceReference ¶
type SubresourceReference struct { // Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" Kind string `json:"kind,omitempty"` // Namespace of the referent; More info: http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md Namespace string `json:"namespace,omitempty"` // Name of the referent; More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names Name string `json:"name,omitempty"` // API version of the referent APIVersion string `json:"apiVersion,omitempty"` // Subresource name of the referent Subresource string `json:"subresource,omitempty"` }
SubresourceReference contains enough information to let you inspect or modify the referred subresource.
type ThirdPartyResource ¶
type ThirdPartyResource struct { unversioned.TypeMeta `json:",inline"` // Standard object metadata api.ObjectMeta `json:"metadata,omitempty"` // Description is the description of this object. Description string `json:"description,omitempty"` // Versions are versions for this third party object Versions []APIVersion `json:"versions,omitempty"` }
A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.
func (*ThirdPartyResource) IsAnAPIObject ¶
func (*ThirdPartyResource) IsAnAPIObject()
type ThirdPartyResourceData ¶
type ThirdPartyResourceData struct { unversioned.TypeMeta `json:",inline"` // Standard object metadata. api.ObjectMeta `json:"metadata,omitempty"` // Data is the raw JSON data for this data. Data []byte `json:"name,omitempty"` }
An internal object, used for versioned storage in etcd. Not exposed to the end user.
func (*ThirdPartyResourceData) IsAnAPIObject ¶
func (*ThirdPartyResourceData) IsAnAPIObject()
type ThirdPartyResourceDataList ¶
type ThirdPartyResourceDataList struct { unversioned.TypeMeta `json:",inline"` // Standard list metadata // More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata unversioned.ListMeta `json:"metadata,omitempty"` // Items is a list of third party objects Items []ThirdPartyResourceData `json:"items"` }
func (*ThirdPartyResourceDataList) IsAnAPIObject ¶
func (*ThirdPartyResourceDataList) IsAnAPIObject()
type ThirdPartyResourceList ¶
type ThirdPartyResourceList struct { unversioned.TypeMeta `json:",inline"` // Standard list metadata. unversioned.ListMeta `json:"metadata,omitempty"` // Items is the list of horizontal pod autoscalers. Items []ThirdPartyResource `json:"items"` }
func (*ThirdPartyResourceList) IsAnAPIObject ¶
func (*ThirdPartyResourceList) IsAnAPIObject()
Directories ¶
Path | Synopsis |
---|---|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |