From 1c94b40c59566e10644438d2788e46c2b616b6cf Mon Sep 17 00:00:00 2001 From: CaitlynStocker Date: Fri, 14 Feb 2025 16:23:49 +1000 Subject: [PATCH 1/5] Add warning message to CaC Runbooks docs --- .../version-control/unsupported-config-as-code-scenarios.md | 2 +- src/pages/docs/runbooks/config-as-code-runbooks.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md b/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md index 07a86e1970..29bab1d890 100644 --- a/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md +++ b/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md @@ -26,7 +26,7 @@ That scaffolding data includes (but is not limited to): That data is not stored in source control because it is shared across multiple projects. :::div{.warning} -An error will occur when Octopus Deploy attempts to load a process from source control with one or more of those items missing. You'll be unable to create releases until those errors are resolved. +An error will occur when Octopus Deploy attempts to load a process from source control with one or more of those items missing. You'll be unable to create releases or access runbooks until those errors are resolved. ::: ## Syncing multiple instances diff --git a/src/pages/docs/runbooks/config-as-code-runbooks.md b/src/pages/docs/runbooks/config-as-code-runbooks.md index af9a7b2b05..f153880fcd 100644 --- a/src/pages/docs/runbooks/config-as-code-runbooks.md +++ b/src/pages/docs/runbooks/config-as-code-runbooks.md @@ -87,3 +87,9 @@ The information that was previously found on the **Snapshot** page is still avai If you use automated scripts that run runbooks via the Octopus Server API and you convert your runbooks to Config As Code the URL for the runbook will change to include a branch reference (e.g. `refs/heads/main`) as a result you need to update your scripts to include the branch reference where the runbook is stored. - [PowerShell example](https://github.com/OctopusDeploy/OctopusDeploy-Api/blob/master/REST/PowerShell/Runbooks/RunConfigAsCodeRunbook.ps1) + +## Deleting required resources + +Once your Runbooks are version controlled, it's up to you to take care to avoid deleting any Octopus resources required by your Runbooks. See our [core design decisions](docs\projects\version-control\unsupported-config-as-code-scenarios#core-design-decisions) for more information. + + From 5f427c8214bf13b61da449c541a0f4a99b543715 Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Fri, 14 Feb 2025 08:30:50 +0000 Subject: [PATCH 2/5] Fix link --- src/pages/docs/runbooks/config-as-code-runbooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/runbooks/config-as-code-runbooks.md b/src/pages/docs/runbooks/config-as-code-runbooks.md index f153880fcd..52c4e72d10 100644 --- a/src/pages/docs/runbooks/config-as-code-runbooks.md +++ b/src/pages/docs/runbooks/config-as-code-runbooks.md @@ -90,6 +90,6 @@ If you use automated scripts that run runbooks via the Octopus Server API and yo ## Deleting required resources -Once your Runbooks are version controlled, it's up to you to take care to avoid deleting any Octopus resources required by your Runbooks. See our [core design decisions](docs\projects\version-control\unsupported-config-as-code-scenarios#core-design-decisions) for more information. +Once your Runbooks are version controlled, it's up to you to take care to avoid deleting any Octopus resources required by your Runbooks. See our [core design decisions](/docs/projects/version-control/unsupported-config-as-code-scenarios#core-design-decision) for more information. From 5930aa2ae02ed5f1e134321d8747ce5e89489974 Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Fri, 14 Feb 2025 08:31:25 +0000 Subject: [PATCH 3/5] Update modified date --- src/pages/docs/runbooks/config-as-code-runbooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/runbooks/config-as-code-runbooks.md b/src/pages/docs/runbooks/config-as-code-runbooks.md index 52c4e72d10..48d1c388da 100644 --- a/src/pages/docs/runbooks/config-as-code-runbooks.md +++ b/src/pages/docs/runbooks/config-as-code-runbooks.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2024-11-24 -modDate: 2024-11-24 +modDate: 2025-02-14 title: Config as Code runbooks description: Details about using configuration as code with runbooks. navOrder: 20 From 4ee99cc3d39812014e89310a53b199ba9b43c2ca Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Fri, 14 Feb 2025 08:31:42 +0000 Subject: [PATCH 4/5] Update modified date --- .../version-control/unsupported-config-as-code-scenarios.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md b/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md index 29bab1d890..4bc92736e3 100644 --- a/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md +++ b/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-12-16 +modDate: 2025-02-14 title: Unsupported Configuration as Code Scenarios description: Unsupported scenarios for the Configuration as Code feature in Octopus Deploy. icon: fa-brands fa-git-alt From 06429d8638bcbd38fb68fb733a4a602986ac34e9 Mon Sep 17 00:00:00 2001 From: CaitlynStocker Date: Tue, 18 Feb 2025 11:28:51 +1000 Subject: [PATCH 5/5] Add cac deletion warnings to octo-things --- src/pages/docs/infrastructure/environments/index.mdx | 6 +++++- src/pages/docs/infrastructure/workers/worker-pools.md | 6 +++++- src/pages/docs/projects/custom-step-templates.md | 6 +++++- .../unsupported-config-as-code-scenarios.md | 2 +- src/pages/docs/releases/channels/index.md | 8 ++++++-- src/pages/docs/releases/lifecycles/index.mdx | 8 ++++++-- src/pages/docs/runbooks/config-as-code-runbooks.md | 2 +- src/pages/docs/tenants/tenant-tags.md | 4 +++- 8 files changed, 32 insertions(+), 10 deletions(-) diff --git a/src/pages/docs/infrastructure/environments/index.mdx b/src/pages/docs/infrastructure/environments/index.mdx index 8b3a20373a..bc417af21d 100644 --- a/src/pages/docs/infrastructure/environments/index.mdx +++ b/src/pages/docs/infrastructure/environments/index.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-04-30 +modDate: 2025-02-18 title: Environments 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. navOrder: 20 @@ -64,6 +64,10 @@ This will let you search by: - Health Status - Communication style +## Removing environments + +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. + ## Learn more Learn how to add and manage your [deployment targets](/docs/infrastructure/deployment-targets). diff --git a/src/pages/docs/infrastructure/workers/worker-pools.md b/src/pages/docs/infrastructure/workers/worker-pools.md index f0e1d1be87..47208f77b2 100644 --- a/src/pages/docs/infrastructure/workers/worker-pools.md +++ b/src/pages/docs/infrastructure/workers/worker-pools.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-11-17 +modDate: 2025-02-18 title: Worker pools 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. navOrder: 40 @@ -91,6 +91,10 @@ When a step is run on a worker, the following variables are available: | **`Octopus.WorkerPool.Id`**
The Id of the pool | WorkerPools-1 | | **`Octopus.WorkerPool.Name`**
The name of the pool | Default Worker Pool | +## Removing worker pools + +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. + ## Workers Q&A *I've added only a single worker to the default pool, won't that machine get overworked?* diff --git a/src/pages/docs/projects/custom-step-templates.md b/src/pages/docs/projects/custom-step-templates.md index b9cb6243d2..ec17611e10 100644 --- a/src/pages/docs/projects/custom-step-templates.md +++ b/src/pages/docs/projects/custom-step-templates.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-08-27 +modDate: 2025-02-18 title: Custom step templates icon: fa-solid fa-shapes description: How to create reusable steps @@ -120,6 +120,10 @@ All steps have a name, which is used to identify the step. 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}` ::: +## Removing step templates + +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. + ## Learn more - [Blog: Creating an Octopus Deploy step template](https://octopus.com/blog/creating-an-octopus-deploy-step-template) diff --git a/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md b/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md index 4bc92736e3..9cf2c9418a 100644 --- a/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md +++ b/src/pages/docs/projects/version-control/unsupported-config-as-code-scenarios.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2025-02-14 +modDate: 2025-02-18 title: Unsupported Configuration as Code Scenarios description: Unsupported scenarios for the Configuration as Code feature in Octopus Deploy. icon: fa-brands fa-git-alt diff --git a/src/pages/docs/releases/channels/index.md b/src/pages/docs/releases/channels/index.md index 0099620db1..2ce246e98d 100644 --- a/src/pages/docs/releases/channels/index.md +++ b/src/pages/docs/releases/channels/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-08-28 +modDate: 2025-02-18 title: Channels icon: fa-solid fa-arrows-split-up-and-left 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: The image below shows an example dashboard with discrete channel release enabled: -![Discrete channel releases on dashboard](/docs/releases/channels/images/discrete-channels-dashboard.png) \ No newline at end of file +![Discrete channel releases on dashboard](/docs/releases/channels/images/discrete-channels-dashboard.png) + +## Removing channels + +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. \ No newline at end of file diff --git a/src/pages/docs/releases/lifecycles/index.mdx b/src/pages/docs/releases/lifecycles/index.mdx index 88e5a269ec..73c4df2b21 100644 --- a/src/pages/docs/releases/lifecycles/index.mdx +++ b/src/pages/docs/releases/lifecycles/index.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-08-29 +modDate: 2025-02-18 title: Lifecycles description: Lifecycles allow you to control the way releases are promoted between environments. icon: fa-solid fa-arrows-spin @@ -184,6 +184,10 @@ It typically consists of just one phase and one environment, also called Mainten ![Maintenance lifecycle](/docs/releases/lifecycles/images/maintenance-lifecycle.png "width=500") ::: +## Removing lifecycles + +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. + ## Recommendations \{#lifecycle-recommendations} When configuring your lifecycles, here are some tips to consider: @@ -191,4 +195,4 @@ When configuring your lifecycles, here are some tips to consider: - Update the default lifecycle to define the phases you need. This makes configuring and maintaining your Octopus Server easier. - Keep the number of environments under ten to keep the phases added by the default lifecycle low. - Create a lifecycle for any projects which need a different promotion flow between environments. Remember to define phases for the lifecycle. -- Set specific retention policies for your lifecycles. This will prevent keeping releases and files forever, reducing disk and database usage. +- Set specific retention policies for your lifecycles. This will prevent keeping releases and files forever, reducing disk and database usage. \ No newline at end of file diff --git a/src/pages/docs/runbooks/config-as-code-runbooks.md b/src/pages/docs/runbooks/config-as-code-runbooks.md index 48d1c388da..695c93d0aa 100644 --- a/src/pages/docs/runbooks/config-as-code-runbooks.md +++ b/src/pages/docs/runbooks/config-as-code-runbooks.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2024-11-24 -modDate: 2025-02-14 +modDate: 2025-02-18 title: Config as Code runbooks description: Details about using configuration as code with runbooks. navOrder: 20 diff --git a/src/pages/docs/tenants/tenant-tags.md b/src/pages/docs/tenants/tenant-tags.md index de58ec79aa..6a72dea978 100644 --- a/src/pages/docs/tenants/tenant-tags.md +++ b/src/pages/docs/tenants/tenant-tags.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2024-08-30 +modDate: 2025-02-18 title: Tenant tags icon: fa-solid fa-tags 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 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. +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. + ## Tag-based filters {#tag-based-filters} Once you have defined some tag sets and tags you can start leveraging those tags to tailor your environments and deployments.