43 lines
1.0 KiB
Markdown
43 lines
1.0 KiB
Markdown
|
---
|
||
|
|
layout: "rancher"
|
||
|
|
page_title: "Rancher: rancher_environment"
|
||
|
|
sidebar_current: "docs-rancher-resource-environment"
|
||
|
|
description: |-
|
||
|
|
Provides a Rancher Environment resource. This can be used to create and manage environments on rancher.
|
||
|
|
---
|
||
|
|
|
||
|
|
# rancher\_environment
|
||
|
|
|
||
|
|
Provides a Rancher Environment resource. This can be used to create and manage environments on rancher.
|
||
|
|
|
||
|
|
## Example Usage
|
||
|
|
|
||
|
|
```hcl
|
||
|
|
# Create a new Rancher environment
|
||
|
|
resource "rancher_environment" "default" {
|
||
|
|
name = "staging"
|
||
|
|
description = "The staging environment"
|
||
|
|
orchestration = "cattle"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Argument Reference
|
||
|
|
|
||
|
|
The following arguments are supported:
|
||
|
|
|
||
|
|
* `name` - (Required) The name of the environment.
|
||
|
|
* `description` - (Optional) An environment description.
|
||
|
|
* `orchestration` - (Optional) Must be one of **cattle**, **swarm**, **mesos** or **kubernetes**. Defaults to **cattle**.
|
||
|
|
|
||
|
|
## Attributes Reference
|
||
|
|
|
||
|
|
No further attributes are exported.
|
||
|
|
|
||
|
|
## Import
|
||
|
|
|
||
|
|
Environments can be imported using their Rancher API ID, e.g.
|
||
|
|
|
||
|
|
```
|
||
|
|
$ terraform import rancher_environment.dev 1a15
|
||
|
|
```
|