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

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

TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#policy

def policy() -> ::String
Returns
  • (::String) — Configures the strategy for resource alignment. Allowed values are:

    • none: the default policy, and does not perform any topology alignment.
    • restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred.
    • best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway.
    • single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure.

    The default policy value is 'none' if unspecified. Details about each strategy can be found here.

#policy=

def policy=(value) -> ::String
Parameter
  • value (::String) — Configures the strategy for resource alignment. Allowed values are:

    • none: the default policy, and does not perform any topology alignment.
    • restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred.
    • best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway.
    • single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure.

    The default policy value is 'none' if unspecified. Details about each strategy can be found here.

Returns
  • (::String) — Configures the strategy for resource alignment. Allowed values are:

    • none: the default policy, and does not perform any topology alignment.
    • restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred.
    • best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway.
    • single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure.

    The default policy value is 'none' if unspecified. Details about each strategy can be found here.

#scope

def scope() -> ::String
Returns
  • (::String) — The Topology Manager aligns resources in following scopes:

    • container
    • pod

    The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes

#scope=

def scope=(value) -> ::String
Parameter
  • value (::String) — The Topology Manager aligns resources in following scopes:

    • container
    • pod

    The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes

Returns
  • (::String) — The Topology Manager aligns resources in following scopes:

    • container
    • pod

    The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes