Skip to content
This repository was archived by the owner on Jul 22, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions docs/guides/0-moving-to-cctopus-deploy-namespace.md
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.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ description: |-

## Warning

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`.
This provider has been moved under the namespace OctopusDeploy, the provider under OctopusDeployLabs is no longer maintained.
Please read *0. Moving to Octopus Deploy Namespace* under the guides subcategory to learn how to upgrade your provider while maintaining state.

## Overview

Expand Down
73 changes: 73 additions & 0 deletions templates/guides/0-moving-to-cctopus-deploy-namespace.md.tmpl
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.
3 changes: 2 additions & 1 deletion templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ description: |-

## Warning

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`.
This provider has been moved under the namespace OctopusDeploy, the provider under OctopusDeployLabs is no longer maintained.
Please read *0. Moving to Octopus Deploy Namespace* under the guides subcategory to learn how to upgrade your provider while maintaining state.

## Overview

Expand Down
Loading