Kubernetes Engine V1 API - Class Google::Cloud::Container::V1::NodeKubeletConfig (v1.9.0)

Reference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::NodeKubeletConfig.

Node kubelet configs.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allowed_unsafe_sysctls

def allowed_unsafe_sysctls() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in *).

    The unsafe namespaced sysctl groups are kernel.shm*, kernel.msg*, kernel.sem, fs.mqueue.*, and net.*. Leaving this allowlist empty means they cannot be set on Pods.

    To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: kernel.msg*,net.ipv4.route.min_pmtu.

    See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.

#allowed_unsafe_sysctls=

def allowed_unsafe_sysctls=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in *).

    The unsafe namespaced sysctl groups are kernel.shm*, kernel.msg*, kernel.sem, fs.mqueue.*, and net.*. Leaving this allowlist empty means they cannot be set on Pods.

    To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: kernel.msg*,net.ipv4.route.min_pmtu.

    See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.

Returns
  • (::Array<::String>) — Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in *).

    The unsafe namespaced sysctl groups are kernel.shm*, kernel.msg*, kernel.sem, fs.mqueue.*, and net.*. Leaving this allowlist empty means they cannot be set on Pods.

    To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: kernel.msg*,net.ipv4.route.min_pmtu.

    See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.

#container_log_max_files

def container_log_max_files() -> ::Integer
Returns
  • (::Integer) — Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation

    The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified.

#container_log_max_files=

def container_log_max_files=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation

    The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified.

Returns
  • (::Integer) — Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation

    The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified.

#container_log_max_size

def container_log_max_size() -> ::String
Returns
  • (::String) — Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation

    Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive.

    Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files.

    The default value is 10Mi if unspecified.

#container_log_max_size=

def container_log_max_size=(value) -> ::String
Parameter
  • value (::String) — Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation

    Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive.

    Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files.

    The default value is 10Mi if unspecified.

Returns
  • (::String) — Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation

    Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive.

    Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files.

    The default value is 10Mi if unspecified.

#cpu_cfs_quota

def cpu_cfs_quota() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — Enable CPU CFS quota enforcement for containers that specify CPU limits.

    This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all.

    Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits.

    The default value is 'true' if unspecified.

#cpu_cfs_quota=

def cpu_cfs_quota=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — Enable CPU CFS quota enforcement for containers that specify CPU limits.

    This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all.

    Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits.

    The default value is 'true' if unspecified.

Returns
  • (::Google::Protobuf::BoolValue) — Enable CPU CFS quota enforcement for containers that specify CPU limits.

    This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all.

    Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits.

    The default value is 'true' if unspecified.

#cpu_cfs_quota_period

def cpu_cfs_quota_period() -> ::String
Returns
  • (::String) — Set the CPU CFS quota period value 'cpu.cfs_period_us'.

    The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

#cpu_cfs_quota_period=

def cpu_cfs_quota_period=(value) -> ::String
Parameter
  • value (::String) — Set the CPU CFS quota period value 'cpu.cfs_period_us'.

    The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

Returns
  • (::String) — Set the CPU CFS quota period value 'cpu.cfs_period_us'.

    The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.

#cpu_manager_policy

def cpu_manager_policy() -> ::String
Returns
  • (::String) —

    Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

    The following values are allowed.

    • "none": the default, which represents the existing scheduling behavior.
    • "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

#cpu_manager_policy=

def cpu_manager_policy=(value) -> ::String
Parameter
  • value (::String) —

    Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

    The following values are allowed.

    • "none": the default, which represents the existing scheduling behavior.
    • "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
Returns
  • (::String) —

    Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

    The following values are allowed.

    • "none": the default, which represents the existing scheduling behavior.
    • "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

#eviction_max_pod_grace_period_seconds

def eviction_max_pod_grace_period_seconds() -> ::Integer
Returns
  • (::Integer) — Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].

#eviction_max_pod_grace_period_seconds=

def eviction_max_pod_grace_period_seconds=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
Returns
  • (::Integer) — Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].

#eviction_minimum_reclaim

def eviction_minimum_reclaim() -> ::Google::Cloud::Container::V1::EvictionMinimumReclaim
Returns
  • (::Google::Cloud::Container::V1::EvictionMinimumReclaim) — Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.

#eviction_minimum_reclaim=

def eviction_minimum_reclaim=(value) -> ::Google::Cloud::Container::V1::EvictionMinimumReclaim
Parameter
  • value (::Google::Cloud::Container::V1::EvictionMinimumReclaim) — Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
Returns
  • (::Google::Cloud::Container::V1::EvictionMinimumReclaim) — Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.

#eviction_soft

def eviction_soft() -> ::Google::Cloud::Container::V1::EvictionSignals
Returns
  • (::Google::Cloud::Container::V1::EvictionSignals) — Optional. eviction_soft is a map of signal names to quantities that defines soft eviction thresholds. Each signal is compared to its corresponding threshold to determine if a pod eviction should occur.

#eviction_soft=

def eviction_soft=(value) -> ::Google::Cloud::Container::V1::EvictionSignals
Parameter
  • value (::Google::Cloud::Container::V1::EvictionSignals) — Optional. eviction_soft is a map of signal names to quantities that defines soft eviction thresholds. Each signal is compared to its corresponding threshold to determine if a pod eviction should occur.
Returns
  • (::Google::Cloud::Container::V1::EvictionSignals) — Optional. eviction_soft is a map of signal names to quantities that defines soft eviction thresholds. Each signal is compared to its corresponding threshold to determine if a pod eviction should occur.

#eviction_soft_grace_period

def eviction_soft_grace_period() -> ::Google::Cloud::Container::V1::EvictionGracePeriod
Returns
  • (::Google::Cloud::Container::V1::EvictionGracePeriod) — Optional. eviction_soft_grace_period is a map of signal names to quantities that defines grace periods for each soft eviction signal. The grace period is the amount of time that a pod must be under pressure before an eviction occurs.

#eviction_soft_grace_period=

def eviction_soft_grace_period=(value) -> ::Google::Cloud::Container::V1::EvictionGracePeriod
Parameter
  • value (::Google::Cloud::Container::V1::EvictionGracePeriod) — Optional. eviction_soft_grace_period is a map of signal names to quantities that defines grace periods for each soft eviction signal. The grace period is the amount of time that a pod must be under pressure before an eviction occurs.
Returns
  • (::Google::Cloud::Container::V1::EvictionGracePeriod) — Optional. eviction_soft_grace_period is a map of signal names to quantities that defines grace periods for each soft eviction signal. The grace period is the amount of time that a pod must be under pressure before an eviction occurs.

#image_gc_high_threshold_percent

def image_gc_high_threshold_percent() -> ::Integer
Returns
  • (::Integer) — Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100.

    The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent.

    The default value is 85 if unspecified.

#image_gc_high_threshold_percent=

def image_gc_high_threshold_percent=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100.

    The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent.

    The default value is 85 if unspecified.

Returns
  • (::Integer) — Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100.

    The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent.

    The default value is 85 if unspecified.

#image_gc_low_threshold_percent

def image_gc_low_threshold_percent() -> ::Integer
Returns
  • (::Integer) — Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100.

    The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent.

    The default value is 80 if unspecified.

#image_gc_low_threshold_percent=

def image_gc_low_threshold_percent=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100.

    The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent.

    The default value is 80 if unspecified.

Returns
  • (::Integer) — Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100.

    The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent.

    The default value is 80 if unspecified.

#image_maximum_gc_age

def image_maximum_gc_age() -> ::String
Returns
  • (::String) — Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

    The value must be a positive duration greater than image_minimum_gc_age or "0s".

    The default value is "0s" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long.

#image_maximum_gc_age=

def image_maximum_gc_age=(value) -> ::String
Parameter
  • value (::String) — Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

    The value must be a positive duration greater than image_minimum_gc_age or "0s".

    The default value is "0s" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long.

Returns
  • (::String) — Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

    The value must be a positive duration greater than image_minimum_gc_age or "0s".

    The default value is "0s" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long.

#image_minimum_gc_age

def image_minimum_gc_age() -> ::String
Returns
  • (::String) — Optional. Defines the minimum age for an unused image before it is garbage collected.

    The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

    The value must be a positive duration less than or equal to 2 minutes.

    The default value is "2m0s" if unspecified.

#image_minimum_gc_age=

def image_minimum_gc_age=(value) -> ::String
Parameter
  • value (::String) — Optional. Defines the minimum age for an unused image before it is garbage collected.

    The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

    The value must be a positive duration less than or equal to 2 minutes.

    The default value is "2m0s" if unspecified.

Returns
  • (::String) — Optional. Defines the minimum age for an unused image before it is garbage collected.

    The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

    The value must be a positive duration less than or equal to 2 minutes.

    The default value is "2m0s" if unspecified.

#insecure_kubelet_readonly_port_enabled

def insecure_kubelet_readonly_port_enabled() -> ::Boolean
Returns
  • (::Boolean) — Enable or disable Kubelet read only port.

#insecure_kubelet_readonly_port_enabled=

def insecure_kubelet_readonly_port_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Enable or disable Kubelet read only port.
Returns
  • (::Boolean) — Enable or disable Kubelet read only port.

#max_parallel_image_pulls

def max_parallel_image_pulls() -> ::Integer
Returns
  • (::Integer) — Optional. Defines the maximum number of image pulls in parallel. The range is 2 to 5, inclusive. The default value is 2 or 3 depending on the disk type.

    See https://kubernetes.io/docs/concepts/containers/images/#maximum-parallel-image-pulls for more details.

#max_parallel_image_pulls=

def max_parallel_image_pulls=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Defines the maximum number of image pulls in parallel. The range is 2 to 5, inclusive. The default value is 2 or 3 depending on the disk type.

    See https://kubernetes.io/docs/concepts/containers/images/#maximum-parallel-image-pulls for more details.

Returns
  • (::Integer) — Optional. Defines the maximum number of image pulls in parallel. The range is 2 to 5, inclusive. The default value is 2 or 3 depending on the disk type.

    See https://kubernetes.io/docs/concepts/containers/images/#maximum-parallel-image-pulls for more details.

#memory_manager

def memory_manager() -> ::Google::Cloud::Container::V1::MemoryManager
Returns

#memory_manager=

def memory_manager=(value) -> ::Google::Cloud::Container::V1::MemoryManager
Parameter
  • value (::Google::Cloud::Container::V1::MemoryManager) — Optional. Controls NUMA-aware Memory Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/
Returns

#pod_pids_limit

def pod_pids_limit() -> ::Integer
Returns
  • (::Integer) — Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits

    Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.

#pod_pids_limit=

def pod_pids_limit=(value) -> ::Integer
Parameter
  • value (::Integer) — Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits

    Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.

Returns
  • (::Integer) — Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits

    Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.

#single_process_oom_kill

def single_process_oom_kill() -> ::Boolean
Returns
  • (::Boolean) — Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.

#single_process_oom_kill=

def single_process_oom_kill=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.
Returns
  • (::Boolean) — Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.

#topology_manager

def topology_manager() -> ::Google::Cloud::Container::V1::TopologyManager
Returns

#topology_manager=

def topology_manager=(value) -> ::Google::Cloud::Container::V1::TopologyManager
Parameter
Returns