Pod Template "Annotations" Field

README.md

@@ -72,6 +72,7 @@ Either way it provides access to the following fields:
 * **nodeSelector** The node selector of the pod.
 * **volumes** Volumes that are defined for the pod and are mounted by **ALL** containers.
 * **envVars*** Environment variables that are applied to **ALL** containers. 
+* **annotations** Annotations to apply to the pod.
 * **inheritFrom** List of one or more pod templates to inherit from *(more details below)*.
 
 The `containerTemplate` is a template of container that will be added to the pod. Again, its configurable via the user interface or via pipeline and allows you to set the following fields:
@@ -195,6 +196,10 @@ volumes: [
  hostPathVolume(mountPath: '/etc/mount4', hostPath: '/mnt/my-mount'),
  nfsVolume(mountPath: '/etc/mount5', serverAddress: '127.0.0.1', serverPath: '/', readOnly: true),
  persistentVolumeClaim(mountPath: '/etc/mount6', claimName: 'myClaim', readOnly: true)
+],
+annotations: [
+ podAnnotation(key: "my-key", value: "my-value")
+ ...
 ]) {
  ...
 }

src/main/java/org/csanchez/jenkins/plugins/kubernetes/PodAnnotation.java

@@ -3,6 +3,7 @@
 import hudson.Extension;
 import hudson.model.AbstractDescribableImpl;
 import hudson.model.Descriptor;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import java.io.Serializable;
@@ -37,6 +38,7 @@ public void setValue(String value) {
  }
 
  @Extension
+ @Symbol("podAnnotation")
  public static class DescriptorImpl extends Descriptor<PodAnnotation> {
  @Override
  public String getDisplayName() {

src/main/java/org/csanchez/jenkins/plugins/kubernetes/PodTemplate.java

@@ -82,7 +82,7 @@ public class PodTemplate extends AbstractDescribableImpl<PodTemplate> implements
 
  private final List<PodEnvVar> envVars = new ArrayList<PodEnvVar>();
 
- private final List<PodAnnotation> annotations = new ArrayList<PodAnnotation>();
+ private List<PodAnnotation> annotations = new ArrayList<PodAnnotation>();
 
  private final List<PodImagePullSecret> imagePullSecrets = new ArrayList<PodImagePullSecret>();
 
@@ -460,6 +460,11 @@ protected Object readResolve() {
  containerTemplate.setWorkingDir(remoteFs);
  containers.add(containerTemplate);
  }
+
+ if (annotations == null) {
+ annotations = new ArrayList<>();
+ }
+
  return this;
  }
 

src/main/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/PodTemplateStep.java

@@ -6,6 +6,7 @@
 import java.util.Set;
 
 import org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate;
+import org.csanchez.jenkins.plugins.kubernetes.PodAnnotation;
 import org.csanchez.jenkins.plugins.kubernetes.volumes.PodVolume;
 import org.csanchez.jenkins.plugins.kubernetes.volumes.workspace.WorkspaceVolume;
 import org.jenkinsci.plugins.workflow.steps.Step;
@@ -36,6 +37,7 @@ public class PodTemplateStep extends Step implements Serializable {
  private List<ContainerTemplate> containers = new ArrayList<>();
  private List<PodVolume> volumes = new ArrayList<PodVolume>();
  private WorkspaceVolume workspaceVolume;
+ private List<PodAnnotation> annotations = new ArrayList<>();
 
  private int instanceCap;
  private String serviceAccount;
@@ -142,6 +144,15 @@ public StepExecution start(StepContext context) throws Exception {
  return new PodTemplateStepExecution(this, context);
  }
 
+ public List<PodAnnotation> getAnnotations() {
+ return annotations;
+ }
+
+ @DataBoundSetter
+ public void setAnnotations(List<PodAnnotation> annotations) {
+ this.annotations = annotations;
+ }
+
  @Extension
  public static class DescriptorImpl extends StepDescriptor {
 

src/main/java/org/csanchez/jenkins/plugins/kubernetes/pipeline/PodTemplateStepExecution.java

@@ -59,6 +59,7 @@ public boolean start() throws Exception {
  newTemplate.setContainers(step.getContainers());
  newTemplate.setNodeSelector(step.getNodeSelector());
  newTemplate.setServiceAccount(step.getServiceAccount());
+ newTemplate.setAnnotations(step.getAnnotations());
 
  kubernetesCloud.addTemplate(newTemplate);
  getContext().newBodyInvoker().withContext(step).withCallback(new PodTemplateCallback(newTemplate)).start();

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/config.jelly

@@ -40,7 +40,7 @@
  <f:textbox/>
  </f:entry>
 
- <f:entry title="${%Annotations}" description="${%List of annotations to set in slave pod}">
+ <f:entry title="${%Annotations}" description="${%List of annotations to set in slave pod}" field="annotations">
  <f:repeatableHeteroProperty field="annotations" hasHeader="true" addCaption="Add Annotation"
  deleteCaption="Delete annotation Variable" />
  </f:entry>

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/help-annotations.html

@@ -0,0 +1,2 @@
+Annotations to set on pod metadata<br/>
+<a href="https://kubernetes.io/docs/user-guide/annotations/">https://kubernetes.io/docs/user-guide/annotations/</a>

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/PodTemplateStep/config.jelly

@@ -25,6 +25,11 @@
  deleteCaption="Delete Volume" />
  </f:entry>
 
+ <f:entry title="${%Annotations}" description="${%List of annotations to add to the pod metadata}" field="annotations">
+ <f:repeatableHeteroProperty field="annotations" hasHeader="true" addCaption="Add Annotation"
+ deleteCaption="Delete Annotation" />
+ </f:entry>
+
  <f:advanced>
  <f:entry field="instanceCap" title="${%Max number of instances}">
  <f:textbox default="0"/>

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/pipeline/PodTemplateStep/help-annotations.html

@@ -0,0 +1,2 @@
+Annotations to set on pod metadata<br/>
+<a href="https://kubernetes.io/docs/user-guide/annotations/">https://kubernetes.io/docs/user-guide/annotations/</a>