TDP v3.5.1 Release Notes

Release date: 19 June 2023 (Last updated: 20 March 2024)

📘

Quality Management

TetraScience is committed to creating quality software. Software is developed and tested by using the ISO 9001-certified TetraScience Quality Management system. This system ensures the quality and reliability of TetraScience software while maintaining data confidentiality and integrity.

What's New

TetraScience has released its next version of the Tetra Data Platform (TDP), version 3.5.1. This release focuses on bug fixes.

New Functionality

New functionality includes features not previously available in TDP. These features may or may not affect "intended use" for GxP validation purposes.

  • There is no new functionality in this release.

Enhancements

Enhancements are modifications to existing functionality that improve performance or usability, but do not alter the function or intended use of the system.

  • Node.js memory settings are now dynamically configured based on allocated compute size.

Bug Fixes

The following bugs are now fixed:

  • Max Parallel Workflows and Pipeline Priority settings now work as expected, without slowing down or increasing other pipelines' processing speeds within the same organization.
  • For applications that use the /file route to access the TDP File Details page, requests sent to access the page no longer return a 404 error code. All redirects that use the /file route now correctly display TDP file details information.
  • URLs for TDP users that are not signed in to the platform are now correctly redirected to the TDP login page. After the user signs in, they are then redirected to the original URL. (Issue # 2595)
  • Pipelines that are configured with a pipeline is trigger condition on input files that either have a label added or updated now work as expected.

Deprecated Features

The following features have been deprecated for this release or are now on a deprecation path:

  • There are no new deprecated features in this release.

For more information about TDP deprecations, see Tetra Product Deprecation Notices.

Known and Possible Issues

The following are known and possible issues for the TDP v3.5.1 release:

  • If an IDS’s protocol doesn’t have a README file, then the ReadMe tab displays as blank on the IDS Details page for that IDS.
  • When editing a user-defined Agent, customers can create a Source Type value that includes unsupported, uppercase letters. The Source Type value doesn’t allow uppercase letters normally.
  • If customers modify an existing collection of search queries by adding a new filter condition from one of the Option modals (Basic, Attributes, Data (IDS) Filters, or RAW EQL), but they don't select the Apply button, the previous, existing query is deleted. To modify the filters for an existing collection, customers must select the Apply button in the Options modal before they update the collection. For more information, see How to Save Collections and Shortcuts.
  • Processing a single file can sometimes run a pipeline more than once. When this happens, one file can run duplicate TDP workflows or send duplicate events to downstream systems. The behavior occurs because Amazon Simple Queue Service (Amazon SQS) standard queues provide at-least-once message delivery, but don’t stop messages from being processed multiple times.
  • On the Pipeline Manager page, pipeline trigger conditions that customers set with a text option must match all of the characters that are entered in the text field. This includes trailing spaces, if there are any.
  • File edit and update operations are not supported on metadata and label names (keys) that include special characters. Metadata, tag, and label values can include special characters, but it’s recommended that customers use the approved special characters only. For more information, see Attributes.
  • The File Details page sometimes displays an Unknown status for workflows that are actually either in a Pending or Running status. Output files that are generated by intermediate files within a task script sometimes show an Unknown status, too.
  • Protocol step custom memory settings configured through the TDP UI don’t behave as expected when pipelines are retried after receiving out-of-memory errors. Retries that occur after out-of-memory errors ignore these custom memory settings when calculating the next retry attempt’s memory. A fix for this issue is in development and testing, and will be available in the TDP v3.5.2 patch release. To avoid retries that use less memory than what’s configured in the TDP UI, customers can do either of the following as a temporary workaround:
    • Configure protocol step custom memory settings outside of the TDP UI.
      -or-
    • Configure pipeline retry settings to No Retry.
  • Customer-hosted TDP deployment upgrades to TDP v3.5.1 might fail if AWS permissions for creating network access control lists (ACLs) aren’t configured for the TDP. A fix for this issue is in development and testing, and will be available in the TDP v3.5.2 patch release.
  • When installing a Tetra Hub on a host server that already has an AWS Systems Manager registration key, the Amazon ECS container agent startup fails. An AccessDenied error is then logged in the agent’s Amazon CloudWatch Logs. A fix for this issue is currently in development and testing for a future TDP release. As a workaround, customers can move the existing SSM registration key to a backup location prior to Hub installation, so that the installer won’t detect it. To move an existing SSM registration key to a backup location, run the following command in the host server’s terminal:
    mv /var/lib/amazon/ssm/Vault/Store/RegistrationKey 
    /var/lib/amazon/ssm/Vault/Store/RegistrationKey-backup-$(date +%s)
    
  • The Tetra Hub installation script doesn’t detect an existing Amazon Elastic Compute Cloud (Amazon EC2) instance role on a host server if there is one. If there is an existing AWS Identity and Access Management (IAM) role, the Hub’s Amazon ECS service will attempt to use it. The Hub’s Amazon ECS instance registration process fails when this happens. A fix for this issue is currently in development and testing for a future TDP v3.6.x patch release. As a workaround, customers can detach the Amazon EC2 IAM role from the Amazon EC2 instance, and then rerun the Hub installation script. For more information, see Detach an IAM role in the AWS documentation.

Security

TetraScience continually monitors and tests the TDP codebase to identify potential security issues. There are no security fixes in this release.

Upgrade Considerations

During the upgrade, there might be a brief downtime when users won't be able to access the TDP user interface and APIs. After the upgrade is complete, customers should check their pipelines for failures or cancellations and reprocess those pipelines if any are found. Customers should also do a smoke test of their configuration settings to make sure that there are no failures.

After the upgrade, the TetraScience team verifies that the platform infrastructure is working as expected through a combination of manual and automated tests. If any failures are detected, the issues are immediately addressed or the release is rolled back.

For more information about the release schedule, including the GxP release schedule and timelines, see the Product Release Schedule.

For more details about the timing of the upgrade, customers should contact their customer success manager.

Other Release Notes

To view other TDP release notes, see Tetra Data Platform (TDP) Release Notes.