Add support of audit logs configurations

TykTechnologies · Nov 7, 2024 · 7dfe7cb · 7dfe7cb
1 parent 214b8d0
commit 7dfe7cb
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 2 deletions.
diff --git a/components/tyk-dashboard/templates/deployment-dashboard.yaml b/components/tyk-dashboard/templates/deployment-dashboard.yaml
@@ -83,7 +83,6 @@ spec:
         {{- toYaml .Values.dashboard.containerSecurityContext | nindent 12 }}
         {{- end }}
         env:
-          ## DEFAULT TYK DASHBOARD CONFIGURATION
           - name: "TYK_DB_ENABLEOWNERSHIP"
             value: "{{ .Values.dashboard.enableOwnership }}"
           - name: "TYK_DB_PAGESIZE"
@@ -128,7 +127,6 @@ spec:
             value: "{{ .Values.dashboard.enableHashedKeysListing }}"
           - name: "TYK_DB_ENABLEMULTIORGUSERS"
             value: "{{ .Values.dashboard.enableMultiOrgUsers }}"
-          ## DEFAULT TYK CONFIGURATION END
           - name: TYK_DB_LISTENPORT
             value: "{{ .Values.dashboard.containerPort }}"
           - name: TYK_DB_OAS_VALIDATE_EXAMPLES
@@ -221,6 +219,19 @@ spec:
             value: "{{ .Values.dashboard.hostName }}"
           - name: "TYK_DB_ENABLEAGGREGATELOOKUPS"
             value: "{{ .Values.dashboard.enableAggregateLookups }}"
+          {{ if (.Values.dashboard.auditLogs).enabled }}
+          - name: TYK_DB_AUDIT_ENABLED
+            value: "{{ .Values.dashboard.auditLogs.enabled }}"
+          - name: TYK_DB_AUDIT_TYPE
+            value: "{{ .Values.dashboard.auditLogs.type }}"
+          - name: TYK_DB_AUDIT_FORMAT
+            value: "{{ .Values.dashboard.auditLogs.format }}"
+          - name: TYK_DB_AUDIT_PATH
+            value: "{{ .Values.dashboard.auditLogs.path }}"
+          - name: TYK_DB_AUDIT_DETAILEDRECORDING
+            value: "{{ .Values.dashboard.auditLogs.enableDetailedRecording }}"
+          {{ end }}
+
           {{ if eq "postgres" (include "tyk-dashboard.storageType" .) }}
           - name: TYK_DB_STORAGE_MAIN_TYPE
             value: "postgres"

diff --git a/components/tyk-dashboard/values.yaml b/components/tyk-dashboard/values.yaml
@@ -272,6 +272,25 @@ dashboard:
   # Enable support for users with the same email for multiple organisations
   # It is used to set TYK_DB_ENABLEMULTIORGUSERS
   enableMultiOrgUsers: true
+  # Configuration for Audit logs
+  auditLogs:
+    # Enables audit logging.
+    # It is used to set TYK_DB_AUDIT_ENABLED
+    enabled: true
+    # Allow users to configure how dashboard store the audit logs.
+    # Possible values are db and file.
+    # It is used to set TYK_DB_AUDIT_TYPE
+    type: "file"
+    # Format of audit log file. Possible values are json and text
+    # It is used to set TYK_DB_AUDIT_FORMAT
+    format: "text"
+    # Path to the audit log
+    # It is used to set TYK_DB_AUDIT_PATH
+    path: ""
+    # Enables detailed records in the audit log.
+    # If set to true then audit log records will contain the http-request (without body) and full http-response including the body.
+    # It is used to set TYK_DB_AUDIT_DETAILEDRECORDING
+    enableDetailedRecording: false
 
   # replicaCount specifies number of replicas to be created if kind is Deployment.
   replicaCount: 1

diff --git a/tyk-control-plane/values.yaml b/tyk-control-plane/values.yaml
@@ -1062,6 +1062,24 @@ tyk-dashboard:
     # Enable support for users with the same email for multiple organisations
     # It is used to set TYK_DB_ENABLEMULTIORGUSERS
     enableMultiOrgUsers: true
+    auditLogs:
+    # Enables audit logging.
+    # It is used to set TYK_DB_AUDIT_ENABLED
+    enabled: true
+    # Allow users to configure how dashboard store the audit logs.
+    # Possible values are db and file.
+    # It is used to set TYK_DB_AUDIT_TYPE
+    type: "file"
+    # Format of audit log file. Possible values are json and text
+    # It is used to set TYK_DB_AUDIT_FORMAT
+    format: "text"
+    # Path to the audit log
+    # It is used to set TYK_DB_AUDIT_PATH
+    path: ""
+    # Enables detailed records in the audit log.
+    # If set to true then audit log records will contain the http-request (without body) and full http-response including the body.
+    # It is used to set TYK_DB_AUDIT_DETAILEDRECORDING
+    enableDetailedRecording: false
 
 
     # replicaCount specifies number of replicas to be created if kind is Deployment.

diff --git a/tyk-stack/values.yaml b/tyk-stack/values.yaml
@@ -1057,6 +1057,25 @@ tyk-dashboard:
     # Enable support for users with the same email for multiple organisations
     # It is used to set TYK_DB_ENABLEMULTIORGUSERS
     enableMultiOrgUsers: true
+    auditLogs:
+      # Enables audit logging.
+      # It is used to set TYK_DB_AUDIT_ENABLED
+      enabled: true
+      # Allow users to configure how dashboard store the audit logs.
+      # Possible values are db and file.
+      # It is used to set TYK_DB_AUDIT_TYPE
+      type: "file"
+      # Format of audit log file. Possible values are json and text
+      # It is used to set TYK_DB_AUDIT_FORMAT
+      format: "text"
+      # Path to the audit log
+      # It is used to set TYK_DB_AUDIT_PATH
+      path: ""
+      # Enables detailed records in the audit log.
+      # If set to true then audit log records will contain the http-request (without body) and full http-response including the body.
+      # It is used to set TYK_DB_AUDIT_DETAILEDRECORDING
+      enableDetailedRecording: false
+
 
     # replicaCount specifies number of replicas to be created if kind is Deployment.
     replicaCount: 1