Skip to content

Commit 06429d8

Browse files
Add cac deletion warnings to octo-things
1 parent 266ef8c commit 06429d8

8 files changed

Lines changed: 32 additions & 10 deletions

File tree

src/pages/docs/infrastructure/environments/index.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2024-04-30
4+
modDate: 2025-02-18
55
title: Environments
66
description: Environments are how you group your deployment targets so you can promote your software through different phases, for instance, into Development, then Test, and finally into Production.
77
navOrder: 20
@@ -64,6 +64,10 @@ This will let you search by:
6464
- Health Status
6565
- Communication style
6666

67+
## Removing environments
68+
69+
For projects using Config as Code, it's up to you to take care to avoid deleting any environments required by your deployments or runbooks. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.
70+
6771
## Learn more
6872

6973
Learn how to add and manage your [deployment targets](/docs/infrastructure/deployment-targets).

src/pages/docs/infrastructure/workers/worker-pools.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2023-11-17
4+
modDate: 2025-02-18
55
title: Worker pools
66
description: Worker pools are used to group workers and allow targeting steps at the pool of workers best equipped to execute the step. This page describes how to configure worker pools for a variety of scenarios.
77
navOrder: 40
@@ -91,6 +91,10 @@ When a step is run on a worker, the following variables are available:
9191
| **`Octopus.WorkerPool.Id`** <br/> The Id of the pool | WorkerPools-1 |
9292
| **`Octopus.WorkerPool.Name`** <br/> The name of the pool | Default Worker Pool |
9393

94+
## Removing worker pools
95+
96+
For projects using Config as Code, it's up to you to take care to avoid deleting any worker pools required by your deployments or runbooks. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.
97+
9498
## Workers Q&A
9599

96100
*I've added only a single worker to the default pool, won't that machine get overworked?*

src/pages/docs/projects/custom-step-templates.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2024-08-27
4+
modDate: 2025-02-18
55
title: Custom step templates
66
icon: fa-solid fa-shapes
77
description: How to create reusable steps
@@ -120,6 +120,10 @@ All steps have a name, which is used to identify the step.
120120
Be careful when changing names. Octopus commonly uses names as a convenient identity or handle to things, and the steps and actions in a deployment process are special in that way. For example, you can use [output variables](/docs/projects/variables/output-variables) to chain steps together, and you use the name as the indexer for the output variable. E.g. `#{Octopus.Action[StepA].Output.TestResult}`
121121
:::
122122

123+
## Removing step templates
124+
125+
For projects using Config as Code, it's up to you to take care to avoid deleting any step templates required by your deployments or runbooks. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.
126+
123127
## Learn more
124128

125129
- [Blog: Creating an Octopus Deploy step template](https://octopus.com/blog/creating-an-octopus-deploy-step-template)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2025-02-14
4+
modDate: 2025-02-18
55
title: Unsupported Configuration as Code Scenarios
66
description: Unsupported scenarios for the Configuration as Code feature in Octopus Deploy.
77
icon: fa-brands fa-git-alt

src/pages/docs/releases/channels/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2024-08-28
4+
modDate: 2025-02-18
55
title: Channels
66
icon: fa-solid fa-arrows-split-up-and-left
77
description: Channels allow you to dynamically change the deployment logic and lifecycle of a project based on the version being deployed.
@@ -244,4 +244,8 @@ Setting this to `Treat independently from other channels` will cause:
244244

245245
The image below shows an example dashboard with discrete channel release enabled:
246246

247-
![Discrete channel releases on dashboard](/docs/releases/channels/images/discrete-channels-dashboard.png)
247+
![Discrete channel releases on dashboard](/docs/releases/channels/images/discrete-channels-dashboard.png)
248+
249+
## Removing channels
250+
251+
For projects using Config as Code, it's up to you to take care to avoid deleting any channels required by your deployments. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.

src/pages/docs/releases/lifecycles/index.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2024-08-29
4+
modDate: 2025-02-18
55
title: Lifecycles
66
description: Lifecycles allow you to control the way releases are promoted between environments.
77
icon: fa-solid fa-arrows-spin
@@ -184,11 +184,15 @@ It typically consists of just one phase and one environment, also called Mainten
184184
![Maintenance lifecycle](/docs/releases/lifecycles/images/maintenance-lifecycle.png "width=500")
185185
:::
186186

187+
## Removing lifecycles
188+
189+
For projects using Config as Code, it's up to you to take care to avoid deleting any lifecycles required by your deployments. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.
190+
187191
## Recommendations \{#lifecycle-recommendations}
188192

189193
When configuring your lifecycles, here are some tips to consider:
190194

191195
- Update the default lifecycle to define the phases you need. This makes configuring and maintaining your Octopus Server easier.
192196
- Keep the number of environments under ten to keep the phases added by the default lifecycle low.
193197
- Create a lifecycle for any projects which need a different promotion flow between environments. Remember to define phases for the lifecycle.
194-
- Set specific retention policies for your lifecycles. This will prevent keeping releases and files forever, reducing disk and database usage.
198+
- Set specific retention policies for your lifecycles. This will prevent keeping releases and files forever, reducing disk and database usage.

src/pages/docs/runbooks/config-as-code-runbooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2024-11-24
4-
modDate: 2025-02-14
4+
modDate: 2025-02-18
55
title: Config as Code runbooks
66
description: Details about using configuration as code with runbooks.
77
navOrder: 20

src/pages/docs/tenants/tenant-tags.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: src/layouts/Default.astro
33
pubDate: 2023-01-01
4-
modDate: 2024-08-30
4+
modDate: 2025-02-18
55
title: Tenant tags
66
icon: fa-solid fa-tags
77
description: Tenant Tags help you to classify your tenants with custom tags so you can tailor your tenanted deployments accordingly.
@@ -62,6 +62,8 @@ This example of configuring a tenanted deployment target shows how the tenant fi
6262

6363
If tenant tags are tied to specific tenants, included in project/runbook release [variable snapshots](/docs/releases#variable-snapshot) (via project/variable sets), or captured in published runbooks, you will not be able to delete the relevant tag(s) until these associations are removed (by removing these from the tenant, deleting the associated release(s), or deleting published runbook snapshot(s)). Alternatively, in the case of release variable snapshots and assuming you've removed the tenant tag(s) association in the underlying project/variable set, you can update the variable snapshot that is associated with the release(s) to remove this association.
6464

65+
For projects using Config as Code, there are fewer guardrails in place. It's up to you to take care to avoid deleting any tenant tags required by your deployments. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information.
66+
6567
## Tag-based filters {#tag-based-filters}
6668

6769
Once you have defined some tag sets and tags you can start leveraging those tags to tailor your environments and deployments.

0 commit comments

Comments
 (0)