103 lines
4 KiB
Go
103 lines
4 KiB
Go
/*
|
|
Copyright 2016 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package apps
|
|
|
|
import (
|
|
"k8s.io/client-go/pkg/api"
|
|
"k8s.io/client-go/pkg/api/unversioned"
|
|
)
|
|
|
|
// +genclient=true
|
|
|
|
// StatefulSet represents a set of pods with consistent identities.
|
|
// Identities are defined as:
|
|
// - Network: A single stable DNS and hostname.
|
|
// - Storage: As many VolumeClaims as requested.
|
|
// The StatefulSet guarantees that a given network identity will always
|
|
// map to the same storage identity.
|
|
type StatefulSet struct {
|
|
unversioned.TypeMeta `json:",inline"`
|
|
// +optional
|
|
api.ObjectMeta `json:"metadata,omitempty"`
|
|
|
|
// Spec defines the desired identities of pods in this set.
|
|
// +optional
|
|
Spec StatefulSetSpec `json:"spec,omitempty"`
|
|
|
|
// Status is the current status of Pods in this StatefulSet. This data
|
|
// may be out of date by some window of time.
|
|
// +optional
|
|
Status StatefulSetStatus `json:"status,omitempty"`
|
|
}
|
|
|
|
// A StatefulSetSpec is the specification of a StatefulSet.
|
|
type StatefulSetSpec struct {
|
|
// Replicas is the desired number of replicas of the given Template.
|
|
// These are replicas in the sense that they are instantiations of the
|
|
// same Template, but individual replicas also have a consistent identity.
|
|
// If unspecified, defaults to 1.
|
|
// TODO: Consider a rename of this field.
|
|
// +optional
|
|
Replicas int32 `json:"replicas,omitempty"`
|
|
|
|
// Selector is a label query over pods that should match the replica count.
|
|
// If empty, defaulted to labels on the pod template.
|
|
// More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
|
|
// +optional
|
|
Selector *unversioned.LabelSelector `json:"selector,omitempty"`
|
|
|
|
// Template is the object that describes the pod that will be created if
|
|
// insufficient replicas are detected. Each pod stamped out by the StatefulSet
|
|
// will fulfill this Template, but have a unique identity from the rest
|
|
// of the StatefulSet.
|
|
Template api.PodTemplateSpec `json:"template"`
|
|
|
|
// VolumeClaimTemplates is a list of claims that pods are allowed to reference.
|
|
// The StatefulSet controller is responsible for mapping network identities to
|
|
// claims in a way that maintains the identity of a pod. Every claim in
|
|
// this list must have at least one matching (by name) volumeMount in one
|
|
// container in the template. A claim in this list takes precedence over
|
|
// any volumes in the template, with the same name.
|
|
// TODO: Define the behavior if a claim already exists with the same name.
|
|
// +optional
|
|
VolumeClaimTemplates []api.PersistentVolumeClaim `json:"volumeClaimTemplates,omitempty"`
|
|
|
|
// ServiceName is the name of the service that governs this StatefulSet.
|
|
// This service must exist before the StatefulSet, and is responsible for
|
|
// the network identity of the set. Pods get DNS/hostnames that follow the
|
|
// pattern: pod-specific-string.serviceName.default.svc.cluster.local
|
|
// where "pod-specific-string" is managed by the StatefulSet controller.
|
|
ServiceName string `json:"serviceName"`
|
|
}
|
|
|
|
// StatefulSetStatus represents the current state of a StatefulSet.
|
|
type StatefulSetStatus struct {
|
|
// most recent generation observed by this autoscaler.
|
|
// +optional
|
|
ObservedGeneration *int64 `json:"observedGeneration,omitempty"`
|
|
|
|
// Replicas is the number of actual replicas.
|
|
Replicas int32 `json:"replicas"`
|
|
}
|
|
|
|
// StatefulSetList is a collection of StatefulSets.
|
|
type StatefulSetList struct {
|
|
unversioned.TypeMeta `json:",inline"`
|
|
// +optional
|
|
unversioned.ListMeta `json:"metadata,omitempty"`
|
|
Items []StatefulSet `json:"items"`
|
|
}
|