Google Cloud Container V1 Client - Class NodeNetworkConfig (1.20.0)

Version 1.20.0

• 2.3.1 (latest)
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.3
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.1
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.1
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.1
• 1.10.3
• 1.9.1

Reference documentation and code samples for the Google Cloud Container V1 Client class NodeNetworkConfig.

Parameters for node pool-level network config.

Generated from protobuf message google.container.v1.NodeNetworkConfig

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ create_pod_range	bool Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified. If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.
↳ pod_range	string The ID of the secondary range for pod IPs. If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.
↳ pod_ipv4_cidr_block	string The IP address range for pod IPs in this node pool. Only applicable if create_pod_range is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.
↳ enable_private_nodes	bool Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes
↳ network_performance_config	Google\Cloud\Container\V1\NodeNetworkConfig\NetworkPerformanceConfig Network bandwidth tier configuration.
↳ pod_cidr_overprovision_config	Google\Cloud\Container\V1\PodCIDROverprovisionConfig [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
↳ additional_node_network_configs	array<Google\Cloud\Container\V1\AdditionalNodeNetworkConfig> We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
↳ additional_pod_network_configs	array<Google\Cloud\Container\V1\AdditionalPodNetworkConfig> We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node
↳ pod_ipv4_range_utilization	float Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.

getCreatePodRange

Input only. Whether to create a new range for pod IPs in this node pool.

Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified. If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.

Returns
Type	Description
bool

setCreatePodRange

Input only. Whether to create a new range for pod IPs in this node pool.

Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified. If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getPodRange

The ID of the secondary range for pod IPs.

If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.

Returns
Type	Description
string

setPodRange

The ID of the secondary range for pod IPs.

If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPodIpv4CidrBlock

The IP address range for pod IPs in this node pool.

Only applicable if create_pod_range is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.

Returns
Type	Description
string

setPodIpv4CidrBlock

The IP address range for pod IPs in this node pool.

Only applicable if create_pod_range is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEnablePrivateNodes

Whether nodes have internal IP addresses only.

If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes

Returns
Type	Description
bool

hasEnablePrivateNodes

clearEnablePrivateNodes

setEnablePrivateNodes

Whether nodes have internal IP addresses only.

If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getNetworkPerformanceConfig

Network bandwidth tier configuration.

Returns
Type	Description
Google\Cloud\Container\V1\NodeNetworkConfig\NetworkPerformanceConfig|null

hasNetworkPerformanceConfig

clearNetworkPerformanceConfig

setNetworkPerformanceConfig

Network bandwidth tier configuration.

Parameter
Name	Description
var	Google\Cloud\Container\V1\NodeNetworkConfig\NetworkPerformanceConfig

Returns
Type	Description
$this

getPodCidrOverprovisionConfig

[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool.

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.

Returns
Type	Description
Google\Cloud\Container\V1\PodCIDROverprovisionConfig|null

hasPodCidrOverprovisionConfig

clearPodCidrOverprovisionConfig

setPodCidrOverprovisionConfig

[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool.

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.

Parameter
Name	Description
var	Google\Cloud\Container\V1\PodCIDROverprovisionConfig

Returns
Type	Description
$this

getAdditionalNodeNetworkConfigs

We specify the additional node networks for this node pool using this list.

Each node network corresponds to an additional interface

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setAdditionalNodeNetworkConfigs

We specify the additional node networks for this node pool using this list.

Each node network corresponds to an additional interface

Parameter
Name	Description
var	array<Google\Cloud\Container\V1\AdditionalNodeNetworkConfig>

Returns
Type	Description
$this

getAdditionalPodNetworkConfigs

We specify the additional pod networks for this node pool using this list.

Each pod network corresponds to an additional alias IP range for the node

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setAdditionalPodNetworkConfigs

We specify the additional pod networks for this node pool using this list.

Each pod network corresponds to an additional alias IP range for the node

Parameter
Name	Description
var	array<Google\Cloud\Container\V1\AdditionalPodNetworkConfig>

Returns
Type	Description
$this

getPodIpv4RangeUtilization

Output only. [Output only] The utilization of the IPv4 range for the pod.

The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.

Returns
Type	Description
float

setPodIpv4RangeUtilization

Output only. [Output only] The utilization of the IPv4 range for the pod.

The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.

Parameter
Name	Description
var	float

Returns
Type	Description
$this