Adds support for ScriptPods having configurable Annotations (#1071)

* Adds support for ScriptPods having configurable Annotations (#1070)

---------

Co-authored-by: Alastair Pitts <[email protected]>

Author: seanson

README.md

@@ -101,7 +101,7 @@ Currently we can only debug netcore apps running in WSL from VSCode, Visual Stud
 ```
 ## Debugging the Kubernetes Agent Tentacle
 
-The Kubernetes Agent Tentacle is a bit more complex to debug, as it normally runs inside a Kubernetes Pod. To debug it locally, you can run the `setup-k8s-agent-for-local-debug.sh` script in the root of this repo which will guide you through the process of installing a specially configured kind cluster, deploying the agent to it and then scaling back the installed agent so you can run a local copy to take it's place.
+The Kubernetes Agent Tentacle is more complex to debug, as it normally runs inside a Kubernetes Pod. To debug it locally, you can run the `setup-k8s-agent-for-local-debug.sh` script in the root of this repo which will guide you through the process of installing a specially configured kind cluster, deploying the agent to it and then scaling back the installed agent so you can run a local copy to take it's place.
 
 NOTE: This script has only been tested on MacOS so far and requires Docker Desktop, Kubectl, Go CLI and Kind to be installed. It is also only for the Kubernetes Agent Tentacle running as a Deployment Target, not as a Worker.
 

source/Octopus.Tentacle/Kubernetes/KubernetesConfig.cs

@@ -64,7 +64,10 @@ public static class KubernetesConfig
 
         public static readonly string PodSecurityContextJsonVariableName = $"{EnvVarPrefix}__PODSECURITYCONTEXTJSON";
         public static string? PodSecurityContextJson => Environment.GetEnvironmentVariable(PodSecurityContextJsonVariableName);
-        
+
+        public static readonly string PodAnnotationsJsonVariableName = $"{EnvVarPrefix}__PODANNOTATIONSJSON";
+        public static string? PodAnnotationsJson => Environment.GetEnvironmentVariable(PodAnnotationsJsonVariableName);
+
         public static readonly string TentacleConfigMapNameVariableName = $"{EnvVarPrefix}__TENTACLECONFIGMAPNAME";
         public static string TentacleConfigMapName => GetEnvironmentVariableOrDefault(TentacleConfigMapNameVariableName, "tentacle-config");
 
@@ -109,7 +112,7 @@ public static string[] ServerCommsAddresses
         static string GetRequiredEnvVar(string variable, string errorMessage)
             => Environment.GetEnvironmentVariable(variable)
                 ?? throw new InvalidOperationException($"{errorMessage} The environment variable '{variable}' must be defined with a non-null value.");
-        
+
         static string GetEnvironmentVariableOrDefault(string variable, string defaultValue)
             => Environment.GetEnvironmentVariable(variable) ?? defaultValue;
     }

source/Octopus.Tentacle/Kubernetes/KubernetesScriptPodCreator.cs

@@ -80,7 +80,7 @@ public async Task CreatePod(StartKubernetesScriptCommandV1 command, IScriptWorks
             {
                 //Write the log encryption key here
                 await scriptPodLogEncryptionKeyProvider.GenerateAndWriteEncryptionKeyfileToWorkspace(command.ScriptTicket, cancellationToken);
-                
+
                 //Possibly create the image pull secret name
                 var imagePullSecretName = await CreateImagePullSecret(command, cancellationToken);
 
@@ -188,7 +188,7 @@ async Task CreatePod(StartKubernetesScriptCommandV1 command, IScriptWorkspace wo
                 .WhereNotNull()
                 .Select(secretName => new V1LocalObjectReference(secretName))
                 .ToList();
-             
+
             var pod = new V1Pod
             {
                 Metadata = new V1ObjectMeta
@@ -199,7 +199,8 @@ async Task CreatePod(StartKubernetesScriptCommandV1 command, IScriptWorkspace wo
                     {
                         ["octopus.com/serverTaskId"] = command.TaskId,
                         ["octopus.com/scriptTicketId"] = command.ScriptTicket.TaskId
-                    }
+                    },
+                    Annotations = ParseScriptPodAnnotations(tentacleScriptLog)
                 },
                 Spec = new V1PodSpec
                 {
@@ -406,6 +407,13 @@ V1Affinity ParseScriptPodAffinity(InMemoryTentacleScriptLog tentacleScriptLog)
                 KubernetesConfig.PodSecurityContextJsonVariableName,
                 "pod security context");
 
+        Dictionary<string, string>? ParseScriptPodAnnotations(InMemoryTentacleScriptLog tentacleScriptLog)
+            => ParseScriptPodJson<Dictionary<string, string>>(
+                tentacleScriptLog,
+                KubernetesConfig.PodAnnotationsJson,
+                KubernetesConfig.PodAnnotationsJsonVariableName,
+                "pod annotations");
+
         [return: NotNullIfNotNull("defaultValue")]
         T? ParseScriptPodJson<T>(InMemoryTentacleScriptLog tentacleScriptLog, string? json, string envVarName, string description, T? defaultValue = null) where T : class
         {