Class: Kubernetes::V1beta1StatefulSetSpec

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1beta1_stateful_set_spec.rb

Overview

A StatefulSetSpec is the specification of a StatefulSet.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1beta1StatefulSetSpec

Initializes the object



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 72

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

  if attributes.key?(:podManagementPolicy)
    self.pod_management_policy = attributes[:podManagementPolicy]
  end

  self.replicas = attributes[:replicas] if attributes.key?(:replicas)

  if attributes.key?(:revisionHistoryLimit)
    self.revision_history_limit = attributes[:revisionHistoryLimit]
  end

  self.selector = attributes[:selector] if attributes.key?(:selector)

  self.service_name = attributes[:serviceName] if attributes.key?(:serviceName)

  self.template = attributes[:template] if attributes.key?(:template)

  self.update_strategy = attributes[:updateStrategy] if attributes.key?(:updateStrategy)

  return unless attributes.key?(:volumeClaimTemplates)
  return unless (value = attributes[:volumeClaimTemplates]).is_a?(Array)

  self.volume_claim_templates = value
end

Instance Attribute Details

#pod_management_policy ⇒ Object

podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is ‘OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.



19
20
21
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 19

def pod_management_policy
  @pod_management_policy
end

#replicas ⇒ Object

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.



22
23
24
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 22

def replicas
  @replicas
end

#revision_history_limit ⇒ Object

revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet’s revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.



25
26
27
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 25

def revision_history_limit
  @revision_history_limit
end

#selector ⇒ Object

selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors



28
29
30
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 28

def selector
  @selector
end

#service_name ⇒ Object

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.



31
32
33
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 31

def service_name
  @service_name
end

#template ⇒ Object

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.



34
35
36
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 34

def template
  @template
end

#update_strategy ⇒ Object

updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.



37
38
39
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 37

def update_strategy
  @update_strategy
end

#volume_claim_templates ⇒ Object

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.



40
41
42
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 40

def volume_claim_templates
  @volume_claim_templates
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 43

def self.attribute_map
  {
    pod_management_policy: :podManagementPolicy,
    replicas: :replicas,
    revision_history_limit: :revisionHistoryLimit,
    selector: :selector,
    service_name: :serviceName,
    template: :template,
    update_strategy: :updateStrategy,
    volume_claim_templates: :volumeClaimTemplates
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 57

def self.swagger_types
  {
    pod_management_policy: :String,
    replicas: :Integer,
    revision_history_limit: :Integer,
    selector: :V1LabelSelector,
    service_name: :String,
    template: :V1PodTemplateSpec,
    update_strategy: :V1beta1StatefulSetUpdateStrategy,
    volume_claim_templates: :'Array<V1PersistentVolumeClaim>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 128

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    pod_management_policy == other.pod_management_policy &&
    replicas == other.replicas &&
    revision_history_limit == other.revision_history_limit &&
    selector == other.selector &&
    service_name == other.service_name &&
    template == other.template &&
    update_strategy == other.update_strategy &&
    volume_claim_templates == other.volume_claim_templates
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 182

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Kubernetes.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 249

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 158

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

See Also:

  • `==` method


144
145
146
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



150
151
152
153
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 150

def hash
  [pod_management_policy, replicas, revision_history_limit, selector, service_name, template,
   update_strategy, volume_claim_templates].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 104

def list_invalid_properties
  invalid_properties = []
  if @service_name.nil?
    invalid_properties.push("invalid value for 'service_name', service_name cannot be nil.")
  end

  if @template.nil?
    invalid_properties.push("invalid value for 'template', template cannot be nil.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



228
229
230
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 228

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 234

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



222
223
224
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 222

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



119
120
121
122
123
124
 
# File 'lib/kubernetes/models/v1beta1_stateful_set_spec.rb', line 119

def valid?
  return false if @service_name.nil?
  return false if @template.nil?

  true
end