Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

NodeDriver

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

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 Node Driver
        var foo = new Rancher2.NodeDriver("foo", new Rancher2.NodeDriverArgs
        {
            Active = true,
            Builtin = false,
            Checksum = "0x0",
            Description = "Foo description",
            ExternalId = "foo_external",
            UiUrl = "local://ui",
            Url = "local://",
            WhitelistDomains = 
            {
                "*.foo.com",
            },
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.NewNodeDriver(ctx, "foo", &rancher2.NodeDriverArgs{
            Active:      pulumi.Bool(true),
            Builtin:     pulumi.Bool(false),
            Checksum:    pulumi.String("0x0"),
            Description: pulumi.String("Foo description"),
            ExternalId:  pulumi.String("foo_external"),
            UiUrl:       pulumi.String("local://ui"),
            Url:         pulumi.String("local://"),
            WhitelistDomains: pulumi.StringArray{
                pulumi.String("*.foo.com"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Node Driver
foo = rancher2.NodeDriver("foo",
    active=True,
    builtin=False,
    checksum="0x0",
    description="Foo description",
    external_id="foo_external",
    ui_url="local://ui",
    url="local://",
    whitelist_domains=["*.foo.com"])
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

// Create a new rancher2 Node Driver
const foo = new rancher2.NodeDriver("foo", {
    active: true,
    builtin: false,
    checksum: "0x0",
    description: "Foo description",
    externalId: "foo_external",
    uiUrl: "local://ui",
    url: "local://",
    whitelistDomains: ["*.foo.com"],
});

Create a NodeDriver Resource

new NodeDriver(name: string, args: NodeDriverArgs, opts?: CustomResourceOptions);
def NodeDriver(resource_name: str, opts: Optional[ResourceOptions] = None, active: Optional[bool] = None, annotations: Optional[Mapping[str, Any]] = None, builtin: Optional[bool] = None, checksum: Optional[str] = None, description: Optional[str] = None, external_id: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, ui_url: Optional[str] = None, url: Optional[str] = None, whitelist_domains: Optional[Sequence[str]] = None)
func NewNodeDriver(ctx *Context, name string, args NodeDriverArgs, opts ...ResourceOption) (*NodeDriver, error)
public NodeDriver(string name, NodeDriverArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args NodeDriverArgs
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 NodeDriverArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NodeDriverArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

NodeDriver Resource Properties

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

Inputs

The NodeDriver resource accepts the following input properties:

Active bool

Specify if the node driver state (bool)

Builtin bool

Specify wheter the node driver is an internal node driver or not (bool)

Url string

The URL to download the machine driver binary for 64-bit Linux (string)

Annotations Dictionary<string, object>

Annotations of the resource (map)

Checksum string

Verify that the downloaded driver matches the expected checksum (string)

Description string

Description of the node driver (string)

ExternalId string

External ID (string)

Labels Dictionary<string, object>

Labels of the resource (map)

Name string

Name of the node driver (string)

UiUrl string

The URL to load for customized Add Nodes screen for this driver (string)

WhitelistDomains List<string>

Domains to whitelist for the ui (list)

Active bool

Specify if the node driver state (bool)

Builtin bool

Specify wheter the node driver is an internal node driver or not (bool)

Url string

The URL to download the machine driver binary for 64-bit Linux (string)

Annotations map[string]interface{}

Annotations of the resource (map)

Checksum string

Verify that the downloaded driver matches the expected checksum (string)

Description string

Description of the node driver (string)

ExternalId string

External ID (string)

Labels map[string]interface{}

Labels of the resource (map)

Name string

Name of the node driver (string)

UiUrl string

The URL to load for customized Add Nodes screen for this driver (string)

WhitelistDomains []string

Domains to whitelist for the ui (list)

active boolean

Specify if the node driver state (bool)

builtin boolean

Specify wheter the node driver is an internal node driver or not (bool)

url string

The URL to download the machine driver binary for 64-bit Linux (string)

annotations {[key: string]: any}

Annotations of the resource (map)

checksum string

Verify that the downloaded driver matches the expected checksum (string)

description string

Description of the node driver (string)

externalId string

External ID (string)

labels {[key: string]: any}

Labels of the resource (map)

name string

Name of the node driver (string)

uiUrl string

The URL to load for customized Add Nodes screen for this driver (string)

whitelistDomains string[]

Domains to whitelist for the ui (list)

active bool

Specify if the node driver state (bool)

builtin bool

Specify wheter the node driver is an internal node driver or not (bool)

url str

The URL to download the machine driver binary for 64-bit Linux (string)

annotations Mapping[str, Any]

Annotations of the resource (map)

checksum str

Verify that the downloaded driver matches the expected checksum (string)

description str

Description of the node driver (string)

external_id str

External ID (string)

labels Mapping[str, Any]

Labels of the resource (map)

name str

Name of the node driver (string)

ui_url str

The URL to load for customized Add Nodes screen for this driver (string)

whitelist_domains Sequence[str]

Domains to whitelist for the ui (list)

Outputs

All input properties are implicitly available as output properties. Additionally, the NodeDriver 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 NodeDriver Resource

Get an existing NodeDriver 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?: NodeDriverState, opts?: CustomResourceOptions): NodeDriver
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, active: Optional[bool] = None, annotations: Optional[Mapping[str, Any]] = None, builtin: Optional[bool] = None, checksum: Optional[str] = None, description: Optional[str] = None, external_id: Optional[str] = None, labels: Optional[Mapping[str, Any]] = None, name: Optional[str] = None, ui_url: Optional[str] = None, url: Optional[str] = None, whitelist_domains: Optional[Sequence[str]] = None) -> NodeDriver
func GetNodeDriver(ctx *Context, name string, id IDInput, state *NodeDriverState, opts ...ResourceOption) (*NodeDriver, error)
public static NodeDriver Get(string name, Input<string> id, NodeDriverState? 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:

Active bool

Specify if the node driver state (bool)

Annotations Dictionary<string, object>

Annotations of the resource (map)

Builtin bool

Specify wheter the node driver is an internal node driver or not (bool)

Checksum string

Verify that the downloaded driver matches the expected checksum (string)

Description string

Description of the node driver (string)

ExternalId string

External ID (string)

Labels Dictionary<string, object>

Labels of the resource (map)

Name string

Name of the node driver (string)

UiUrl string

The URL to load for customized Add Nodes screen for this driver (string)

Url string

The URL to download the machine driver binary for 64-bit Linux (string)

WhitelistDomains List<string>

Domains to whitelist for the ui (list)

Active bool

Specify if the node driver state (bool)

Annotations map[string]interface{}

Annotations of the resource (map)

Builtin bool

Specify wheter the node driver is an internal node driver or not (bool)

Checksum string

Verify that the downloaded driver matches the expected checksum (string)

Description string

Description of the node driver (string)

ExternalId string

External ID (string)

Labels map[string]interface{}

Labels of the resource (map)

Name string

Name of the node driver (string)

UiUrl string

The URL to load for customized Add Nodes screen for this driver (string)

Url string

The URL to download the machine driver binary for 64-bit Linux (string)

WhitelistDomains []string

Domains to whitelist for the ui (list)

active boolean

Specify if the node driver state (bool)

annotations {[key: string]: any}

Annotations of the resource (map)

builtin boolean

Specify wheter the node driver is an internal node driver or not (bool)

checksum string

Verify that the downloaded driver matches the expected checksum (string)

description string

Description of the node driver (string)

externalId string

External ID (string)

labels {[key: string]: any}

Labels of the resource (map)

name string

Name of the node driver (string)

uiUrl string

The URL to load for customized Add Nodes screen for this driver (string)

url string

The URL to download the machine driver binary for 64-bit Linux (string)

whitelistDomains string[]

Domains to whitelist for the ui (list)

active bool

Specify if the node driver state (bool)

annotations Mapping[str, Any]

Annotations of the resource (map)

builtin bool

Specify wheter the node driver is an internal node driver or not (bool)

checksum str

Verify that the downloaded driver matches the expected checksum (string)

description str

Description of the node driver (string)

external_id str

External ID (string)

labels Mapping[str, Any]

Labels of the resource (map)

name str

Name of the node driver (string)

ui_url str

The URL to load for customized Add Nodes screen for this driver (string)

url str

The URL to download the machine driver binary for 64-bit Linux (string)

whitelist_domains Sequence[str]

Domains to whitelist for the ui (list)

Import

Node Driver can be imported using the Rancher Node Driver ID

 $ pulumi import rancher2:index/nodeDriver:NodeDriver foo &lt;node_driver_id&gt;

Package Details

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