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.



2605
2606
2607
 
# File 'lib/google/apis/container_v1/classes.rb', line 2605

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:



2469
2470
2471
 
# File 'lib/google/apis/container_v1/classes.rb', line 2469

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) 


2474
2475
2476
 
# File 'lib/google/apis/container_v1/classes.rb', line 2474

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) 


2486
2487
2488
 
# File 'lib/google/apis/container_v1/classes.rb', line 2486

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) 


2494
2495
2496
 
# File 'lib/google/apis/container_v1/classes.rb', line 2494

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) 


2500
2501
2502
 
# File 'lib/google/apis/container_v1/classes.rb', line 2500

def create_subnetwork
  @create_subnetwork
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) 


2506
2507
2508
 
# File 'lib/google/apis/container_v1/classes.rb', line 2506

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) 


2511
2512
2513
 
# File 'lib/google/apis/container_v1/classes.rb', line 2511

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) 


2522
2523
2524
 
# File 'lib/google/apis/container_v1/classes.rb', line 2522

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:



2527
2528
2529
 
# File 'lib/google/apis/container_v1/classes.rb', line 2527

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) 


2532
2533
2534
 
# File 'lib/google/apis/container_v1/classes.rb', line 2532

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) 


2544
2545
2546
 
# File 'lib/google/apis/container_v1/classes.rb', line 2544

def services_ipv4_cidr_block
  @services_ipv4_cidr_block
end

#services_ipv6_cidr_block ⇒ String

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

Returns:

  • (String) 


2549
2550
2551
 
# File 'lib/google/apis/container_v1/classes.rb', line 2549

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) 


2557
2558
2559
 
# File 'lib/google/apis/container_v1/classes.rb', line 2557

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) 


2562
2563
2564
 
# File 'lib/google/apis/container_v1/classes.rb', line 2562

def stack_type
  @stack_type
end

#subnet_ipv6_cidr_block ⇒ String

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

Returns:

  • (String) 


2567
2568
2569
 
# File 'lib/google/apis/container_v1/classes.rb', line 2567

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) 


2573
2574
2575
 
# File 'lib/google/apis/container_v1/classes.rb', line 2573

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) 


2585
2586
2587
 
# File 'lib/google/apis/container_v1/classes.rb', line 2585

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) 


2593
2594
2595
 
# File 'lib/google/apis/container_v1/classes.rb', line 2593

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) 


2602
2603
2604
 
# File 'lib/google/apis/container_v1/classes.rb', line 2602

def use_routes
  @use_routes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
 
# File 'lib/google/apis/container_v1/classes.rb', line 2610

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)
  @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