Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. ClusterDriver
Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2

rancher2.ClusterDriver

Explore with Pulumi AI

Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2

Provides a Rancher v2 Cluster Driver resource. This can be used to create Cluster Driver for Rancher v2.2.x Kontainer Engine clusters and retrieve their information.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  # Create a new Rancher2 Cluster Driver
  foo:
    type: rancher2:ClusterDriver
    properties:
      active: true
      builtin: false
      checksum: 0x0
      description: Foo description
      externalId: foo_external
      name: foo
      uiUrl: local://ui
      url: local://
      whitelistDomains:
        - '*.foo.com'
Copy

Create ClusterDriver Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ClusterDriver(name: string, args: ClusterDriverArgs, opts?: CustomResourceOptions);
@overload
def ClusterDriver(resource_name: str,
                  args: ClusterDriverArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ClusterDriver(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  active: Optional[bool] = None,
                  builtin: Optional[bool] = None,
                  url: Optional[str] = None,
                  actual_url: Optional[str] = None,
                  annotations: Optional[Mapping[str, str]] = None,
                  checksum: Optional[str] = None,
                  labels: Optional[Mapping[str, str]] = None,
                  name: Optional[str] = None,
                  ui_url: Optional[str] = None,
                  whitelist_domains: Optional[Sequence[str]] = None)
func NewClusterDriver(ctx *Context, name string, args ClusterDriverArgs, opts ...ResourceOption) (*ClusterDriver, error)
public ClusterDriver(string name, ClusterDriverArgs args, CustomResourceOptions? opts = null)
public ClusterDriver(String name, ClusterDriverArgs args)
public ClusterDriver(String name, ClusterDriverArgs args, CustomResourceOptions options)

type: rancher2:ClusterDriver
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClusterDriverArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ClusterDriverArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterDriverArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterDriverArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClusterDriverArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var clusterDriverResource = new Rancher2.ClusterDriver("clusterDriverResource", new()
{
    Active = false,
    Builtin = false,
    Url = "string",
    ActualUrl = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Checksum = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    UiUrl = "string",
    WhitelistDomains = new[]
    {
        "string",
    },
});
Copy
example, err := rancher2.NewClusterDriver(ctx, "clusterDriverResource", &rancher2.ClusterDriverArgs{
	Active:    pulumi.Bool(false),
	Builtin:   pulumi.Bool(false),
	Url:       pulumi.String("string"),
	ActualUrl: pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Checksum: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:  pulumi.String("string"),
	UiUrl: pulumi.String("string"),
	WhitelistDomains: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var clusterDriverResource = new ClusterDriver("clusterDriverResource", ClusterDriverArgs.builder()
    .active(false)
    .builtin(false)
    .url("string")
    .actualUrl("string")
    .annotations(Map.of("string", "string"))
    .checksum("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .uiUrl("string")
    .whitelistDomains("string")
    .build());
Copy
cluster_driver_resource = rancher2.ClusterDriver("clusterDriverResource",
    active=False,
    builtin=False,
    url="string",
    actual_url="string",
    annotations={
        "string": "string",
    },
    checksum="string",
    labels={
        "string": "string",
    },
    name="string",
    ui_url="string",
    whitelist_domains=["string"])
Copy
const clusterDriverResource = new rancher2.ClusterDriver("clusterDriverResource", {
    active: false,
    builtin: false,
    url: "string",
    actualUrl: "string",
    annotations: {
        string: "string",
    },
    checksum: "string",
    labels: {
        string: "string",
    },
    name: "string",
    uiUrl: "string",
    whitelistDomains: ["string"],
});
Copy
type: rancher2:ClusterDriver
properties:
    active: false
    actualUrl: string
    annotations:
        string: string
    builtin: false
    checksum: string
    labels:
        string: string
    name: string
    uiUrl: string
    url: string
    whitelistDomains:
        - string
Copy

ClusterDriver Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ClusterDriver resource accepts the following input properties:

Active This property is required. bool
Specify the cluster driver state (bool)
Builtin This property is required. bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
Url This property is required. string
The URL to download the machine driver binary for 64-bit Linux (string)
ActualUrl string
Actual url of the cluster driver (string)
Annotations Dictionary<string, string>
Annotations of the resource (map)
Checksum string
Verify that the downloaded driver matches the expected checksum (string)
Labels Dictionary<string, string>
Labels of the resource (map)
Name string
Name of the cluster driver (string)
UiUrl string
The URL to load for customized Add Clusters screen for this driver (string)
WhitelistDomains List<string>
Domains to whitelist for the ui (list)
Active This property is required. bool
Specify the cluster driver state (bool)
Builtin This property is required. bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
Url This property is required. string
The URL to download the machine driver binary for 64-bit Linux (string)
ActualUrl string
Actual url of the cluster driver (string)
Annotations map[string]string
Annotations of the resource (map)
Checksum string
Verify that the downloaded driver matches the expected checksum (string)
Labels map[string]string
Labels of the resource (map)
Name string
Name of the cluster driver (string)
UiUrl string
The URL to load for customized Add Clusters screen for this driver (string)
WhitelistDomains []string
Domains to whitelist for the ui (list)
active This property is required. Boolean
Specify the cluster driver state (bool)
builtin This property is required. Boolean
Specify whether the cluster driver is an internal cluster driver or not (bool)
url This property is required. String
The URL to download the machine driver binary for 64-bit Linux (string)
actualUrl String
Actual url of the cluster driver (string)
annotations Map<String,String>
Annotations of the resource (map)
checksum String
Verify that the downloaded driver matches the expected checksum (string)
labels Map<String,String>
Labels of the resource (map)
name String
Name of the cluster driver (string)
uiUrl String
The URL to load for customized Add Clusters screen for this driver (string)
whitelistDomains List<String>
Domains to whitelist for the ui (list)
active This property is required. boolean
Specify the cluster driver state (bool)
builtin This property is required. boolean
Specify whether the cluster driver is an internal cluster driver or not (bool)
url This property is required. string
The URL to download the machine driver binary for 64-bit Linux (string)
actualUrl string
Actual url of the cluster driver (string)
annotations {[key: string]: string}
Annotations of the resource (map)
checksum string
Verify that the downloaded driver matches the expected checksum (string)
labels {[key: string]: string}
Labels of the resource (map)
name string
Name of the cluster driver (string)
uiUrl string
The URL to load for customized Add Clusters screen for this driver (string)
whitelistDomains string[]
Domains to whitelist for the ui (list)
active This property is required. bool
Specify the cluster driver state (bool)
builtin This property is required. bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
url This property is required. str
The URL to download the machine driver binary for 64-bit Linux (string)
actual_url str
Actual url of the cluster driver (string)
annotations Mapping[str, str]
Annotations of the resource (map)
checksum str
Verify that the downloaded driver matches the expected checksum (string)
labels Mapping[str, str]
Labels of the resource (map)
name str
Name of the cluster driver (string)
ui_url str
The URL to load for customized Add Clusters screen for this driver (string)
whitelist_domains Sequence[str]
Domains to whitelist for the ui (list)
active This property is required. Boolean
Specify the cluster driver state (bool)
builtin This property is required. Boolean
Specify whether the cluster driver is an internal cluster driver or not (bool)
url This property is required. String
The URL to download the machine driver binary for 64-bit Linux (string)
actualUrl String
Actual url of the cluster driver (string)
annotations Map<String>
Annotations of the resource (map)
checksum String
Verify that the downloaded driver matches the expected checksum (string)
labels Map<String>
Labels of the resource (map)
name String
Name of the cluster driver (string)
uiUrl String
The URL to load for customized Add Clusters screen for this driver (string)
whitelistDomains List<String>
Domains to whitelist for the ui (list)

Outputs

All input properties are implicitly available as output properties. Additionally, the ClusterDriver 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 string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ClusterDriver Resource

Get an existing ClusterDriver 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?: ClusterDriverState, opts?: CustomResourceOptions): ClusterDriver
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        actual_url: Optional[str] = None,
        annotations: Optional[Mapping[str, str]] = None,
        builtin: Optional[bool] = None,
        checksum: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        ui_url: Optional[str] = None,
        url: Optional[str] = None,
        whitelist_domains: Optional[Sequence[str]] = None) -> ClusterDriver
func GetClusterDriver(ctx *Context, name string, id IDInput, state *ClusterDriverState, opts ...ResourceOption) (*ClusterDriver, error)
public static ClusterDriver Get(string name, Input<string> id, ClusterDriverState? state, CustomResourceOptions? opts = null)
public static ClusterDriver get(String name, Output<String> id, ClusterDriverState state, CustomResourceOptions options)
resources:  _:    type: rancher2:ClusterDriver    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 the cluster driver state (bool)
ActualUrl string
Actual url of the cluster driver (string)
Annotations Dictionary<string, string>
Annotations of the resource (map)
Builtin bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
Checksum string
Verify that the downloaded driver matches the expected checksum (string)
Labels Dictionary<string, string>
Labels of the resource (map)
Name string
Name of the cluster driver (string)
UiUrl string
The URL to load for customized Add Clusters 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 the cluster driver state (bool)
ActualUrl string
Actual url of the cluster driver (string)
Annotations map[string]string
Annotations of the resource (map)
Builtin bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
Checksum string
Verify that the downloaded driver matches the expected checksum (string)
Labels map[string]string
Labels of the resource (map)
Name string
Name of the cluster driver (string)
UiUrl string
The URL to load for customized Add Clusters 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 the cluster driver state (bool)
actualUrl String
Actual url of the cluster driver (string)
annotations Map<String,String>
Annotations of the resource (map)
builtin Boolean
Specify whether the cluster driver is an internal cluster driver or not (bool)
checksum String
Verify that the downloaded driver matches the expected checksum (string)
labels Map<String,String>
Labels of the resource (map)
name String
Name of the cluster driver (string)
uiUrl String
The URL to load for customized Add Clusters 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 boolean
Specify the cluster driver state (bool)
actualUrl string
Actual url of the cluster driver (string)
annotations {[key: string]: string}
Annotations of the resource (map)
builtin boolean
Specify whether the cluster driver is an internal cluster driver or not (bool)
checksum string
Verify that the downloaded driver matches the expected checksum (string)
labels {[key: string]: string}
Labels of the resource (map)
name string
Name of the cluster driver (string)
uiUrl string
The URL to load for customized Add Clusters 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 the cluster driver state (bool)
actual_url str
Actual url of the cluster driver (string)
annotations Mapping[str, str]
Annotations of the resource (map)
builtin bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
checksum str
Verify that the downloaded driver matches the expected checksum (string)
labels Mapping[str, str]
Labels of the resource (map)
name str
Name of the cluster driver (string)
ui_url str
The URL to load for customized Add Clusters 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)
active Boolean
Specify the cluster driver state (bool)
actualUrl String
Actual url of the cluster driver (string)
annotations Map<String>
Annotations of the resource (map)
builtin Boolean
Specify whether the cluster driver is an internal cluster driver or not (bool)
checksum String
Verify that the downloaded driver matches the expected checksum (string)
labels Map<String>
Labels of the resource (map)
name String
Name of the cluster driver (string)
uiUrl String
The URL to load for customized Add Clusters 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)

Import

Cluster Driver can be imported using the Rancher Cluster Driver ID

$ pulumi import rancher2:index/clusterDriver:ClusterDriver foo &lt;CLUSTER_DRIVER_ID&gt;
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Rancher2 pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.
Rancher 2 v8.1.5 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-rancher2