From c7664792919c734a82c168fbd4e8a85274cb5a8c Mon Sep 17 00:00:00 2001 From: Rob E Date: Mon, 18 Mar 2024 11:00:36 +1000 Subject: [PATCH 1/3] Update config-as-code-reference.md Include note indicating missing slugs will result in an error Relates to https://app.shortcut.com/octopusdeploy/story/61036/cac-target-deletion-does-not-cascade-to-variable-scope --- .../docs/projects/version-control/config-as-code-reference.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/pages/docs/projects/version-control/config-as-code-reference.md b/src/pages/docs/projects/version-control/config-as-code-reference.md index 3b847c856f..7b56d12df2 100644 --- a/src/pages/docs/projects/version-control/config-as-code-reference.md +++ b/src/pages/docs/projects/version-control/config-as-code-reference.md @@ -318,6 +318,7 @@ When designing the config-as-code feature, we made several decisions to keep an - The Octopus Terraform Provider and OCL are not a 1:1 match. You cannot copy resources between the two and expect everything to work. We want to narrow the gap as much as possible, but as of right now, a gap exists. - Octopus currently only supports connecting to git repositories over HTTPS and not SSH. - Shared resources (environments, external feeds, channels, etc.) are referenced by their slug from OCL. The API however will still use IDs. +- Shared resources referenced in OCL which no longer exist in Octopus Server will result in an error when loading through the portal or API. The provided error message should provide information indicating what reference is no longer valid and should be updated or removed before being loaded again. - Shared resources must exist before loading an OCL file into Octopus Deploy. What that means is if you copy the OCL files from one git repo to another, and point a new project at those files, then any shared resource must exist before creating that project. That only applies when projects are in different spaces or on different instances. If the resources do not exist, an error message will appear. - Pointing multiple projects to the same folder in the same git repo is unsupported. Please see our [unsupported config as code scenarios](/docs/projects/version-control/unsupported-config-as-code-scenarios) for more information. - Converting a project to be version-controlled is a one-way process. At this time, you cannot convert back. From be0844e6c8d14d9edfdfc1711ebdac5e7369f225 Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Mon, 18 Mar 2024 14:57:40 +0000 Subject: [PATCH 2/3] Add "snapshotting" to dictionary --- dictionary-octopus.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt index 60cc6eab74..7977d825b3 100644 --- a/dictionary-octopus.txt +++ b/dictionary-octopus.txt @@ -174,6 +174,7 @@ shiki SIEM signingkeys skiplinks +snapshotting sourcedata speculationrules srcset From 521ba5530f3fad4bda634d9928ad4efb9a961856 Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Wed, 20 Mar 2024 13:30:19 +0000 Subject: [PATCH 3/3] Update src/pages/docs/projects/version-control/config-as-code-reference.md --- .../docs/projects/version-control/config-as-code-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/projects/version-control/config-as-code-reference.md b/src/pages/docs/projects/version-control/config-as-code-reference.md index 7b56d12df2..3fb9d6079b 100644 --- a/src/pages/docs/projects/version-control/config-as-code-reference.md +++ b/src/pages/docs/projects/version-control/config-as-code-reference.md @@ -318,7 +318,7 @@ When designing the config-as-code feature, we made several decisions to keep an - The Octopus Terraform Provider and OCL are not a 1:1 match. You cannot copy resources between the two and expect everything to work. We want to narrow the gap as much as possible, but as of right now, a gap exists. - Octopus currently only supports connecting to git repositories over HTTPS and not SSH. - Shared resources (environments, external feeds, channels, etc.) are referenced by their slug from OCL. The API however will still use IDs. -- Shared resources referenced in OCL which no longer exist in Octopus Server will result in an error when loading through the portal or API. The provided error message should provide information indicating what reference is no longer valid and should be updated or removed before being loaded again. +- Shared resources referenced in OCL that no longer exist in Octopus Server will result in an error when loading through the portal or API. The provided error message should provide information indicating what reference is no longer valid and should be updated or removed before being loaded again. - Shared resources must exist before loading an OCL file into Octopus Deploy. What that means is if you copy the OCL files from one git repo to another, and point a new project at those files, then any shared resource must exist before creating that project. That only applies when projects are in different spaces or on different instances. If the resources do not exist, an error message will appear. - Pointing multiple projects to the same folder in the same git repo is unsupported. Please see our [unsupported config as code scenarios](/docs/projects/version-control/unsupported-config-as-code-scenarios) for more information. - Converting a project to be version-controlled is a one-way process. At this time, you cannot convert back.