Class: ArgoWorkflows::IoK8sApiCoreV1PodSecurityContext

Inherits:
Object
  • Object
show all
Defined in:
lib/argo_workflows/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



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 92

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

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'appArmorProfile')
    self.app_armor_profile = attributes[:'appArmorProfile']
  end

  if attributes.has_key?(:'fsGroup')
    self.fs_group = attributes[:'fsGroup']
  end

  if attributes.has_key?(:'fsGroupChangePolicy')
    self.fs_group_change_policy = attributes[:'fsGroupChangePolicy']
  end

  if attributes.has_key?(:'runAsGroup')
    self.run_as_group = attributes[:'runAsGroup']
  end

  if attributes.has_key?(:'runAsNonRoot')
    self.run_as_non_root = attributes[:'runAsNonRoot']
  end

  if attributes.has_key?(:'runAsUser')
    self.run_as_user = attributes[:'runAsUser']
  end

  if attributes.has_key?(:'seLinuxOptions')
    self.se_linux_options = attributes[:'seLinuxOptions']
  end

  if attributes.has_key?(:'seccompProfile')
    self.seccomp_profile = attributes[:'seccompProfile']
  end

  if attributes.has_key?(:'supplementalGroups')
    if (value = attributes[:'supplementalGroups']).is_a?(Array)
      self.supplemental_groups = value
    end
  end

  if attributes.has_key?(:'supplementalGroupsPolicy')
    self.supplemental_groups_policy = attributes[:'supplementalGroupsPolicy']
  end

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

  if attributes.has_key?(:'windowsOptions')
    self.windows_options = attributes[:'windowsOptions']
  end
end

Instance Attribute Details

#app_armor_profile ⇒ Object

appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.



19
20
21
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 19

def app_armor_profile
  @app_armor_profile
end

#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.



22
23
24
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 22

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.



25
26
27
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 25

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.



28
29
30
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 28

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.



31
32
33
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 31

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.



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

def run_as_user
  @run_as_user
end

#se_linux_options ⇒ Object

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. 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.



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

def se_linux_options
  @se_linux_options
end

#seccomp_profile ⇒ Object

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.



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

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 and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the supplementalGroupsPolicy field determines whether these are in addition to or instead of any group memberships defined in the container image. If unspecified, no additional groups are added, though group memberships defined in the container image may still be used, depending on the supplementalGroupsPolicy field. Note that this field cannot be set when spec.os.name is windows.



43
44
45
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 43

def supplemental_groups
  @supplemental_groups
end

#supplemental_groups_policy ⇒ Object

Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled and the container runtime must implement support for this feature. Note that this field cannot be set when spec.os.name is windows.



46
47
48
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 46

def supplemental_groups_policy
  @supplemental_groups_policy
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.



49
50
51
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 49

def sysctls
  @sysctls
end

#windows_options ⇒ Object

The Windows specific settings applied to all containers. If unspecified, the options within a container’s SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.



52
53
54
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 52

def windows_options
  @windows_options
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 55

def self.attribute_map
  {
    :'app_armor_profile' => :'appArmorProfile',
    :'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',
    :'supplemental_groups_policy' => :'supplementalGroupsPolicy',
    :'sysctls' => :'sysctls',
    :'windows_options' => :'windowsOptions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 73

def self.swagger_types
  {
    :'app_armor_profile' => :'IoK8sApiCoreV1AppArmorProfile',
    :'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>',
    :'supplemental_groups_policy' => :'String',
    :'sysctls' => :'Array<IoK8sApiCoreV1Sysctl>',
    :'windows_options' => :'IoK8sApiCoreV1WindowsSecurityContextOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_armor_profile == o.app_armor_profile &&
      fs_group == o.fs_group &&
      fs_group_change_policy == o.fs_group_change_policy &&
      run_as_group == o.run_as_group &&
      run_as_non_root == o.run_as_non_root &&
      run_as_user == o.run_as_user &&
      se_linux_options == o.se_linux_options &&
      seccomp_profile == o.seccomp_profile &&
      supplemental_groups == o.supplemental_groups &&
      supplemental_groups_policy == o.supplemental_groups_policy &&
      sysctls == o.sysctls &&
      windows_options == o.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



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
247
248
249
250
251
252
253
254
255
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 219

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 = ArgoWorkflows.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 285

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 198

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 attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 191

def hash
  [app_armor_profile, fs_group, fs_group_change_policy, run_as_group, run_as_non_root, run_as_user, se_linux_options, seccomp_profile, supplemental_groups, supplemental_groups_policy, 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



153
154
155
156
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  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



265
266
267
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 265

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



271
272
273
274
275
276
277
278
279
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 271

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



259
260
261
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 259

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



160
161
162
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_pod_security_context.rb', line 160

def valid?
  true
end