NodeGroup

Represents a NodeGroup resource to manage a group of sole-tenant nodes.

To get more information about NodeGroup, see:

API documentation
How-to Guides
- Sole-Tenant Nodes

Warning: Due to limitations of the API, this provider cannot update the number of nodes in a node group and changes to node group size either through provider config or through external changes will cause the provider to delete and recreate the node group.

Create a NodeGroup Resource

new NodeGroup(name: string, args: NodeGroupArgs, opts?: CustomResourceOptions);

def NodeGroup(resource_name, opts=None, autoscaling_policy=None, description=None, name=None, node_template=None, project=None, size=None, zone=None, __props__=None);

func NewNodeGroup(ctx *Context, name string, args NodeGroupArgs, opts ...ResourceOption) (*NodeGroup, error)

public NodeGroup(string name, NodeGroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NodeGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NodeGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NodeGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

NodeGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NodeGroup resource accepts the following input properties:

NodeTemplate string: The URL of the node template to which this node group belongs.
Size int: The total number of nodes in the node group.
AutoscalingPolicy NodeGroupAutoscalingPolicyArgs: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
Description string: An optional textual description of the resource.
Name string: Name of the resource.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: Zone where this node group is located

NodeTemplate string: The URL of the node template to which this node group belongs.
Size int: The total number of nodes in the node group.
AutoscalingPolicy NodeGroupAutoscalingPolicy: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
Description string: An optional textual description of the resource.
Name string: Name of the resource.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: Zone where this node group is located

nodeTemplate string: The URL of the node template to which this node group belongs.
size number: The total number of nodes in the node group.
autoscalingPolicy NodeGroupAutoscalingPolicy: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
description string: An optional textual description of the resource.
name string: Name of the resource.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone string: Zone where this node group is located

node_template str: The URL of the node template to which this node group belongs.
size float: The total number of nodes in the node group.
autoscaling_policy Dict[NodeGroupAutoscalingPolicy]: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
description str: An optional textual description of the resource.
name str: Name of the resource.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone str: Zone where this node group is located

Outputs

All input properties are implicitly available as output properties. Additionally, the NodeGroup resource produces the following output properties:

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.

creationTimestamp string: Creation timestamp in RFC3339 text format.
id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.

creation_timestamp str: Creation timestamp in RFC3339 text format.
id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.

Look up an Existing NodeGroup Resource

Get an existing NodeGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NodeGroupState, opts?: CustomResourceOptions): NodeGroup

static get(resource_name, id, opts=None, autoscaling_policy=None, creation_timestamp=None, description=None, name=None, node_template=None, project=None, self_link=None, size=None, zone=None, __props__=None);

func GetNodeGroup(ctx *Context, name string, id IDInput, state *NodeGroupState, opts ...ResourceOption) (*NodeGroup, error)

public static NodeGroup Get(string name, Input<string> id, NodeGroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoscalingPolicy NodeGroupAutoscalingPolicyArgs: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional textual description of the resource.
Name string: Name of the resource.
NodeTemplate string: The URL of the node template to which this node group belongs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Size int: The total number of nodes in the node group.
Zone string: Zone where this node group is located

AutoscalingPolicy NodeGroupAutoscalingPolicy: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
Description string: An optional textual description of the resource.
Name string: Name of the resource.
NodeTemplate string: The URL of the node template to which this node group belongs.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Size int: The total number of nodes in the node group.
Zone string: Zone where this node group is located

autoscalingPolicy NodeGroupAutoscalingPolicy: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
creationTimestamp string: Creation timestamp in RFC3339 text format.
description string: An optional textual description of the resource.
name string: Name of the resource.
nodeTemplate string: The URL of the node template to which this node group belongs.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
selfLink string: The URI of the created resource.
size number: The total number of nodes in the node group.
zone string: Zone where this node group is located

autoscaling_policy Dict[NodeGroupAutoscalingPolicy]: - If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups. Structure is documented below.
creation_timestamp str: Creation timestamp in RFC3339 text format.
description str: An optional textual description of the resource.
name str: Name of the resource.
node_template str: The URL of the node template to which this node group belongs.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
self_link str: The URI of the created resource.
size float: The total number of nodes in the node group.
zone str: Zone where this node group is located

Supporting Types

NodeGroupAutoscalingPolicy

See the input and output API doc for this type.

MaxNodes int: Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.
MinNodes int: Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.
Mode string: The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler. - ON: Enables scaling in and scaling out. - ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers.

MaxNodes int: Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.
MinNodes int: Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.
Mode string: The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler. - ON: Enables scaling in and scaling out. - ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers.

maxNodes number: Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.
minNodes number: Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.
mode string: The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler. - ON: Enables scaling in and scaling out. - ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers.

maxNodes float: Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.
minNodes float: Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.
mode str: The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler. - ON: Enables scaling in and scaling out. - ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud