Skip to main content
Version: Spectra Detect 6.2.0

Processing Secrets and ConfigMap Values

Secrets

Custom NameDefault NameTypeDescriptionUsed in deployments (Pods)
<secrets.api.customSecretName><release_name>-secret-worker-api-tokenOptionalToken secret which contains token that is used to protect all endpoints with /api/ prefix, e.g. file upload.Auth
<secrets.apiTask.customSecretName><release_name>-secret-worker-api-task-tokenOptionalToken secret which contains token that is used to protect /api/tiscale/v1/task endpoints. If left empty, the mentioned API is protected by <release_name>-secret-worker-api-tokenAuth
<secrets.cloud.customSecretName><release_name>-secret-worker-cloudRequired when related feature is enabledBasic authentication secret which contains username and password for Spectra Intelligence authentication. Required when Spectra Intelligence is enabled (configuration.cloud.enabled).Processor, Retry Processor, Preprocessor, Postprocessor, Receiver
<secrets.cloudProxy.customSecretName><release_name>-secret-worker-cloud-proxyRequired when related feature is enabledBasic authentication secret which contains username and password for Spectra Intelligence Proxy authentication. Required when Spectra Intelligence Proxy is enabled (configuration.cloud.proxy.enabled).Processor, Retry processor, Preprocessor, Postprocessor, Receiver, Cloud Cache
<secrets.aws.customSecretName><release_name>-secret-worker-awsRequired when related feature is enabledBasic authentication secret which contains username and password for AWS authentication. Required if any type of S3 storage (File, SNS, Report, Unpacked) is enabled (configuration.s3.enabled, configuration.sns.enabled, configuration.reportS3.enabled, configuration.unpackedS3.enabled)Postprocessor
<secrets.azure.customSecretName><release_name>-secret-worker-azureRequired when related feature is enabledBasic authentication secret which contains username and password for Azure authentication. Required if any type of ADL storage (File, Report, Unpacked) is enabled (configuration.adl.enabled, configuration.reportAdl.enabled, configuration.unpackedAdl.enabled).Postprocessor
<secrets.msGraph.customSecretName><release_name>-secret-worker-ms-graphRequired when related feature is enabledBasic authentication secret which contains username and password for Microsoft Cloud Storage authentication. Required if any type of Microsoft Cloud storage (File, Report, Unpacked) is enabled (configuration.msGraph.enabled, configuration.reportMsGraph.enabled, configuration.unpackedMsGraph.enabled).Postprocessor
<secrets.unpackedS3.customSecretName><release_name>-secret-worker-unpacked-s3OptionalSecret which contains only password. Used for encryption of the archive file. Relevant only when the configuration.unpackedS3.archiveUnpacked option is set to true.Postprocessor
<secrets.reportS3.customSecretName><release_name>-secret-worker-report-s3OptionalSecret which contains only password. Used for encryption of the archive file. Relevant only when the configuration.reportS3.archiveSplitReport option is set to true.Postprocessor
<secrets.unpackedAdl.customSecretName><release_name>-secret-worker-unpacked-adlOptionalSecret which contains only password. Used for encryption of the archive file. Relevant only when the configuration.unpackedAdl.archiveUnpacked option is set to true.Postprocessor
<secrets.reportAdl.customSecretName><release_name>-secret-worker-report-adlOptionalSecret which contains only password. Used for encryption of the archive file. Relevant only when the configuration.reportAdl.archiveSplitReport option is set to true.Postprocessor
<secrets.unpackedMsGraph.customSecretName><release_name>-secret-worker-unpacked-ms-graphOptionalSecret which contains only password. Used for encryption of the archive file. Relevant only when the configuration.unpackedMsGraph.archiveUnpacked option is set to true.Postprocessor
<secrets.reportMsGraph.customSecretName><release_name>-secret-worker-report-ms-graphOptionalSecret which contains only password. Used for encryption of the archive file. Relevant only when the configuration.reportMsGraph.archiveSplitReport option is set to true.Postprocessor
<secrets.splunk.customSecretName><release_name>-secret-worker-splunkOptionalToken secret which contains token for Splunk authentication. Relevant only if Splunk Integration is enabled (configuration.splunk.enabled).Postprocessor
<secrets.archive.customSecretName><release_name>-secret-worker-archive-zipOptionalSecret which contains only password. Relevant only when the configuration.archive.fileWrapper value is set to "zip" or "mzip".Postprocessor
<secrets.spectraAnalyzeIntegration.customSecretName><release_name>-secret-worker-spectra-analyze-integration-tokenRequired when related feature is enabledToken secret which contains the token used in authentication on Spectra Analyze when Spectra Analyze Integration is enabled (configuration.spectraAnalyzeIntegration.enabled). This token should be created in Spectra Analyze.Postprocessor
<secrets.authCreds.customSecretName><release_name>-secret-worker-auth-credsOptionalSecret of type kubernetes.io/dockerconfigjson. Contains authentication credentials for multiple registries. Required when using API for container image upload.Receiver
<secrets.caCerts.customSecretName><release_name>-secret-worker-ca-certsOptionalOpaque secret which contains a single key, ca_bundle. The value of that key are bundled certificates. Needed when certificates are required, example when using API for container image upload and the registry the image is on requires it.Receiver

Values

Secret Configuration

KeyTypeDefaultDescription
secrets.apiobject-Secret configuration values for setting the authorization token that is used to protect all endpoint with /api/ prefix.
secrets.api.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the token parameter. WARNING: Use this for convenience/testing only.
secrets.api.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.api.tokenstring""API token secret. 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.apiTaskobject-Secret configuration values for setting the authorization token that is used to protect /api/tiscale/v1/task endpoints.
secrets.apiTask.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the token parameter. WARNING: Use this for convenience/testing only.
secrets.apiTask.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.apiTask.tokenstring""API task token secret. 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.archiveobject-Secret configuration values for setting the password used for encryption of the zip file. Relevant only when the configuration.archive.fileWrapper value is set to 'zip' or 'mzip'.
secrets.archive.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the password parameter. WARNING: Use this for convenience/testing only.
secrets.archive.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.archive.passwordstring""Archive password secret. 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.authCredsobject-Secret configuration values for setting the dockerconfig secret which will contain registry authentication credentials used for upload of the container images for analysis.
secrets.authCreds.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret of type dockerconfig using the credentials list of username, password and registry parameters. WARNING: Use this for convenience/testing only.
secrets.authCreds.credentialslist[]List of credentials from which the dockerconfig secret can be created. Only used if 'createUserSecret' is set to 'true'. Structure of the list items can be found here: Authentication Credentials. 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.authCreds.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.awsobject-Secret configuration values for setting the credentials for any S3 type storage.
secrets.aws.awsS3AccessKeyIdstring""AWS S3 access key ID. 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.aws.awsS3SecretAccessKeystring""AWS S3 secret access key. 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.aws.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the awsS3AccessKeyId and awsS3SecretAccessKey parameters. WARNING: Use this for convenience/testing only.
secrets.aws.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.azureobject-Secret configuration values for setting the Azure credentials.
secrets.azure.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the username and password parameters. WARNING: Use this for convenience/testing only.
secrets.azure.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.azure.passwordstring""Azure password secret. 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.azure.usernamestring""Azure username secret. 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.caCertsobject-Secret configuration values for setting the secret which will contain bundled certificates.
secrets.caCerts.certificateslist[]List of certificates which will be bundled. Each list item must contain the complete PEM-encoded file content of the certificate, including headers, not its file path. Only used if 'createUserSecret' is set to 'true'. WARNING: Use this for convenience/testing only. Do not store sensitive data 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.caCerts.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret which contains bundled certificates that are given in the certificates list. WARNING: Use this for convenience/testing only.
secrets.caCerts.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.cloudobject-Secret configuration values for setting the Spectra Intelligence credentials.
secrets.cloud.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the username and password parameters. WARNING: Use this for convenience/testing only.
secrets.cloud.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.cloud.passwordstring""Cloud password secret. 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.cloud.usernamestring""Cloud username secret. 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.cloudProxyobject-Secret configuration values for setting the Spectra Intelligence credentials when proxy is used.
secrets.cloudProxy.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the username and password parameters. WARNING: Use this for convenience/testing only.
secrets.cloudProxy.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.cloudProxy.passwordstring""Cloud proxy password secret. 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.cloudProxy.usernamestring""Cloud proxy username secret. 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.msGraphobject-Secret configuration values for setting the credentials for Microsoft Cloud Storage.
secrets.msGraph.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the username and password parameters. WARNING: Use this for convenience/testing only.
secrets.msGraph.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.msGraph.passwordstring""MS Graph password secret. 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.msGraph.usernamestring""MS Graph username secret. 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.reportAdlobject-Secret configuration values for setting the password used for encryption of the archive file. Relevant only when the configuration.reportAdl.archiveSplitReport option is set to true.
secrets.reportAdl.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the password parameter. WARNING: Use this for convenience/testing only.
secrets.reportAdl.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.reportAdl.passwordstring""Report ADL password secret. 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.reportMsGraphobject-Secret configuration values for setting the password used for encryption of the archive file. Relevant only when the configuration.unpackedMsGraph.archiveSplitReport option is set to true.
secrets.reportMsGraph.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the password parameter. WARNING: Use this for convenience/testing only.
secrets.reportMsGraph.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.reportMsGraph.passwordstring""Report MS Graph password secret. 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.reportS3object-Secret configuration values for setting the password used for encryption of the archive file. Relevant only when the configuration.reportS3.archiveSplitReport option is set to true.
secrets.reportS3.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the password parameter. WARNING: Use this for convenience/testing only.
secrets.reportS3.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.reportS3.passwordstring""Report S3 password secret. 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.spectraAnalyzeIntegrationobject-Secret configuration values for setting the token used for authentication on Spectra Analyze when Spectra Analyze Integration is enabled (configuration.spectraAnalyzeIntegration.enabled).
secrets.spectraAnalyzeIntegration.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the token parameter. WARNING: Use this for convenience/testing only.
secrets.spectraAnalyzeIntegration.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.spectraAnalyzeIntegration.tokenstring""Spectra Analyze Integration token secret. 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.splunkobject-Secret configuration values for setting the token for Splunk authentication.
secrets.splunk.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the token parameter. WARNING: Use this for convenience/testing only.
secrets.splunk.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.splunk.tokenstring""Splunk token secret. 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.unpackedAdlobject-Secret configuration values for setting the password used for encryption of the archive file. Relevant only when the configuration.unpackedAdl.archiveUnpacked option is set to true.
secrets.unpackedAdl.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the password parameter. WARNING: Use this for convenience/testing only.
secrets.unpackedAdl.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.unpackedAdl.passwordstring""Unpacked ADL password secret. 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.unpackedMsGraphobject-Secret configuration values for setting the password used for encryption of the archive file. Relevant only when the configuration.reportMsGraph.archiveSplitReport option is set to true.
secrets.unpackedMsGraph.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the password parameter. WARNING: Use this for convenience/testing only.
secrets.unpackedMsGraph.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.unpackedMsGraph.passwordstring""Unpacked MS Graph password secret. 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.unpackedS3object-Secret configuration values for setting the password used for encryption of the archive file. Relevant only when the configuration.unpackedS3.archiveUnpacked option is set to true.
secrets.unpackedS3.createUserSecretboolfalseIf true, the chart creates a Kubernetes Secret using the password parameter. WARNING: Use this for convenience/testing only.
secrets.unpackedS3.customSecretNamestringnilCustom secret name. If not set, default secret name will be used.
secrets.unpackedS3.passwordstring""Unpacked S3 password secret. 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.

Secret Configuration - Authentication Credentials

KeyTypeDefaultDescription
passwordstring""Registry password. WARNING: Use this for convenience/testing only. Do not store sensitive data 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.
registrystring""Registry name.
usernamestring""Registry username. WARNING: Use this for convenience/testing only. Do not store sensitive data 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["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.
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.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).
monitoring.enabledboolfalseEnable/disable monitoring with Prometheus.
monitoring.prometheusReleaseNamestring"kube-prometheus-stack"Prometheus release name.
nodeSelectorobject{}Node labels for pod assignment. Pods will only be scheduled to nodes that match all labels defined here.
tolerationslist[]Tolerations for pod assignment. Allows pods to be scheduled onto "tainted" nodes that would otherwise repel them. Used for dedicated hardware (GPUs) or specialized node pools.
useReloaderstringnilWhether to enable Reloader annotations. When defined, this value takes precedence over global.useReloader.

Application Configuration

KeyTypeDefaultDescription
advancedFiltersobject{}Contains key-value pairs in which keys are filter names and values are the filter definitions.
appliance.configModestring"STANDARD"Configuration mode of the appliance. Allowed values: CONFIGMAP (Configuration is provided with configmap), STANDARD (configuration is provided over UI).
configuration.a1000object-Integration with Spectra Analyze appliance.
configuration.a1000.hoststring""The hostname or IP address of the A1000 appliance associated with the Worker.
configuration.adlobject-Settings for storing files in an Azure Data Lake container.
configuration.adl.containerstring""The hostname or IP address of the Azure Data Lake container that will be used for storage. Required when storing files in ADL is enabled.
configuration.adl.enabledboolfalseEnable or disable the storage of processed files.
configuration.adl.folderstring""Specify the name of the folder on the container where files will be stored.
configuration.apiServerobject-Configures a custom Worker IP address which is included in the response when uploading a file to the Worker for processing.
configuration.apiServer.hoststring""Configures the hostname or IP address of the Worker. Only necessary if the default IP address or network interface is incorrect.
configuration.archiveobject-After processing, files can be zipped before external storage. Available only for S3 and Azure.
configuration.archive.fileWrapperstring""Specify whether the files should be compressed as a ZIP archive before uploading to external storage. Supported values are: zip, mzip. If this parameter is left blank, files will be uploaded in their original format.
configuration.archive.zipCompressint0ZIP compression level to use when storing files in a ZIP file. Allowed range: 0 (no compression) to 9 (maximum compression).
configuration.archive.zipMaxfilesint0Maximum allowed number of files that can be stored in one ZIP archive. Allowed range: 1-65535. 0 represents unlimited.
configuration.authenticationobject-Authentication settings for Detect Worker.
configuration.authentication.enabledboolfalseEnable/disable authentication on Detect Worker ingress APIs.
configuration.authentication.externalAuthUrlstring""If set external/custom authentication service will be used for authentication, otherwise simple Token service is deployed which protects paths with tokens defined in the secrets.
configuration.awsobject-Configuration of integration with AWS or AWS-compatible storage to be used for SNS, and for uploading files and analysis reports to S3.
configuration.aws.caPathstring""Path on the file system pointing to the certificate of a custom (self-hosted) S3 server.
configuration.aws.endpointUrlstring""Only required in non-AWS setups in order to store files to an S3-compatible server. When this parameter is left blank, the default is https://aws.amazonaws.com. Supported pattern(s): https?://.+".
configuration.aws.maxReattemptsint5Maximum number of retries when saving a report to an S3-compatible server.
configuration.aws.payloadSigningEnabledboolfalseSpecifies whether to include an SHA-256 checksum with Amazon Signature Version 4 payloads.
configuration.aws.regionstring"us-east-1"Specify the correct AWS geographical region where the S3 bucket is located. Required parameter, ignored for non-AWS setups.
configuration.aws.serverSideEncryptionstring""Specify the encryption algorithm used on the target S3 bucket (e.g. aws:kms or AES256).
configuration.aws.sslVerifyboolfalseEnable/disable SSL verification.
configuration.aws.useAssignedCredentialsbooleanfalseUse AWS provided credentials. When enabled, application uses credentials assigned by AWS rather than authenticating with its own. This is used in combination with AWS Pod Identity and similar to avoid less safe long-term tokens.
configuration.awsRoleobject-Configures the AWS IAM roles used to access S3 buckets without sharing secret keys. The IAM role which will be used to obtain temporary tokens has to be created in the AWS console.
configuration.awsRole.enableArnboolfalseEnables or disables this entire feature.
configuration.awsRole.externalRoleIdstring""The external ID of the role that will be assumed. This can be any string. Usually, it’s an ID provided by the entity which uses (but doesn’t own) an S3 bucket. The owner of that bucket takes that external ID and builds an ARN with it.
configuration.awsRole.refreshBufferint5Number of seconds to fetch a new ARN token before the token timeout is reached.
configuration.awsRole.roleArnstring""The role ARN created using the external role ID and an Amazon ID. In other words, the ARN which allows a Worker to obtain a temporary token, which then allows it to save to S3 buckets without a secret access key.
configuration.awsRole.roleSessionNamestring""Name of the session visible in AWS logs. Can be any string.
configuration.awsRole.tokenDurationint900How long before the authentication token expires and is refreshed. The minimum value is 900 seconds.
configuration.azureobject-Configures integration with Azure Data Lake Gen2 for the purpose of storing processed files in Azure Data Lake containers.
configuration.azure.endpointSuffixstring"core.windows.net"Specify the suffix for the address of your Azure Data Lake container.
configuration.callbackobject-Settings for automatically sending file analysis reports via POST request.
configuration.callback.advancedFilterEnabledboolfalseEnable/disable the advanced filter.
configuration.callback.advancedFilterNamestring""Name of the advanced filter.
configuration.callback.caPathstring""If the url parameter is configured to use HTTPS, this parameter can be used to set the path to the certificate file. This automatically enables SSL verification. If this parameter is left blank or not configured, SSL verification will be disabled, and the certificate will not be validated.
configuration.callback.enabledboolfalseEnable/disable connection.
configuration.callback.maliciousOnlyboolfalseWhen set, the report will only contain malicious and suspicious children.
configuration.callback.reportTypestring"medium"Specifies which report type is returned. By default, or when empty, only the medium (summary) report is provided in the callback response. Set to extended_small, small, medium or large to view results of filtering the full report.
configuration.callback.splitReportboolfalseBy default, reports contain information on parent files and all extracted children files. If set to true, reports for extracted files will be separated from the full report and saved as standalone files. If any user-defined data was appended to the analyzed parent file, it will be included in every split child report.
configuration.callback.sslVerifyboolfalseEnable/disable SSL verification
configuration.callback.timeoutint5Specify the number of seconds to wait before the POST request times out. In case of failure, the Worker will retry the request up to six times, increasing the waiting time between requests after the second retry has failed. With the default timeout set, the total possible waiting time before a request finally fails is 159 seconds.
configuration.callback.topContainerOnlyboolfalseIf set to true, the reports will only contain metadata for the top container. Reports for unpacked files will not be generated.
configuration.callback.urlstring""Specify the full URL that will be used to send the callback POST request. Both HTTP and HTTPS are supported. If this parameter is left blank, reports will not be sent, and the callback feature will be disabled. Supported pattern(s): http?://.+
configuration.callback.viewstring""Specifies whether a custom report view should be applied to the report.
configuration.cefobject-Configures Common Event Format (CEF) settings. CEF is an extensible, text-based logging and auditing format that uses a standard header and a variable extension, formatted as key-value pairs.
configuration.cef.cefMsgHashTypestring"md5"Specify the type of hash that will be included in CEF messages. Supported values are: md5, sha1, sha256.
configuration.cef.enableCefMsgboolfalseEnable or disable sending CEF messages to syslog. Defaults to false to avoid flooding.
configuration.classifyobject-Configure settings for Worker analysis and classification of files using the Spectra Core static analysis engine.
configuration.classify.certificatesbooltrueEnable checking whether file certificate passes the certificate validation, in addition to checking certificate whitelists and blacklists.
configuration.classify.documentsbooltrueEnable document format threat detection.
configuration.classify.emailsbooltrueEnable detection of phishing and other email threats.
configuration.classify.hyperlinksbooltrueEnable embedded hyperlinks detection.
configuration.classify.ignoreAdwareboolfalseWhen set to true, classification results that match adware will be ignored.
configuration.classify.ignoreHacktoolboolfalseWhen set to true, classification results that match hacktool will be ignored.
configuration.classify.ignorePackerboolfalseWhen set to true, classification results that match packer will be ignored.
configuration.classify.ignoreProtestwareboolfalseWhen set to true, classification results that match protestware will be ignored.
configuration.classify.ignoreRiskwareboolfalseWhen set to true, classification results that match riskware will be ignored.
configuration.classify.ignoreSpamboolfalseWhen set to true, classification results that match spam will be ignored.
configuration.classify.ignoreSpywareboolfalseWhen set to true, classification results that match spyware will be ignored.
configuration.classify.imagesbooltrueWhen true, the heuristic image classifier for supported file formats is used.
configuration.classify.modelsLinuxGeneralstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsScriptsAutoitstring"malicious"This setting controls how the ML Model affects the classification Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsScriptsExcelstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsScriptsPowershellstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsScriptsPythonstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsScriptsVisualbasicstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsBackdoorstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsDownloaderstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsGeneralstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsInfostealerstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsKeyloggerstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsRansomwarestring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsRiskwarestring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.modelsWindowsWormstring"malicious"This setting controls how the ML Model affects the classification. Possible values: malicious, suspicious, ignored, disabled.
configuration.classify.pecoffbooltrueWhen true, the heuristic Windows executable classifier for supported PE file formats is used.
configuration.cleanupobject-Configures how often the Worker file system is cleaned up.
configuration.cleanup.fileAgeLimitint1440Time before an unprocessed file present on the appliance is deleted, in minutes.
configuration.cleanup.taskAgeLimitint90Time before analysis reports and records of processed tasks are deleted, in minutes.
configuration.cleanup.taskUnprocessedLimitint1440Time before an incomplete processing task is canceled, in minutes.
configuration.cloudobject-Configures integration with the Spectra Intelligence service or a T1000 instance to receive additional classification information.
configuration.cloud.enabledboolfalseEnable/disable connection.
configuration.cloud.proxyobject-Configure an optional proxy connection.
configuration.cloud.proxy.enabledboolfalseEnable/disable proxy server.
configuration.cloud.proxy.portint8080Specify the TCP port number if using an HTTP proxy. Allowed range(s): 1 - 65535. Required only if proxy is used.
configuration.cloud.proxy.serverstring""Proxy hostname or IP address for routing requests from the appliance to Spectra Intelligence. Required only if proxy is used.
configuration.cloud.serverstring"https://appliance-api.reversinglabs.com"Hostname or IP address of the Spectra Intelligence server. Required if Spectra Intelligence integration is enabled. Format: https://<ip_or_hostname>.
configuration.cloud.timeoutint6Specify the number of seconds to wait when connecting to Spectra Intelligence before terminating the connection request.
configuration.cloudAutomationobject-Configures the Worker to automatically submit files to Spectra Intelligence for antivirus scanning (in addition to local static analysis and remote reputation lookup (from previous antivirus scans)).
configuration.cloudAutomation.dataChangeSubscribeboolfalseSubscribe to the Spectra Intelligence data change notification mechanism.
configuration.cloudAutomation.scanOnlyUnknownboolfalseSend only files classified as Unknown to Deep Cloud Analysis.
configuration.cloudAutomation.spexUploadobject-Scanning settings.
configuration.cloudAutomation.spexUpload.enabledboolfalseEnable/disable this feature.
configuration.cloudAutomation.spexUpload.rescanEnabledbooltrueEnable/disable rescan of files upon submission based on the configured interval to include the latest AV results in the reports.
configuration.cloudAutomation.spexUpload.rescanThresholdInDaysint3Set the interval in days for triggering an AV rescan. If the last scan is older than the specified value, a rescan will be initiated. A value of 0 means files will be rescanned with each submission.
configuration.cloudAutomation.spexUpload.scanUnpackedFilesboolfalseEnable/disable sending unpacked files to Deep Cloud Analysis for scanning. Consumes roughly double the processing resources compared to standard analysis.
configuration.cloudAutomation.waitForAvScansTimeoutInMinutesint240Sets the maximum wait time (in minutes) for Deep Cloud Analysis to complete. If the timeout is reached, the report will be generated without the latest AV results.
configuration.cloudAutomation.waitForAvScansToFinishboolfalseIf set to true, delays report generation until Deep Cloud Analysis completes, ensuring the latest AV results are included.
configuration.cloudCache.cacheMaxSizePercentagefloat6.25Maximum cache size expressed as a percentage of the total allocated RAM on the Worker. Allowed range: 5 - 15.
configuration.cloudCache.cleanupWindowint10How often to run the cache cleanup process, in minutes. It is advisable for this value to be lower, or at least equal to the TTL value. Allowed range: 5 - 60.
configuration.cloudCache.enabledbooltrueEnable or disable the caching feature.
configuration.cloudCache.maxIdleUpstreamConnectionsint50The maximum number of idle upstream connections. Allowed range: 10 - 50.
configuration.cloudCache.ttlint240Time to live for cached records, in minutes. Allowed range: 1 - 7200.
configuration.general.maxUploadSizeMbint2048The largest file (in MB) that Worker will accept and start processing. Ignored if Spectra Intelligence is connected and file upload limits are set there.
configuration.general.tsWorkerCheckThresholdMinsint720How often the processing service will be checked for timeouts. If any issues are detected, the process will be restarted.
configuration.general.uploadSizeLimitEnabledboolfalseWhether or not the upload size filter is active. Ignored if Spectra Intelligence is connected and file upload limits are set there.
configuration.hashesobject-Spectra Core calculates file hashes during analysis and includes them in the analysis report. The following options configure which additional hash types should be calculated and included in the Worker report. SHA1 and SHA256 are always included and therefore aren’t configurable. Selecting additional hash types (especially SHA384 and SHA512) may slow report generation.
configuration.hashes.enableCrc32boolfalseInclude CRC32 hashes in reports.
configuration.hashes.enableMd5booltrueInclude MD5 hashes in reports.
configuration.hashes.enableSha384boolfalseInclude SHA384 hashes in reports.
configuration.hashes.enableSha512boolfalseInclude SHA512 hashes in reports.
configuration.hashes.enableSsdeepboolfalseInclude SSDEEP hashes in reports.
configuration.hashes.enableTlshboolfalseInclude TLSH hashes in reports.
configuration.healthobject-Configures system health check configuration.
configuration.health.diskHighint95Threshold for high disk usage.
configuration.health.diskPathstring"/scratch"Empty string disables disk status check.
configuration.health.enableDiskUsageCheckboolfalseEnable/disable disk usage check.
configuration.health.enabledbooltrueEnable/disable system health check.
configuration.health.queueHighint2000Number of files allowed in the queue.
configuration.health.runtimeint10Specifies the number of seconds over which disk usage is sampled to assess the disk status.
configuration.largeFileProcessingOverridesobject-Configuration overrides applicable when processing large files.
configuration.largeFileProcessingOverrides.configurationOverridesobject-Configuration overrides which will be applied over regular configuration settings. Allowed configuration sections: cef, classify, cloud, cloudCache, general, hashes, processing, propagation, strings, ticore, wordlist.
configuration.largeFileProcessingOverrides.configurationOverrides.cloudCacheobject-Caches Spectra Intelligence results to preserve quota and bandwidth when analyzing sets of samples containing many duplicates or identical extracted files.
configuration.largeFileProcessingOverrides.configurationOverrides.cloudCache.enabledbooltrueEnable or disable the caching feature.
configuration.largeFileProcessingOverrides.configurationOverrides.cloudCache.ttlint480Time to live for cached records, in minutes. Allowed range: 1 - 7200.
configuration.largeFileProcessingOverrides.configurationOverrides.general.tsWorkerCheckThresholdMinsint4320How often the processing service will be checked for timeouts. If any issues are detected, the process will be restarted.
configuration.largeFileProcessingOverrides.configurationOverrides.processingobject-Configure the Worker file processing capabilities to improve performance and load balancing.
configuration.largeFileProcessingOverrides.configurationOverrides.processing.cacheEnabledbooltrueEnable/disable caching. When enabled, Spectra Core can skip reprocessing the same files (duplicates) if uploaded consecutively in a short period.
configuration.largeFileProcessingOverrides.configurationOverrides.processing.cacheTimeToLiveint0If file processing caching is enabled, specify how long (in seconds) the analysis reports should be preserved in the cache before they expire. A value of 0 uses the default. Default: 600. Maximum: 86400.
configuration.largeFileProcessingOverrides.configurationOverrides.processing.timeoutint259200Specifies how many seconds the Worker should wait for a file to process before terminating the task. Default: 28800. Maximum: 259200.
configuration.largeFileProcessingOverrides.configurationOverrides.ticoreobject-Configures cloud options supported by Spectra Core. Worker must be connected to Spectra Intelligence for these settings to take effect.
configuration.largeFileProcessingOverrides.configurationOverrides.ticore.processingModestring"fast"Determines which file formats are unpacked by Spectra Core for detailed analysis. "best" fully processes all supported formats; "fast" processes a limited set.
configuration.largeFileProcessingOverrides.enabledbooltrueEnable configuration overrides which affect processing of larger files.
configuration.loggingobject-Configures the severity above which events will be logged or sent to a remote syslog server. Severity can be: INFO, WARNING, or ERROR.
configuration.logging.tiscaleLogLevelstring"INFO"Events below this level will not be presented on standard output.
configuration.msGraphobject-Configures the Microsoft Cloud Storage file integration.
configuration.msGraph.enabledboolfalseTurns the Microsoft Cloud Storage file integration on or off.
configuration.msGraph.folderstring""Folder where samples will be stored in Microsoft Cloud Storage.
configuration.msGraphGeneralobject-Configures the general options for the Microsoft Cloud Storage integration.
configuration.msGraphGeneral.customDomainstring""Application’s custom domain configured in the Azure portal.
configuration.msGraphGeneral.siteHostnamestring""Used only if storageType is set to SharePoint. This is the SharePoint hostname.
configuration.msGraphGeneral.siteRelativePathstring""SharePoint Online site relative path. Only used when storageType is set to SharePoint.
configuration.msGraphGeneral.storageTypestring"onedrive"Specifies the storage type. Supported values are: onedrive or sharepoint.
configuration.msGraphGeneral.usernamestring""Used only if storageType is set to OneDrive. Specifies which user’s drive will be used.
configuration.processingobject-Configure the Worker file processing capabilities to improve performance and load balancing.
configuration.processing.cacheEnabledboolfalseEnable/disable caching. When enabled, Spectra Core can skip reprocessing the same files (duplicates) if uploaded consecutively in a short period.
configuration.processing.cacheTimeToLiveint0If file processing caching is enabled, specify how long (in seconds) the analysis reports should be preserved in the cache before they expire. A value of 0 uses the default. Default: 600. Maximum: 86400.
configuration.processing.depthint0Specifies how "deep" a file is unpacked. By default, when set to 0, Workers will unpack files recursively until no more files can be unpacked. Setting a value greater than 0 limits the depth of recursion, which can speed up analyses but provide less detail.
configuration.processing.largefileThresholdint100If advanced mode is enabled, files larger than this threshold (in MB) will be processed individually, one by one. This parameter is ignored in standard mode.
configuration.processing.modeint2Configures the Worker processing mode to improve load balancing. Supported modes are standard (1) and advanced (2).
configuration.processing.timeoutint28800Specifies how many seconds the Worker should wait for a file to process before terminating the task. Default: 28800. Maximum: 259200.
configuration.propagationobject-Configure advanced classification propagation options supported by the Spectra Core static analysis engine. When Spectra Core classifies files, the classification of a child file can be applied to the parent file.
configuration.propagation.enabledbooltrueEnable/disable the classification propagation feature. When propagation is enabled, files can be classified based on the content extracted from them. This means that files containing a malicious or suspicious file will also be considered malicious or suspicious.
configuration.propagation.goodwareOverridesEnabledbooltrueEnable/disable goodware overrides. When enabled, any files extracted from a parent file and whitelisted by certificate, source or user override can no longer be classified as malicious or suspicious. This is an advanced goodware whitelisting technique that can be used to reduce the amount of false positive detections.
configuration.propagation.goodwareOverridesFactorint1When goodware overrides are enabled, this parameter must be configured to determine the factor to which overrides will be applied. Supported values are 0 to 5, where zero represents the best trust factor (highest confidence that a sample contains goodware). Overrides will apply to files with a trust factor equal to or lower than the value configured here.
configuration.reportobject-Configure the contents of the Spectra Detect file analysis report.
configuration.report.firstReportOnlyboolfalseIf disabled, the reports for samples with child files will include relationships for all descendant files. Enabling this setting will only include relationship metadata for the root parent file to reduce redundancy.
configuration.report.includeStringsboolfalseWhen enabled, strings are included in the file analysis report. Spectra Core can extract strings from binaries. This can be useful but may result in extensive metadata. To reduce noise, the types of included strings can be customized in the strings section.
configuration.report.networkReputationboolfalseIf enabled, analysis reports include a top-level network_reputation object with reputation information for every extracted network resource. For this feature, Spectra Intelligence must be configured on the Worker, and the ticore.processingMode option must be set to "best".
configuration.report.relationshipsboolfalseIncludes sample relationship metadata in the file analysis report. When enabled, the relationships section lists the hashes of files found within the given file.
configuration.reportAdlobject-Settings to configure how reports saved to Azure Data Lake are formatted.
configuration.reportAdl.archiveSplitReportbooltrueEnable sending a single, smaller archive of split report files to ADL instead of each file. Relevant only when the 'Split report' option is used.
configuration.reportAdl.containerstring""Container where reports will be stored. Required when this feature is enabled.
configuration.reportAdl.enabledboolfalseEnable/disable storing file processing reports to ADL.
configuration.reportAdl.filenameTimestampFormatstring""File naming pattern for the report itself. A timestamp is appended to the SHA1 hash of the file. The timestamp format must follow the strftime specification and be enclosed in quotation marks. If not specified, the ISO 8601 format is used.
configuration.reportAdl.folderstring""Specify the name of a folder where analysis reports will be stored. If the folder name is not provided, files are stored into the root of the configured container.
configuration.reportAdl.folderOptionstring"date_based"Select the naming pattern that will be used when automatically creating subfolders for storing analysis reports. Supported options are: date_based (YYYY/mm/dd/HH), datetime_based (YYYY/mm/dd/HH/MM/SS), and sha1_based (using the first 4 characters of the file hash).
configuration.reportAdl.maliciousOnlyboolfalseWhen set, the report will only contain malicious and suspicious children.
configuration.reportAdl.reportTypestring"large"Specify the report type that should be applied to the Worker analysis report before storing it. Report types are results of filtering the full report. In other words, fields can be included or excluded as required. Report types are stored in the /etc/ts-report/report-types directory.
configuration.reportAdl.splitReportboolfalseBy default, reports contain information on parent files and all extracted children files. When this option is enabled, analysis reports for extracted files are separated from their parent file report, and saved as individual report files.
configuration.reportAdl.timestampEnabledbooltrueEnable/disable appending a timestamp to the report name.
configuration.reportAdl.topContainerOnlyboolfalseWhen enabled, the file analysis report will only include metadata for the top container and subreports for unpacked files will not be generated.
configuration.reportAdl.viewstring""Apply a view for transforming report data to the “large” report type to ensure maximum compatibility. Several existing views are also available as report types, which should be used as a view substitute due to performance gains. Custom views can be defined by placing the scripts in the “/usr/libexec/ts-report-views.d” directory on Spectra Detect Worker.
configuration.reportApiobject-Configures the settings applied to the file analysis report fetched using the GET endpoint. To modify synchronous API timeouts or connection limits, apply the appropriate annotations to your Ingress resource.
configuration.reportApi.maliciousOnlyboolfalseWhen set, the report will only contain malicious and suspicious children.
configuration.reportApi.reportTypestring"large"Specify the report type that should be applied to the Worker analysis report before storing it. Report types are results of filtering the full report. In other words, fields can be included or excluded as required. Report types are stored in the /etc/ts-report/report-types directory.
configuration.reportApi.topContainerOnlyboolfalseWhen enabled, the file analysis report will only include metadata for the top container and subreports for unpacked files will not be generated.
configuration.reportApi.viewstring""Apply a view for transforming report data to the “large” report type to ensure maximum compatibility. Several existing views are also available as report types, which should be used as a view substitute due to performance gains. Custom views can be defined by placing the scripts in the “/usr/libexec/ts-report-views.d” directory on Spectra Detect Worker.
configuration.reportMsGraphobject-Settings to configure how reports saved to OneDrive or SharePoint are formatted.
configuration.reportMsGraph.archiveSplitReportbooltrueEnable sending a single, smaller archive of split report files to Microsoft Cloud Storage instead of each file. Relevant only when the "Split Report" option is used.
configuration.reportMsGraph.enabledboolfalseEnable/disable storing file processing reports.
configuration.reportMsGraph.filenameTimestampFormatstring""This refers to the naming of the report file itself. A timestamp is appended to the SHA1 hash of the file. The timestamp format must follow the strftime specification and be enclosed in quotation marks. If not specified, the ISO 8601 format is used.
configuration.reportMsGraph.folderstring""Folder where report files will be stored on the Microsoft Cloud Storage. If the folder name is not provided, files are stored into the root of the configured container.
configuration.reportMsGraph.folderOptionstring"date_based"Select the naming pattern that will be used when automatically creating subfolders for storing analysis reports. Supported options are: date_based (YYYY/mm/dd/HH), datetime_based (YYYY/mm/dd/HH/MM/SS), and sha1_based (using the first 4 characters of the file hash).
configuration.reportMsGraph.maliciousOnlyboolfalseWhen set, the report will only contain malicious and suspicious children.
configuration.reportMsGraph.reportTypestring"large"Specify the report type that should be applied to the Worker analysis report before storing it. Report types are results of filtering the full report. In other words, fields can be included or excluded as required. Report types are stored in the /etc/ts-report/report-types directory.
configuration.reportMsGraph.splitReportboolfalseBy default, reports contain information on parent files and all extracted children files. When this option is enabled, analysis reports for extracted files are separated from their parent file report, and saved as individual report files.
configuration.reportMsGraph.topContainerOnlyboolfalseWhen enabled, the file analysis report will only include metadata for the top container, and subreports for unpacked files will not be generated.
configuration.reportMsGraph.viewstring""Apply a view for transforming report data to the “large” report type to ensure maximum compatibility. Several existing views are also available as report types, which should be used as a view substitute due to performance gains. Custom views can be defined by placing the scripts in the “/usr/libexec/ts-report-views.d” directory on Spectra Detect Worker.
configuration.reportS3object-Settings to configure how reports saved to S3 buckets are formatted.
configuration.reportS3.advancedFilterEnabledboolfalseEnable/disable the advanced filter.
configuration.reportS3.advancedFilterNamestring""Name of the advanced filter.
configuration.reportS3.archiveSplitReportbooltrueEnable sending a single, smaller archive of split report files to S3 instead of each file. Relevant only when the 'Split report' option is used.
configuration.reportS3.bucketMappingobject{}Used if destinationType is set to mapping. Accepts a dictionary of S3 input buckets mapped to output buckets, enclosed in quotation marks.
configuration.reportS3.bucketNamestring""Name of the S3 bucket where processed files will be stored. Required when this feature is enabled.
configuration.reportS3.bucketS3ConnectionMappinglist[]List of structures that sets individual AWS connection methods for each target output bucket.
configuration.reportS3.destinationTypestring"default"Supported values are default (saves the reports into the bucket configured by bucketName), source (saves the reports into the S3 bucket where the samples originated from), mapping (saves the reports according to the mapping configured by bucketMapping).
configuration.reportS3.enabledboolfalseEnable/disable storing file processing reports to S3.
configuration.reportS3.filenameTimestampFormatstring""This refers to the naming of the report file itself. A timestamp is appended to the SHA1 hash of the file. The timestamp format must follow the strftime specification and be enclosed in quotation marks. If not specified, the ISO 8601 format is used.
configuration.reportS3.folderstring""Folder where report files will be stored in the given S3 bucket. The folder can be up to 1024 bytes long when encoded in UTF-8, and can contain letters, numbers and special characters: "!", "-", "_", ".", "*", "'", "(", ")", "/". It must not start or end with a slash or contain leading or trailing spaces. Consecutive slashes ("//") are not allowed.
configuration.reportS3.folderOptionstring"date_based"Select the naming pattern used when automatically creating subfolders for storing analysis reports. Supported options are: date_based (YYYY/mm/dd/HH), datetime_based (YYYY/mm/dd/HH/MM/SS), and sha1_based (using the first 4 characters of the file hash).
configuration.reportS3.maliciousOnlyboolfalseWhen set, the report will only contain malicious and suspicious children.
configuration.reportS3.reportTypestring"large"Specify the report type that should be applied to the Worker analysis report before storing it. Report types are results of filtering the full report. In other words, fields can be included or excluded as required. Report types are stored in the /etc/ts-report/report-types directory.
configuration.reportS3.splitReportboolfalseBy default, reports contain information on parent files and all extracted children files. When this option is enabled, analysis reports for extracted files are separated from their parent file report, and saved as individual report files.
configuration.reportS3.timestampEnabledbooltrueEnable/disable appending a timestamp to the report name.
configuration.reportS3.topContainerOnlyboolfalseWhen enabled, file analysis report will only include metadata for the top container and subreports for unpacked files will not be generated.
configuration.reportS3.viewstring""Apply a view for transforming report data to the “large” report type to ensure maximum compatibility. Several existing views are also available as report types, which should be used as a view substitute due to performance gains. Custom views can be defined by placing the scripts in the “/usr/libexec/ts-report-views.d” directory on Spectra Detect Worker.
configuration.s3object-Settings for storing a copy of all files uploaded for analysis on Worker to an S3 or a third-party, S3-compatible server.
configuration.s3.advancedFilterEnabledboolfalseEnable/disable the advanced filter.
configuration.s3.advancedFilterNamestring""Name of the advanced filter.
configuration.s3.bucketMappingobject{}Used if destinationType is set to mapping. Accepts a dictionary of S3 input buckets mapped to output buckets, enclosed in quotation marks.
configuration.s3.bucketNamestring""Name of the S3 bucket where processed files will be stored. Required when this feature is enabled.
configuration.s3.bucketS3ConnectionMappinglist[]List of structures that sets individual AWS connection methods for each target output bucket.
configuration.s3.destinationTypestring"default"Supported values are default (saves reports into the bucket configured by bucketName) and mapping (saves reports according to bucketMapping).
configuration.s3.enabledboolfalseEnable/disable storing file processed files on S3.
configuration.s3.failedFolderstring""Specify the folder where failed samples will be stored on the given S3 bucket. If the folder name is not provided, files are stored into the root of the configured bucket.
configuration.s3.folderstring""Specify the name of a folder where successfully processed samples will be stored. If the folder name is not provided, files are stored into the root of the configured bucket.
configuration.s3.storeMetadatabooltrueWhen true, analysis metadata will be stored to the uploaded S3 object.
configuration.s3.storeModestring"all"Determines which processed samples are uploaded to S3. Supported values are all, failed_only, success_only.
configuration.scalingobject-Configures the number of concurrent processes and the number of files analyzed concurrently. Parameters in this section can be used to optimize the file processing performance on Worker.
configuration.scaling.postprocessingint1Specify how many post-processing instances to run. Post-processing instances will then modify and save reports or upload processed files to external storage. Increasing this value can increase throughput for servers with extra available cores. Maximum: 256.
configuration.scaling.preprocessingUnpackerint1Specify how many copies of Spectra Core are used to unpack samples for Deep Cloud Analysis. This setting only has effect if Deep Cloud Analysis is enabled with Scan Unpacked Files capability.
configuration.scaling.processingint1Specify how many copies of Spectra Core engine instances to run. Each instance starts threads to process files. Maximum: 256.
configuration.snsobject-Configures settings for publishing notifications about file processing status and links the reports to an Amazon SNS (Simple Notification Service) topic.
configuration.sns.enabledboolfalseEnable/disable publishing notifications to Amazon SNS.
configuration.sns.topicstring""Specify the SNS topic ARN that the notifications should be published to. Prerequisite: the AWS account in the AWS settings must be given permission to publish to this topic. Required when this feature is enabled.
configuration.spectraAnalyzeIntegrationobject-Configuration settings to upload processed samples to configured Spectra Analyze.
configuration.spectraAnalyzeIntegration.addressstring""Spectra Analyze address. Required when this feature is enabled. Has to be in the following format: https://<ip_or_hostname>.
configuration.spectraAnalyzeIntegration.advancedFilterEnabledbooltrueEnable/disable the advanced filter.
configuration.spectraAnalyzeIntegration.advancedFilterNamestring"default_filter"Name of the advanced filter.
configuration.spectraAnalyzeIntegration.enabledboolfalseEnable/disable integration with Spectra Analyze.
configuration.splunkobject-Configures integration with Splunk, a logging server that can receive Spectra Detect file analysis reports.
configuration.splunk.caPathstring""Path to the certificate.
configuration.splunk.chunkSizeMbint0The maximum size (MB) of a single request sent to Splunk. If an analysis report exceeds this size, it will be split into multiple parts. The report is split into its subreports (for child files). A request can contain one or multiple subreports, as long as its total size doesn’t exceed this limit. The report is never split by size alone; instead, complete subreports are always preserved and sent to Splunk. Default: 0 (disabled).
configuration.splunk.enabledboolfalseEnable/disable Splunk integration.
configuration.splunk.hoststring""Specify the hostname or IP address of the Splunk server that should connect to the Worker appliance.
configuration.splunk.httpsbooltrueIf set to true, HTTPS will be used for sending information to Splunk. If set to false, HTTP is used.
configuration.splunk.portint8088Specify the TCP port of the Splunk server’s HTTP Event Collector.
configuration.splunk.reportTypestring"large"Specifies which report type is returned. By default, or when empty, only the medium (summary) report is provided in the callback response. Set to small, medium or large to view results of filtering the full report.
configuration.splunk.sslVerifyboolfalseIf HTTPS is enabled, setting this to true will enable certificate verification.
configuration.splunk.timeoutint5Specify how many seconds to wait for a response from the Splunk server before the request fails. If the request fails, the report will not be uploaded to the Splunk server, and an error will be logged. The timeout value must be greater than or equal to 1, and less than or equal to 999.
configuration.splunk.topContainerOnlyboolfalseSpecifies if Splunk should receive the report for the top (parent) file only. If set to true, no subreports will be sent.
configuration.splunk.viewstring""Specifies whether a custom Report View should be applied to the file analysis report and returned in the response.
configuration.stringsobject-Configure the output of strings extracted from files during Spectra Core static analysis.
configuration.strings.enableStringExtractionboolfalseIf set to true, user-provided criteria for string extraction will be used.
configuration.strings.maxLengthint32768Maximum number of characters in strings.
configuration.strings.minLengthint4Minimum number of characters in strings. Strings shorter than this value are not extracted.
configuration.strings.unicodePrintableboolfalseSpecify whether strings are Unicode printable or not.
configuration.strings.utf16bebooltrueAllow/disallow extracting UTF-16BE strings.
configuration.strings.utf16lebooltrueAllow/disallow extracting UTF-16LE strings.
configuration.strings.utf32beboolfalseAllow/disallow extracting UTF-32BE strings.
configuration.strings.utf32leboolfalseAllow/disallow extracting UTF-32LE strings.
configuration.strings.utf8booltrueAllow/disallow extracting UTF-8 strings.
configuration.ticoreobject-Configures cloud options supported by Spectra Core. Worker must be connected to Spectra Intelligence for these settings to take effect.
configuration.ticore.maxDecompressionFactorfloat1.0Decimal value between 0 and 999.9. If multiple decimals are given, it will be rounded to one decimal. Used to protect the user from intentional or unintentional archive bombs, terminating decompression if the size of unpacked content exceeds a set quota.
configuration.ticore.mwpExtendedboolfalseEnable/disable information from antivirus engines in Spectra Intelligence.
configuration.ticore.mwpGoodwareFactorint2Determines when a file classified as KNOWN in Spectra Intelligence Cloud is classified as Goodware by Spectra Core. By default, all KNOWN cloud classifications are converted to Goodware. Supported values are 0 - 5, where zero represents the best trust factor (highest confidence that a sample contains goodware). Lowering the value reduces the number of samples classified as goodware. Samples with a trust factor above the configured value are considered UNKNOWN.
configuration.ticore.processingModestring"best"Determines which file formats are unpacked by Spectra Core for detailed analysis. "best" fully processes all supported formats; "fast" processes a limited set.
configuration.ticore.useXrefboolfalseEnabling XREF service will enrich analysis reports with cross-reference metadata like AV scanner results.
configuration.unpackedAdlobject-Settings for storing extracted files in an Azure Data Lake container.
configuration.unpackedAdl.archiveUnpackedbooltrueEnable sending a single, smaller archive of unpacked files to ADL instead of each unpacked file.
configuration.unpackedAdl.containerstring""Specify the name of the Azure Data Lake container where extracted files will be saved. Required when this feature is enabled.
configuration.unpackedAdl.enabledboolfalseEnable/disable storing extracted files to ADL.
configuration.unpackedAdl.folderstring""Specify the name of a folder in the configured Azure container where extracted files will be stored. If the folder name is not provided, files are stored into the root of the configured container.
configuration.unpackedAdl.folderOptionstring"date_based"Select the naming pattern that will be used when automatically creating subfolders for storing analyzed files. Supported options are: date_based (YYYY/mm/dd/HH), datetime_based (YYYY/mm/dd/HH/MM/SS), and sha1_based (using the first 4 characters of the file hash).
configuration.unpackedMsGraphobject-Settings for storing extracted files to Microsoft Cloud Storage.
configuration.unpackedMsGraph.archiveUnpackedbooltrueEnable sending a single, smaller archive of unpacked files to Microsoft Cloud Storage instead of each unpacked file.
configuration.unpackedMsGraph.enabledboolfalseEnable/disable storing extracted files.
configuration.unpackedMsGraph.folderstring""Folder where unpacked files will be stored on the Microsoft Cloud Storage. If the folder name is not provided, files are stored into the root of the configured container.
configuration.unpackedMsGraph.folderOptionstring"date_based"Select the naming pattern that will be used when automatically creating subfolders for storing analyzed files. Supported options are: date_based (YYYY/mm/dd/HH), datetime_based (YYYY/mm/dd/HH/MM/SS), and sha1_based (using the first 4 characters of the file hash).
configuration.unpackedS3object-Settings for storing extracted files to S3 container.
configuration.unpackedS3.advancedFilterEnabledboolfalseEnable/disable the use of advanced filters.
configuration.unpackedS3.advancedFilterNamestring""Name of the advanced filter.
configuration.unpackedS3.archiveUnpackedbooltrueEnable sending a single, smaller archive of unpacked files to S3 instead of each unpacked file.
configuration.unpackedS3.bucketNamestring""Specify the name of the S3 container where extracted files will be saved. Required when this feature is enabled.
configuration.unpackedS3.enabledboolfalseEnable/disable storing extracted files in S3.
configuration.unpackedS3.folderstring""The name of a folder in the configured S3 container where extracted files will be stored. If the folder name is not provided, files are stored into the root of the configured container. The folder can be up to 1024 bytes long when encoded in UTF-8, and can contain letters, numbers and special characters: "!", "-", "_", ".", "*", "'", "(", ")", "/". It must not start or end with a slash or contain leading or trailing spaces. Consecutive slashes ("//") are not allowed.
configuration.unpackedS3.folderOptionstring"date_based"Select the naming pattern that will be used when automatically creating subfolders for storing analyzed files. Supported options are: date_based (YYYY/mm/dd/HH), datetime_based (YYYY/mm/dd/HH/MM/SS), and sha1_based (using the first 4 characters of the file hash).
configuration.wordlistlist-List of passwords for protected files.
configuration.yaraobject-Configure YARA sync parameters.
configuration.yara.enabledboolfalseEnable YARA sync functionality When enabled, configManager is automatically enabled.
configuration.yara.reloadPeriodint600Period between rule reloads in seconds
configuration.yara.syncPeriodint60Period between sync checks in seconds
configuration.yara.syncTimeoutint20Timeout for SDM sync requests in seconds
reportTypesobject{}Contains key-value pairs where keys are the report type names and values are the report type definitions.
yaraRulesobject{}Contains key-value pairs where keys are names of yara rule files and values are the yara rule definitions.

Pod Settings - General

KeyTypeDefaultDescription
persistenceobject-Data storage configuration for storing samples and reports.
persistence.accessModeslist["ReadWriteMany"]Specifies the access modes for the volume. When autoscaling or multiple worker is used should be set to [ "ReadWriteMany" ].
persistence.requestStoragestring"10Gi"The amount of storage to request.
persistence.storageClassNamestringnilName of the StorageClass to use. When autoscaling or multiple worker is used storage class should support "ReadWriteMany". If EFS storage is used, disable disk health check by setting configuration.health.enableDiskUsageCheck to false.
sdmPortalobject-Reference to the SDM portal service for config manager. Required if SDM Portal is deployed.
sdmPortal.namespacestring""The namespace where SDM Portal is deployed. Defaults to the Worker's namespace if left empty.
sdmPortal.portstringnilThe port used to access the SDM Portal. Defaults to 8080 if not specified.
sdmPortal.releaseNamestring""The release name of the SDM Portal. Fill this out if centralManager.queueLoggingEnabled is true and SDM is deployed without an umbrella chart.
sdmPortal.urlOverridestring""Full URL of the SDM Portal (e.g., http://sdm.example.com). If provided, releaseName and namespace are ignored. Use this if SDM is outside the cluster.
tcScratchobject-tcScratch values configure generic ephemeral volume options for the Spectra Core /tc-scratch directory.
tcScratch.accessModeslist["ReadWriteOnce"]Access modes.
tcScratch.requestStoragestring"100Gi"Requested storage size for the ephemeral volume.
tcScratch.storageClassNamestringnilSets the storage class for the ephemeral volume. If not set, emptyDir is used instead of an ephemeral volume.
utilitiesImageobject-Configuration values of the utilities image used for init containers.
utilitiesImage.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
utilitiesImage.tagstring"6.2.0-14"Image tag.

Pod Settings - Authentication

KeyTypeDefaultDescription
auth.imageobject-Configuration values of the image used for authentication.
auth.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
auth.image.tagstring"8.2.0-24"Image tag.
auth.podAnnotationsobject-Pod annotations. Additional custom annotations for authentication pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
auth.resourcesobject-Resource requests and limits for the container.
auth.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
auth.resources.limits.cpustring"4000m"CPU limit. Throttling occurs if the container exceeds this value.
auth.resources.limits.memorystring"256Mi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
auth.resources.requestsobject-The minimum amount of resources the container is guaranteed.
auth.resources.requests.cpustring"500m"CPU request.
auth.resources.requests.memorystring"128Mi"Memory request.

Pod Settings - Authentication Reverse Proxy

KeyTypeDefaultDescription
authReverseProxy.imageobject-Configuration values of the auth reverse proxy image.
authReverseProxy.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
authReverseProxy.image.repositorystring"nginx"Image repository.
authReverseProxy.image.tagstring"1.30.2"Image tag.
authReverseProxy.podAnnotationsobject-Pod annotations. Additional custom annotations for authentication proxy pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
authReverseProxy.resourcesobject-Resource requests and limits for the container.
authReverseProxy.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
authReverseProxy.resources.limits.cpustring"2000m"CPU limit. Throttling occurs if the container exceeds this value.
authReverseProxy.resources.limits.memorystring"512Mi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
authReverseProxy.resources.requestsobject-The minimum amount of resources the container is guaranteed.
authReverseProxy.resources.requests.cpustring"250m"CPU request.
authReverseProxy.resources.requests.memorystring"128Mi"Memory request.

Pod Settings - Cleanup

KeyTypeDefaultDescription
cleanup.failedJobsHistoryLimitint1Number of failed finished jobs to keep.
cleanup.imageobject-Configuration values of the image used for cleanup job.
cleanup.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
cleanup.image.tagstring"6.2.0-14"Image tag.
cleanup.resourcesobject-Resource requests and limits for the container.
cleanup.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
cleanup.resources.limits.cpustring"2000m"CPU limit. Throttling occurs if the container exceeds this value.
cleanup.resources.limits.memorystring"2Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
cleanup.resources.requestsobject-The minimum amount of resources the container is guaranteed.
cleanup.resources.requests.cpustring"1000m"CPU request.
cleanup.resources.requests.memorystring"1Gi"Memory request.
cleanup.startingDeadlineSecondsint180Deadline (in seconds) for starting the Job, if that Job misses its scheduled time for any reason. After missing the deadline, the CronJob skips that instance of the Job.
cleanup.successfulJobsHistoryLimitint1Number of successful finished jobs to keep.

Pod Settings - Cloud Cache

KeyTypeDefaultDescription
cloudCache.imageobject-Configuration values of the cloud cache image.
cloudCache.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
cloudCache.image.tagstring"1.3.4-2"Image tag.
cloudCache.podAnnotationsobject-Pod annotations. Additional custom annotations for cloud-cache pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
cloudCache.resourcesobject-Resource requests and limits for the container.
cloudCache.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
cloudCache.resources.limits.cpustring"4000m"CPU limit. Throttling occurs if the container exceeds this value.
cloudCache.resources.limits.memorystring"4Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
cloudCache.resources.requestsobject-The minimum amount of resources the container is guaranteed.
cloudCache.resources.requests.cpustring"1000m"CPU request.
cloudCache.resources.requests.memorystring"1Gi"Memory request.

Pod Settings - Config Manager

KeyTypeDefaultDescription
configManager.enabledboolfalseWhether to enable the config manager service. MUST be set to false if SDM Portal is not deployed or configManager will attempt to register with SDM indefinitely.
configManager.imageobject-Configuration values for the config manager service.
configManager.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
configManager.image.tagstring"8.2.0-24"Image tag.
configManager.podAnnotationsobject-Pod annotations. Additional custom annotations for config manager pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
configManager.resourcesobject-Resource requests and limits for the container.
configManager.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
configManager.resources.limits.cpustring"1000m"CPU limit. Throttling occurs if the container exceeds this value.
configManager.resources.limits.memorystring"256Mi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
configManager.resources.requestsobject-The minimum amount of resources the container is guaranteed.
configManager.resources.requests.cpustring"250m"CPU request.
configManager.resources.requests.memorystring"128Mi"Memory request.
configManager.serviceAccountobject-ServiceAccount configuration.
configManager.serviceAccount.createbooltrueSpecifies whether a ServiceAccount will be created. If set to false, pre-create ServiceAccount named "name".
configManager.serviceAccount.namestring""The name of the ServiceAccount to use. If not set, the name of the ServiceAccount will equal the name of the workload.
configManager.upgradeJobServiceAccountobject-Helm upgrade Job ServiceAccount configuration.
configManager.upgradeJobServiceAccount.createbooltrueSpecifies whether a ServiceAccount will be created for the Helm upgrader Job. If set to false, pre-create ServiceAccount named "name". This account has to have all possible roles bound (namespace admin) or else the upgrade Job will fail.
configManager.upgradeJobServiceAccount.namestring""The name of the ServiceAccount to use. If not set, the name of the ServiceAccount will equal the name of the workload.

Pod Settings - Health Check

KeyTypeDefaultDescription
checkHealth.failedJobsHistoryLimitint1Number of failed finished jobs to keep.
checkHealth.imageobject-Configuration values of the image used for health check job.
checkHealth.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
checkHealth.image.tagstring"6.2.0-14"Image tag.
checkHealth.resourcesobject-Resource requests and limits for the container.
checkHealth.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
checkHealth.resources.limits.cpustring"2000m"CPU limit. Throttling occurs if the container exceeds this value.
checkHealth.resources.limits.memorystring"2Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
checkHealth.resources.requestsobject-The minimum amount of resources the container is guaranteed.
checkHealth.resources.requests.cpustring"1000m"CPU request.
checkHealth.resources.requests.memorystring"1Gi"Memory request.
checkHealth.startingDeadlineSecondsint60Deadline (in seconds) for starting the Job, if that Job misses its scheduled time for any reason. After missing the deadline, the CronJob skips that instance of the Job.
checkHealth.successfulJobsHistoryLimitint1Number of successful finished jobs to keep.

Pod Settings - Postprocessor

KeyTypeDefaultDescription
postprocessor.autoscalingobject-Autoscaling configuration values.
postprocessor.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
postprocessor.autoscaling.enabledbooltrueEnable/disable autoscaling.
postprocessor.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling is enabled.
postprocessor.autoscaling.minReplicasint0Minimum number of replicas that need to be deployed.
postprocessor.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
postprocessor.autoscaling.scaleDownobject-ScaleDown configuration values.
postprocessor.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
postprocessor.autoscaling.scaleUpobject-ScaleUp configuration values.
postprocessor.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
postprocessor.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
postprocessor.autoscaling.scaleUp.stabilizationWindowint15Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
postprocessor.autoscaling.targetInputQueueSizeint10Number of messages in backlog to trigger scaling on. Must be greater than 0.
postprocessor.imageobject-Configuration values of the postprocessor image.
postprocessor.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
postprocessor.image.tagstring"8.2.0-24"Image tag.
postprocessor.podAnnotationsobject-Pod annotations. Additional custom annotations for postprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
postprocessor.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
postprocessor.resourcesobject-Resource requests and limits for the container.
postprocessor.resources.limits.cpustringnilCPU limit. Throttling occurs if the container exceeds this value.
postprocessor.resources.limits.memorystring"16Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
postprocessor.resources.requestsobject-The minimum amount of resources the container is guaranteed.
postprocessor.resources.requests.cpustring"2500m"CPU request.
postprocessor.resources.requests.memorystring"2Gi"Memory request.
postprocessor.serviceAccountobject-ServiceAccount configuration.
postprocessor.serviceAccount.createbooltrueSpecifies whether a ServiceAccount will be created. If set to false, pre-create ServiceAccount named "name".
postprocessor.serviceAccount.namestring""The name of the ServiceAccount to use. If not set, the name of the ServiceAccount will equal the name of the workload.
postprocessor.terminationGracePeriodSecondsint3600Termination grace period in seconds. The application's internal shutdown grace period is automatically set to 30 seconds less than this value to ensure graceful shutdown completes before Kubernetes sends SIGKILL.

Pod Settings - Preprocessor

KeyTypeDefaultDescription
preprocessor.autoscalingobject-Autoscaling configuration values.
preprocessor.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
preprocessor.autoscaling.enabledbooltrueEnable/disable autoscaling.
preprocessor.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling is enabled.
preprocessor.autoscaling.minReplicasint0Minimum number of replicas that need to be deployed.
preprocessor.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
preprocessor.autoscaling.scaleDownobject-ScaleDown configuration values.
preprocessor.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
preprocessor.autoscaling.scaleUpobject-ScaleUp configuration values.
preprocessor.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
preprocessor.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
preprocessor.autoscaling.scaleUp.stabilizationWindowint15Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
preprocessor.autoscaling.targetInputQueueSizeint10Number of messages in backlog to trigger scaling on. Must be greater than 0.
preprocessor.imageobject-Configuration values of the preprocessor image.
preprocessor.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
preprocessor.image.tagstring"8.2.0-24"Image tag.
preprocessor.podAnnotationsobject-Pod annotations. Additional custom annotations for preprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
preprocessor.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
preprocessor.resourcesobject-Resource requests and limits for the container.
preprocessor.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
preprocessor.resources.limits.cpustring"4000m"CPU limit. Throttling occurs if the container exceeds this value.
preprocessor.resources.limits.memorystring"4Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
preprocessor.resources.requestsobject-The minimum amount of resources the container is guaranteed.
preprocessor.resources.requests.cpustring"1000m"CPU request.
preprocessor.resources.requests.memorystring"1Gi"Memory request.

Pod Settings - Preprocessor Unpacker

The Preprocessor Unpacker shares the Processor's container image (processor.image); it does not have a dedicated image configuration.

KeyTypeDefaultDescription
preprocessorUnpacker.autoscalingobject-Autoscaling configuration values.
preprocessorUnpacker.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
preprocessorUnpacker.autoscaling.enabledbooltrueEnable/disable autoscaling.
preprocessorUnpacker.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling is enabled.
preprocessorUnpacker.autoscaling.minReplicasint0Minimum number of replicas that need to be deployed.
preprocessorUnpacker.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
preprocessorUnpacker.autoscaling.scaleDownobject-ScaleDown configuration values.
preprocessorUnpacker.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
preprocessorUnpacker.autoscaling.scaleUpobject-ScaleUp configuration values.
preprocessorUnpacker.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
preprocessorUnpacker.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
preprocessorUnpacker.autoscaling.scaleUp.stabilizationWindowint15Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
preprocessorUnpacker.autoscaling.targetInputQueueSizeint10Number of messages in backlog to trigger scaling on. Must be greater than 0.
preprocessorUnpacker.podAnnotationsobject-Pod annotations. Additional custom annotations for postprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
preprocessorUnpacker.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
preprocessorUnpacker.resourcesobject-Resource requests and limits for the container.
preprocessorUnpacker.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
preprocessorUnpacker.resources.limits.cpustringnilCPU limit. Throttling occurs if the container exceeds this value.
preprocessorUnpacker.resources.limits.memorystring"16Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
preprocessorUnpacker.resources.requestsobject-The minimum amount of resources the container is guaranteed.
preprocessorUnpacker.resources.requests.cpustring"4000m"CPU request.
preprocessorUnpacker.resources.requests.memorystring"4Gi"Memory request.
preprocessorUnpacker.scaling.concurrencyCountint0Defines the number of concurrent threads per Spectra Detect instance that should be used for processing. When set to 0, number of threads equals to the number of CPU cores on the system. Modifying this option may impact system performance. Consult with ReversingLabs Support before making any changes to the parameter.
preprocessorUnpacker.scaling.prefetchCountint4Defines the maximum number of individual files that can simultaneously be processed by a single instance of Spectra Core. When one file is processed, another from the queue enters the processing state. Must be greater than 0.
preprocessorUnpacker.terminationGracePeriodSecondsint3600Termination grace period in seconds. The application's internal shutdown grace period is automatically set to 30 seconds less than this value to ensure graceful shutdown completes before Kubernetes sends SIGKILL.

Pod Settings - Processor

KeyTypeDefaultDescription
processor.autoscalingobject-Autoscaling configuration values.
processor.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
processor.autoscaling.enabledbooltrueEnable/disable autoscaling.
processor.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling is enabled.
processor.autoscaling.minReplicasint0Minimum number of replicas that need to be deployed.
processor.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
processor.autoscaling.scaleDownobject-ScaleDown configuration values.
processor.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
processor.autoscaling.scaleUpobject-ScaleUp configuration values.
processor.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
processor.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
processor.autoscaling.scaleUp.stabilizationWindowint15Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
processor.autoscaling.targetInputQueueSizeint10Number of messages in backlog to trigger scaling on. Must be greater than 0.
processor.imageobject-Configuration values of the processor image.
processor.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
processor.image.tagstring"8.2.0-24"Image tag.
processor.podAnnotationsobject-Pod annotations. Additional custom annotations for postprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
processor.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
processor.resourcesobject-Resource requests and limits for the container.
processor.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
processor.resources.limits.cpustringnilCPU limit. Throttling occurs if the container exceeds this value.
processor.resources.limits.memorystring"32Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
processor.resources.requestsobject-The minimum amount of resources the container is guaranteed.
processor.resources.requests.cpustring"4000m"CPU request.
processor.resources.requests.memorystring"4Gi"Memory request.
processor.scaling.concurrencyCountint0Defines the number of concurrent threads per Spectra Detect instance that should be used for processing. When set to 0, number of threads equals to the number of CPU cores on the system. Modifying this option may impact system performance. Consult with ReversingLabs Support before making any changes to the parameter.
processor.scaling.prefetchCountint8Defines the maximum number of individual files that can simultaneously be processed by a single instance of Spectra Core. When one file is processed, another from the queue enters the processing state. Must be greater than 0.
processor.terminationGracePeriodSecondsint3600Termination grace period in seconds. The application's internal shutdown grace period is automatically set to 30 seconds less than this value to ensure graceful shutdown completes before Kubernetes sends SIGKILL.

Pod Settings - Receiver

KeyTypeDefaultDescription
receiver.autoscalingobject-Autoscaling configuration values.
receiver.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
receiver.autoscaling.enabledbooltrueEnable/disable autoscaling.
receiver.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling is enabled.
receiver.autoscaling.minReplicasint1Minimum number of replicas that need to be deployed.
receiver.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
receiver.autoscaling.scaleDownobject-ScaleDown configuration values.
receiver.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
receiver.autoscaling.scaleUpobject-ScaleUp configuration values.
receiver.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
receiver.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
receiver.autoscaling.scaleUp.stabilizationWindowint30Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
receiver.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.
receiver.imageobject-Configuration values of the receiver image.
receiver.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
receiver.image.tagstring"8.2.0-24"Image tag.
receiver.podAnnotationsobject-Pod annotations. Additional custom annotations for postprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
receiver.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
receiver.resourcesobject-Resource requests and limits for the container.
receiver.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
receiver.resources.limits.cpustring"5000m"CPU limit. Throttling occurs if the container exceeds this value.
receiver.resources.limits.memorystring"8Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
receiver.resources.requestsobject-The minimum amount of resources the container is guaranteed.
receiver.resources.requests.cpustring"2000m"CPU request.
receiver.resources.requests.memorystring"1Gi"Memory request.

Pod Settings - Report

KeyTypeDefaultDescription
report.autoscalingobject-Autoscaling configuration values.
report.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
report.autoscaling.enabledbooltrueEnable/disable autoscaling.
report.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling in enabled.
report.autoscaling.minReplicasint1Minimum number of replicas that need to be deployed.
report.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
report.autoscaling.scaleDownobject-ScaleDown configuration values.
report.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
report.autoscaling.scaleUpobject-ScaleUp configuration values.
report.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
report.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
report.autoscaling.scaleUp.stabilizationWindowint30Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
report.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.
report.imageobject-Configuration values of the report image.
report.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
report.image.tagstring"8.2.0-24"Image tag.
report.podAnnotationsobject-Pod annotations. Additional custom annotations for postprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
report.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
report.resourcesobject-Resource requests and limits for the container.
report.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
report.resources.limits.cpustring"8000m"CPU limit. Throttling occurs if the container exceeds this value.
report.resources.limits.memorystring"8Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
report.resources.requestsobject-The minimum amount of resources the container is guaranteed.
report.resources.requests.cpustring"2000m"CPU request.
report.resources.requests.memorystring"2Gi"Memory request.

Pod Settings - Retry Processor

The Retry Processor shares the Processor's container image (processor.image); it does not have a dedicated image configuration.

KeyTypeDefaultDescription
processorRetry.autoscalingobject-Autoscaling configuration values.
processorRetry.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
processorRetry.autoscaling.enabledbooltrueEnable/disable autoscaling.
processorRetry.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling is enabled.
processorRetry.autoscaling.minReplicasint0Minimum number of replicas that need to be deployed.
processorRetry.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
processorRetry.autoscaling.scaleDownobject-ScaleDown configuration values.
processorRetry.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
processorRetry.autoscaling.scaleUpobject-ScaleUp configuration values.
processorRetry.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
processorRetry.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
processorRetry.autoscaling.scaleUp.stabilizationWindowint15Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
processorRetry.autoscaling.targetInputQueueSizeint10Number of messages in backlog to trigger scaling on. Must be greater than 0.
processorRetry.podAnnotationsobject-Pod annotations. Additional custom annotations for postprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
processorRetry.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
processorRetry.resourcesobject-Resource requests and limits for the container.
processorRetry.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
processorRetry.resources.limits.cpustringnilCPU limit. Throttling occurs if the container exceeds this value.
processorRetry.resources.limits.memorystring"64Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
processorRetry.resources.requestsobject-The minimum amount of resources the container is guaranteed.
processorRetry.resources.requests.cpustring"4000m"CPU request.
processorRetry.resources.requests.memorystring"8Gi"Memory request.
processorRetry.scaling.concurrencyCountint0Defines the number of concurrent threads per Spectra Detect instance that should be used for processing. When set to 0, number of threads equals to the number of CPU cores on the system. Modifying this option may impact system performance. Consult with ReversingLabs Support before making any changes to the parameter.
processorRetry.scaling.prefetchCountint1Defines the maximum number of individual files that can simultaneously be processed by a single instance of Spectra Core. When one file is processed, another from the queue enters the processing state. Must be greater than 0. Recommended value for this type of processor is 1.
processorRetry.terminationGracePeriodSecondsint28800Termination grace period in seconds. The application's internal shutdown grace period is automatically set to 30 seconds less than this value to ensure graceful shutdown completes before Kubernetes sends SIGKILL.

Pod Settings - TC Libs

KeyTypeDefaultDescription
tclibs.autoscalingobject-Autoscaling configuration values.
tclibs.autoscaling.cooldownPeriodint180The period to wait after the last trigger reported active before scaling the resource back to 0, in seconds.
tclibs.autoscaling.enabledbooltrueEnable/disable autoscaling.
tclibs.autoscaling.maxReplicasint8Maximum number of replicas that can be deployed when scaling is enabled.
tclibs.autoscaling.minReplicasint1Minimum number of replicas that need to be deployed.
tclibs.autoscaling.pollingIntervalint10Interval to check each trigger, in seconds.
tclibs.autoscaling.scaleDownobject-ScaleDown configuration values.
tclibs.autoscaling.scaleDown.stabilizationWindowint180Number of continuous seconds in which the scaling condition is not met. When this is reached, scale down is started.
tclibs.autoscaling.scaleUpobject-ScaleUp configuration values.
tclibs.autoscaling.scaleUp.numberOfPodsint1Number of pods that can be scaled in the defined period.
tclibs.autoscaling.scaleUp.periodint30Interval in which the numberOfPods value is applied.
tclibs.autoscaling.scaleUp.stabilizationWindowint30Number of continuous seconds in which the scaling condition is met. When this is reached, scale up is started.
tclibs.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.
tclibs.imageobject-Configuration values of the tcLibs image.
tclibs.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
tclibs.image.tagstring"0.1.1-2"Image tag.
tclibs.replicaCountint1Number of desired pod instances. Ignored when autoscaling is enabled.
tclibs.resourcesobject-Resource requests and limits for the container.
tclibs.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
tclibs.resources.limits.cpustring"2000m"CPU limit. Throttling occurs if the container exceeds this value.
tclibs.resources.limits.memorystring"2Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
tclibs.resources.requestsobject-The minimum amount of resources the container is guaranteed.
tclibs.resources.requests.cpustring"1000m"CPU request.
tclibs.resources.requests.memorystring"1Gi"Memory request.

Pod Settings - Yara Sync

KeyTypeDefaultDescription
yaraSync.imageobject-Configuration values of the yara sync image.
yaraSync.image.pullPolicystring"Always"Image pull policy. Options: Always, IfNotPresent, Never.
yaraSync.image.tagstring"8.2.0-24"Image tag.
yaraSync.podAnnotationsobject-Pod annotations. Additional custom annotations for postprocessor pods. Note: checksum annotation is automatically added in the deployment when Reloader is disabled.
yaraSync.resourcesobject-Resource requests and limits for the container.
yaraSync.resources.limitsobject-The maximum amount of resources the container is allowed to consume.
yaraSync.resources.limits.cpustring"2000m"CPU limit. Throttling occurs if the container exceeds this value.
yaraSync.resources.limits.memorystring"2Gi"Memory limit. If exceeded, the container may be terminated with an OOMKilled error.
yaraSync.resources.requestsobject-The minimum amount of resources the container is guaranteed.
yaraSync.resources.requests.cpustring"1000m"CPU request.
yaraSync.resources.requests.memorystring"1Gi"Memory request.