Class: Google::Cloud::Container::V1::IPAllocationPolicy

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/container/v1/cluster_service.rb

Overview

Configuration for controlling how IPs are allocated in the cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#additional_pod_ranges_config ⇒ ::Google::Cloud::Container::V1::AdditionalPodRangesConfig (readonly)

Returns 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.

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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#cluster_ipv4_cidr ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns This field is deprecated, use cluster_ipv4_cidr_block.

Returns:

  • (::String) —

    This field is deprecated, use cluster_ipv4_cidr_block.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#cluster_ipv4_cidr_block ⇒ ::String

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#cluster_secondary_range_name ⇒ ::String

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#create_subnetwork ⇒ ::Boolean

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#default_pod_ipv4_range_utilization ⇒ ::Float (readonly)

Returns 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.

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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ipv6_access_type ⇒ ::Google::Cloud::Container::V1::IPv6AccessType

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

Returns:



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#node_ipv4_cidr ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns This field is deprecated, use node_ipv4_cidr_block.

Returns:

  • (::String) —

    This field is deprecated, use node_ipv4_cidr_block.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#node_ipv4_cidr_block ⇒ ::String

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pod_cidr_overprovision_config ⇒ ::Google::Cloud::Container::V1::PodCIDROverprovisionConfig

Returns [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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#services_ipv4_cidr ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns This field is deprecated, use services_ipv4_cidr_block.

Returns:

  • (::String) —

    This field is deprecated, use services_ipv4_cidr_block.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#services_ipv4_cidr_block ⇒ ::String

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#services_ipv6_cidr_block ⇒ ::String (readonly)

Returns Output only. The services IPv6 CIDR block for the cluster.

Returns:

  • (::String) —

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



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#services_secondary_range_name ⇒ ::String

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#stack_type ⇒ ::Google::Cloud::Container::V1::StackType

Returns The IP stack type of the cluster.

Returns:



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#subnet_ipv6_cidr_block ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#subnetwork_name ⇒ ::String

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#tpu_ipv4_cidr_block ⇒ ::String

Returns 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.



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_ip_aliases ⇒ ::Boolean

Returns 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



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_routes ⇒ ::Boolean

Returns 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



1517
1518
1519
1520
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1517

class IPAllocationPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end