Class: Kubernetes::V1SecurityContext

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

Overview

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1SecurityContext

Initializes the object



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 77

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?(:allowPrivilegeEscalation)
    self.allow_privilege_escalation = attributes[:allowPrivilegeEscalation]
  end

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

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

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

  if attributes.key?(:readOnlyRootFilesystem)
    self.read_only_root_filesystem = attributes[:readOnlyRootFilesystem]
  end

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

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

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

  return unless attributes.key?(:seLinuxOptions)

  self.se_linux_options = attributes[:seLinuxOptions]
end

Instance Attribute Details

#allow_privilege_escalation ⇒ Object

AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN



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

def allow_privilege_escalation
  @allow_privilege_escalation
end

#capabilities ⇒ Object

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.



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

def capabilities
  @capabilities
end

#privileged ⇒ Object

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.



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

def privileged
  @privileged
end

#proc_mount ⇒ Object

procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.



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

def proc_mount
  @proc_mount
end

#read_only_root_filesystem ⇒ Object

Whether this container has a read-only root filesystem. Default is false.



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

def read_only_root_filesystem
  @read_only_root_filesystem
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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.



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

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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.



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

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 PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.



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

def run_as_user
  @run_as_user
end

#se_linux_options ⇒ Object

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.



43
44
45
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 43

def se_linux_options
  @se_linux_options
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 46

def self.attribute_map
  {
    allow_privilege_escalation: :allowPrivilegeEscalation,
    capabilities: :capabilities,
    privileged: :privileged,
    proc_mount: :procMount,
    read_only_root_filesystem: :readOnlyRootFilesystem,
    run_as_group: :runAsGroup,
    run_as_non_root: :runAsNonRoot,
    run_as_user: :runAsUser,
    se_linux_options: :seLinuxOptions
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 61

def self.swagger_types
  {
    allow_privilege_escalation: :BOOLEAN,
    capabilities: :V1Capabilities,
    privileged: :BOOLEAN,
    proc_mount: :String,
    read_only_root_filesystem: :BOOLEAN,
    run_as_group: :Integer,
    run_as_non_root: :BOOLEAN,
    run_as_user: :Integer,
    se_linux_options: :V1SELinuxOptions
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 122

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

  self.class == other.class &&
    allow_privilege_escalation == other.allow_privilege_escalation &&
    capabilities == other.capabilities &&
    privileged == other.privileged &&
    proc_mount == other.proc_mount &&
    read_only_root_filesystem == other.read_only_root_filesystem &&
    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
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



177
178
179
180
181
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
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 177

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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 244

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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 153

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


139
140
141
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



145
146
147
148
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 145

def hash
  [allow_privilege_escalation, capabilities, privileged, proc_mount, read_only_root_filesystem,
   run_as_group, run_as_non_root, run_as_user, se_linux_options].hash
end

#list_invalid_properties ⇒ Object

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



110
111
112
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 110

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



223
224
225
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 223

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 229

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



217
218
219
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 217

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



116
117
118
 
# File 'lib/kubernetes/models/v1_security_context.rb', line 116

def valid?
  true
end