Add a dedicated helm values stanza for s3 attachments (#854)

Co-authored-by: Yevhen Ivantsov <[email protected]>
atlassian · Aug 9, 2024 · 94f47dd · 94f47dd
1 parent c52ab24
commit 94f47dd
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 7 deletions.
diff --git a/src/main/charts/jira/README.md b/src/main/charts/jira/README.md
@@ -106,9 +106,12 @@ Kubernetes: `>=1.21.x-0`
 | jira.resources.jvm.maxHeap | string | `"768m"` | The maximum amount of heap memory that will be used by the Jira JVM  |
 | jira.resources.jvm.minHeap | string | `"384m"` | The minimum amount of heap memory that will be used by the Jira JVM  |
 | jira.resources.jvm.reservedCodeCache | string | `"512m"` | The memory reserved for the Jira JVM code cache  |
-| jira.s3Storage.avatars.bucketName | string | `nil` |  |
-| jira.s3Storage.avatars.bucketRegion | string | `nil` |  |
-| jira.s3Storage.avatars.endpointOverride | string | `nil` |  |
+| jira.s3Storage.attachments.bucketName | string | `nil` | Bucket name to store attachments. If a bucket name and region (see below) are defined, Jira will automatically use AWS S3 to store attachments. Only bucket name is required, not the full arn. If you provide the same bucket name for both avatars and attachments, they will be stored in the same bucket  |
+| jira.s3Storage.attachments.bucketRegion | string | `nil` | AWS region where the S3 bucket is located.  |
+| jira.s3Storage.attachments.endpointOverride | string | `nil` | Override the default AWS API endpoint with a custom one  |
+| jira.s3Storage.avatars.bucketName | string | `nil` | Bucket name to store avatars. If a bucket name and region (see below) are defined, Jira will automatically use AWS S3 to store avatars. Only bucket name is required, not the full arn.  |
+| jira.s3Storage.avatars.bucketRegion | string | `nil` | AWS region where the S3 bucket is located.  |
+| jira.s3Storage.avatars.endpointOverride | string | `nil` | Override the default AWS API endpoint with a custom one  |
 | jira.securityContext.fsGroup | int | `2001` | The GID used by the Jira docker image GID will default to 2001 if not supplied and securityContextEnabled is set to true. This is intended to ensure that the shared-home volume is group-writeable by the GID used by the Jira container. However, this doesn't appear to work for NFS volumes due to a K8s bug: https://github.com/kubernetes/examples/issues/260  |
 | jira.securityContextEnabled | bool | `true` | Whether to apply security context to pod.  |
 | jira.seraphConfig | object | `{"autoLoginCookieAge":"1209600","generateByHelm":false}` | By default seraph-config.xml is generated in the container entrypoint from a template shipped with an official Jira image. However, seraph-config.xml generation may fail if container is not run as root, which is a common case if Jira is deployed to OpenShift.  |

diff --git a/src/main/charts/jira/templates/_helpers.tpl b/src/main/charts/jira/templates/_helpers.tpl
@@ -401,6 +401,16 @@ volumeClaimTemplates:
   value: {{ .Values.jira.s3Storage.avatars.endpointOverride | quote }}
 {{- end }}
 {{- end }}
+{{- if and .Values.jira.s3Storage.attachments.bucketName .Values.jira.s3Storage.attachments.bucketRegion }}
+- name: ATL_S3ATTACHMENTS_BUCKET_NAME
+  value: {{ .Values.jira.s3Storage.attachments.bucketName | quote }}
+- name: ATL_S3ATTACHMENTS_REGION
+  value: {{ .Values.jira.s3Storage.attachments.bucketRegion | quote }}
+{{- if .Values.jira.s3Storage.attachments.endpointOverride }}
+- name: ATL_S3ATTACHMENTS_ENDPOINT_OVERRIDE
+  value: {{ .Values.jira.s3Storage.attachments.endpointOverride | quote }}
+{{- end }}
+{{- end }}
 {{- end }}
 
 {{- define "jira.databaseEnvVars" -}}

diff --git a/src/main/charts/jira/values.yaml b/src/main/charts/jira/values.yaml
@@ -648,22 +648,37 @@ jira:
     #
     localHomeSubPath: "log"
 
-  # Use AWS S3 to store avatars. From Jira 9.9 onwards.
+  # Use AWS S3 to store avatars and attachments. From Jira 9.9 onwards.
   #
 
   s3Storage:
 
     avatars:
-      # Bucket name to store avatars. If a bucket name and region (see below) are defined, Jira will automatically
+      # -- Bucket name to store avatars. If a bucket name and region (see below) are defined, Jira will automatically
       # use AWS S3 to store avatars. Only bucket name is required, not the full arn.
       #
       bucketName:
 
-      # AWS region where the S3 bucket is located.
+      # -- AWS region where the S3 bucket is located.
       #
       bucketRegion:
 
-      # Override the default AWS API endpoint with a custom one
+      # -- Override the default AWS API endpoint with a custom one
+      #
+      endpointOverride:
+
+    attachments:
+      # -- Bucket name to store attachments. If a bucket name and region (see below) are defined, Jira will automatically
+      # use AWS S3 to store attachments. Only bucket name is required, not the full arn.
+      # If you provide the same bucket name for both avatars and attachments, they will be stored in the same bucket
+      #
+      bucketName:
+
+      # -- AWS region where the S3 bucket is located.
+      #
+      bucketRegion:
+
+      # -- Override the default AWS API endpoint with a custom one
       #
       endpointOverride:
 

diff --git a/src/test/resources/expected_helm_output/jira/output.yaml b/src/test/resources/expected_helm_output/jira/output.yaml
@@ -180,6 +180,10 @@ data:
           minHeap: 384m
           reservedCodeCache: 512m
       s3Storage:
+        attachments:
+          bucketName: null
+          bucketRegion: null
+          endpointOverride: null
         avatars:
           bucketName: null
           bucketRegion: null