opensearch-project / opensearch-project/flow-framework

[FEATURE] Template for ML resource cleanup

Open
#1,297 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
62
Forks
66
Avg merge
3d 20h
Merged PRs (30d)
20

Description

Is your feature request related to a problem?

Currently, Flow Framework has several pre-configured templates for deploying remote models and creating corresponding connectors: https://docs.opensearch.org/latest/automating-configurations/workflow-templates/#supported-workflow-templates. However, there is
no similar template that allows cleanup of ML resources. This is needed for scenarios involving one-time autonomous actions that need to create resources during a setup step and tear them down after the action is completed.

What solution would you like?

Template that can roll back resources create by "model deployment" templates:

  • undeploy model
  • delete model
  • delete model group
  • delete connector
What alternatives have you considered?

Perform resource cleanup via individual API calls. This lowers user adoption because such operations require deeper knowledge of OpenSearch internals and are error-prone.

Do you have any additional context?

This new functionality would be helpful for search relevance experiment scenarios, when a user does not have a connector to an LLM but wants to use features like LLM-generated judgments: https://docs.opensearch.org/latest/search-plugins/search-relevance/
using-search-relevance-workbench

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files or tests are named. Start by reviewing the supported workflow templates and the model-deployment templates referenced in the issue, then trace the existing resource APIs. Done means a cleanup template can undeploy the model and delete the model, model group, and connector.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
ai, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.