ClusterDriver
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!
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
// Create a new Rancher2 Cluster Driver
const foo = new rancher2.ClusterDriver("foo", {
active: true,
builtin: false,
checksum: "0x0",
description: "Foo description",
externalId: "foo_external",
uiUrl: "local://ui",
url: "local://",
whitelistDomains: ["*.foo.com"],
});
Create a ClusterDriver Resource
new ClusterDriver(name: string, args: ClusterDriverArgs, opts?: CustomResourceOptions);
def ClusterDriver(resource_name: str, opts: Optional[ResourceOptions] = None, active: Optional[bool] = None, actual_url: Optional[str] = None, annotations: Optional[Mapping[str, Any]] = None, builtin: Optional[bool] = None, checksum: 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 NewClusterDriver(ctx *Context, name string, args ClusterDriverArgs, opts ...ResourceOption) (*ClusterDriver, error)
public ClusterDriver(string name, ClusterDriverArgs args, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args ClusterDriverArgs
- 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 ClusterDriverArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterDriverArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
ClusterDriver Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The ClusterDriver resource accepts the following input properties:
- Active bool
Specify the cluster driver state (bool)
- Builtin bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
- Url string
The URL to download the machine driver binary for 64-bit Linux (string)
- Actual
Url string Actual url of the cluster driver (string)
- Annotations Dictionary<string, object>
Annotations of the resource (map)
- Checksum string
Verify that the downloaded driver matches the expected checksum (string)
- Labels Dictionary<string, object>
Labels of the resource (map)
- Name string
Name of the cluster driver (string)
- Ui
Url string The URL to load for customized Add Clusters screen for this driver (string)
- Whitelist
Domains List<string> Domains to whitelist for the ui (list)
- Active bool
Specify the cluster driver state (bool)
- Builtin bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
- Url string
The URL to download the machine driver binary for 64-bit Linux (string)
- Actual
Url string Actual url of the cluster driver (string)
- Annotations map[string]interface{}
Annotations of the resource (map)
- Checksum string
Verify that the downloaded driver matches the expected checksum (string)
- Labels map[string]interface{}
Labels of the resource (map)
- Name string
Name of the cluster driver (string)
- Ui
Url string The URL to load for customized Add Clusters screen for this driver (string)
- Whitelist
Domains []string Domains to whitelist for the ui (list)
- active boolean
Specify the cluster driver state (bool)
- builtin boolean
Specify whether the cluster driver is an internal cluster driver or not (bool)
- url string
The URL to download the machine driver binary for 64-bit Linux (string)
- actual
Url string Actual url of the cluster driver (string)
- annotations {[key: string]: any}
Annotations of the resource (map)
- checksum string
Verify that the downloaded driver matches the expected checksum (string)
- labels {[key: string]: any}
Labels of the resource (map)
- name string
Name of the cluster driver (string)
- ui
Url string The URL to load for customized Add Clusters screen for this driver (string)
- whitelist
Domains string[] Domains to whitelist for the ui (list)
- active bool
Specify the cluster driver state (bool)
- builtin bool
Specify whether the cluster driver is an internal cluster driver or not (bool)
- url 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, Any]
Annotations of the resource (map)
- checksum str
Verify that the downloaded driver matches the expected checksum (string)
- labels Mapping[str, Any]
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)
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 str
- The provider-assigned unique ID for this managed resource.
Look up an 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, Any]] = None, builtin: Optional[bool] = None, checksum: 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) -> 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)
- 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 the cluster driver state (bool)
- Actual
Url string Actual url of the cluster driver (string)
- Annotations Dictionary<string, object>
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, object>
Labels of the resource (map)
- Name string
Name of the cluster driver (string)
- Ui
Url 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)
- Whitelist
Domains List<string> Domains to whitelist for the ui (list)
- Active bool
Specify the cluster driver state (bool)
- Actual
Url string Actual url of the cluster driver (string)
- Annotations map[string]interface{}
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]interface{}
Labels of the resource (map)
- Name string
Name of the cluster driver (string)
- Ui
Url 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)
- Whitelist
Domains []string Domains to whitelist for the ui (list)
- active boolean
Specify the cluster driver state (bool)
- actual
Url string Actual url of the cluster driver (string)
- annotations {[key: string]: any}
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]: any}
Labels of the resource (map)
- name string
Name of the cluster driver (string)
- ui
Url 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)
- whitelist
Domains 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, Any]
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, Any]
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)
Import
Cluster Driver can be imported using the Rancher Cluster Driver ID
$ pulumi import rancher2:index/clusterDriver:ClusterDriver foo <CLUSTER_DRIVER_ID>
Package Details
- Repository
- https://github.com/pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
rancher2
Terraform Provider.