All notable changes to Code Local Engine project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Snyk Code rules updated
- Updated
broker-client
to 4.203.4 - Update routing to handle Code PR checks in
sast-analysis-api
instead ofcode-pr-check-service
. Thecode-pr-check-service
has been made redundant and is pending removal.
- The
broker-client
no longer supports body logging (broker-client.logEnableBody
). This value is deprecated, and has no effect if specified.
scm-bundle-store
andminio
images upgraded to resolve a vulnerability in the Golang SSH package. This vulnerability was not reachable in SCLE.
broker-client
supports the GitHub Server App integration type - this functionality is in Closed Beta. Discuss with your Snyk representative for enablement.- New documentation to support configuration of GitHub Server App connections with Snyk Code Local Engine
- Corrected
github-com
togithub
when specifying a Universal Broker connection togithub.com
- Removed the
ephemeral-storage
limit forscm-bundle-store
. This prevents pods that were previously being replaced by Kubernetes when exceedingephemeral-storage
limits remaining until cluster-level garbage collection occurs, keeping health checks accurate.
- Snyk Code rules updated
- Updated
broker-client
to 4.196.7
- Included
.snyk
ignore file for Minio - Add Snyk Code Local Engine documentation as a pdf
broker-client
now deploys as a statefulset to increase stability when running in HA mode- Updated
scm-bundle-store
to use Minio instead of MongoDB for backend storage global.localEngine.mongodbSecretName
is deprecated, replaced byglobal.localEngine.s3SecretName
andglobal.localEngine.jwtSecretName
.- Updated
broker-client
to 4.193.4
- References to the MongoDB image are removed
- Removed the deprecated form of
deeproxy.verificationEndpoint
fromvalues-customer-settings.yaml
, usingapi.snyk.io
instead - Added
broker-client.brokerDispatcherUrl
tovalues-customer-settings.yaml
for High Availability Broker
- Support for Personal Access Token in Bitbucket Server
- Resolved an ingress deployment failure when TLS secret name is provided. The fix ensures that Snyk Code Local Engine can now correctly use a pre-existing TLS secret for the certificate and key material when specified
- Corrected Broker behaviour when encountering non-ASCII characters in payloads
- Resolves some C++ analyses reporting all issues on line 1
- Updated
broker-client
to 4.190.3 - Update Snyk Code services with latest rulesets
- Updated values-customer-settings.yaml file with new settings for Universal Broker
- Updated MongoDB image to Debian 12 version
- Updated ignores for MongoDB
- Updated
broker-client
to 4.181.1
- Removed local analysis queue debug endpoints
- Corrected a filter for the GitLab Snyk Broker that would cause some requests to fail
- Updated the list of images to remove the standalone
mongodb
image, which is no longer required - Updated
broker-client
to v4.179.3
- Support for multiple SCMs/instances of SCMs via Broker in Universal mode
- Updated snyk ignore file for Redis
- Added versioned snyk ignore (.snyk) files. These files detail any vulnerabilities within Snyk Code Local Engine that are either unreachable or otherwise not valid.
- Resolved a Helm validation bug for Broker
- Snyk Code rules updated
- Updated
broker-client
to v4.174.1
scm-bundle-store.server.useTokenAuth
is now deprecated - repository detection should ensure the presence of required headers for self-hosted Azure DevOps/TFS servers. This value now has no effect.
scm-bundle-store.server.useTokenAuth
for compatibility with self-hosted Azure DevOps Server
- Corrected documentation for using EU or AU Snyk tenants with Snyk Code Local Engine
- Resolved a bug that caused git requests to Azure DevOps Server to fail
- Snyk Code rules updated
- Introduced additional validation rules for EU or AU Snyk tenant usage
- Updates the default Snyk API domain from
https://snyk.io
tohttps://api.snyk.io
- Updated the
broker-client
to v4.172.6
- Resolved a bug preventing cleanup jobs from running successfully
- Updates to Snyk images for updated rulesets
- Updated the
broker-client
to v4.172.2
- Documentation updated to include alternative tenant setup
- Updates to Snyk images for new rulesets
- Updated the
broker-client
to v4.171.9
- Snyk Code rules updated
- Suggest services updated JDK to remove vulnerabilities
- Documentation updated to remove "Overview" section and streamline introduction to Snyk Code Local Engine
- CronJobs to clean up older/expired data in MongoDB
- Minimum Kubernetes version is now 1.21
- Fixed non-reachable vulnerabilities in the scm-bundle-store and mongodb components.
- Corrected the list of images under the Private Registry section
- The
scm-meld
component is no longer required and has been removed
- Resolved an "Unauthorized" failure during IDE and CLI scans occurring after a proxy CA certificate change. The fix ensures that Snyk Code Local Engine properly picks up the new configuration when redeployed.
- The
/status
endpoint is now also presented on/
for better compatibility with Load Balancer health checks
- Updated the
broker-client
to v4.169.2 - Updates to latest Snyk Code rules
- Updates to Snyk Code services
- Fixed outbound CA support for SCM when a proxy is not utilized
- Updated the architectural diagram with
suggest-sticky
component
- Introduced a new
largeManifestFileRule
value, gives the option to add rule for fetching large manifest file. Avaliable for Github and Github Enterprise only. - Caching mechanism for IDE scans by the new
suggest-sticky
component.
- Updated architecture diagram with new internal-proxy connectivity
- Updated Ingress template to include the
host
key if specified - Updated documentation for JetBrains IDE
internal-proxy
component (based onenvoy
) replaces routes previously defined by the Ingress resource
- Updated the
broker-client
to v4.163.0 - Ingress resource simplified - defies one route (
/
) and removes the need for request rewriting/regex capture groups
- Updated documentation for proxy and custom Certificate Authority support for better clarity
- Specify the
brokerServerUrl
by default in thevalues-customer-settings.yaml
file
- Any references to the previously-used MongoDB Sharded cluster in documentation
- The pre-packaged NGINX Ingress Controller is removed. Functionality is handled internally by the
internal-proxy
component
- Allows python projects that use poetry to be scanned by Snyk Open Source through the broker
- Updated the
broker-client
to v4.161.0 - Updated Snyk Code services for latest analysis rules
- Changed database infrastructure for
scm-bundle-store
from a sharded MongoDB cluster to a single MongoDB instance
- Fixed an upgrade/stability issue with MongoDB by migrating to a single MongoDB instance
- Snyk Code Local Engine now supports custom CAs towards SCMs via
global.privateCaCert.*
values. - A subset of available Helm values are listed in documentation
- A subset of available Helm values are subject to input validation
- The IDE has been added to the Architecture diagram
- NGINX Ingress documentation has been updated to better reflect usage and deployment options
- The
global.proxy.cert
andglobal.proxy.useCustomCert
values are both deprecated.
- The inbuilt NGINX Ingress Controller is now disabled by default, and is separate from the Ingress resource. This enables customers to re-use their own instance of NGINX Ingress Controller without manually manipulating the Chart.
- To enable the NGINX Ingress Controller, set
global.ingressController.enabled: true
.
- To enable the NGINX Ingress Controller, set
- Support for custom image registries:
- Authenticated/unauthenticated private registries
- Custom image pull secrets
- IDE Scans for VSCode v1.21 and higher
- Update of scm-meld to support custom CA override
- Update of files-bundle-store to improve CPU usage, and concurrency
- Suggest has been upgraded with some key bug fixes:
- Better queueing mechanism to reduce stuck analyses
- Introduced better analyses timeout mechanisms
- Suggest runs as non-root
- Migrates additional services to run as non-root
- Inconsistency when deploying Local Engine to a custom namespace
- Webhook creation for PR checks
- Modular service deployment, only deploy the services needed for the intended use case
- PR check functionality
- Ability to configure self managed secrets
- Partial standardisation of service base images (more to follow)
- Partial migration of services not to run as root anymore (more to follow)
- Updates core Snyk Code services to include new rule sets
- We removed CRDs and ClusterRoles - no more cluster-wide access needed.
- Includes the “new” Snyk Code stack, giving customers parity between Snyk SaaS and Local Engine environments.
- We host the Helm Chart on Dockerhub - customers can pull the Helm Chart with the same credentials for v1.Documentation and the values-customer-settings.yaml are still shared manually with the customer.
- We removed CRDs and ClusterRoles - no more cluster-wide access needed.
- This release does not include PR Checks. CLI scans/ Imports are currently supported.
- This release does not include pulling images from a custom registry.
- This release does not include centralised logging.