Skip to main content
Version: Spectra Detect 6.2.0

SDM Portal Secrets and ConfigMap values

Secrets

Custom NameDefault NameTypeDescriptionUsed in Components (Pods)
<global.secrets.tiCloud.customSecretName><release_name>-secret-sdm-cloudRequired when related feature is enabledBasic authentication secret which contains username and password for Spectra Intelligence authentication. Required when Spectra Intelligence is enabled (config.ticloud.enabled). Secret is either created manually (sdm-portal chart) or already exists.Portal, Celery, DCS
<global.secrets.tiCloudProxy.customSecretName><release_name>-secret-sdm-cloud-proxyOptionalBasic authentication secret which contains username and password for Spectra Intelligence proxy authentication. Secret is either created manually (sdm-portal chart) or already exists.Portal, Celery
<global.secrets.oidc.customSecretName><release_name>-secret-sdm-oidcRequired when related feature is enabled (config.oidc.enabled)Opaque secret which contains rp_client_id and rp_client_secret for OIDC authentication. Required when OIDC authentication is enabled (config.oidc.enabled). Secret is either created manually (sdm-portal chart) or already exists.Portal, Celery
<global.secrets.ldap.credentials.customSecretName><release_name>-secret-sdm-ldapRequired when related feature is enabledOpaque secret which contains bind_dn and bind_password for LDAP authentication. Required when LDAP authentication is enabled (config.ldap.enabled). Secret is either created manually (sdm-portal chart) or already exists.Portal
<global.secrets.ldap.cacert.customSecretName><release_name>-secret-sdm-ldap-cacertRequired when related feature is enabledOpaque secret which contains CA certificate for LDAP authentication. Required when LDAP authentication is enabled, and TLS features are enabled (config.ldap.enabled and config.ldap.tls and config.ldap.tlsRequireCert). Secret is either created manually (sdm-portal chart) or already exists.Portal
<global.secrets.ldap.cert.customSecretName><release_name>-secret-sdm-ldap-certRequired when related feature is enabledOpaque secret which contains TLS certificate for LDAP server. Required when LDAP authentication is enabled and TLS features are enabled (config.ldap.enabled and config.ldap.tls and config.ldap.tlsRequireCert). Secret is either created manually (sdm-portal chart) or already exists.Portal
<global.secrets.saml.customSecretName><release_name>-secret-sdm-saml-metadataRequired when related feature is enabledOpaque secret which contains SAML federation metadata. Required when SAML authentication is enabled (config.saml.enabled). Secret is either created manually (sdm-portal chart) or already exists.Portal

Values

Secret Configuration

KeyTypeDefaultDescription
secretsobject-Secret configuration values for Spectra Detect Portal
secrets.ldapobject-LDAP secret configuration values
secrets.ldap.cacertobject-Secret containing PEM encoded file with CA certificate under the ca.pem key.
secrets.ldap.cacert.caCertificatestringnilLDAP CA certificate in PEM format. Creates a Secret with the ca.pem key. Can be set with --set-file secrets.ldap.cacert.caCertificate=/path/to/file/ca_certificate.pem.
secrets.ldap.cacert.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the caCertificate value parameters. WARNING: Use this for convenience/testing only.
secrets.ldap.certobject-Secret containing PEM encoded certificate for client authentication PEM under the cert.pem key.
secrets.ldap.cert.certificatestringnilLDAP client certificate in PEM format. Creates a Secret with the cert.pem key. Can be set with --set-file secrets.ldap.cert.certificate=/path/to/file/certificate.pem.
secrets.ldap.cert.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the certificate value parameters. WARNING: Use this for convenience/testing only.
secrets.ldap.credentialsobject-Secret containing LDAP bind (bindDn and bindPassword) credentials.
secrets.ldap.credentials.bindDnstring""LDAP Bind DN. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.
secrets.ldap.credentials.bindPasswordstring""LDAP Bind Password. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.
secrets.ldap.credentials.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the bindDn and bindPassword parameters. WARNING: Use this for convenience/testing only.
secrets.oidcobject-Secret configuration values for setting the OIDC client credentials.
secrets.oidc.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the rpClientId and rpClientSecret parameters. WARNING: Use this for convenience/testing only.
secrets.oidc.rpClientIdstring""OpenID Connect client ID provided by OpenID Connect provider. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.
secrets.oidc.rpClientSecretstring""OpenID Connect client secret provided by OpenID Connect provider. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.
secrets.samlobject-Secret configuration values for setting the SAML integration.
secrets.saml.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the metadata value. WARNING: Use this for convenience/testing only.
secrets.saml.metadatastringnilSAML federation metadata XML. Creates a Secret with the metadata.xml key. Can be set with --set-file secrets.saml.metadata=/path/to/file/metadata.xml.
secrets.tiCloudobject-Secret configuration values for setting the Spectra Intelligence.
secrets.tiCloud.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the username and password parameters. WARNING: Use this for convenience/testing only.
secrets.tiCloud.passwordstring""Spectra Intelligence password. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.
secrets.tiCloud.usernamestring""Spectra Intelligence username. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.
secrets.tiCloudProxyobject-Secret configuration values for setting the Spectra Intelligence credentials when proxy is used.
secrets.tiCloudProxy.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the username and password parameters. WARNING: Use this for convenience/testing only.
secrets.tiCloudProxy.passwordstring""Cloud proxy password. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.
secrets.tiCloudProxy.usernamestring""Cloud proxy username. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive credentials in configuration files that are committed to Git. Consider using a dedicated secret management solution (e.g., Sealed Secrets, External Secrets, or Vault) for production environments.

Kubernetes Settings

KeyTypeDefaultDescription
affinityobject{}Affinity for pod scheduling. Allows to constrain which nodes your pod can be scheduled on based on node labels or ensure pods are co-located (or isolated) from other pods.
imagePullSecretslist[{"name":"rl-registry-key"}]Set of stored credentials (authentication tokens) that allows Kubernetes node to "log in" to a private container registry to pull restricted images. Each item must be an object with a 'name' key.
ingressobject-Ingress configuration values.
ingress.annotationsobject{}Custom annotations to fine-tune the Ingress Controller behavior.
ingress.classNamestring"nginx"IngressClass that will handle this resource. Must match an existing 'IngressClass' in the cluster.
ingress.enabledbooltrueEnable/disable the creation of the Ingress resource.
ingress.hoststring""The Fully Qualified Domain Name (FQDN) for the application. Required if 'enabled' is true.
ingress.paths[n]object-A list of paths for this host. Each path must have a path and a pathType. For the root path, use "/" with pathType "Prefix".
ingress.paths[n].pathstring"/"The URL path that this rule applies to. A single forward slash (/) represents the root or "catch-all" path.
ingress.paths[n].pathTypestring"Prefix"Determines how the Ingress controller matches the URL path. 'Prefix' matches based on a URL path prefix split by '/'. This is the most common and flexible setting for web applications.
ingress.tlsobject-TLS / SSL Configuration.
ingress.tls.certificateArnstring""The Amazon Resource Name (ARN) of the certificate for AWS Load Balancer Controller. Only applicable when 'className' is 'alb'.
ingress.tls.issuerstring""The name of the cert-manager ClusterIssuer or Issuer to request certificates from.
ingress.tls.issuerKindstring"Issuer"The resource type of the issuer. Typically, 'Issuer' (namespace-scoped) or 'ClusterIssuer' (cluster-wide).
nodeSelectorobject{}Node labels for pod assignment. Pods will only be scheduled to nodes that match all labels defined here.
rbacobject-RBAC resource configuration values.
rbac.createbooltrueSpecifies whether Role and RoleBinding resources should be created.
serviceAccountobject-Service Account configuration values.
serviceAccount.annotationsobject{}Additional annotations to add to the ServiceAccount.
serviceAccount.createbooltrueSpecifies whether a ServiceAccount should be created. If false, an existing ServiceAccount name should be provided in name variable.
serviceAccount.namestringnilThe name of the ServiceAccount to use. If not set and create is true, default account name is used.
useReloaderstringnilWhether to enable Reloader annotations. When defined, this value takes precedence over global.useReloader.

Application Configuration

KeyTypeDefaultDescription
configobject-SDM Portal configuration values.
config.centralConfigobject-Configure Central Configuration.
config.centralConfig.enabledbooleantrueEnable/disable central configuration feature.
config.centralFileStorageobject-Configure file storage in Spectra Detect Manager, allowing connected Workers to store samples for pivoting to and reprocessing in Spectra Analyze.
config.centralFileStorage.enabledbooleanfalseEnable/disable file storage.
config.centralFileStorage.fileSizeLimitint400File size limit in MiB. Samples larger than the set threshold will not be stored. Minimum: 1. Maximum: 400.
config.centralFileStorage.ttlint24Sample retention period in hours after which the uploaded samples will be removed from the Central File Storage. Minimum: 1. Maximum: 2160.
config.centralLoggingobject-Configure Central Logging, which is used to collect and display information about all events happening on connected Workers and Integrations.
config.centralLogging.enabledboolfalseEnable/disable central logging.
config.centralLogging.retentionPeriodint90Retention period in days. Minimum: 1. Maximum: 540.
config.classificationChangesobject-Monitor classification changes from Spectra Intelligence directly on the Spectra Detect Dashboard.
config.classificationChanges.enabledboolfalseSubscribe to classification changes.
config.deepCloudAnalysisobject-Configure Deep Cloud Analysis. This uploads files to Spectra Intelligence for scanning with multiple AV engines, refining the final verdict (classification), risk score, and threat name. Depending on the configuration, this may increase processing load and require additional resources.
config.deepCloudAnalysis.enabledboolfalseEnable/disable Deep Cloud Analysis.
config.deepCloudAnalysis.scanner1string""AV scanner results to display in the Detections Overview preview.
config.deepCloudAnalysis.scanner2string""AV scanner results to display in the Detections Overview preview.
config.deepCloudAnalysis.scanner3string""AV scanner results to display in the Detections Overview preview.
config.deepCloudAnalysis.scanner4string""AV scanner results to display in the Detections Overview preview.
config.deepCloudAnalysis.scanner5string""AV scanner results to display in the Detections Overview preview.
config.rlappobject-General SDM Portal configuration.
config.rlapp.allowedHostslist[]A list of host/domain names that this application site can serve.
config.rlapp.sessionCookieAgeint604800Duration of the login session, in seconds. Minimum: 60 (1 minute). Maximum: 7776000 (90 days).
config.rlapp.sessionTimeoutAutomaticallyLogoutboolfalseIf true, automatically log out inactive users.
config.rlapp.sessionTimeoutPeriodint600Period of inactivity before sign out, in seconds. Minimum: 60 (1 minute). Maximum: 2592000 (30 days).
config.smtpobject-SMTP Settings.
config.smtp.defaultFromEmailstring"online@reversinglabs.com"Default email address to use for automated correspondence.
config.syncobject-Synchronization settings.
config.sync.yaraRulesetsEnabledbooleanfalseAllow connected appliances to synchronize YARA rulesets.
config.ticloudobject-Spectra Intelligence settings.
config.ticloud.enabledbooleanfalseEnable Spectra Intelligence.
config.ticloud.proxyHoststring""Proxy hostname for routing requests from the appliance to Spectra Intelligence.
config.ticloud.proxyPortinteger25Proxy port number. Minimum: 0. Maximum: 65535.
config.ticloud.timeoutinteger60Specifies how long to wait before the Spectra Intelligence connection times out. Minimum: 1. Maximum: 1000.

Application Configuration - LDAP

KeyTypeDefaultDescription
config.ldapobject-Settings for LDAP authentication.
config.ldap.denyGroupstring""Authentication will fail for any user that belongs to this group.
config.ldap.enabledbooleanfalseEnable/disable LDAP authentication.
config.ldap.groupSchemaClassstring"group"The objectClass value used when searching for groups.
config.ldap.groupSchemaNameAttrstring"cn"The group name field.
config.ldap.groupSchemaTypestring"member"Group schema type. Allowed values: uniqueMember and member.
config.ldap.groupSearchBaseDnstring""Root node in LDAP from which to search for groups. Example: 'cn=users,dc=example,dc=com'.
config.ldap.groupSearchScopeinteger2Scope. Allowed values: 0 (Base), 1 (One level), 2 (Subtree), 3 (Subordinate).
config.ldap.hoststring""Hostname or IP of the server running LDAP.
config.ldap.portinteger389LDAP server port. Minimum: 0. Maximum: 65535.
config.ldap.requireGroupstring""Authentication will fail for any user that does not belong to this group. Example: 'cn=enabled,ou=groups,dc=example,dc=com'
config.ldap.tlsbooleantrueIf true, use Transport Layer Security (TLS) connection.
config.ldap.tlsRequireCertbooleanfalseIf true, TLS certificate is required.
config.ldap.userAttrMapEmailstring"mail"Field to map to the email address.
config.ldap.userAttrMapFirstNamestring"givenName"Field to map to the first name.
config.ldap.userAttrMapLastNamestring"sn"Field to map to the last name.
config.ldap.userFlagsByGroupIsActivestring""Users will be marked as active only if they belong to this group. Example: 'cn=active,ou=users,dc=example,dc=com'.
config.ldap.userFlagsByGroupIsSuperuserstring""Users will be marked as superusers only if they belong to this group. Example: 'cn=admins,ou=groups,dc=example,dc=com'.
config.ldap.userSchemaClassstring"user"The objectClass value used when searching for users.
config.ldap.userSchemaNameAttrstring"sAMAccountName"The username field. Examples: 'sAMAccountName' or 'cn'.
config.ldap.userSearchBaseDnstring""Root node in LDAP from which to search for users. Example: 'cn=users,dc=example,dc=com.'
config.ldap.userSearchScopeinteger2Scope. Allowed values: 0 (Base), 1 (One level), 2 (Subtree), 3 (Subordinate).

Application Configuration - OIDC

KeyTypeDefaultDescription
config.oidcobject-Configure authentication with an OpenID Connect client.
config.oidc.accessDenyGroupstring""Authentication will fail for any user that belongs to one or more of the provided group(s). Use the access groups delimiter to separate multiple group names.
config.oidc.accessRequireGroupstring""Authentication will fail for any user that does not belong to one or more of the provided group(s). Use the access groups delimiter to separate multiple group names.
config.oidc.audiencestring""Identifies the intended recipient of the token.
config.oidc.claimsSourcestring"ID_TOKEN"Source used to extract user claims. Allowed values: ID_TOKEN, USER_INFO_ENDPOINT, ACCESS_TOKEN.
config.oidc.clientTypestring"CONFIDENTIAL"Authenticate with client secret (CONFIDENTIAL) or without (PUBLIC).
config.oidc.enabledbooleanfalseEnable/disable authentication with OIDC.
config.oidc.issuerstring""Issuer.
config.oidc.mapClaimAccessGroupsDelimiterstring""Character to split the User Access Groups on. Optional. The maximum length of the delimiter is 2 characters. These characters must not be used in any access group name.
config.oidc.mapClaimEmailstring"email"The claim containing the unique email address.
config.oidc.mapClaimFirstNamestring"given_name"The claim containing the user's first name.
config.oidc.mapClaimGroupsstring"group"The claim containing the list of user's groups.
config.oidc.mapClaimGroupsDelimiterstring""Character to split the Groups string on. Optional.
config.oidc.mapClaimLastNamestring"family_name"The claim containing the user's last name.
config.oidc.mapClaimUsernamestring"unique_name"The claim containing the unique username.
config.oidc.opAuthorizationEndpointstring""URL of your OpenID Connect provider authorization endpoint.
config.oidc.opJwksEndpointstring""URL of your OpenID Connect provider JWKS endpoint.
config.oidc.opTokenEndpointstring""URL of your OpenID Connect provider token endpoint.
config.oidc.opUserEndpointstring""URL of your OpenID Connect provider userinfo endpoint.
config.oidc.pkceEnabledbooleanfalseIf true, use PKCE (Proof Key of Code Exchange) to prevent auth code interception.
config.oidc.promptLoginbooleanfalseIf true, require the authorization server to reauthenticate the user even if the user is already authenticated.
config.oidc.relyingPartIdstring""Relying Party ID.
config.oidc.rpIdpSignKeystring""The key used to sign ID tokens when using an RSA sign algorithm.
config.oidc.rpScopesstring"openid allatclaims"The OpenID Connect scopes to request during login.
config.oidc.rpSignAlgostring"RS256"Signature algorithm. Allowed values: RS256 and HS256.
config.oidc.timeoutint30Timeout in seconds for OIDC HTTP requests. Should be less than uwsgi harakiri timeout (default 60s).
config.oidc.userFlagsByGroupIsActivestring""Users will be marked as active only if they belong to one or more of the provided group(s). Use the access group delimiter to separate multiple group names.
config.oidc.userFlagsByGroupIsSuperuserstring""Users will be marked as superusers only if they belong to one or more of the provided group(s). Use the access groups delimiter to separate multiple group names.
config.oidc.verifySslbooleantrueControls whether the OpenID Connect client verifies the SSL certificate of the OP responses.

Application Configuration - SAML

KeyTypeDefaultDescription
config.samlobject-Configure authentication with SAML.
config.saml.accessDenyGroupstring""Authentication will fail for any user that belongs to one or more of the provided group(s). Use the access groups delimiter to separate multiple group names.
config.saml.accessRequireGroupstring""Authentication will fail for any user that does not belong to one or more of the provided group(s). Use the access groups delimiter to separate multiple group names.
config.saml.allowUnsolicitedboolfalseAllow unsolicited responses from IdP.
config.saml.enabledbooleanfalseEnable/disable SAML authentication.
config.saml.entityIdstring""Entity ID.
config.saml.mapClaimAccessGroupsDelimiterstring""Character to split the User Access Groups on. Optional. The maximum length of the delimiter is 2 characters. These characters must not be used in any access group name.
config.saml.mapClaimEmailstring"email"The claim containing the unique email address.
config.saml.mapClaimFirstNamestring"given_name"The claim containing the user's first name.
config.saml.mapClaimGroupsstring"group"The claim that contains the list of user's groups.
config.saml.mapClaimGroupsDelimiterstring""Character to split the Groups string on. Optional.
config.saml.mapClaimLastNamestring"family_name"The claim containing the user's last name.
config.saml.mapClaimUsernamestring"unique_name"The claim containing the unique username.
config.saml.userFlagsByGroupIsActivestring""Users will be marked as active only if they belong to one or more of the provided group(s). Use the access groups delimiter to separate multiple group names.
config.saml.userFlagsByGroupIsSuperuserstring""Users will be marked as superusers only if they belong to one or more of the provided group(s). Use the access groups delimiter to separate multiple group names.

Pod Settings

KeyTypeDefaultDescription
autoscalingobject-Autoscaling configuration values.
autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
autoscaling.enabledboolfalseEnable/disable autoscaling.
autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling in enabled.
autoscaling.minReplicasint1Minimum number of replicas that need to be deployed.
autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
autoscaling.scaleDownobject-ScaleDown configuration values.
autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
autoscaling.scaleUpobject-ScaleUp configuration values.
autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
autoscaling.scaleUp.stabilizationWindowint15Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
autoscaling.triggerCPUValueint75CPU value (in percentage), which will cause scaling when reached. The percentage is taken from the resource.limits.cpu value. Limits have to be set up.
imageobject-Configuration values of the SDM Portal image.
image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
image.tagstring"6.2.0-34"Image tag.
registryobject-Registry configuration values used by SDM Portal.
registry.customSecretNamestringnilCustom secret name for the registry credentials secret. When deployed with an umbrella chart, this value is ignored, and global.registryCredentialsCustomSecretName value is used. If not set, the default secret name rl-registry-credentials will be used.
replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
resourcesobject-Resource requests and limits for the container.
resources.limitsobject-The maximum amount of resources the container is allowed to consume.
resources.limits.cpustring"3000m"CPU limit. Throttling occurs if the container exceeds this value.
resources.limits.memorystring"4Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
resources.requestsobject-The minimum amount of resources the container is guaranteed.
resources.requests.cpustring"2000m"CPU request.
resources.requests.memorystring"2Gi"Memory request.
utilitiesImageobject-Configuration values of the utilities image used by SDM Portal.
utilitiesImage.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
utilitiesImage.tagstring"6.2.0-14"Image tag.