Skip to content

Latest commit

 

History

History
242 lines (150 loc) · 10.8 KB

CHANGELOG.md

File metadata and controls

242 lines (150 loc) · 10.8 KB
Raw

2.3.0

Features

  • Implemented Key-Outputs and Interface for DSL 2.0 workflows
  • Support setting the source to an application-dependency to a directory that's present in the Git repository of the workflow

New enhancements

  • Improved validation of DSL 2.0 for command-line tools as well as the Build Canvas page of ST4SD Registry UI
  • Miscellaneous optimizations to the ST4SD registry UI

2.2.0

Features

  • Registry UI now supports plotting histograms of properties

2.1.2

Fixes

  • Fixed bug in light validation of DSL 2.0 which would be triggered when the validated graphs contained templates for which some parameters were unset
  • Fixed miscellaneous bugs in st4sd-registry-ui (most important are firefox compatibility and modals responsiveness)

New enhancements

  • Improved light validation of DSL 2.0 helps catch more errors in Graphs before they are admitted into the Graph Library

2.1.1

Fixes

  • Verify the contents of Secrets containing S3 credentials for Internal Experiments (i.e. Build Canvas feature) and the Graph Library

2.1.0

Registry UI improvements

  • Support building experiments using an interactive Build Canvas
    • Experiments created this way can also be Edited using the same Build Canvas
  • Support for a Graph Library containing reusable Graph recipes

New enhancements

  • (Beta) Support for Experiment Domain Specific Language 2.0 (DSL 2.0)

2.0.1

Bugs and regressions

  • Disable "View runs" link on ST4SD Registry for global instances

2.0.0

Registry UI improvements

  • Introduce View Canvas for viewing experiment graphs.
  • (BETA) Introduce Edit Canvas for applying transformations to experiments.

Bugs and regressions

  • Miscellaneous fixes

2.0.0-alpha14

Runtime Service improvements

  • Enhanced support for Transformation Relationships: More powerful substitutions (e.g. replace references with variables and vice versa)
  • Generate DSL 2.0 for Parameterised Virtual Experiment Packages (PVEP) (including synthesized ones).
  • Generate a preview of the would-be DSL for a synthetic PVEP before applying a Relationship to synthesize it.

New enhancements

  • Re-use default gitsecret-oauth that ST4SD admins manually register in st4sd-runtime-service ConfigMap without using Helm

Bugs and regressions

  • Miscellaneous fixes

2.0.0-alpha13

Registry UI updates

  • Upgrade to Vue 3
  • UI can generate stp login command (similar to the OpenShift Web Console feature for oc login)
  • Miscellaneous enhancements to improve User Interface and User Experience (UI/UX)

Bugs and regressions

  • Miscellaneous fixes

2.0.0-alpha12

New enhancements

  • Support deploying ST4SD in namespaces containing ResourceQuota objects

2.0.0-alpha8

New enhancements

  • Ensure properties endpoint produces valid JSON in st4sd-registry-backend
  • Add endpoint for retrieving PVEP properties from all of its runs in st4sd-registry-backend
  • Add property table and line chart for all runs of a PVEP in st4sd-registry-ui
  • Allow searching experiments by properties in st4sd-registry-ui

2.0.0-alpha7

New enhancements

  • Allow fetching measured properties in st4sd-registry-backend
  • Show measured properties for runs in st4sd-registry-ui

Security

  • Fix CVE-2022-25881 in st4sd-registry-ui

2.0.0-alpha6

New enhancements

  • Improved search functionality in the Experiment Registry UI
  • Improved error-reporting in st4sd-runtime-service

Bugs and regressions

  • Surrogates: st4sd-runtime-service uses intra-dependencies to reduce the set of parameters which require an explicit relationship.graphParameteers mapping
  • Fix resolution of environment variables in Components which use a DEFAULTS instruction

2.0.0-alpha

New enhancements

  • Runtime support for surrogates. The runtime registry supports defining relationships between graphs, using the relationships to auto-generate surrogate parameterised virtual experiment packages, and decide between starting a parameterised package and one of its surrogates based on a runtime policy.
  • Local instance of ST4SD registry for parameterised virtual experiment packages. The registry supports viewing the parameterised packages in the ST4SD instance as well as runs of the parameterised packages and their logs. You can access your registry UI at https://${your_domain}/registry-ui/.
  • Documentation to install the full arsenal of ST4SD microservices locally.
  • Public images! We will store our public images in https://quay.io/organization/st4sd/

API Change

Bugs and regressions

  • Miscellaneous optimisations in error reporting

1.6.0

New enhancements

  • Improved definition of virtual experiment entries in the registry. They are now self-contained. We refer to them with the term parameterised virtual experiment packages.
    • Documentation for creating parameterised virtual experiment packages here.
  • Global ST4SD registry of parameterised virtual experiments. The packages in this registry are accessible by all ST4SD deployments.

API Change

  • Updated the payload to ExperimentRestAPI.api_experiment_push() to support the new functionality that the ST4SD registry provides. Please read instructions for updating v1.5.3 virtual experiment entries to v1.6.0 parameterised virtual experiment packages entries.

Bugs and regressions

  • Miscellaneous optimisations in error reporting

v1.5.3

New enhancements

  • Support for virtual experiment interface (measure one or more characteristics of one or more input systems).
  • Support defining namespace wide arguments to virtual experiment instances (e.g. --executionMode="production")
  • Support executing specific commits of virtual experiment definitions hosted on Git
  • Alpha: Support customising kubernetes tasks via components.resourceManager.kubernetes.podSpec

Bugs and regressions

  • Miscellaneous fixes in the K8s backend and the Helm chart

v1.5.2

New enhancements

Updated MongoDB backend to 5.0.9

v1.5.1

Bugs and regressions

  • Miscellaneous fixes in the K8s backend.

v1.5.0

This is the first release of the toolkit as the brand Simulation Toolkit for Scientific Discovery!

New enhancements

  • Replaced custom deployment framework with helm charts

Bugs and regressions

  • Miscellaneous fixes and improvements

v1.4.0

New enhancements

  • Improved error handling and syntax error reports. The runtime will now even report what it thinks you meant to type!
  • Improved RBAC for Kubernetes objects, received clearance by ETE to deploy on shared clusters.
  • Improved reactive implementation leading to greater scalability.
    • Support at least 4000 components per experiment.
  • Garbage collection for kubernetes objects: Use it by providing the additionalOption --executionMode=production
    • For more information, run elaunch.py --help
  • Security
    • Improved authentication / authorization for services
  • Support burstable and best-effort classes on k8s. Burstable pods start with 1/10th of their resource requirements and may grow.

Bugs and regressions

  • Miscellaneous fixes and improvements

API Change

Updated the internal structure of the experiment python module. For example, experiment.db.ExperimentRestAPI is now experiment.service.db.ExperimentRestAPI.

All microservices now require authentication. Additionally, the microservices now reject OpenShift tokens if the associated account does not have permission to Get the workflow-authentication Service object inside the namespace that the workflow stack is deployed to.

v1.3.0

New enhancements

  • New MongoDB documents in the CDB are easier to digest
    • All documents now contain a uid field. Component documents also contain a producers field that points to the uids of their producers.
    • For more information see the api-quickstart notebooks.

Bugs and regressions

  • Miscellaneous fixes and improvements

API Change

  • Renamed nearly all experiment.db.ExperimentRestAPI.api_instance_* methods to experiment.db.ExperimentRestAPI.api_rest_uid_*. Exceptions:
    • api_instance_create is now api_experiment_start
    • api_instance_create_lambda is now api_experiment_start_lambda
  • Changed most experiment.db.ExperimentRestAPI.cdb_* methods to feature a consistent interface.
    • In the deprecated API, arguments to the cdb_* methods were automatically converted to regular strings. Now, this only happens to parameters other than query. The query argument is treated as a MongoDB query.
    • For example, to query for documents containing the hello key with a value that matches the regular expression world[0-9]+ you may use the $regex operator of MongoDB inside query like so: api.cdb_get_document(query={"hello": {"$regex": "world[0-9]+"}}).
    • Documentation for the $regex operator: https://docs.mongodb.com/manual/reference/operator/query/regex
  • We introduce a new class experiment.db.ExperimentRestAPIDeprecated that offers the interface of the now deprecated API. Users may find this new class useful to update their Python notebooks with minimum effort to make them compatible with the latest stable version of the workflow stack. Users may then work on a copy of their code to gradually replace the use of experiment.db.ExperimentRestAPIDeprecated with experiment.db.ExperimentRestAPI.
  • Components that define neither workflowAttributes.maxRestarts nor workflowAttributes.restartHookFile will no longer re-execute indefinitely on a ResourceExhausted exit-reason. They will restart up to 3 times.