Skip to content

Commit 77439ec

Browse files
domenicsim1domenicsim1
authored
Merge pull request #4 from OctopusDeploy/chore/v1-release-doc-updates
chore: doc updates
2 parents f073e3c + 1cee239 commit 77439ec

File tree

9 files changed

+158
-18
lines changed

9 files changed

+158
-18
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ This repository contains the source code for the Terraform Provider for [Octopus
66

77
## 🪄 Installation and Configuration
88

9-
The Terraform Provider for Octopus Deploy is available via the Terraform Registry: [OctopusDeployLabs/octopusdeploy](https://registry.terraform.io/providers/OctopusDeployLabs/octopusdeploy). To install this provider, copy and paste this code into your Terraform configuration:
9+
The Terraform Provider for Octopus Deploy is available via the Terraform Registry: [OctopusDeployLabs/octopusdeploy](https://registry.terraform.io/providers/OctopusDeploy/octopusdeploy). To install this provider, copy and paste this code into your Terraform configuration:
1010

1111
```hcl
1212
terraform {
1313
required_providers {
1414
octopusdeploy = {
15-
source = "OctopusDeployLabs/octopusdeploy"
16-
version = "version-number" # example: 0.21.1
15+
source = "OctopusDeploy/octopusdeploy"
16+
version = "version-number" # example: 1.0.0
1717
}
1818
}
1919
}

‎docs/guides/moving-from-octopus-deploy-labs-namespace.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
page_title: "Moving from Octopus Deploy Labs Namespace"
3+
subcategory: "Guides"
4+
---
5+
6+
# Moving from Octopus Deploy Labs Namespace
7+
8+
The aim of this guide is to help move your pre-existing *OctopusDeployLabs* provider configuration to the *OctopusDeploy* namespace while maintaining state.
9+
10+
> Keep in mind, it's important to finish all steps within guide before running `terraform apply`.
11+
12+
## 1. Update the Provider Block
13+
14+
Change from the *OctopusDeployLabs* provider source to the *OctopusDeploy* provider source.
15+
16+
Before:
17+
18+
```terraform
19+
terraform {
20+
required_providers {
21+
octopusdeploy = {
22+
source = "OctopusDeployLabs/octopusdeploy"
23+
version = "0.43.x"
24+
}
25+
}
26+
}
27+
```
28+
29+
After:
30+
31+
```terraform
32+
terraform {
33+
required_providers {
34+
octopusdeploy = {
35+
source = "OctopusDeploy/octopusdeploy"
36+
version = "1.x.x"
37+
}
38+
}
39+
}
40+
```
41+
42+
If copying from the example above please ensure to set the latest version.
43+
44+
## 2. Pull the Provider
45+
46+
Run the following to tell terraform to pull the provider under the *OctopusDeploy* namespace.
47+
48+
```shell
49+
terraform init -upgrade
50+
```
51+
52+
## 3. Move the Existing State
53+
54+
This is the key step to maintain state.
55+
Tell terraform to map the *OctopusDeployLabs* namespace state to the *OctopusDeploy* namespace.
56+
57+
```shell
58+
terraform state replace-provider OctopusDeployLabs/octopusdeploy OctopusDeploy/octopusdeploy
59+
```
60+
61+
## 4. Verify
62+
63+
To verify the resources have moved to the *OctopusDeploy* namespace correctly run the following.
64+
65+
```shell
66+
terraform plan
67+
```
68+
69+
The plan should show no unexpected changes.
70+
If the version being upgrading to introduced some breaking changes you may see some changes as expected.
71+
72+
## 5. Done
73+
74+
Success! Continue to use the provider as normal.

‎docs/index.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,9 @@ description: |-
77

88
# octopusdeploy Provider
99

10-
## Warning
11-
12-
This provider is under active development. Its functionality can and will change; it is a `v0.*` product until its robustness can be assured. Please be aware that types like resources can and will be modified over time. It is strongly recommended to `validate` and `plan` configuration prior to committing changes via `apply`.
13-
1410
## Overview
1511

16-
This provider is used to configure resources in Octopus Deploy. The provider must be configured with the proper credentials before it can be used.
12+
This provider is used to configure resources in Octopus Deploy.
1713

1814
## Configuration
1915

‎docs/resources/process_templated_step.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ resource "octopusdeploy_process" "example" {
8585
}
8686
8787
# Templated script step
88-
resource "octopusdeploy_templated_process_step" "script" {
88+
resource "octopusdeploy_process_templated_step" "script" {
8989
process_id = octopusdeploy_process.example.id
9090
name = "Templated Step"
9191
template_id = octopusdeploy_step_template.my_script.id

‎examples/resources/octopusdeploy_process_templated_step/resource.tf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ resource "octopusdeploy_process" "example" {
6363
}
6464

6565
# Templated script step
66-
resource "octopusdeploy_templated_process_step" "script" {
66+
resource "octopusdeploy_process_templated_step" "script" {
6767
process_id = octopusdeploy_process.example.id
6868
name = "Templated Step"
6969
template_id = octopusdeploy_step_template.my_script.id

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ go 1.22.0
55
toolchain go1.22.5
66

77
require (
8-
github.com/OctopusDeploy/go-octopusdeploy/v2 v2.71.0
8+
github.com/OctopusDeploy/go-octopusdeploy/v2 v2.73.0
99
github.com/OctopusSolutionsEngineering/OctopusTerraformTestFramework v0.0.0-20250307001652-0d83fd2b1e49
1010
github.com/google/uuid v1.6.0
1111
github.com/hashicorp/go-cty v1.4.1-0.20200723130312-85980079f637

‎go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERo
1818
github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
1919
github.com/OctopusDeploy/go-octodiff v1.0.0 h1:U+ORg6azniwwYo+O44giOw6TiD5USk8S4VDhOQ0Ven0=
2020
github.com/OctopusDeploy/go-octodiff v1.0.0/go.mod h1:Mze0+EkOWTgTmi8++fyUc6r0aLZT7qD9gX+31t8MmIU=
21-
github.com/OctopusDeploy/go-octopusdeploy/v2 v2.71.0 h1:aepu9SiIM4VeQ1u7UhHWNmWnRzvzsGPJyXR3HjLRTNc=
22-
github.com/OctopusDeploy/go-octopusdeploy/v2 v2.71.0/go.mod h1:ZCOnCz9ae/uuOk7AIQ9NzjnzFbuN8Q7H3oj2Eq4QSgQ=
21+
github.com/OctopusDeploy/go-octopusdeploy/v2 v2.73.0 h1:zLDnx3vpFAoNnGLWlPy01Oxr2DjxEwdD5mRu+aoPArA=
22+
github.com/OctopusDeploy/go-octopusdeploy/v2 v2.73.0/go.mod h1:ZCOnCz9ae/uuOk7AIQ9NzjnzFbuN8Q7H3oj2Eq4QSgQ=
2323
github.com/OctopusSolutionsEngineering/OctopusTerraformTestFramework v0.0.0-20250307001652-0d83fd2b1e49 h1:yXSNfiTSlnR9dxVQBz6hi911yulxsZME8xD1vDf8l1M=
2424
github.com/OctopusSolutionsEngineering/OctopusTerraformTestFramework v0.0.0-20250307001652-0d83fd2b1e49/go.mod h1:UAZ9L//VwW/GcXW89n05pTpPSeLAXDf2A6SF4rz2PFA=
2525
github.com/ProtonMail/go-crypto v1.1.0-alpha.2 h1:bkyFVUP+ROOARdgCiJzNQo2V2kiB97LyUpzH9P6Hrlg=

‎templates/guides/moving-from-octopus-deploy-labs-namespace.md.tmpl‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
page_title: "Moving from Octopus Deploy Labs Namespace"
3+
subcategory: "Guides"
4+
---
5+
6+
# Moving from Octopus Deploy Labs Namespace
7+
8+
The aim of this guide is to help move your pre-existing *OctopusDeployLabs* provider configuration to the *OctopusDeploy* namespace while maintaining state.
9+
10+
> Keep in mind, it's important to finish all steps within guide before running `terraform apply`.
11+
12+
## 1. Update the Provider Block
13+
14+
Change from the *OctopusDeployLabs* provider source to the *OctopusDeploy* provider source.
15+
16+
Before:
17+
18+
```terraform
19+
terraform {
20+
required_providers {
21+
octopusdeploy = {
22+
source = "OctopusDeployLabs/octopusdeploy"
23+
version = "0.43.x"
24+
}
25+
}
26+
}
27+
```
28+
29+
After:
30+
31+
```terraform
32+
terraform {
33+
required_providers {
34+
octopusdeploy = {
35+
source = "OctopusDeploy/octopusdeploy"
36+
version = "1.x.x"
37+
}
38+
}
39+
}
40+
```
41+
42+
If copying from the example above please ensure to set the latest version.
43+
44+
## 2. Pull the Provider
45+
46+
Run the following to tell terraform to pull the provider under the *OctopusDeploy* namespace.
47+
48+
```shell
49+
terraform init -upgrade
50+
```
51+
52+
## 3. Move the Existing State
53+
54+
This is the key step to maintain state.
55+
Tell terraform to map the *OctopusDeployLabs* namespace state to the *OctopusDeploy* namespace.
56+
57+
```shell
58+
terraform state replace-provider OctopusDeployLabs/octopusdeploy OctopusDeploy/octopusdeploy
59+
```
60+
61+
## 4. Verify
62+
63+
To verify the resources have moved to the *OctopusDeploy* namespace correctly run the following.
64+
65+
```shell
66+
terraform plan
67+
```
68+
69+
The plan should show no unexpected changes.
70+
If the version being upgrading to introduced some breaking changes you may see some changes as expected.
71+
72+
## 5. Done
73+
74+
Success! Continue to use the provider as normal.

‎templates/index.md.tmpl‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,9 @@ description: |-
77

88
# {{.ProviderShortName}} Provider
99

10-
## Warning
11-
12-
This provider is under active development. Its functionality can and will change; it is a `v0.*` product until its robustness can be assured. Please be aware that types like resources can and will be modified over time. It is strongly recommended to `validate` and `plan` configuration prior to committing changes via `apply`.
13-
1410
## Overview
1511

16-
This provider is used to configure resources in Octopus Deploy. The provider must be configured with the proper credentials before it can be used.
12+
This provider is used to configure resources in Octopus Deploy.
1713

1814
## Configuration
1915

0 commit comments

Comments
 (0)