KubernetesNodePool

Provides a Civo Kubernetes node pool resource. While the default node pool must be defined in the civo.KubernetesCluster resource, this resource can be used to add additional ones to a cluster.

Create a KubernetesNodePool Resource

new KubernetesNodePool(name: string, args: KubernetesNodePoolArgs, opts?: CustomResourceOptions);
@overload
def KubernetesNodePool(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cluster_id: Optional[str] = None,
                       num_target_nodes: Optional[int] = None,
                       region: Optional[str] = None,
                       target_nodes_size: Optional[str] = None)
@overload
def KubernetesNodePool(resource_name: str,
                       args: KubernetesNodePoolArgs,
                       opts: Optional[ResourceOptions] = None)
func NewKubernetesNodePool(ctx *Context, name string, args KubernetesNodePoolArgs, opts ...ResourceOption) (*KubernetesNodePool, error)
public KubernetesNodePool(string name, KubernetesNodePoolArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

KubernetesNodePool Resource Properties

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

Inputs

The KubernetesNodePool resource accepts the following input properties:

ClusterId string
The ID of the Kubernetes cluster to which the node pool is associated.
Region string
The region of the node pool, has to match that of the cluster.
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
TargetNodesSize string
The size of each node.
ClusterId string
The ID of the Kubernetes cluster to which the node pool is associated.
Region string
The region of the node pool, has to match that of the cluster.
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
TargetNodesSize string
The size of each node.
clusterId string
The ID of the Kubernetes cluster to which the node pool is associated.
region string
The region of the node pool, has to match that of the cluster.
numTargetNodes number
The number of instances to create (The default at the time of writing is 3).
targetNodesSize string
The size of each node.
cluster_id str
The ID of the Kubernetes cluster to which the node pool is associated.
region str
The region of the node pool, has to match that of the cluster.
num_target_nodes int
The number of instances to create (The default at the time of writing is 3).
target_nodes_size str
The size of each node.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing KubernetesNodePool Resource

Get an existing KubernetesNodePool 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?: KubernetesNodePoolState, opts?: CustomResourceOptions): KubernetesNodePool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        num_target_nodes: Optional[int] = None,
        region: Optional[str] = None,
        target_nodes_size: Optional[str] = None) -> KubernetesNodePool
func GetKubernetesNodePool(ctx *Context, name string, id IDInput, state *KubernetesNodePoolState, opts ...ResourceOption) (*KubernetesNodePool, error)
public static KubernetesNodePool Get(string name, Input<string> id, KubernetesNodePoolState? 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:

ClusterId string
The ID of the Kubernetes cluster to which the node pool is associated.
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
Region string
The region of the node pool, has to match that of the cluster.
TargetNodesSize string
The size of each node.
ClusterId string
The ID of the Kubernetes cluster to which the node pool is associated.
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
Region string
The region of the node pool, has to match that of the cluster.
TargetNodesSize string
The size of each node.
clusterId string
The ID of the Kubernetes cluster to which the node pool is associated.
numTargetNodes number
The number of instances to create (The default at the time of writing is 3).
region string
The region of the node pool, has to match that of the cluster.
targetNodesSize string
The size of each node.
cluster_id str
The ID of the Kubernetes cluster to which the node pool is associated.
num_target_nodes int
The number of instances to create (The default at the time of writing is 3).
region str
The region of the node pool, has to match that of the cluster.
target_nodes_size str
The size of each node.

Import

Then the Kubernetes cluster node pool can be imported using the cluster’s and pool id cluster_id:node_pool_id, e.g.

 $ pulumi import civo:index/kubernetesNodePool:KubernetesNodePool my-pool 1b8b2100-0e9f-4e8f-ad78-9eb578c2a0af:502c1130-cb9b-4a88-b6d2-307bd96d946a

Package Details

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