github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/kubernetes/r/resource_quota.html.markdown (about)

     1  ---
     2  layout: "kubernetes"
     3  page_title: "Kubernetes: kubernetes_resource_quota"
     4  sidebar_current: "docs-kubernetes-resource-resource-quota"
     5  description: |-
     6    A resource quota provides constraints that limit aggregate resource consumption per namespace. It can limit the quantity of objects that can be created in a namespace by type, as well as the total amount of compute resources that may be consumed by resources in that project.
     7  ---
     8  
     9  # kubernetes_resource_quota
    10  
    11  A resource quota provides constraints that limit aggregate resource consumption per namespace. It can limit the quantity of objects that can be created in a namespace by type, as well as the total amount of compute resources that may be consumed by resources in that project.
    12  
    13  
    14  ## Example Usage
    15  
    16  ```hcl
    17  resource "kubernetes_resource_quota" "example" {
    18    metadata {
    19      name = "terraform-example"
    20    }
    21    spec {
    22      hard {
    23        pods = 10
    24      }
    25      scopes = ["BestEffort"]
    26    }
    27  }
    28  ```
    29  
    30  ## Argument Reference
    31  
    32  The following arguments are supported:
    33  
    34  * `metadata` - (Required) Standard resource quota's metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata
    35  * `spec` - (Optional) Spec defines the desired quota. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
    36  
    37  ## Nested Blocks
    38  
    39  ### `metadata`
    40  
    41  #### Arguments
    42  
    43  * `annotations` - (Optional) An unstructured key value map stored with the resource quota that may be used to store arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
    44  * `labels` - (Optional) Map of string keys and values that can be used to organize and categorize (scope and select) the resource quota. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
    45  * `name` - (Optional) Name of the resource quota, must be unique. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
    46  * `namespace` - (Optional) Namespace defines the space within which name of the resource quota must be unique.
    47  
    48  #### Attributes
    49  
    50  
    51  * `generation` - A sequence number representing a specific generation of the desired state.
    52  * `resource_version` - An opaque value that represents the internal version of this resource quota that can be used by clients to determine when resource quota has changed. Read more: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#concurrency-control-and-consistency
    53  * `self_link` - A URL representing this resource quota.
    54  * `uid` - The unique in time and space value for this resource quota. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
    55  
    56  ### `spec`
    57  
    58  #### Arguments
    59  
    60  * `hard` - (Optional) The set of desired hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota
    61  * `scopes` - (Optional) A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.
    62  
    63  ## Import
    64  
    65  Resource Quota can be imported using its name, e.g.
    66  
    67  ```
    68  $ terraform import kubernetes_resource_quota.example terraform-example
    69  ```