Class: Google::Cloud::Container::V1beta1::IPAllocationPolicy

Inherits:

Object

Object
Google::Cloud::Container::V1beta1::IPAllocationPolicy

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/container/v1beta1/cluster_service.rb

Overview

Configuration for controlling how IPs are allocated in the cluster.

Defined Under Namespace

Modules: IPv6AccessType, StackType

Instance Attribute Summary collapse

#additional_pod_ranges_config ⇒ ::Google::Cloud::Container::V1beta1::AdditionalPodRangesConfig readonly
Output only.
#allow_route_overlap ⇒ ::Boolean
If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes.
#cluster_ipv4_cidr ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#cluster_ipv4_cidr_block ⇒ ::String
The IP address range for the cluster pod IPs.
#cluster_secondary_range_name ⇒ ::String
The name of the secondary range to be used for the cluster CIDR block.
#create_subnetwork ⇒ ::Boolean
Whether a new subnetwork will be created automatically for the cluster.
#default_pod_ipv4_range_utilization ⇒ ::Float readonly
Output only.
#ipv6_access_type ⇒ ::Google::Cloud::Container::V1beta1::IPAllocationPolicy::IPv6AccessType
The ipv6 access type (internal or external) when create_subnetwork is true.
#node_ipv4_cidr ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#node_ipv4_cidr_block ⇒ ::String
The IP address range of the instance IPs in this cluster.
#pod_cidr_overprovision_config ⇒ ::Google::Cloud::Container::V1beta1::PodCIDROverprovisionConfig
[PRIVATE FIELD] Pod CIDR size overprovisioning config for the cluster.
#services_ipv4_cidr ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#services_ipv4_cidr_block ⇒ ::String
The IP address range of the services IPs in this cluster.
#services_ipv6_cidr_block ⇒ ::String readonly
Output only.
#services_secondary_range_name ⇒ ::String
The name of the secondary range to be used as for the services CIDR block.
#stack_type ⇒ ::Google::Cloud::Container::V1beta1::IPAllocationPolicy::StackType
IP stack type.
#subnet_ipv6_cidr_block ⇒ ::String readonly
Output only.
#subnetwork_name ⇒ ::String
A custom subnetwork name to be used if create_subnetwork is true.
#tpu_ipv4_cidr_block ⇒ ::String
The IP address range of the Cloud TPUs in this cluster.
#use_ip_aliases ⇒ ::Boolean
Whether alias IPs will be used for pod IPs in the cluster.
#use_routes ⇒ ::Boolean
Whether routes will be used for pod IPs in the cluster.

Instance Attribute Details

#additional_pod_ranges_config ⇒ `::Google::Cloud::Container::V1beta1::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::V1beta1::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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
end

#allow_route_overlap ⇒ `::Boolean`

Returns If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range.

If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. 10.96.0.0/14, but not /14), which means: 1) When use_ip_aliases is true, cluster_ipv4_cidr_block and services_ipv4_cidr_block must be fully-specified. 2) When use_ip_aliases is false, cluster.cluster_ipv4_cidr muse be fully-specified.

Returns:

(::Boolean) —
If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range.

If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. 10.96.0.0/14, but not /14), which means: 1) When use_ip_aliases is true, cluster_ipv4_cidr_block and services_ipv4_cidr_block must be fully-specified. 2) When use_ip_aliases is false, cluster.cluster_ipv4_cidr muse be fully-specified.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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 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 and create_subnetwork is false.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
end

#ipv6_access_type ⇒ `::Google::Cloud::Container::V1beta1::IPAllocationPolicy::IPv6AccessType`

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

Returns:

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

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
end

#pod_cidr_overprovision_config ⇒ `::Google::Cloud::Container::V1beta1::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::V1beta1::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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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 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 and create_subnetwork is false.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
end

#stack_type ⇒ `::Google::Cloud::Container::V1beta1::IPAllocationPolicy::StackType`

Returns IP stack type.

Returns:

(::Google::Cloud::Container::V1beta1::IPAllocationPolicy::StackType) —
IP stack type

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

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. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead.

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
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

# File 'proto_docs/google/container/v1beta1/cluster_service.rb', line 1584

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

  # Possible values for IP stack type
  module StackType
    # By default, the clusters will be IPV4 only
    STACK_TYPE_UNSPECIFIED = 0

    # The value used if the cluster is a IPV4 only
    IPV4 = 1

    # The value used if the cluster is a dual stack cluster
    IPV4_IPV6 = 2
  end

  # IPv6 access type
  module IPv6AccessType
    # Default value, will be defaulted as type external.
    IPV6_ACCESS_TYPE_UNSPECIFIED = 0

    # Access type internal (all v6 addresses are internal IPs)
    INTERNAL = 1

    # Access type external (all v6 addresses are external IPs)
    EXTERNAL = 2
  end
end

Class: Google::Cloud::Container::V1beta1::IPAllocationPolicy

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

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

#allow_route_overlap ⇒ ::Boolean

#cluster_ipv4_cidr ⇒ ::String

#cluster_ipv4_cidr_block ⇒ ::String

#cluster_secondary_range_name ⇒ ::String

#create_subnetwork ⇒ ::Boolean

#default_pod_ipv4_range_utilization ⇒ ::Float (readonly)

#ipv6_access_type ⇒ ::Google::Cloud::Container::V1beta1::IPAllocationPolicy::IPv6AccessType

#node_ipv4_cidr ⇒ ::String

#node_ipv4_cidr_block ⇒ ::String

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

#services_ipv4_cidr ⇒ ::String

#services_ipv4_cidr_block ⇒ ::String

#services_ipv6_cidr_block ⇒ ::String (readonly)

#services_secondary_range_name ⇒ ::String

#stack_type ⇒ ::Google::Cloud::Container::V1beta1::IPAllocationPolicy::StackType

#subnet_ipv6_cidr_block ⇒ ::String (readonly)

#subnetwork_name ⇒ ::String

#tpu_ipv4_cidr_block ⇒ ::String

#use_ip_aliases ⇒ ::Boolean

#use_routes ⇒ ::Boolean

#additional_pod_ranges_config ⇒ `::Google::Cloud::Container::V1beta1::AdditionalPodRangesConfig` (readonly)

#allow_route_overlap ⇒ `::Boolean`

#cluster_ipv4_cidr ⇒ `::String`

#cluster_ipv4_cidr_block ⇒ `::String`

#cluster_secondary_range_name ⇒ `::String`

#create_subnetwork ⇒ `::Boolean`

#default_pod_ipv4_range_utilization ⇒ `::Float` (readonly)

#ipv6_access_type ⇒ `::Google::Cloud::Container::V1beta1::IPAllocationPolicy::IPv6AccessType`

#node_ipv4_cidr ⇒ `::String`

#node_ipv4_cidr_block ⇒ `::String`

#pod_cidr_overprovision_config ⇒ `::Google::Cloud::Container::V1beta1::PodCIDROverprovisionConfig`

#services_ipv4_cidr ⇒ `::String`

#services_ipv4_cidr_block ⇒ `::String`

#services_ipv6_cidr_block ⇒ `::String` (readonly)

#services_secondary_range_name ⇒ `::String`

#stack_type ⇒ `::Google::Cloud::Container::V1beta1::IPAllocationPolicy::StackType`

#subnet_ipv6_cidr_block ⇒ `::String` (readonly)

#subnetwork_name ⇒ `::String`

#tpu_ipv4_cidr_block ⇒ `::String`

#use_ip_aliases ⇒ `::Boolean`

#use_routes ⇒ `::Boolean`