This repository was archived by the owner on Jul 22, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 66
chore: provider moved docs #914
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
page_title: "0. Moving to Octopus Deploy Namespace" | ||
subcategory: "Guides" | ||
--- | ||
|
||
# 0. Moving to Octopus Deploy Namespace | ||
|
||
The aim of this guide is to help move your pre-existing *OctopusDeployLabs* provider configuration to the *OctopusDeploy* namespace while maintaining state. | ||
Keep in mind, it's important to finish all steps within guide before running `terraform apply`. | ||
|
||
## 1. Update the Provider Block | ||
|
||
Change from the *OctopusDeployLabs* provider source to the *OctopusDeploy* provider source. | ||
|
||
Before: | ||
|
||
```terraform | ||
terraform { | ||
required_providers { | ||
octopusdeploy = { | ||
source = "OctopusDeployLabs/octopusdeploy" | ||
version = "0.43.x" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
After: | ||
|
||
```terraform | ||
terraform { | ||
required_providers { | ||
octopusdeploy = { | ||
source = "OctopusDeploy/octopusdeploy" | ||
version = "1.x.x" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
If copying from the example above please ensure to set the latest version. | ||
|
||
## 2. Pull the Provider | ||
|
||
Run the following to tell terraform to pull the provider under the *OctopusDeploy* namespace. | ||
|
||
```shell | ||
terraform init -upgrade | ||
``` | ||
|
||
## 3. Move the Existing State | ||
|
||
This is the key step to maintain state. | ||
Tell terraform to map the *OctopusDeployLabs* namespace state to the *OctopusDeploy* namespace. | ||
|
||
```shell | ||
terraform state replace-provider OctopusDeployLabs/octopusdeploy OctopusDeploy/octopusdeploy | ||
``` | ||
|
||
## 4. Verify | ||
|
||
To verify the resources have moved to the *OctopusDeploy* namespace correctly run the following. | ||
|
||
```shell | ||
terraform plan | ||
``` | ||
|
||
The plan should show no unexpected changes. | ||
If the version being upgrading to introduced some breaking changes you may see some changes as expected. | ||
|
||
## 5. Done | ||
|
||
Success! Continue to use the provider as normal. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 73 additions & 0 deletions
73
templates/guides/0-moving-to-cctopus-deploy-namespace.md.tmpl
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
page_title: "0. Moving to Octopus Deploy Namespace" | ||
subcategory: "Guides" | ||
--- | ||
|
||
# 0. Moving to Octopus Deploy Namespace | ||
|
||
The aim of this guide is to help move your pre-existing *OctopusDeployLabs* provider configuration to the *OctopusDeploy* namespace while maintaining state. | ||
Keep in mind, it's important to finish all steps within guide before running `terraform apply`. | ||
domenicsim1 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## 1. Update the Provider Block | ||
|
||
Change from the *OctopusDeployLabs* provider source to the *OctopusDeploy* provider source. | ||
|
||
Before: | ||
|
||
```terraform | ||
terraform { | ||
required_providers { | ||
octopusdeploy = { | ||
source = "OctopusDeployLabs/octopusdeploy" | ||
version = "0.43.x" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
After: | ||
|
||
```terraform | ||
terraform { | ||
required_providers { | ||
octopusdeploy = { | ||
source = "OctopusDeploy/octopusdeploy" | ||
version = "1.x.x" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
If copying from the example above please ensure to set the latest version. | ||
|
||
## 2. Pull the Provider | ||
|
||
Run the following to tell terraform to pull the provider under the *OctopusDeploy* namespace. | ||
|
||
```shell | ||
terraform init -upgrade | ||
``` | ||
|
||
## 3. Move the Existing State | ||
|
||
This is the key step to maintain state. | ||
Tell terraform to map the *OctopusDeployLabs* namespace state to the *OctopusDeploy* namespace. | ||
|
||
```shell | ||
terraform state replace-provider OctopusDeployLabs/octopusdeploy OctopusDeploy/octopusdeploy | ||
``` | ||
|
||
## 4. Verify | ||
|
||
To verify the resources have moved to the *OctopusDeploy* namespace correctly run the following. | ||
|
||
```shell | ||
terraform plan | ||
``` | ||
|
||
The plan should show no unexpected changes. | ||
If the version being upgrading to introduced some breaking changes you may see some changes as expected. | ||
|
||
## 5. Done | ||
|
||
Success! Continue to use the provider as normal. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.