Skip to content

namespace.md

Latest commit

 

History

History
141 lines (110 loc) · 4.73 KB

namespace.md

File metadata and controls

141 lines (110 loc) · 4.73 KB
Raw
page_title rancher2_namespace Resource

rancher2_namespace Resource

Provides a Rancher v2 Namespace resource. This can be used to create namespaces for Rancher v2 environments and retrieve their information.

Example Usage

# Create a new rancher2 Namespace
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 new rancher2 Cluster 
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"
  }
}

Argument Reference

The following arguments are supported:

  • name - (Required) The name of the namespace (string)
  • project_id - (Required) The project id where assign namespace. It's on the form project_id=<cluster_id>:<id>. Updating <id> part on same <cluster_id> namespace will be moved between projects (string)
  • container_resource_limit - (Optional) Default containers resource limits on namespace (List maxitem:1)
  • description - (Optional) A namespace description (string)
  • resource_quota - (Optional/Computed) Resource quota for namespace. Rancher v2.1.x or higher (list maxitems:1)
  • wait_for_cluster - (Optional) Wait for cluster becomes active. Default false (bool)
  • annotations - (Optional/Computed) Annotations for Node Pool object (map)
  • labels - (Optional/Computed) Labels for Node Pool object (map)

Attributes Reference

The following attributes are exported:

  • id - (Computed) The ID of the resource (string)

Nested blocks

container_resource_limit

Arguments

  • limits_cpu - (Optional) CPU limit for containers (string)
  • limits_memory - (Optional) Memory limit for containers (string)
  • requests_cpu - (Optional) CPU reservation for containers (string)
  • requests_memory - (Optional) Memory reservation for containers (string)

resource_quota

Arguments

  • limit - (Required) Resource quota limit for namespace (list maxitems:1)

limit

Arguments
  • config_maps - (Optional) Limit for config maps in namespace (string)
  • limits_cpu - (Optional) Limit for limits cpu in namespace (string)
  • limits_memory - (Optional) Limit for limits memory in namespace (string)
  • persistent_volume_claims - (Optional) Limit for persistent volume claims in namespace (string)
  • pods - (Optional) Limit for pods in namespace (string)
  • replication_controllers - (Optional) Limit for replication controllers in namespace (string)
  • requests_cpu - (Optional) Limit for requests cpu in namespace (string)
  • requests_memory - (Optional) Limit for requests memory in namespace (string)
  • requests_storage - (Optional) Limit for requests storage in namespace (string)
  • secrets - (Optional) Limit for secrets in namespace (string)
  • services_load_balancers - (Optional) Limit for services load balancers in namespace (string)
  • services_node_ports - (Optional) Limit for services node ports in namespace (string)

More info at resource-quotas

Timeouts

rancher2_namespace provides the following Timeouts configuration options:

  • create - (Default 10 minutes) Used for creating namespaces.
  • update - (Default 10 minutes) Used for namespace modifications.
  • delete - (Default 10 minutes) Used for deleting namespaces.

Import

Namespaces can be imported using the namespace ID in the format <project_id>.<namespace_id>

$ terraform import rancher2_namespace.foo &lt;project_id&gt;.&lt;namespaces_id&gt;

<project_id> is in the format <cluster_id>:<id>, this is the output from data.rancher2_cluster.downstream_cluster.default_project_id

The <project_id> must match the actual resource, importing will error on project mismatch.

In past versions you could modify the namespace while importing it, this functionality is no longer available.