Rancher2 Provider

https://registry.terraform.io/providers/rancher/rancher2/latest/docs
Admin
A Terraform provider for interacting with and managing resources supported by Rancher v2, with...
Tokens:46,620
Snippets:400
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Define Plugin Configuration

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster

Example syntax for defining a plugin configuration block.

```hcl
configuration = <
```

--------------------------------

### Create Rancher2 Catalogs

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/catalog

Examples for creating global, cluster, and project-scoped catalogs in Rancher v2 using Terraform.

```hcl
# Create a new Rancher2 Global Catalog
resource "rancher2_catalog" "foo-global" {
  name = "foo-global"
  url = "https://<CATALOG_URL>"
}
# Create a new Rancher2 Cluster Catalog
resource "rancher2_catalog" "foo-cluster" {
  name = "foo-cluster"
  url = "https://<CATALOG_URL>"
  scope = "cluster"
}
# Create a new Rancher2 Project Catalog
resource "rancher2_catalog" "foo-project" {
  name = "foo-project"
  url = "https://<CATALOG_URL>"
  scope = "project"
}
```

--------------------------------

### Create Rancher v2 Role Templates

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/role_template

Examples for creating role templates with either cluster or project context.

```hcl
# Create a new rancher2 cluster Role Template
resource "rancher2_role_template" "foo" {
  name = "foo"
  context = "cluster"
  default_role = true
  description = "Terraform role template acceptance test"
  rules {
    api_groups = ["*"]
    resources = ["secrets"]
    verbs = ["create"]
  }
}
```

```hcl
# Create a new rancher2 project Role Template
resource "rancher2_role_template" "foo" {
  name = "foo"
  context = "project"
  default_role = true
  description = "Terraform role template acceptance test"
  rules {
    api_groups = ["*"]
    resources = ["secrets"]
    verbs = ["create"]
  }
}
```

--------------------------------

### rancher2_cluster_v2

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Configuration example for creating a cluster with a custom system-default-registry using the rancher2_cluster_v2 resource.

```APIDOC
## resource "rancher2_cluster_v2"

### Description
Creates and manages a Rancher v2 cluster, including configuration for custom registries and system-default-registry settings.

### Configuration
- **name** (string) - The name of the cluster.
- **kubernetes_version** (string) - The version of RKE2 or K3s to deploy.
- **rke_config** (block) - Configuration for the RKE cluster.
  - **machine_selector_config** (block) - Configuration for machine selectors.
    - **config** (string) - YAML object string, e.g., "system-default-registry: registry_domain_name".
  - **registries** (block) - Registry configuration.
    - **configs** (block) - Individual registry settings.
      - **hostname** (string) - The registry domain name.
      - **auth_config_secret_name** (string) - Name of the Kubernetes secret containing registry credentials.
      - **insecure** (bool) - Whether to allow insecure TLS connections.

### Example
```hcl
resource "rancher2_cluster_v2" "foo_cluster_v2" {
  name = "cluster-with-custom-registry"
  kubernetes_version = "rke2/k3s-version"
  rke_config {
    machine_selector_config {
      config = "system-default-registry: registry_domain_name"
    }
    registries {
      configs {
        hostname = "registry_domain_name"
        auth_config_secret_name = var.registry_secret_name 
        insecure = "<tls-insecure-bool>"
      }
    }
  }
}
```
```

--------------------------------

### rancher2_cluster_v2

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Configuration example for creating a cluster with additional Kubernetes manifests using the rancher2_cluster_v2 resource.

```APIDOC
## resource "rancher2_cluster_v2"

### Description
Defines a Rancher v2 cluster resource, allowing for the specification of Kubernetes versions, RKE configuration, and additional manifests.

### Configuration
- **name** (string) - The name of the cluster.
- **kubernetes_version** (string) - The version of RKE2 or K3S to deploy.
- **rke_config** (block) - Configuration block for RKE settings.
  - **additional_manifest** (string) - YAML-formatted string containing Kubernetes manifests to be applied to the cluster.
  - **machine_pools** (block) - Configuration for node-driver clusters.

### Example
```hcl
resource "rancher2_cluster_v2" "foo" {
  name = "foo"
  kubernetes_version = "rke2/k3s-version"
  rke_config {
    additional_manifest = <<EOF
apiVersion: v1
kind: Namespace
metadata:
  name: testing-namespace-1
---
apiVersion: v1
kind: Namespace
metadata:
  name: testing-namespace-2
EOF
  }
}
```
```

--------------------------------

### Create Rancher2 Catalog V2

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/catalog_v2

Examples for defining a catalog using either a Git repository or a direct Helm index URL.

```hcl
# Create a new Rancher2 Catalog V2 using git repo and branch
resource "rancher2_catalog_v2" "foo" {
  cluster_id = <CLUSTER_ID>
  name = "foo"
  git_repo = "<GIT_REPO_URL>"
  git_branch = "<GIT_BRANCH>"
}
# Create a new Rancher2 Catalog V2 using url
resource "rancher2_catalog_v2" "foo-url" {
  cluster_id = <CLUSTER_ID>
  name = "foo-url"
  url = "https://<CATALOG_URL>"
}
```

--------------------------------

### Create a Rancher v2 Node Pool

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/node_pool

Example demonstrating the creation of an RKE cluster, cloud credential, node template, and the associated node pool.

```hcl
# Create a new rancher2 RKE Cluster 
resource "rancher2_cluster" "foo-custom" {
  name = "foo-custom"
  description = "Foo rancher2 custom cluster"
  kind = "rke"
  rke_config {
    network {
      plugin = "canal"
    }
  }
}
# Create a new rancher2 Cloud Credential
resource "rancher2_cloud_credential" "foo" {
  name = "foo"
  description= "Terraform cloudCredential acceptance test"
  amazonec2_credential_config {
    access_key = "XXXXXXXXXXXXXXXXXXXX"
    secret_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}
# Create a new rancher2 Node Template
resource "rancher2_node_template" "foo" {
  name = "foo"
  description = "foo test"
  cloud_credential_id = rancher2_cloud_credential.foo.id
  amazonec2_config {
    ami =  "<AMI_ID>"
    region = "<REGION>"
    security_group = ["<AWS_SECURITY_GROUP>"]
    subnet_id = "<SUBNET_ID>"
    vpc_id = "<VPC_ID>"
    zone = "<ZONE>"
  }
}
# Create a new rancher2 Node Pool
resource "rancher2_node_pool" "foo" {
  cluster_id =  rancher2_cluster.foo-custom.id
  name = "foo"
  hostname_prefix =  "foo-cluster-0"
  node_template_id = rancher2_node_template.foo.id
  quantity = 1
  control_plane = true
  etcd = true
  worker = true
}
```

--------------------------------

### Create a new rancher2 Cluster and Namespace

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/namespace

Example showing the creation of a cluster and a namespace assigned to that cluster's default project.

```hcl
resource "rancher2_cluster" "foo-custom" {
  name = "foo-custom"
  description = "Foo rancher2 custom cluster"
  rke_config {
    network {
      plugin = "canal"
    }
  }
}
# Create a new rancher2 Namespace assigned to default cluster project
resource "rancher2_namespace" "foo" {
  name = "foo"
  project_id = rancher2_cluster.foo-custom.default_project_id
  description = "foo namespace"
  resource_quota {
    limit {
      limits_cpu = "100m"
      limits_memory = "100Mi"
      requests_storage = "1Gi"
    }
  }
  container_resource_limit {
    limits_cpu = "20m"
    limits_memory = "20Mi"
    requests_cpu = "1m"
    requests_memory = "1Mi"
  }
}
```

--------------------------------

### Create Rancher2 Secret V2 Examples

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/secret_v2

Demonstrates creating a standard secret and a basic-auth secret using the rancher2_secret_v2 resource.

```hcl
# Create a new Rancher2 Secret V2
resource "rancher2_secret_v2" "foo" {
  cluster_id = <CLUSTER_ID>
  name = "foo"
  data = {
      mydata1 = "<data1>"
      mydata2 = "<data2>"
      mydata3 = "<data3>"
  }
}
# Create a new Rancher2 Secret V2 basic-auth
resource "rancher2_secret_v2" "foo" {
  cluster_id = <CLUSTER_ID>
  name = "foo"
  namespace = "<mynamespace>"
  type = "kubernetes.io/basic-auth"
  data = {
      password = "<mysecret>"
      username = "<myuser>"
  }
}
```

--------------------------------

### Create Rancher v2 Tokens

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/token

Examples for creating both global and cluster-scoped tokens. Note that tokens cannot be updated after creation.

```hcl
# Create a new rancher2 Token
resource "rancher2_token" "foo" {
  description = "foo token"
  ttl = 1200
}
```

```hcl
# Create a new rancher2 Token scoped
resource "rancher2_token" "foo" {
  cluster_id = "<cluster-id>"
  description = "foo token"
  ttl = 1200
}
```

--------------------------------

### Create a rancher2 Node Driver

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/node_driver

Example configuration for defining a new node driver resource in Terraform.

```hcl
resource "rancher2_node_driver" "foo" {
    active = true
    builtin = false
    checksum = "0x0"
    description = "Foo description"
    external_id = "foo_external"
    name = "foo"
    ui_url = "local://ui"
    url = "local://"
    whitelist_domains = ["*.foo.com"]
}
```

--------------------------------

### Create a custom user token

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/custom_user_token

Example showing the creation of a Rancher user, assigning the necessary global role binding, and generating a custom user token.

```hcl
# Create a rancher2 Token
resource "rancher2_user" "foo" {
  name = "foo"
  username = "foo"
  password = "changeme"
  enabled = true
}

resource "rancher2_global_role_binding" "foo-login" {
  name = "foo-login-binding"
  global_role_id = "user-base"
  user_id = rancher2_user.foo.id
}

resource "rancher2_custom_user_token" "foo" {
  username = rancher2_user.foo.username
  password = rancher2_user.foo.password
  description = "foo token"
  ttl = 0

  depends_on = [
    rancher2_global_role_binding.foo-login
  ]
}
```

--------------------------------

### Create Rancher v2 Secrets

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/secret

Examples for creating project-level and namespaced secrets using the rancher2_secret resource.

```hcl
# Create a new rancher2 Project Secret
resource "rancher2_secret" "foo" {
  name = "foo"
  description = "Terraform secret foo"
  project_id = "<project_id>"
  data = {
    address = base64encode("test.io")
    username = base64encode("user2")
    password = base64encode("pass")
  }
}
```

```hcl
# Create a new rancher2 Namespaced Secret
resource "rancher2_secret" "foo" {
  name = "foo"
  description = "Terraform secret foo"
  project_id = "<project_id>"
  namespace_id = "<namespace_id>"
  data = {
    address = base64encode("test.io")
    username = base64encode("user2")
    password = base64encode("pass")
  }
}
```

--------------------------------

### Define Audit Policy Configuration

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster

Example syntax for defining an audit policy configuration block.

```hcl
policy = <
```

--------------------------------

### rancher2_node_template (Hetzner)

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/node_template

Example of creating a Rancher2 node template configured for the Hetzner node driver.

```APIDOC
## resource "rancher2_node_template" "my_hetzner_node_template"

### Description
Creates a new Rancher2 Node Template using the Hetzner node_driver.

### Configuration
- **name** (string) - The name of the node template.
- **driver_id** (string) - The ID of the node driver.
- **hetzner_config** (object) - Configuration block for Hetzner settings including api_token, image, server_location, and server_type.
```

--------------------------------

### Create rancher2 Global Role Binding

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/global_role_binding

Examples showing how to create a global role binding using either a user ID or a group principal ID. Note that either user_id or group_principal_id must be defined.

```hcl
# Create a new rancher2 Global Role Binding using user_id
resource "rancher2_global_role_binding" "foo" {
  name = "foo"
  global_role_id = "admin"
  user_id = "user-XXXXX"
}
# Create a new rancher2 Global Role Binding using group_principal_id
resource "rancher2_global_role_binding" "foo2" {
  name = "foo2"
  global_role_id = "admin"
  group_principal_id = "local://g-XXXXX"
}
```

--------------------------------

### Configure Generic OIDC Authentication

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/auth_config_generic_oidc

Example configuration for integrating GitLab as a Generic OIDC provider. Group search must be explicitly enabled for group processing.

```hcl
resource "rancher2_auth_config_generic_oidc" "generic_oidc" {
  name          = "genericoidc"
  client_id     = "<GITLAB_APPLICATION_ID>"
  client_secret = "<GITLAB_CLIENT_SECRET>"
  issuer        = "https://gitlab.com"
  rancher_url   = "https://<RANCHER_URL>/verify-auth"

  # OIDC claim mapping
  scopes               = "openid profile email read_api"
  groups_field         = "groups"

  # For the 'genericoidc' provider, group processing must be explicitly enabled.
  group_search_enabled = true
}
```

--------------------------------

### Bootstrap Rancher v2.6.0+ Environment

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/bootstrap

Configuration for Rancher v2.6.0 and above, requiring the initial_password argument to match the installation password.

```hcl
# Provider bootstrap config
provider "rancher2" {
  api_url   = "https://rancher.my-domain.com"
  bootstrap = true
}

# Create a new rancher2_bootstrap for Rancher v2.6.0 and above
resource "rancher2_bootstrap" "admin" {
  initial_password = "<INSTALL_PASSWORD>"
  password = "blahblah"
}
```

--------------------------------

### Create AmazonEC2 machine configuration

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Setup required for node-driver clusters using AmazonEC2. Includes cloud credential and machine configuration resources.

```hcl
# Create AmazonEC2 cloud credential
resource "rancher2_cloud_credential" "foo" {
  name = "foo"
  amazonec2_credential_config {
    access_key = "<ACCESS_KEY>"
    secret_key = "<SECRET_KEY>"
  }
}

# Create AmazonEC2 machine config v2
resource "rancher2_machine_config_v2" "foo" {
  generate_name = "test-foo"
  amazonec2_config {
    ami =  "ami-id"
    region = "region"
    security_group = ["security-group"]
    subnet_id = "subnet-id"
    vpc_id = "vpc-id"
    zone = "zone"
  }
}
```

--------------------------------

### Define Secrets Encryption Custom Configuration

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster

Example syntax for defining a custom secrets encryption configuration block.

```hcl
custom_config = <
```

--------------------------------

### Create rancher2 cluster and node template

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_sync

Example configuration for defining a custom RKE cluster and an associated AWS node template in Rancher.

```hcl
# Create a new rancher2 rke Cluster 
resource "rancher2_cluster" "foo-custom" {
  name = "foo-custom"
  description = "Foo rancher2 custom cluster"
  rke_config {
    network {
      plugin = "canal"
    }
  }
}
# Create a new rancher2 Node Template
resource "rancher2_node_template" "foo" {
  name = "foo"
  description = "foo test"
  amazonec2_config {
    access_key = "<AWS_ACCESS_KEY>"
    secret_key = "<AWS_SECRET_KEY>"
    ami =  "<AMI_ID>"
    region = "<REGION>"
    security_group = ["<AWS_SECURITY_GROUP>"]
    subnet_id = "<SUBNET_ID>"
    vpc_id = "<VPC_ID>"
    zone = "<ZONE>"
  }
}
```

--------------------------------

### rancher2_node_template (Harvester)

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/node_template

Example of creating a Rancher2 node template configured for a Harvester cluster.

```APIDOC
## resource "rancher2_node_template" "foo-harvester"

### Description
Creates a new Rancher2 Node Template using the harvester node_driver.

### Configuration
- **name** (string) - The name of the node template.
- **cloud_credential_id** (string) - The ID of the cloud credential to use.
- **engine_install_url** (string) - The URL for the Docker engine installation script.
- **harvester_config** (object) - Configuration block for Harvester settings including vm_namespace, cpu_count, memory_size, disk_info, network_info, ssh_user, and user_data.
```

--------------------------------

### Configure Cluster and Fleet Agent Deployments

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Demonstrates how to customize agent deployments using cluster_agent_deployment_customization and fleet_agent_deployment_customization blocks.

```hcl
resource "rancher2_cluster_v2" "foo" {
  name = "foo"
  kubernetes_version = "rke2/k3s-version"
  cluster_agent_deployment_customization {
    append_tolerations {
      key    = "tolerate/control-plane"
      effect = "NoSchedule"
      value  = "true"
    }
    # Each toleration must be passed separately
    append_tolerations {
      key    = "tolerate/etcd"
      effect = "NoSchedule"
      value  = "true"
    }
    # Override_affinity accepts a string whose value is an Affinity, a k8s native object, in JSON format
    override_affinity = <<EOF
{
  "nodeAffinity": {
    "requiredDuringSchedulingIgnoredDuringExecution": {
      "nodeSelectorTerms": [{
        "matchExpressions": [{
          "key": "not.this/nodepool",
          "operator": "In",
          "values": [
            "true"
          ]
        }]
      }]
    }
  }
}
EOF
    # The resource units follow Kubernetes' standard
    override_resource_requirements {
      cpu_limit      = "800m"
      cpu_request    = "500m"
      memory_limit   = "800Mi"
      memory_request = "500Mi"
    }
  }

  fleet_agent_deployment_customization {
    # The same format and requirement for values as the cluster_agent_deployment_customization argument
    # ...
  }
  rke_config {
    # In the case of a node-driver cluster
    machine_pools {
      # ...
      }
    } 
}
```

--------------------------------

### Create a Project Registry

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/registry

Defines a registry resource accessible to all namespaces within a specified project.

```hcl
resource "rancher2_registry" "foo" {
  name = "foo"
  description = "Terraform registry foo"
  project_id = "<project_id>"
  registries {
    address = "test.io"
    username = "user"
    password = "pass"
  }
}
```

--------------------------------

### Create a Rancher2 App V2

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/app_v2

Basic configuration for deploying a Helm chart as a Rancher App V2 using a local values file.

```hcl
resource "rancher2_app_v2" "foo" {
  cluster_id = "<CLUSTER_ID>"
  name = "rancher-monitoring"
  namespace = "cattle-monitoring-system"
  repo_name = "rancher-charts"
  chart_name = "rancher-monitoring"
  chart_version = "9.4.200"
  values = file("values.yaml")
}
```

--------------------------------

### Configure Rancher2 Provider in Bootstrap Mode

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/index

Enable bootstrap mode to initialize a new Rancher2 system.

```hcl
# Configure the Rancher2 provider to bootstrap
provider "rancher2" {
  api_url   = "https://rancher.my-domain.com"
  bootstrap = true
}
```

--------------------------------

### Create a Pod Security Admission Configuration Template

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/rancher2_pod_security_admission_configuration_template

Defines a new template with specific default security levels and exemption rules for users, runtime classes, and namespaces.

```hcl
resource "rancher2_pod_security_admission_configuration_template" "foo" {
  name = "custom-psact"
  description = "This is my custom Pod Security Admission Configuration Template"
  defaults {
    audit = "restricted"
    audit_version = "latest"
    enforce = "restricted"
    enforce_version = "latest"
    warn = "restricted"
    warn_version = "latest"
  }
  exemptions {
    usernames = ["testuser"]
    runtime_classes = ["testclass"]
    namespaces = ["ingress-nginx","kube-system"]
  }
}
```

--------------------------------

### Create Cluster with Machine Global or Selector Config

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Initializes a basic Rancher V2 cluster resource block.

```hcl
resource "rancher2_cluster_v2" "foo" {
  name = "foo"
```

--------------------------------

### Create a node-driver cluster with Nutanix

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Configures a cluster using Nutanix as the infrastructure provider, including cloud credentials and machine configuration.

```hcl
# Create Nutanix cloud credential
resource "rancher2_cloud_credential" "foo_nutanix" {
  name = "foo-nutanix"
  nutanix_credential_config {
    endpoint = "<PRISM_ENDPOINT>"
    username = "X-ntnx-api-key"
    password = "<NUTANIX_API_KEY_OR_PASSWORD>"
    port     = "9440"
  }
}

# Create Nutanix machine config v2
resource "rancher2_machine_config_v2" "foo_nutanix" {
  generate_name = "foo-nutanix"
  nutanix_config {
    cluster    = "<NUTANIX_CLUSTER_NAME>"
    vm_network = ["<NETWORK_NAME_OR_UUID>"]
    vm_image   = "<IMAGE_NAME>"
  }
}

# Create a cluster using Nutanix machine config and cloud credential
resource "rancher2_cluster_v2" "foo_nutanix" {
  name               = "foo-nutanix"
  kubernetes_version = "<rke2/k3s-version>"

  rke_config {
    machine_pools {
      name                         = "pool1"
      cloud_credential_secret_name = rancher2_cloud_credential.foo_nutanix.id
      control_plane_role           = true
      etcd_role                    = true
      worker_role                  = true
      quantity                     = 1

      machine_config {
        kind = rancher2_machine_config_v2.foo_nutanix.kind
        name = rancher2_machine_config_v2.foo_nutanix.name
      }
    }
  }
}
```

--------------------------------

### Create a Project Certificate

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/certificate

Defines a certificate available to all namespaces within a specified project.

```hcl
resource "rancher2_certificate" "foo" {
  certs = base64encode(<PUBLIC_CERTS>)
  key = base64encode(<PRIVATE_KEY>)
  name = "foo"
  description = "Terraform certificate foo"
  project_id = "<project_id>"
}
```

--------------------------------

### Create Harvester Machine Config

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/machine_config_v2

Configures a machine using the Harvester node driver, including cloud credential setup and VM resource specifications.

```hcl
# Get imported harvester cluster info
data "rancher2_cluster_v2" "foo-harvester" {
  name = "foo-harvester"
}

# Create a new Cloud Credential for an imported Harvester cluster
resource "rancher2_cloud_credential" "foo-harvester" {
  name = "foo-harvester"
  harvester_credential_config {
    cluster_id = data.rancher2_cluster_v2.foo-harvester.cluster_v1_id
    cluster_type = "imported"
    kubeconfig_content = data.rancher2_cluster_v2.foo-harvester.kube_config
  }
}

# Create a new rancher2 machine config v2 using harvester node_driver
resource "rancher2_machine_config_v2" "foo-harvester-v2" {
  generate_name = "foo-harvester-v2"
  harvester_config {
    vm_namespace = "default"
    cpu_count = "2"
    memory_size = "4"
    disk_info = <<EOF
    {
        "disks": [{
            "imageName": "harvester-public/image-57hzg",
            "size": 40,
            "bootOrder": 1
        }]
    }
    EOF
    network_info = <<EOF
    {
        "interfaces": [{
            "networkName": "harvester-public/vlan1"
        }]
    }
    EOF
    ssh_user = "ubuntu"
    user_data = <<EOF
    package_update: true
    packages:
      - qemu-guest-agent
      - iptables
    runcmd:
      - - systemctl
        - enable
        - '--now'
        - qemu-guest-agent.service
    EOF
  }
}
```

--------------------------------

### Create a custom cluster

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Minimum configuration required to define a custom cluster. After creation, use the cluster_registration_token to register nodes.

```hcl
resource "rancher2_cluster_v2" "foo" {
  name = "foo"
  kubernetes_version = "rke2-/k3s-version"
}
```

--------------------------------

### Create a new rancher2 App

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/app

Basic configuration for deploying a new application using a catalog template and custom answers.

```hcl
# Create a new rancher2 App
resource "rancher2_app" "foo" {
  catalog_name = "<catalog_name>"
  name = "foo"
  description = "Foo app"
  project_id = "<project_id>"
  template_name = "<template_name>"
  template_version = "<template_version>"
  target_namespace = "<namespace_name>"
  answers = {
    "ingress_host" = "test.xip.io"
    "foo" = "bar"
  }
}
```

--------------------------------

### Create a new rancher2 Multi Cluster App overriding answers

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/multi_cluster_app

Advanced configuration demonstrating multiple target projects and project-specific answer overrides.

```hcl
resource "rancher2_multi_cluster_app" "foo" {
  catalog_name = "<catalog_name>"
  name = "foo"
  targets {
    project_id = "<project_id1>"
  }
  targets {
    project_id = "<project_id2>"
  }
  template_name = "<template_name>"
  template_version = "<template_version>"
  answers {
    values = {
      "ingress_host" = "test.xip.io"
    }
  }
  answers {
    project_id = "<project_id2>"
    values = {
      "ingress_host" = "test2.xip.io"
    }
  }
  roles = ["project-member"]
}
```

--------------------------------

### Bootstrap Rancher v2 Environment

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/bootstrap

Basic configuration for bootstrapping a Rancher v2 environment using the provider's bootstrap setting.

```hcl
# Provider bootstrap config
provider "rancher2" {
  api_url   = "https://rancher.my-domain.com"
  bootstrap = true
}

# Create a new rancher2_bootstrap
resource "rancher2_bootstrap" "admin" {
  password = "blahblah"
}
```

--------------------------------

### Create a Global Role

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/global_role

Defines a new global role with specific permissions and inheritance settings.

```hcl
# Create a new rancher2 Global Role
resource "rancher2_global_role" "foo" {
  name                    = "foo"
  new_user_default        = true
  description             = "Terraform global role acceptance test"
  inherited_cluster_roles = ["projects-view"]

  rules {
    api_groups = ["*"]
    resources = ["secrets"]
    verbs = ["create"]
  }
}
```

--------------------------------

### Create an App with a Custom Registry

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/app_v2

Overrides the global system default registry for a specific app deployment.

```hcl
resource "rancher2_app_v2" "cis_benchmark" {
  cluster_id = "<CLUSTER_ID>"
  name = "rancher-cis-benchmark"
  namespace = "cis-operator-system"
  repo_name = "rancher-charts"
  chart_name = "rancher-cis-benchmark"

  # Valid DNS for Private Registry
  system_default_registry = "<some.dns.here>:<PORT>"
}
```

--------------------------------

### Create a rancher2 user and global role binding

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/user

Defines a new user and assigns the required user-base global role binding to enable login.

```hcl
# Create a new rancher2 User
resource "rancher2_user" "foo" {
  name = "Foo user"
  username = "foo"
  password = "changeme"
  enabled = true
  must_change_password = true
}
# Create a new rancher2 global_role_binding for User
resource "rancher2_global_role_binding" "foo" {
  name = "foo"
  global_role_id = "user-base"
  user_id = rancher2_user.foo.id
}
```

--------------------------------

### Bootstrap with Provider Alias

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/bootstrap

Configuration using a specific provider alias for the bootstrap resource.

```hcl
# Provider bootstrap config with alias
provider "rancher2" {
  alias = "bootstrap"

  api_url   = "https://rancher.my-domain.com"
  bootstrap = true
}

# Create a new rancher2_bootstrap using bootstrap provider config
resource "rancher2_bootstrap" "admin" {
  provider = "rancher2.bootstrap"

  password = "blahblah"
}
```

--------------------------------

### opennebula_config

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/node_template

Configuration resource for OpenNebula VM integration.

```APIDOC
## opennebula_config

### Description
Configures the OpenNebula VM settings for the Rancher provider.

### Arguments
- **image_id** (string) - Required* - Image ID to use as the VM OS. Conflicts with `image_name`.
- **image_name** (string) - Required* - Opennebula image to use as the VM OS. Conflicts with `image_id`.
- **template_id** (string) - Required* - Opennebula template ID to use. Conflicts with `template_name`.
- **template_name** (string) - Required* - Name of the Opennbula template to use. Conflicts with `template_id`.
- **password** (string) - Required - Set the password for the XML-RPC API authentication.
- **user** (string) - Required - Set the user for the XML-RPC API authentication.
- **xml_rpc_url** (string) - Required - Set the url for the Opennebula XML-RPC API.
- **b2d_size** (string) - Optional - Size of the Volatile disk in MB - only for b2d.
- **cpu** (string) - Optional - CPU value for the VM.
- **dev_prefix** (string) - Optional - Dev prefix to use for the images. E.g.: 'vd', 'sd', 'hd'.
- **disable_vnc** (bool) - Optional - VNC is enabled by default. Disable it with this flag.
- **disk_resize** (string) - Optional - Size of the disk for the VM in MB.
- **image_owner** (string) - Optional - Owner of the image to use as the VM OS.
- **memory** (string) - Optional - Size of the memory for the VM in MB.
- **network_id** (string) - Optional - Opennebula network ID to connect the machine to. Conflicts with `network_name`.
- **network_name** (string) - Optional - Opennebula network to connect the machine to. Conflicts with `network_id`.
- **network_owner** (string) - Optional - Opennebula user ID of the Network to connect the machine to.
- **ssh_user** (string) - Optional - Set the name of the SSH user. Defaults to docker.
- **vcpu** (string) - Optional - VCPUs for the VM.

> **Note:** `Required*` denotes that one of image_name / image_id or template_name / template_id is required but you cannot combine them.
```

--------------------------------

### Create a new rancher2 App in a new namespace

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/app

Deploys an application into a newly created namespace with specific resource quotas.

```hcl
# Create a new rancher2 App in a new namespace
resource "rancher2_namespace" "foo" {
  name = "foo"
  description = "Foo namespace"
  project_id = "<project_id>"
  resource_quota {
    limit {
      limits_cpu = "100m"
      limits_memory = "100Mi"
      requests_storage = "1Gi"
    }
  }
}

resource "rancher2_app" "foo" {
  catalog_name = "<catalog_name>"
  name = "foo"
  description = "Foo app"
  project_id = "<project_id>"
  template_name = "<template_name>"
  template_version = "<template_version>"
  target_namespace = rancher2_namespace.foo.id
  answers = {
    "ingress_host" = "test.xip.io"
    "foo" = "bar"
  }
}
```

--------------------------------

### Create a new rancher2 Namespace

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/namespace

Basic configuration for creating a namespace within a specific project.

```hcl
resource "rancher2_namespace" "foo" {
  name = "foo"
  project_id = "<PROJECT_ID>"
  description = "foo namespace"
  resource_quota {
    limit {
      limits_cpu = "100m"
      limits_memory = "100Mi"
      requests_storage = "1Gi"
    }
  }
  container_resource_limit {
    limits_cpu = "20m"
    limits_memory = "20Mi"
    requests_cpu = "1m"
    requests_memory = "1Mi"
  }
}
```

--------------------------------

### Create a Rancher2 Storage Class V2

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/storage_class_v2

Defines a new storage class resource with specific parameters and provisioner settings.

```hcl
resource "rancher2_storage_class_v2" "foo" {
  cluster_id = <CLUSTER_ID>
  name = "foo"
  parameters = {
    "gidAllocate" = "true"
    "gidMax" = "50000"
    "gidMin" = "40000"
  }
  k8s_provisioner: "example.com/aws-efs"
  reclaim_policy: "Delete"
}
```

--------------------------------

### Create a Rancher2 Cluster Template with Upgrade Strategy

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_template

Advanced configuration for Rancher v2.4.x and above, incorporating an RKE upgrade strategy.

```hcl
resource "rancher2_cluster_template" "foo" {
  name = "foo"
  members {
    access_type = "owner"
    user_principal_id = "local://user-XXXXX"
  }
  template_revisions {
    name = "V1"
    cluster_config {
      rke_config {
        network {
          plugin = "canal"
        }
        services {
          etcd {
            creation = "6h"
            retention = "24h"
          }
        }
        upgrade_strategy {
          drain = true
          max_unavailable_worker = "20%"
        }
      }
    }
    default = true
  }
  description = "Terraform cluster template foo"
}
```

--------------------------------

### Configure Rancher2 Provider for Bootstrap and Admin

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/index

Use provider aliases to manage both the initial bootstrap process and subsequent resource management within the same configuration.

```hcl
# Configure the Rancher2 provider to bootstrap and admin
# Provider config for bootstrap
provider "rancher2" {
  alias = "bootstrap"

  api_url   = "https://rancher.my-domain.com"
  bootstrap = true
}

# Create a new rancher2_bootstrap using bootstrap provider config
resource "rancher2_bootstrap" "admin" {
  provider = "rancher2.bootstrap"

  password = "blahblah"
}

# Provider config for admin
provider "rancher2" {
  alias = "admin"

  api_url = rancher2_bootstrap.admin.url
  token_key = rancher2_bootstrap.admin.token
  insecure = true
}

# Create a new rancher2 resource using admin provider config
resource "rancher2_catalog" "foo" {
  provider = "rancher2.admin"

  name = "test"
  url = "http://foo.com:8080"
}
```

--------------------------------

### Import Generic OIDC Auth Config

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/auth_config_generic_oidc

Command to import an existing Generic OIDC authentication configuration into Terraform state.

```bash
$ terraform import rancher2_auth_config_generic_oidc.generic_oidc genericoidc
```

--------------------------------

### Create EKS Cluster with Launch Template

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster

Requires Rancher v2.5.6 or higher. The launch template ID must be provided as a static value or fetched via AWS data sources.

```hcl
resource "rancher2_cloud_credential" "foo" {
  name = "foo"
  description = "foo test"
  amazonec2_credential_config {
    access_key = "<aws-access-key>"
    secret_key = "<aws-secret-key>"
  }
}
resource "rancher2_cluster" "foo" {
  name = "foo"
  description = "Terraform EKS cluster"
  eks_config_v2 {
    cloud_credential_id = rancher2_cloud_credential.foo.id
    region = "<EKS_REGION>"
    kubernetes_version = "1.24"
    logging_types = ["audit", "api"]
    node_groups {
      desired_size = 3
      max_size = 5
      name = "node_group1"
      launch_template {
        id = "<ec2-launch-template-id>"
        version = 1
      }
    }
    private_access = true
    public_access = true
  }
}
```

--------------------------------

### Create Node Template for Rancher 2.2.x

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/node_template

Use this configuration for Rancher 2.2.x and later, which requires a separate rancher2_cloud_credential resource.

```hcl
resource "rancher2_cloud_credential" "foo" {
  name = "foo"
  description = "foo test"
  amazonec2_credential_config {
    access_key = "<AWS_ACCESS_KEY>"
    secret_key = "<AWS_SECRET_KEY>"
  }
}
resource "rancher2_node_template" "foo" {
  name = "foo"
  description = "foo test"
  cloud_credential_id = rancher2_cloud_credential.foo.id
  amazonec2_config {
    ami =  "<AMI_ID>"
    region = "<REGION>"
    security_group = ["<AWS_SECURITY_GROUP>"]
    subnet_id = "<SUBNET_ID>"
    vpc_id = "<VPC_ID>"
    zone = "<ZONE>"
  }
}
```

--------------------------------

### Import a Rancher2 Storage Class V2

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/storage_class_v2

Imports an existing storage class using the cluster ID and the storage class name.

```bash
$ terraform import rancher2_storage_class_v2.foo <CLUSTER_ID>.<STORAGE_CLASS_V2_NAME>
```

--------------------------------

### Create a new rancher2 Multi Cluster App

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/multi_cluster_app

Basic configuration for deploying a multi-cluster application with a single target project and defined answers.

```hcl
resource "rancher2_multi_cluster_app" "foo" {
  catalog_name = "<catalog_name>"
  name = "foo"
  targets {
    project_id = "<project_id>"
  }
  template_name = "<template_name>"
  template_version = "<template_version>"
  answers {
    values = {
      "ingress_host" = "test.xip.io"
    }
  }
  roles = ["project-member"]
}
```

--------------------------------

### Create Rancher V2 Cluster with Machine Selector Files

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2

Configures a cluster with machine selector files for control plane and etcd roles, available in Rancher v2.7.2 and above.

```hcl
resource "rancher2_cluster_v2" "foo" {
  name = "foo"
  kubernetes_version = "rke2/k3s-version"
  enable_network_policy = false
  rke_config {
    machine_selector_files {
      machine_label_selector {
        match_labels = {
          # You can specify multiple labels 
          "rke.cattle.io/control-plane-role" = "true",
          "rke.cattle.io/etcd-role" = "true",
        }
        # You can also specify one or more match expressions
        match_expressions  {
          key = "name"
          values = ["a", "b"]
          operator = "In"
        }
        match_expressions  {
          key = "department"
          operator = "In"
          values = ["a", "b"]
        }
      }
      file_sources {
        # The same format for configmap
        secret {
          name = "config-file-v1"
          default_permissions = "644"
          items {
            key = "audit-policy"
            path ="/etc/rancher/rke2/custom/policy-v1.yaml"
            permissions = "666"
          }
        }
      }
    }
    # In the case of a node-driver cluster
    machine_pools {
      # ...
    }
  }
}
```

--------------------------------

### Import a Project Role Template Binding

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/project_role_template_binding

Command to import an existing project role template binding into Terraform state.

```bash
$ terraform import rancher2_project_role_template_binding.foo <project_role_template_binding_id>
```

--------------------------------

### Import GKE Cluster

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster

Requires Rancher v2.5.8 or higher. Use the imported flag to manage existing GKE clusters.

```hcl
resource "rancher2_cloud_credential" "foo-google" {
  name = "foo-google"
  description= "Terraform cloudCredential acceptance test"
  google_credential_config {
    auth_encoded_json = file(<GOOGLE_AUTH_ENCODED_JSON>)
  }
}

resource "rancher2_cluster" "foo" {
  name = "foo"
  description = "Terraform imported GKE cluster"
  gke_config_v2 {
    name = "foo"
    google_credential_secret = rancher2_cloud_credential.foo-google.id
    region = <region> # Zone argument could also be used instead of region
    project_id = <project-id>
    imported = true
  }
}
```

--------------------------------

### Configure Rancher v2 FreeIPA Auth

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/auth_config_freeipa

Basic configuration for enabling FreeIPA authentication with required server and service account details.

```hcl
resource "rancher2_auth_config_freeipa" "freeipa" {
  servers = ["<FREEIPA_SERVER>"]
  service_account_distinguished_name = "<SERVICE_DN>"
  service_account_password = "<SERVICE_PASSWORD>"
  user_search_base = "<SEARCH_BASE>"
  port = <FREEIPA_PORT>
  test_username = "<USER_NAME>"
  test_password = "<USER_PASSWORD>"
}
```

--------------------------------

### Import a Pod Security Admission Configuration Template

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/rancher2_pod_security_admission_configuration_template

Imports an existing template into Terraform state using its resource ID.

```bash
$ terraform import rancher2_pod_security_admission_configuration_template.foo <resource_id>
```

--------------------------------

### Create a Rancher2 Cluster Template

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_template

Basic configuration for a cluster template including member access and RKE network/service settings.

```hcl
resource "rancher2_cluster_template" "foo" {
  name = "foo"
  members {
    access_type = "owner"
    user_principal_id = "local://user-XXXXX"
  }
  template_revisions {
    name = "V1"
    cluster_config {
      rke_config {
        network {
          plugin = "canal"
        }
        services {
          etcd {
            creation = "6h"
            retention = "24h"
          }
        }
      }
    }
    default = true
  }
  description = "Terraform cluster template foo"
}
```

--------------------------------

### Import a rancher2 Namespace

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/namespace

Command to import an existing namespace into Terraform state.

```bash
$ terraform import rancher2_namespace.foo <project_id>.<namespaces_id>
```

--------------------------------

### vsphere_config

Source: https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/node_template

Configuration arguments for vSphere settings in Rancher2.

```APIDOC
## vsphere_config

### Arguments
- **boot2docker_url** (string) - Optional - vSphere URL for boot2docker iso image.
- **cfgparam** (list) - Optional - vSphere vm configuration parameters.
- **clone_from** (string) - Optional - Name of the VM to clone from.
- **cloud_config** (string) - Optional - Cloud Config YAML content.
- **cloudinit** (string) - Optional - vSphere cloud-init file or url.
- **content_library** (string) - Optional - Name of the content library template.
- **cpu_count** (string) - Optional - vSphere CPU number.
- **creation_type** (string) - Optional - Creation type (vm, template, library, legacy).
- **custom_attributes** (List) - Optional - vSphere custom attributes.
- **datacenter** (string) - Optional - vSphere datacenter.
- **datastore** (string) - Optional - vSphere datastore.
- **datastore_cluster** (string) - Optional - vSphere datastore cluster.
- **disk_size** (string) - Optional - Size of disk in MB.
- **folder** (string) - Optional - vSphere folder.
- **hostsystem** (string) - Optional - vSphere compute resource.
- **memory_size** (string) - Optional - Size of memory in MB.
- **network** (list) - Optional - vSphere network.
- **password** (string) - Optional/Sensitive - vSphere password.
- **pool** (string) - Optional - vSphere resource pool.
- **ssh_password** (string) - Optional - SSH password.
- **ssh_port** (string) - Optional - SSH port.
- **ssh_user** (string) - Optional - SSH user.
- **ssh_user_group** (string) - Optional - SSH user group.
- **tags** (list) - Optional - vSphere tags id.
- **username** (string) - Optional/Sensitive - vSphere username.
- **vapp_ip_allocation_policy** (string) - Optional - vApp IP allocation policy.
- **vapp_ip_protocol** (string) - Optional - vApp IP protocol.
- **vapp_property** (list) - Optional - vApp properties.
- **vapp_transport** (string) - Optional - vSphere OVF environment transports.
- **vcenter** (string) - Optional/Sensitive - vSphere IP/hostname for vCenter.
- **vcenter_port** (string) - Optional/Sensitive - vSphere Port for vCenter.
```
Tokens:
Raw