Show / Hide Table of Contents

Class NodeTemplate

Provides a Rancher v2 Node Template resource. This can be used to create Node Template for Rancher v2 and retrieve their information.

amazonec2, azure, digitalocean, linode, opennebula, openstack, and vsphere drivers are supported for node templates.

Note If you are upgrading to Rancher v2.3.3, please take a look to final section

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Node Template up to Rancher 2.1.x
    var foo = new Rancher2.NodeTemplate("foo", new Rancher2.NodeTemplateArgs
    {
        Amazonec2Config = new Rancher2.Inputs.NodeTemplateAmazonec2ConfigArgs
        {
            AccessKey = "AWS_ACCESS_KEY",
            Ami = "<AMI_ID>",
            Region = "<REGION>",
            SecretKey = "<AWS_SECRET_KEY>",
            SecurityGroup = 
            {
                "<AWS_SECURITY_GROUP>",
            },
            SubnetId = "<SUBNET_ID>",
            VpcId = "<VPC_ID>",
            Zone = "<ZONE>",
        },
        Description = "foo test",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
NodeTemplate
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Rancher2
Assembly: Pulumi.Rancher2.dll
Syntax
public class NodeTemplate : CustomResource

Constructors

View Source

NodeTemplate(String, NodeTemplateArgs, CustomResourceOptions)

Create a NodeTemplate resource with the given unique name, arguments, and options.

Declaration
public NodeTemplate(string name, NodeTemplateArgs args = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

NodeTemplateArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Amazonec2Config

AWS config for the Node Template (list maxitems:1)

Declaration
public Output<NodeTemplateAmazonec2Config> Amazonec2Config { get; }
Property Value
Type Description
Output<NodeTemplateAmazonec2Config>
View Source

Annotations

Annotations for Node Template object (map)

Declaration
public Output<ImmutableDictionary<string, object>> Annotations { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

AuthCertificateAuthority

Auth certificate authority for the Node Template (string)

Declaration
public Output<string> AuthCertificateAuthority { get; }
Property Value
Type Description
Output<System.String>
View Source

AuthKey

Auth key for the Node Template (string)

Declaration
public Output<string> AuthKey { get; }
Property Value
Type Description
Output<System.String>
View Source

AzureConfig

Azure config for the Node Template (list maxitems:1)

Declaration
public Output<NodeTemplateAzureConfig> AzureConfig { get; }
Property Value
Type Description
Output<NodeTemplateAzureConfig>
View Source

CloudCredentialId

Cloud credential ID for the Node Template. Required from Rancher v2.2.x (string)

Declaration
public Output<string> CloudCredentialId { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

Description for the Node Template (string)

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

DigitaloceanConfig

Digitalocean config for the Node Template (list maxitems:1)

Declaration
public Output<NodeTemplateDigitaloceanConfig> DigitaloceanConfig { get; }
Property Value
Type Description
Output<NodeTemplateDigitaloceanConfig>
View Source

Driver

(Computed) The driver of the node template (string)

Declaration
public Output<string> Driver { get; }
Property Value
Type Description
Output<System.String>
View Source

DriverId

The node driver id used by the node template. It's required if the node driver isn't built in Rancher (string)

Declaration
public Output<string> DriverId { get; }
Property Value
Type Description
Output<System.String>
View Source

EngineEnv

Engine environment for the node template (string)

Declaration
public Output<ImmutableDictionary<string, object>> EngineEnv { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

EngineInsecureRegistries

Insecure registry for the node template (list)

Declaration
public Output<ImmutableArray<string>> EngineInsecureRegistries { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

EngineInstallUrl

Docker engine install URL for the node template. Default https://releases.rancher.com/install-docker/18.09.sh. Available install docker versions at https://github.com/rancher/install-docker (string)

Declaration
public Output<string> EngineInstallUrl { get; }
Property Value
Type Description
Output<System.String>
View Source

EngineLabel

Engine label for the node template (string)

Declaration
public Output<ImmutableDictionary<string, object>> EngineLabel { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

EngineOpt

Engine options for the node template (map)

Declaration
public Output<ImmutableDictionary<string, object>> EngineOpt { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

EngineRegistryMirrors

Engine registry mirror for the node template (list)

Declaration
public Output<ImmutableArray<string>> EngineRegistryMirrors { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

EngineStorageDriver

Engine storage driver for the node template (string)

Declaration
public Output<string> EngineStorageDriver { get; }
Property Value
Type Description
Output<System.String>
View Source

Labels

Labels for Node Template object (map)

Declaration
public Output<ImmutableDictionary<string, object>> Labels { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

LinodeConfig

Linode config for the Node Template (list maxitems:1)

Declaration
public Output<NodeTemplateLinodeConfig> LinodeConfig { get; }
Property Value
Type Description
Output<NodeTemplateLinodeConfig>
View Source

Name

The name of the Node Template (string)

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

OpennebulaConfig

Opennebula config for the Node Template (list maxitems:1)

Declaration
public Output<NodeTemplateOpennebulaConfig> OpennebulaConfig { get; }
Property Value
Type Description
Output<NodeTemplateOpennebulaConfig>
View Source

OpenstackConfig

Openstack config for the Node Template (list maxitems:1)

Declaration
public Output<NodeTemplateOpenstackConfig> OpenstackConfig { get; }
Property Value
Type Description
Output<NodeTemplateOpenstackConfig>
View Source

UseInternalIpAddress

Engine storage driver for the node template (bool)

Declaration
public Output<bool?> UseInternalIpAddress { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

VsphereConfig

vSphere config for the Node Template (list maxitems:1)

Declaration
public Output<NodeTemplateVsphereConfig> VsphereConfig { get; }
Property Value
Type Description
Output<NodeTemplateVsphereConfig>

Methods

View Source

Get(String, Input<String>, NodeTemplateState, CustomResourceOptions)

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

Declaration
public static NodeTemplate Get(string name, Input<string> id, NodeTemplateState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

NodeTemplateState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
NodeTemplate
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.