You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
page_title:"Terraform Coder Provider Version 2 Upgrade Guide"
3
+
---
4
+
5
+
#Terraform Coder Provider Version 2 Upgrade Guide
6
+
7
+
Version 2.0.0 of the Coder provider for Terraform is a major release that removes and introduces some changes that you will need to consider when upgrading.
8
+
This guide is intended to help with the process and focus only on the changes from version 1.X to version 2.0.0.
9
+
10
+
11
+
!> Using Version 2.0.0 of the Coder provider requires Coder Server version[`2.13.0`](https://github.com/coder/coder/releases/tag/v2.13.0) or later.
12
+
13
+
Upgrade topics:
14
+
15
+
-[Provider Version Configuration](#provider-version-configuration)
-> Before upgrading to version 2.0.0, it is recommended to upgrade to the most recent 1.X version and ensure that your environment successfully runs[`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) without unexpected changes or deprecation notices.
23
+
24
+
We recommended using[version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#version-constraints) when configuring Terraform providers.
25
+
26
+
27
+
For example, given the previous configuration:
28
+
29
+
```terraform
30
+
terraform {
31
+
required_providers {
32
+
coder = {
33
+
source = "coder/coder"
34
+
version = "~> 1.0.0"
35
+
}
36
+
}
37
+
}
38
+
39
+
provider "coder" {
40
+
feature_use_managed_variables = true
41
+
}
42
+
```
43
+
44
+
Update to the latest 2.X version:
45
+
46
+
```terraform
47
+
terraform {
48
+
required_providers {
49
+
coder = {
50
+
source = "coder/coder"
51
+
version = "~> 2.0.0"
52
+
}
53
+
}
54
+
}
55
+
56
+
provider "coder" {}
57
+
```
58
+
59
+
##Provider Arguments
60
+
61
+
Version 2.0.0 removes the[`feature_use_managed_variables`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs#feature_use_managed_variables-1) argument from the`provider` block.
If you are using this data source, you must replace it with the[`coder_external_auth`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/external_auth) data source. The`coder_external_auth` data source is a more generic data source that can be used to create any external authentication provider which supports OAuth2.
If you are using the`owner` properties of the`coder_workspace` data source, you must remove them and use the[`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner) data source instead. The`coder_workspace_owner` data source provides additional properties of the workspace owner.
87
+
88
+
Update your Terraform configuration to use the`coder_workspace_owner` data source instead and update the following attributes:
->While we do not anticipate these changes to affect existing resources, we strongly advice reviewing the plan produced by Terraform to ensure no resources are accidentally removed or altered in an undesired way. If you encounter any unexpected behavior, please report it by opening a GitHub[issue](https://github.com/coder/terraform-provider-coder/issues).
Copy file name to clipboardExpand all lines: docs/index.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,11 @@ description: |-
8
8
9
9
#Coder Provider
10
10
11
-
Terraform provider for managing Coder[templates](https://coder.com/docs/templates), which are the underlying infrastructure for Coder[workspaces](https://coder.com/docs/workspaces).
11
+
Terraform provider for managing Coder[templates](https://coder.com/docs/admin/templates), which are the underlying infrastructure for Coder[workspaces](https://coder.com/docs/user-guides/workspace-management).
12
12
13
13
-> Requires Coder v2.13.0 or later.
14
14
15
-
!>`coder_git_auth` and owner related fields of`coder_workspace` data source have been removed. Follow the[v0 to v1migration guide](https://registry.terraform.io/providers/codercom/coder/latest/docs/guides/v1-to-v2-migration) to update your code.
15
+
!>[`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth) and owner related fields of[`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace) data source have been removed. Follow the[Version 2 Upgrade Guide](https://registry.terraform.io/providers/codercom/coder/latest/docs/guides/version-2-upgrade) to update your code.
page_title: "Terraform Coder Provider Version 2 Upgrade Guide"
3
+
---
4
+
5
+
# Terraform Coder Provider Version 2 Upgrade Guide
6
+
7
+
Version 2.0.0 of the Coder provider for Terraform is a major release that removes and introduces some changes that you will need to consider when upgrading.
8
+
This guide is intended to help with the process and focus only on the changes from version 1.X to version 2.0.0.
9
+
10
+
11
+
!> Using Version 2.0.0 of the Coder provider requires Coder Server version [`2.13.0`](https://github.com/coder/coder/releases/tag/v2.13.0) or later.
12
+
13
+
Upgrade topics:
14
+
15
+
- [Provider Version Configuration](#provider-version-configuration)
-> Before upgrading to version 2.0.0, it is recommended to upgrade to the most recent 1.X version and ensure that your environment successfully runs [`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) without unexpected changes or deprecation notices.
23
+
24
+
We recommended using [version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#version-constraints) when configuring Terraform providers.
25
+
26
+
27
+
For example, given the previous configuration:
28
+
29
+
```terraform
30
+
terraform {
31
+
required_providers {
32
+
coder = {
33
+
source = "coder/coder"
34
+
version = "~> 1.0.0"
35
+
}
36
+
}
37
+
}
38
+
39
+
provider "coder" {
40
+
feature_use_managed_variables = true
41
+
}
42
+
```
43
+
44
+
Update to the latest 2.X version:
45
+
46
+
```terraform
47
+
terraform {
48
+
required_providers {
49
+
coder = {
50
+
source = "coder/coder"
51
+
version = "~> 2.0.0"
52
+
}
53
+
}
54
+
}
55
+
56
+
provider "coder" {}
57
+
```
58
+
59
+
## Provider Arguments
60
+
61
+
Version 2.0.0 removes the [`feature_use_managed_variables`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs#feature_use_managed_variables-1) argument from the `provider` block.
62
+
63
+
64
+
## Data Source: [`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth)
65
+
66
+
If you are using this data source, you must replace it with the [`coder_external_auth`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/external_auth) data source. The `coder_external_auth` data source is a more generic data source that can be used to create any external authentication provider which supports OAuth2.
67
+
68
+
For example, given the previous configuration:
69
+
70
+
```terraform
71
+
data "coder_git_auth" "example" {
72
+
id = "example"
73
+
}
74
+
```
75
+
76
+
Update to the new data source:
77
+
78
+
```terraform
79
+
data "coder_external_auth" "example" {
80
+
id = "example"
81
+
}
82
+
```
83
+
84
+
## Data Source: [`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace)
85
+
86
+
If you are using the `owner` properties of the `coder_workspace` data source, you must remove them and use the [`coder_workspace_owner`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner) data source instead. The `coder_workspace_owner` data source provides additional properties of the workspace owner.
87
+
88
+
Update your Terraform configuration to use the `coder_workspace_owner` data source instead and update the following attributes:
89
+
90
+
```terraform
91
+
data "coder_workspace_owner" "me" {}
92
+
```
93
+
94
+
- Remove `owner_id` attribute. Use [`data.coder_workspace_owner.me.id`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#id) instead.
95
+
- Remove `owner` attribute. Use [`data.coder_workspace_owner.me.name`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#name) instead.
96
+
- Remove `owner_name` attribute. Use [`data.coder_workspace_owner.me.full_name`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#full_name) instead.
97
+
- Remove `owner_email` attribute. Use [`data.coder_workspace_owner.me.email`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#email) instead.
98
+
- Remove `owner_groups` attribute. Use [`data.coder_workspace_owner.me.groups`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#groups) instead.
99
+
- Remove `owner_oidc_access_token` attribute. Use [`data.coder_workspace_owner.me.oidc_access_token`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#oidc_access_token) instead.
100
+
- Remove `owner_session_token` attribute. Use [`data.coder_workspace_owner.me.session_token`](https://registry.terraform.io/providers/coder/coder/2.0.0/docs/data-sources/workspace_owner#session_token) instead.
101
+
102
+
->While we do not anticipate these changes to affect existing resources, we strongly advice reviewing the plan produced by Terraform to ensure no resources are accidentally removed or altered in an undesired way. If you encounter any unexpected behavior, please report it by opening a GitHub [issue](https://github.com/coder/terraform-provider-coder/issues).
Copy file name to clipboardExpand all lines: templates/index.md.tmpl
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,11 @@ description: |-
8
8
9
9
# Coder Provider
10
10
11
-
Terraform provider for managing Coder [templates](https://coder.com/docs/templates), which are the underlying infrastructure for Coder [workspaces](https://coder.com/docs/workspaces).
11
+
Terraform provider for managing Coder [templates](https://coder.com/docs/admin/templates), which are the underlying infrastructure for Coder [workspaces](https://coder.com/docs/user-guides/workspace-management).
12
12
13
13
-> Requires Coder v2.13.0 or later.
14
14
15
-
!> `coder_git_auth` and owner related fields of `coder_workspace` data source have been removed. Follow the [v0 to v1migration guide](https://registry.terraform.io/providers/codercom/coder/latest/docs/guides/v1-to-v2-migration) to update your code.
15
+
!>[`coder_git_auth`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/git_auth) and owner related fields of[`coder_workspace`](https://registry.terraform.io/providers/coder/coder/1.0.4/docs/data-sources/workspace) data source have been removed. Follow the [Version 2 Upgrade Guide](https://registry.terraform.io/providers/codercom/coder/latest/docs/guides/version-2-upgrade) to update your code.