Kubernetes Engine V1 API - Class Google::Cloud::Container::V1::IPAllocationPolicy (v1.3.0)

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

Configuration for controlling how IPs are allocated in the cluster.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#additional_pod_ranges_config

def additional_pod_ranges_config() -> ::Google::Cloud::Container::V1::AdditionalPodRangesConfig

Returns

(::Google::Cloud::Container::V1::AdditionalPodRangesConfig) — 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.

#cluster_ipv4_cidr

def cluster_ipv4_cidr() -> ::String

Returns

(::String) — This field is deprecated, use cluster_ipv4_cidr_block.

#cluster_ipv4_cidr=

def cluster_ipv4_cidr=(value) -> ::String

Parameter

value (::String) — This field is deprecated, use cluster_ipv4_cidr_block.

Returns

(::String) — This field is deprecated, use cluster_ipv4_cidr_block.

#cluster_ipv4_cidr_block

def cluster_ipv4_cidr_block() -> ::String

Returns

(::String) — 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.

#cluster_ipv4_cidr_block=

def cluster_ipv4_cidr_block=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#cluster_secondary_range_name

def cluster_secondary_range_name() -> ::String

Returns

(::String) — 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.

#cluster_secondary_range_name=

def cluster_secondary_range_name=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#create_subnetwork

def create_subnetwork() -> ::Boolean

Returns

(::Boolean) — Whether a new subnetwork will be created automatically for the cluster.

This field is only applicable when use_ip_aliases is true.

#create_subnetwork=

def create_subnetwork=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether a new subnetwork will be created automatically for the cluster.

This field is only applicable when use_ip_aliases is true.

Returns

(::Boolean) — Whether a new subnetwork will be created automatically for the cluster.

This field is only applicable when use_ip_aliases is true.

#default_pod_ipv4_range_utilization

def default_pod_ipv4_range_utilization() -> ::Float

Returns

(::Float) — 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=numNodes*numZones*podIPsPerNode.

#ipv6_access_type

def ipv6_access_type() -> ::Google::Cloud::Container::V1::IPv6AccessType

Returns

(::Google::Cloud::Container::V1::IPv6AccessType) — The ipv6 access type (internal or external) when create_subnetwork is true

#ipv6_access_type=

def ipv6_access_type=(value) -> ::Google::Cloud::Container::V1::IPv6AccessType

Parameter

value (::Google::Cloud::Container::V1::IPv6AccessType) — The ipv6 access type (internal or external) when create_subnetwork is true

Returns

(::Google::Cloud::Container::V1::IPv6AccessType) — The ipv6 access type (internal or external) when create_subnetwork is true

#node_ipv4_cidr

def node_ipv4_cidr() -> ::String

Returns

(::String) — This field is deprecated, use node_ipv4_cidr_block.

#node_ipv4_cidr=

def node_ipv4_cidr=(value) -> ::String

Parameter

value (::String) — This field is deprecated, use node_ipv4_cidr_block.

Returns

(::String) — This field is deprecated, use node_ipv4_cidr_block.

#node_ipv4_cidr_block

def node_ipv4_cidr_block() -> ::String

Returns

(::String) — 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.

#node_ipv4_cidr_block=

def node_ipv4_cidr_block=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#pod_cidr_overprovision_config

def pod_cidr_overprovision_config() -> ::Google::Cloud::Container::V1::PodCIDROverprovisionConfig

Returns

(::Google::Cloud::Container::V1::PodCIDROverprovisionConfig) — [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.

#pod_cidr_overprovision_config=

def pod_cidr_overprovision_config=(value) -> ::Google::Cloud::Container::V1::PodCIDROverprovisionConfig

Parameter

value (::Google::Cloud::Container::V1::PodCIDROverprovisionConfig) — [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.

Returns

(::Google::Cloud::Container::V1::PodCIDROverprovisionConfig) — [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.

#services_ipv4_cidr

def services_ipv4_cidr() -> ::String

Returns

(::String) — This field is deprecated, use services_ipv4_cidr_block.

#services_ipv4_cidr=

def services_ipv4_cidr=(value) -> ::String

Parameter

value (::String) — This field is deprecated, use services_ipv4_cidr_block.

Returns

(::String) — This field is deprecated, use services_ipv4_cidr_block.

#services_ipv4_cidr_block

def services_ipv4_cidr_block() -> ::String

Returns

(::String) — 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.

#services_ipv4_cidr_block=

def services_ipv4_cidr_block=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#services_ipv6_cidr_block

def services_ipv6_cidr_block() -> ::String

Returns

(::String) — Output only. The services IPv6 CIDR block for the cluster.

#services_secondary_range_name

def services_secondary_range_name() -> ::String

Returns

(::String) — 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.

#services_secondary_range_name=

def services_secondary_range_name=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#stack_type

def stack_type() -> ::Google::Cloud::Container::V1::StackType

Returns

(::Google::Cloud::Container::V1::StackType) — The IP stack type of the cluster

#stack_type=

def stack_type=(value) -> ::Google::Cloud::Container::V1::StackType

Parameter

value (::Google::Cloud::Container::V1::StackType) — The IP stack type of the cluster

Returns

(::Google::Cloud::Container::V1::StackType) — The IP stack type of the cluster

#subnet_ipv6_cidr_block

def subnet_ipv6_cidr_block() -> ::String

Returns

(::String) — Output only. The subnet's IPv6 CIDR block used by nodes and pods.

#subnetwork_name

def subnetwork_name() -> ::String

Returns

(::String) — 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.

#subnetwork_name=

def subnetwork_name=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#tpu_ipv4_cidr_block

def tpu_ipv4_cidr_block() -> ::String

Returns

(::String) — 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.

#tpu_ipv4_cidr_block=

def tpu_ipv4_cidr_block=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#use_ip_aliases

def use_ip_aliases() -> ::Boolean

Returns

(::Boolean) — 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

#use_ip_aliases=

def use_ip_aliases=(value) -> ::Boolean

Parameter

value (::Boolean) — 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

Returns

(::Boolean) — 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

#use_routes

def use_routes() -> ::Boolean

Returns

(::Boolean) — 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

#use_routes=

def use_routes=(value) -> ::Boolean

Parameter

value (::Boolean) — 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

Returns

(::Boolean) — 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