Class: Zilla::IoK8sApiCoreV1PodSecurityContext

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb

Overview

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiCoreV1PodSecurityContext

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 86

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiCoreV1PodSecurityContext` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `Zilla::IoK8sApiCoreV1PodSecurityContext`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end

    h[k.to_sym] = v
  end

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

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

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

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

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

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

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

  if attributes.key?(:supplemental_groups) && (value = attributes[:supplemental_groups]).is_a?(Array)
    self.supplemental_groups = value
  end

  if attributes.key?(:sysctls) && (value = attributes[:sysctls]).is_a?(Array)
    self.sysctls = value
  end

  return unless attributes.key?(:windows_options)

  self.windows_options = attributes[:windows_options]
end

Instance Attribute Details

#fs_group ⇒ Object

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw—- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.



20
21
22
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 20

def fs_group
  @fs_group
end

#fs_group_change_policy ⇒ Object

fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.



23
24
25
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 23

def fs_group_change_policy
  @fs_group_change_policy
end

#run_as_group ⇒ Object

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.



26
27
28
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 26

def run_as_group
  @run_as_group
end

#run_as_non_root ⇒ Object

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.



29
30
31
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 29

def run_as_non_root
  @run_as_non_root
end

#run_as_user ⇒ Object

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.



32
33
34
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 32

def run_as_user
  @run_as_user
end

#se_linux_options ⇒ Object

Returns the value of attribute se_linux_options.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 34

def se_linux_options
  @se_linux_options
end

#seccomp_profile ⇒ Object

Returns the value of attribute seccomp_profile.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 34

def seccomp_profile
  @seccomp_profile
end

#supplemental_groups ⇒ Object

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.



37
38
39
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 37

def supplemental_groups
  @supplemental_groups
end

#sysctls ⇒ Object

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.



40
41
42
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 40

def sysctls
  @sysctls
end

#windows_options ⇒ Object

Returns the value of attribute windows_options.



34
35
36
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 34

def windows_options
  @windows_options
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.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
55
56
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 43

def self.attribute_map
  {
    fs_group: :fsGroup,
    fs_group_change_policy: :fsGroupChangePolicy,
    run_as_group: :runAsGroup,
    run_as_non_root: :runAsNonRoot,
    run_as_user: :runAsUser,
    se_linux_options: :seLinuxOptions,
    seccomp_profile: :seccompProfile,
    supplemental_groups: :supplementalGroups,
    sysctls: :sysctls,
    windows_options: :windowsOptions
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



175
176
177
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 175

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 80

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 64

def self.openapi_types
  {
    fs_group: :Integer,
    fs_group_change_policy: :String,
    run_as_group: :Integer,
    run_as_non_root: :Boolean,
    run_as_user: :Integer,
    se_linux_options: :IoK8sApiCoreV1SELinuxOptions,
    seccomp_profile: :IoK8sApiCoreV1SeccompProfile,
    supplemental_groups: :'Array<Integer>',
    sysctls: :'Array<IoK8sApiCoreV1Sysctl>',
    windows_options: :IoK8sApiCoreV1WindowsSecurityContextOptions
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 143

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

  self.class == other.class &&
    fs_group == other.fs_group &&
    fs_group_change_policy == other.fs_group_change_policy &&
    run_as_group == other.run_as_group &&
    run_as_non_root == other.run_as_non_root &&
    run_as_user == other.run_as_user &&
    se_linux_options == other.se_linux_options &&
    seccomp_profile == other.seccomp_profile &&
    supplemental_groups == other.supplemental_groups &&
    sysctls == other.sysctls &&
    windows_options == other.windows_options
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 209

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Zilla.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 280

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 182

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

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 161

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
170
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 167

def hash
  [fs_group, fs_group_change_policy, run_as_group, run_as_non_root, run_as_user, se_linux_options, seccomp_profile,
   supplemental_groups, sysctls, windows_options].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



131
132
133
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 131

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 256

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 262

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



250
251
252
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 250

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



137
138
139
 
# File 'lib/zilla/models/io_k8s_api_core_v1_pod_security_context.rb', line 137

def valid?
  true
end