Class: Google::Apis::ContainerV1::IpAllocationPolicy

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/container_v1/classes.rb,
lib/google/apis/container_v1/representations.rb,
lib/google/apis/container_v1/representations.rb

Overview

Configuration for controlling how IPs are allocated in the cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ IpAllocationPolicy

Returns a new instance of IpAllocationPolicy.



3208
3209
3210
 
# File 'lib/google/apis/container_v1/classes.rb', line 3208

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_pod_ranges_config ⇒ Google::Apis::ContainerV1::AdditionalPodRangesConfig

AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. Corresponds to the JSON property additionalPodRangesConfig

Returns:



3065
3066
3067
 
# File 'lib/google/apis/container_v1/classes.rb', line 3065

def additional_pod_ranges_config
  @additional_pod_ranges_config
end

#cluster_ipv4_cidr ⇒ String

This field is deprecated, use cluster_ipv4_cidr_block. Corresponds to the JSON property clusterIpv4Cidr

Returns:

  • (String) 


3070
3071
3072
 
# File 'lib/google/apis/container_v1/classes.rb', line 3070

def cluster_ipv4_cidr
  @cluster_ipv4_cidr
end

#cluster_ipv4_cidr_block ⇒ 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. Corresponds to the JSON property clusterIpv4CidrBlock

Returns:

  • (String) 


3082
3083
3084
 
# File 'lib/google/apis/container_v1/classes.rb', line 3082

def cluster_ipv4_cidr_block
  @cluster_ipv4_cidr_block
end

#cluster_secondary_range_name ⇒ 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. Corresponds to the JSON property clusterSecondaryRangeName

Returns:

  • (String) 


3090
3091
3092
 
# File 'lib/google/apis/container_v1/classes.rb', line 3090

def cluster_secondary_range_name
  @cluster_secondary_range_name
end

#create_subnetwork ⇒ Boolean Also known as: create_subnetwork?

Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when use_ip_aliases is true. Corresponds to the JSON property createSubnetwork

Returns:

  • (Boolean) 


3096
3097
3098
 
# File 'lib/google/apis/container_v1/classes.rb', line 3096

def create_subnetwork
  @create_subnetwork
end

#default_pod_ipv4_range_utilization ⇒ 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. Corresponds to the JSON property defaultPodIpv4RangeUtilization

Returns:

  • (Float) 


3104
3105
3106
 
# File 'lib/google/apis/container_v1/classes.rb', line 3104

def default_pod_ipv4_range_utilization
  @default_pod_ipv4_range_utilization
end

#ipv6_access_type ⇒ String

The ipv6 access type (internal or external) when create_subnetwork is true Corresponds to the JSON property ipv6AccessType

Returns:

  • (String) 


3109
3110
3111
 
# File 'lib/google/apis/container_v1/classes.rb', line 3109

def ipv6_access_type
  @ipv6_access_type
end

#node_ipv4_cidr ⇒ String

This field is deprecated, use node_ipv4_cidr_block. Corresponds to the JSON property nodeIpv4Cidr

Returns:

  • (String) 


3114
3115
3116
 
# File 'lib/google/apis/container_v1/classes.rb', line 3114

def node_ipv4_cidr
  @node_ipv4_cidr
end

#node_ipv4_cidr_block ⇒ 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. Corresponds to the JSON property nodeIpv4CidrBlock

Returns:

  • (String) 


3125
3126
3127
 
# File 'lib/google/apis/container_v1/classes.rb', line 3125

def node_ipv4_cidr_block
  @node_ipv4_cidr_block
end

#pod_cidr_overprovision_config ⇒ Google::Apis::ContainerV1::PodCidrOverprovisionConfig

[PRIVATE FIELD] Config for pod CIDR size overprovisioning. Corresponds to the JSON property podCidrOverprovisionConfig

Returns:



3130
3131
3132
 
# File 'lib/google/apis/container_v1/classes.rb', line 3130

def pod_cidr_overprovision_config
  @pod_cidr_overprovision_config
end

#services_ipv4_cidr ⇒ String

This field is deprecated, use services_ipv4_cidr_block. Corresponds to the JSON property servicesIpv4Cidr

Returns:

  • (String) 


3135
3136
3137
 
# File 'lib/google/apis/container_v1/classes.rb', line 3135

def services_ipv4_cidr
  @services_ipv4_cidr
end

#services_ipv4_cidr_block ⇒ 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. Corresponds to the JSON property servicesIpv4CidrBlock

Returns:

  • (String) 


3147
3148
3149
 
# File 'lib/google/apis/container_v1/classes.rb', line 3147

def services_ipv4_cidr_block
  @services_ipv4_cidr_block
end

#services_ipv6_cidr_block ⇒ String

Output only. The services IPv6 CIDR block for the cluster. Corresponds to the JSON property servicesIpv6CidrBlock

Returns:

  • (String) 


3152
3153
3154
 
# File 'lib/google/apis/container_v1/classes.rb', line 3152

def services_ipv6_cidr_block
  @services_ipv6_cidr_block
end

#services_secondary_range_name ⇒ 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. Corresponds to the JSON property servicesSecondaryRangeName

Returns:

  • (String) 


3160
3161
3162
 
# File 'lib/google/apis/container_v1/classes.rb', line 3160

def services_secondary_range_name
  @services_secondary_range_name
end

#stack_type ⇒ String

The IP stack type of the cluster Corresponds to the JSON property stackType

Returns:

  • (String) 


3165
3166
3167
 
# File 'lib/google/apis/container_v1/classes.rb', line 3165

def stack_type
  @stack_type
end

#subnet_ipv6_cidr_block ⇒ String

Output only. The subnet's IPv6 CIDR block used by nodes and pods. Corresponds to the JSON property subnetIpv6CidrBlock

Returns:

  • (String) 


3170
3171
3172
 
# File 'lib/google/apis/container_v1/classes.rb', line 3170

def subnet_ipv6_cidr_block
  @subnet_ipv6_cidr_block
end

#subnetwork_name ⇒ 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. Corresponds to the JSON property subnetworkName

Returns:

  • (String) 


3176
3177
3178
 
# File 'lib/google/apis/container_v1/classes.rb', line 3176

def subnetwork_name
  @subnetwork_name
end

#tpu_ipv4_cidr_block ⇒ 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. Corresponds to the JSON property tpuIpv4CidrBlock

Returns:

  • (String) 


3188
3189
3190
 
# File 'lib/google/apis/container_v1/classes.rb', line 3188

def tpu_ipv4_cidr_block
  @tpu_ipv4_cidr_block
end

#use_ip_aliases ⇒ Boolean Also known as: use_ip_aliases?

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 Corresponds to the JSON property useIpAliases

Returns:

  • (Boolean) 


3196
3197
3198
 
# File 'lib/google/apis/container_v1/classes.rb', line 3196

def use_ip_aliases
  @use_ip_aliases
end

#use_routes ⇒ Boolean Also known as: use_routes?

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 Corresponds to the JSON property useRoutes

Returns:

  • (Boolean) 


3205
3206
3207
 
# File 'lib/google/apis/container_v1/classes.rb', line 3205

def use_routes
  @use_routes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
 
# File 'lib/google/apis/container_v1/classes.rb', line 3213

def update!(**args)
  @additional_pod_ranges_config = args[:additional_pod_ranges_config] if args.key?(:additional_pod_ranges_config)
  @cluster_ipv4_cidr = args[:cluster_ipv4_cidr] if args.key?(:cluster_ipv4_cidr)
  @cluster_ipv4_cidr_block = args[:cluster_ipv4_cidr_block] if args.key?(:cluster_ipv4_cidr_block)
  @cluster_secondary_range_name = args[:cluster_secondary_range_name] if args.key?(:cluster_secondary_range_name)
  @create_subnetwork = args[:create_subnetwork] if args.key?(:create_subnetwork)
  @default_pod_ipv4_range_utilization = args[:default_pod_ipv4_range_utilization] if args.key?(:default_pod_ipv4_range_utilization)
  @ipv6_access_type = args[:ipv6_access_type] if args.key?(:ipv6_access_type)
  @node_ipv4_cidr = args[:node_ipv4_cidr] if args.key?(:node_ipv4_cidr)
  @node_ipv4_cidr_block = args[:node_ipv4_cidr_block] if args.key?(:node_ipv4_cidr_block)
  @pod_cidr_overprovision_config = args[:pod_cidr_overprovision_config] if args.key?(:pod_cidr_overprovision_config)
  @services_ipv4_cidr = args[:services_ipv4_cidr] if args.key?(:services_ipv4_cidr)
  @services_ipv4_cidr_block = args[:services_ipv4_cidr_block] if args.key?(:services_ipv4_cidr_block)
  @services_ipv6_cidr_block = args[:services_ipv6_cidr_block] if args.key?(:services_ipv6_cidr_block)
  @services_secondary_range_name = args[:services_secondary_range_name] if args.key?(:services_secondary_range_name)
  @stack_type = args[:stack_type] if args.key?(:stack_type)
  @subnet_ipv6_cidr_block = args[:subnet_ipv6_cidr_block] if args.key?(:subnet_ipv6_cidr_block)
  @subnetwork_name = args[:subnetwork_name] if args.key?(:subnetwork_name)
  @tpu_ipv4_cidr_block = args[:tpu_ipv4_cidr_block] if args.key?(:tpu_ipv4_cidr_block)
  @use_ip_aliases = args[:use_ip_aliases] if args.key?(:use_ip_aliases)
  @use_routes = args[:use_routes] if args.key?(:use_routes)
end