Skip to content

Commit 9abe4a7

Browse files
Update warning about Configuration as Code limitations (#3052)
* Update warning about Configuration as Code limitations Removed out-of-date limitation of Configuration as Code as it now supports runbook processes. * Improve formatting and clarity in unsupported config scenarios Addressing linting issues. * Apply suggestions from code review to clarify the lead in. Co-authored-by: Geoff Lamrock <geoff.lamrock@gmail.com> --------- Co-authored-by: Geoff Lamrock <geoff.lamrock@gmail.com>
1 parent fdde092 commit 9abe4a7

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ An error will occur when Octopus Deploy attempts to load a process from source c
3333

3434
The configuration as code feature is not designed to allow two or more projects on different instances to point to the same folder. We've seen our users attempt to use Configuration as Code to keep the deployment processes in sync across multiple instances. That scenario is unsupported.
3535

36-
While it may work initially, it will be harder and harder to manage over time. You will need to keep _all_ the scaffolding data in sync across multiple instances. That is [easier said than done](/docs/administration/sync-instances). Step templates will be the most difficult, as having the same step template on all instances, the version has to match. Otherwise, you'll have to worry about settings such as parameters, scripts, package versions, feeds, and more.
36+
While it may work initially, it will be harder and harder to manage over time. You will need to keep *all* the scaffolding data in sync across multiple instances. That is [easier said than done](/docs/administration/sync-instances). Step templates will be the most difficult, as having the same step template on all instances, the version has to match. Otherwise, you'll have to worry about settings such as parameters, scripts, package versions, feeds, and more.
3737

3838
:::div{.warning}
39-
Configuration as Code currently supports storing the deployment process and non-sensitive variables for a project in the Git repo. It does not store or runbook processes or sensitive variables.
39+
Configuration as Code currently supports storing the deployment process, runbook processes and non-sensitive variables for a project in the Git repo. It does not store sensitive variables.
4040
:::
4141

42-
Typically, having two instances results from splitting an Octopus Deploy instance by environment (one instance has Dev/Test the other has Staging/Prod), by Tenant (one instance has test tenants, the other has customers), or both. Pointing multiple instances at the same folder will only work if they _are all exactly the same forever_.
42+
Typically, having two instances results from splitting an Octopus Deploy instance by environment (one instance has Dev/Test the other has Staging/Prod), by Tenant (one instance has test tenants, the other has customers), or both. Pointing multiple instances at the same folder will only work if they *are all exactly the same forever*.
4343

44-
### Octopus Terraform Provider
44+
### Octopus Terraform Provider for syncing
4545

4646
Use the [Octopus Terraform Provider](https://registry.terraform.io/providers/OctopusDeployLabs/octopusdeploy/latest/docs) to keep multiple instances in sync. Use Terraform's [variable functionality](https://www.terraform.io/language/values/variables) to manage the differences between the instances. For example, have a variable for environment scoping. One instance populates the environment list with "Test" while the other populates it with **Staging** and **Production**.
4747

@@ -88,7 +88,7 @@ Having a branch per project will partially solve the problem of the subtle diffe
8888
Configuration as Code is an all-or-nothing feature. You'll be unable to say manage "some of my deployment process" using Configuration as Code. It is the entire deployment process or nothing.
8989
:::
9090

91-
### Octopus Terraform Provider
91+
### Octopus Terraform Provider for templating
9292

9393
Use the [Octopus Terraform Provider](https://registry.terraform.io/providers/OctopusDeployLabs/octopusdeploy/latest/docs) to create a deployment process template. Use Terraform's [variable functionality](https://www.terraform.io/language/values/variables) to manage the different projects. For example, have a variable for target roles; one project has **OctoFX-WebApi** while another uses **RandomQuotes-WebApi**.
9494

0 commit comments

Comments
 (0)