Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIN M2] WIN (ZIP/MSI) Final Release Artifact Structure #2307

Closed
peterzhuamazon opened this issue Jul 7, 2022 · 1 comment
Closed

[WIN M2] WIN (ZIP/MSI) Final Release Artifact Structure #2307

peterzhuamazon opened this issue Jul 7, 2022 · 1 comment
Assignees

Comments

@peterzhuamazon
Copy link
Member

peterzhuamazon commented Jul 7, 2022

Tasks(ZIP) Tasks(MSI) Estimate Status(ZIP) Status(MSI) Notes
WIN artifact name should follow the binary file naming scheme %{name}-%{version}-%{platform}-%{architecture}.%{extension} so we have a clear path for upgrade/re-release (e.g. opensearch-1.2.0-windows-x64.zip) Same but opensearch-1.2.0-windows-x64.exe or opensearch-1.2.0-windows-x64.msi 0 Completed Will be discussed in new issue ETA ZIP: 2022/09/16
WIN-ZIP should allow users to extract at any location with sufficient permission to run the binary. WIN-MSI artifact should allow users to customize installation locations through a GUI installer. 0 Completed Will be discussed in new issue ETA ZIP: 2022/09/16
WIN artifact should have its dependencies bundled them in the artifact. Same 0 Completed Will be discussed in new issue ETA ZIP: 2022/09/16
WIN-ZIP will have tar-install equivalent script to handle min and plugin specific configurations upon start. WIN-MSI artifact will have pre/post install/remove scripts to handle min and plugin specific configurations 1 Completed Will be discussed in new issue We used to have such script in ODFE, not sure about OpenSearch right now.

In discussion as knn and pa are the reason we have the install script to start with, windows already have a bat file to handle others
WIN-ZIP should have fixed folder structure just like in TAR. WIN-MSI should let MSI itself handle the creation and removal of user/group/dir during installation / removal, and apply any of these logic from the pre/post scripts 0 Completed Will be discussed in new issue ETA ZIP: 2022/09/16
WIN artifact should be as slim as possible, without duplicate libs and related dependencies Same 0 Completed Will be discussed in new issue
WIN artifact should have no reference to Elasticsearch or Kibana Same 0 Completed Will be discussed in new issue
WIN log folder exist in the extracted folder for WIN-ZIP WIN-MSI should redirect its log to corresponding log location per Windows standard 0 Completed Will be discussed in new issue Depend on if we just want to package the zip or direct the log properly to %APPDATA%/Local/opensearch/ or more.

ETA ZIP: 2022/09/16
Uninstall. Not Applicable, depend all on users. WIN-MSI removal will not remove user data from the Windows host, unless user specify when running the uninstaller. n/a Not Applicable Will be discussed in new issue Just like TAR, the default data location is in the same folder as other content, sorely on user to manage their folder structure and configurations.
WIN artifact should have a clear description of its content in metadata Same 0 Completed Will be discussed in new issue manifest.yml
WIN-ZIP should have the LICENSE file included in the zip. WIN artifact should have a clear label of LICENSE file location, as well as the LICENSE type in its metadata. The LICENSE file should always present on the host once installed 1 Completed Will be discussed in new issue ETA ZIP: 2022/09/16
Service files. Not Applicable, depend all on users. WIN-MSI should contain windows service related service file, so user can manage the software with ease n/a Completed Will be discussed in new issue We need to discuss whether this is needed for Windows users
WIN artifact should not couple the opensearch/dashboards process with any additonal plugin services to reduce the complexity and improve the management (e.g. PA) Same 1 No PA No PA k-NN and PA are not available on Windows yet. If the latter bound to be available then it has to be a separate service file if needed, or scripts. It cannot be coupled with the main opensearch process on start/stop.
WIN artifact should handle the initialization of certain plugins automatically Same 0 Completed Will be discussed in new issue

This milestone will serve as testing MSI as well.

All MSI tasks are tracked on this milestone

@peterzhuamazon
Copy link
Member Author

We will discuss about the MSI in another issue.
We will only focus on zip now.
Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant