Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support of audit logs configurations #356

Merged
merged 8 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion components/tyk-dashboard/templates/deployment-dashboard.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -225,6 +224,21 @@ 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_STORETYPE
value: "{{ .Values.dashboard.auditLogs.type }}"
{{ if eq "file" (.Values.dashboard.auditLogs).type }}
- name: TYK_DB_AUDIT_FORMAT
value: "{{ .Values.dashboard.auditLogs.format }}"
- name: TYK_DB_AUDIT_PATH
value: "{{ .Values.dashboard.auditLogs.path }}"
{{ end }}
- 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"
Expand Down
19 changes: 19 additions & 0 deletions components/tyk-dashboard/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,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: false
# Allow users to configure how dashboard store the audit logs.
# Possible values are db and file.
# It is used to set TYK_DB_AUDIT_STORETYPE
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
opa:
# Enables OPA support.
# It is used to set TYK_DB_SECURITY_OPENPOLICY_ENABLED
Expand Down
19 changes: 18 additions & 1 deletion tyk-control-plane/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1095,6 +1095,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: false
# Allow users to configure how dashboard store the audit logs.
# Possible values are db and file.
# It is used to set TYK_DB_AUDIT_STORETYPE
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
opa:
# Enables OPA support.
# It is used to set TYK_DB_SECURITY_OPENPOLICY_ENABLED
Expand All @@ -1110,7 +1128,6 @@ tyk-dashboard:
# It is used to set TYK_DB_SECURITY_ALLOWADMINRESETPASSWORD
allowAdminPasswordReset: true


# replicaCount specifies number of replicas to be created if kind is Deployment.
replicaCount: 1

Expand Down
20 changes: 19 additions & 1 deletion tyk-stack/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1107,6 +1107,24 @@
# 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: false
# Allow users to configure how dashboard store the audit logs.
# Possible values are db and file.
# It is used to set TYK_DB_AUDIT_STORETYPE
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
# Manage dashboard API Open Policy Agent(OPA) support
opa:
# Enables OPA support.
Expand All @@ -1122,7 +1140,7 @@
# to avoid bootstrap job failure because of the OPA policy restrictions.
# It is used to set TYK_DB_SECURITY_ALLOWADMINRESETPASSWORD
allowAdminPasswordReset: true

Check failure on line 1143 in tyk-stack/values.yaml

View workflow job for this annotation

GitHub Actions / lint-test

[trailing-spaces] trailing spaces
# replicaCount specifies number of replicas to be created if kind is Deployment.
replicaCount: 1

Expand Down
Loading