Reference documentation and code samples for the Google Cloud Container V1 Client class TopologyManager.
TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
Generated from protobuf message google.container.v1.TopologyManager
Namespace
Google \ Cloud \ Container \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ policy |
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 |
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 |
getPolicy
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 | |
|---|---|
| Type | Description |
string |
|
setPolicy
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScope
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 | |
|---|---|
| Type | Description |
string |
|
setScope
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|