Class: Google::Cloud::Container::V1::NodeNetworkConfig

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

Overview

Parameters for node pool-level network config.

Defined Under Namespace

Classes: NetworkPerformanceConfig

Instance Attribute Summary collapse

Instance Attribute Details

#additional_node_network_configs ⇒ ::Array<::Google::Cloud::Container::V1::AdditionalNodeNetworkConfig>

Returns We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface.

Returns:



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#additional_pod_network_configs ⇒ ::Array<::Google::Cloud::Container::V1::AdditionalPodNetworkConfig>

Returns We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node.

Returns:



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#create_pod_range ⇒ ::Boolean

Returns Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified.

If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

Returns:

  • (::Boolean) —

    Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified.

    If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used.

    Only applicable if ip_allocation_policy.use_ip_aliases is true.

    This field cannot be changed after the node pool has been created.



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#enable_private_nodes ⇒ ::Boolean

Returns Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from [Cluster.NetworkConfig.default_enable_private_nodes][].

Returns:

  • (::Boolean) —

    Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from [Cluster.NetworkConfig.default_enable_private_nodes][]



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#network_performance_config ⇒ ::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig

Returns Network bandwidth tier configuration.

Returns:



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#network_tier_config ⇒ ::Google::Cloud::Container::V1::NetworkTierConfig (readonly)

Returns Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades.

Returns:

  • (::Google::Cloud::Container::V1::NetworkTierConfig) —

    Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades.



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

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

Returns [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool.

Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that 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 nodepool.

    Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that 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.



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#pod_ipv4_cidr_block ⇒ ::String

Returns The IP address range for pod IPs in this node pool.

Only applicable if create_pod_range 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) to pick a specific range to use.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

Returns:

  • (::String) —

    The IP address range for pod IPs in this node pool.

    Only applicable if create_pod_range 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) to pick a specific range to use.

    Only applicable if ip_allocation_policy.use_ip_aliases is true.

    This field cannot be changed after the node pool has been created.



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#pod_ipv4_range_utilization ⇒ ::Float (readonly)

Returns Output only. The utilization of the 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 IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#pod_range ⇒ ::String

Returns The ID of the secondary range for pod IPs. If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID.

Only applicable if ip_allocation_policy.use_ip_aliases is true.

This field cannot be changed after the node pool has been created.

Returns:

  • (::String) —

    The ID of the secondary range for pod IPs. If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID.

    Only applicable if ip_allocation_policy.use_ip_aliases is true.

    This field cannot be changed after the node pool has been created.



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end

#subnetwork ⇒ ::String

Returns Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either:

  1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet
  2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.

Returns:

  • (::String) —

    Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either:

    1. A user supplied subnetwork name/full path during node pool creation. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet
    2. A subnetwork path picked based on the IP utilization during node pool creation and is immutable.


1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1182

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

  # Configuration of all network bandwidth tiers
  # @!attribute [rw] total_egress_bandwidth_tier
  #   @return [::Google::Cloud::Container::V1::NodeNetworkConfig::NetworkPerformanceConfig::Tier]
  #     Specifies the total network bandwidth tier for the NodePool.
  class NetworkPerformanceConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Node network tier
    module Tier
      # Default value
      TIER_UNSPECIFIED = 0

      # Higher bandwidth, actual values based on VM size.
      TIER_1 = 1
    end
  end
end