[Complete][Help Needed][Helm] Migrate Helm-Charts to opensearch-project/helm-charts Standalone Repo

[peterzhuamazon]

Is your feature request related to a problem? Please describe.
We have published Helm-Charts standalone repo today with the help of community votes on naming #49.
https://github.com/opensearch-project/helm-charts

We now need to migrate helm charts from this repo to the standalone one.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[TheAlgo]

Thanks @peterzhuamazon for making this. This will be helpful for the community.
Solutions/Steps which I would like to propose for migration:

1. We can transfer all the helm charts from the devops repository to the new repo for Helm chart(without erasing the history).
2. Add a hyperlink for the helm charts from the devops repository something like this. Here docs is linked to a different repository. This will not break it for existing users who might be referring this repo. This way they can get redirected to the Helm Chart repos.
3. All the charts should go in the root of the repository with individual README.md for each chart and in the main README.md (for the entire repo) we should have instructions for adding the repo, pre-requisites, quickstart , support matrix , useful docs etc plus the existing content.

Near future:
Add a root folder named samples/examples which will contain charts solving particular use-cases like logging, monitoring. These charts will reference the core charts of OpenSearch and OpenSearch Dashboards.

[peterzhuamazon]

Thanks @TheAlgo, any more suggestions from other members?

@DandyDeveloper @mprimeaux @smlx

[mprimeaux]

@peterzhuamazon and @TheAlgo

Regarding the above bullets above...

1. I don't have a preference on preserving history other than to say that it might be best to consider not moving history from the old repository into the new repository but instead place a deprecation notice in the README, which accomplishes the desire to preserve history without breaking any existing dependent link and also provides notice to folks with the existing link to now go here. Similar to how it was done here with the Helm community charts.
2. The Helm Chart Releaser and Helm Chart Tester actions that I completed a few weeks ago and plan to issue a PR for does this already. As an example, see this.
3. This is also addressed by bullet 2.

I think we should consider having the root folder for the charts in the new repository named stable to account for experimental charts. Well, either that or keep the root folder as charts (might be better in retrospect) and then simply adhere to Semver for experimental charts as version 0.<minor>.<patch>.

Please let me know if I can clarify. Happy to help.

[TheAlgo]

@peterzhuamazon and @TheAlgo

Regarding the above bullets above...

1. I don't have a preference on preserving history other than to say that it might be best to consider not moving history from the old repository into the new repository but instead place a deprecation notice in the README, which accomplishes the desire to preserve history without breaking any existing dependent link and also provides notice to folks with the existing link to now go here. Similar to how it was done here with the Helm community charts.
2. The Helm Chart Releaser and Helm Chart Tester actions that I completed a few weeks ago and plan to issue a PR for does this already. As an example, see this.
3. This is also addressed by bullet 2.

I think we should consider having the root folder for the charts in the new repository named stable to account for experimental charts. Well, either that or keep the root folder as charts (might be better in retrospect) and then simply adhere to Semver for experimental charts as version 0.<minor>.<patch>.

Please let me know if I can clarify. Happy to help.

@mprimeaux
I kinda disagree on not moving the history and would like to understand more from you. Reasons being:

1. Helm charts were still under development. The example you mentioned contained full fledged charts.
2. Deprecation is not a good idea since we have just started.

Also I agree on the Semver thingy instead of a stable folder. Let me know if you have further questions.

[mprimeaux]

@TheAlgo Thanks for replying. I’m certainly not strongly opposed to bringing over history.

Regarding deprecation, I should have been more precise. The deprecation is not about the charts but about the old repository. Regardless of where the old repository was in its development lifecycle, there were folks in the community who linked to it or, at the very least, saved bookmarks to it. At least for a period of time.

If you are not deleting the old repository, the community deserves to know that the old repository is no longer maintained and to navigate to the new repository.

if you are deleting the old repository then how will the community know where to efficiently find the new repository?

Preserving history is orthogonal to a deprecation notice.

[TheAlgo]

@mprimeaux I get you. But I am not sure whether the old repository is going to be deleted or deprecated. I guess it will not be deleted. Just the Helm Charts will move and sit in the new repository. @peterzhuamazon can you confirm whether it is correct or wrong?

[mprimeaux]

As an secondary question, if you aren’t concerned about a deprecation notice to the community and have the desire to preserve history then why didn’t we simply rename the old repository to the new name?

[smlx]

My 2c:

• just copy the charts over, don't worry about history. Leave a README.md in the old location with a link.
• put the charts in charts/ in the new repo (e.g. charts/opensearch, charts/opensearch-dashboards). This is what all the standard Helm release tooling expects (e.g. chart-testing and chart-releaser)
• start using Semver from 0.x.x

[TheAlgo]

@DandyDeveloper Your opinions on this?

[DandyDeveloper]

Basically echoing what @smlx and @mprimeaux have said.

• Retain existing repo
• README with deprecation notice + New location
• Add charts/ with subdirectories for dashboards and opensearch
• Semvar 0.x.x

[TheAlgo]

Thanks @DandyDeveloper @smlx @mprimeaux for responding on this migration activity. Looks like everyone is almost on the same page for this migration.

1. Migrate the opensearch and opensearch-dashboards charts to the charts directory of the new repo as subdirectories
2. Add link for the helm charts repo in the Readme of this(opensearch-devops) repo and add a deprecation notice to avoid any engagement related to Helm charts here.
3. Going forward start using Semvar 0.x.x.

I would love to volunteer this migration and move all the charts after #56 is merged as it is breaking the opensearch-dashboards deployment. Cheers to all 😄

[mprimeaux]

@TheAlgo Thanks much for the summary. I think one minor correction to bullet 1 is the OpenSearch and OpenSearch-Dashboards would be placed under a charts/ folder in the root of the repo.

I believe @DandyDeveloper and @smlx will keep me "honest" here.

[TheAlgo]

@TheAlgo Thanks much for the summary. I think one minor correction to bullet 1 is the OpenSearch and OpenSearch-Dashboards would be placed under a charts/ folder in the root of the repo.

I believe @DandyDeveloper and @smlx will keep me "honest" here.

Apologies for this. I missed it. I have edited the summary.

[TheAlgo]

Hi All,

I have started the migration activity, will soon be able to raise the PR comprising both the charts in the new repository.

[peterzhuamazon]

@TheAlgo draft PR: opensearch-project/helm-charts#7

[peterzhuamazon]

Close this issue as the initial migration efforts is complete.