Google Kubernetes Engine v1 API - Class IPAllocationPolicy (3.19.0)

public sealed class IPAllocationPolicy : IMessage<IPAllocationPolicy>, IEquatable<IPAllocationPolicy>, IDeepCloneable<IPAllocationPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Kubernetes Engine v1 API class IPAllocationPolicy.

Configuration for controlling how IPs are allocated in the cluster.

Inheritance

object > IPAllocationPolicy

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Constructors

IPAllocationPolicy()

public IPAllocationPolicy()

IPAllocationPolicy(IPAllocationPolicy)

public IPAllocationPolicy(IPAllocationPolicy other)
Parameter
NameDescription
otherIPAllocationPolicy

Properties

AdditionalPodRangesConfig

public AdditionalPodRangesConfig AdditionalPodRangesConfig { get; set; }

Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.

Property Value
TypeDescription
AdditionalPodRangesConfig

ClusterIpv4Cidr

[Obsolete]
public string ClusterIpv4Cidr { get; set; }

This field is deprecated, use cluster_ipv4_cidr_block.

Property Value
TypeDescription
string

ClusterIpv4CidrBlock

public string ClusterIpv4CidrBlock { get; set; }

The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank.

This field is only applicable when use_ip_aliases 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Property Value
TypeDescription
string

ClusterSecondaryRangeName

public string ClusterSecondaryRangeName { get; set; }

The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

Property Value
TypeDescription
string

CreateSubnetwork

public bool CreateSubnetwork { get; set; }

Whether a new subnetwork will be created automatically for the cluster.

This field is only applicable when use_ip_aliases is true.

Property Value
TypeDescription
bool

DefaultPodIpv4RangeUtilization

public double DefaultPodIpv4RangeUtilization { get; set; }

Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.

Property Value
TypeDescription
double

Ipv6AccessType

public IPv6AccessType Ipv6AccessType { get; set; }

The ipv6 access type (internal or external) when create_subnetwork is true

Property Value
TypeDescription
IPv6AccessType

NodeIpv4Cidr

[Obsolete]
public string NodeIpv4Cidr { get; set; }

This field is deprecated, use node_ipv4_cidr_block.

Property Value
TypeDescription
string

NodeIpv4CidrBlock

public string NodeIpv4CidrBlock { get; set; }

The IP address range of the instance IPs in this cluster.

This is applicable only if create_subnetwork 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Property Value
TypeDescription
string

PodCidrOverprovisionConfig

public PodCIDROverprovisionConfig PodCidrOverprovisionConfig { get; set; }

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

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 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.

Property Value
TypeDescription
PodCIDROverprovisionConfig

ServicesIpv4Cidr

[Obsolete]
public string ServicesIpv4Cidr { get; set; }

This field is deprecated, use services_ipv4_cidr_block.

Property Value
TypeDescription
string

ServicesIpv4CidrBlock

public string ServicesIpv4CidrBlock { get; set; }

The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Property Value
TypeDescription
string

ServicesIpv6CidrBlock

public string ServicesIpv6CidrBlock { get; set; }

Output only. [Output only] The services IPv6 CIDR block for the cluster.

Property Value
TypeDescription
string

ServicesSecondaryRangeName

public string ServicesSecondaryRangeName { get; set; }

The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

Property Value
TypeDescription
string

StackType

public StackType StackType { get; set; }

The IP stack type of the cluster

Property Value
TypeDescription
StackType

SubnetIpv6CidrBlock

public string SubnetIpv6CidrBlock { get; set; }

Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.

Property Value
TypeDescription
string

SubnetworkName

public string SubnetworkName { get; set; }

A custom subnetwork name to be used if create_subnetwork is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

Property Value
TypeDescription
string

TpuIpv4CidrBlock

public string TpuIpv4CidrBlock { get; set; }

The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases is true.

If unspecified, the range will use 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) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Property Value
TypeDescription
string

UseIpAliases

public bool UseIpAliases { get; set; }

Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

Property Value
TypeDescription
bool

UseRoutes

public bool UseRoutes { get; set; }

Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode

Property Value
TypeDescription
bool