OpenSearch icon indicating copy to clipboard operation
OpenSearch copied to clipboard

[Cleanup] Remove the upgrade-cli tool

Open msfroh opened this issue 7 months ago • 7 comments

Is your feature request related to a problem? Please describe

See the parent issue for details.

Describe the solution you'd like

Essentially, I think we just need to delete the distribution/tools/upgrade-cli directory. It may be referenced in some Gradle files that need to be cleaned up too.

Related component

Other

Describe alternatives you've considered

No response

Additional context

No response

msfroh avatar May 28 '25 22:05 msfroh

Also distribution/src/bin/opensearch-upgrade[.bat], both of which can be deleted as well.

% git grep 'upgrade-cli'
.github/dependabot.yml:  - directory: /distribution/tools/upgrade-cli/
distribution/build.gradle:    libsUpgradeCli project(path: ':distribution:tools:upgrade-cli')
distribution/build.gradle:        into('tools/upgrade-cli') {
distribution/src/bin/opensearch-upgrade:  OPENSEARCH_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/upgrade-cli \
Binary file distribution/src/bin/opensearch-upgrade.bat matches
distribution/tools/upgrade-cli/build.gradle:  archivesName = 'opensearch-upgrade-cli'
settings.gradle:  'distribution:tools:upgrade-cli',

andrross avatar May 29 '25 20:05 andrross

@msfroh Thanks for creating this - looks save to remove. Didn't see any dangling references elsewhere in the project that need to be updated. I only see refs to build manifests where this was included.

peternied avatar May 29 '25 21:05 peternied

Thanks @andrross I stand corrected, it looks like there are references in the docs website https://github.com/opensearch-project/documentation-website/blob/main/_upgrade-to/upgrade-to.md#upgrade-tool

  • Markdown - https://github.com/opensearch-project/documentation-website/blob/main/_upgrade-to/upgrade-to.md#upgrade-tool

peternied avatar May 29 '25 21:05 peternied

@peternied I don't believe that "update-to" section is still accessible. It seems to redirect to the migration assistant now:

https://github.com/opensearch-project/documentation-website/blob/158d1758d2fc397d3e97a467346a9320f4463e61/_migration-assistant/index.md?plain=1#L11-L12

andrross avatar May 29 '25 22:05 andrross

I'd like to work on this. May I work on this?

BeomSeogKim avatar Jun 09 '25 13:06 BeomSeogKim

@BeomSeogKim I've assigned this issue to you, thanks for taking this on!

peternied avatar Jun 09 '25 15:06 peternied

Fix PR: https://github.com/opensearch-project/OpenSearch/pull/18494

injae-kim avatar Jun 12 '25 13:06 injae-kim

Catch All Triage - 1 2

andrross avatar Jul 07 '25 16:07 andrross