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.

Sign up for GitHub

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

Jump to bottom

Add instructions to run OpenSearch from source code #3512

Merged
merged 7 commits into from
Feb 24, 2025
Merged

Add instructions to run OpenSearch from source code #3512

merged 7 commits into from
Feb 24, 2025

Conversation

Yerzhaisang
Copy link
Contributor

Description

While working on a recent issue, I faced challenges figuring out how to test my implementation locally. Thankfully, @brianf-aws guided me on how to run ml-commons from the source code.

To help new contributors avoid similar confusion, I’ve added clear instructions on how to build and run OpenSearch from source, enabling them to test their changes effectively.

Related Issues

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@opensearch-trigger-bot opensearch-trigger-bot bot added the documentation Improvements or additions to documentation label Feb 6, 2025
@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 6, 2025 22:15 — with GitHub Actions Failure
@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 6, 2025 22:15 — with GitHub Actions Failure
dhrubo-os
dhrubo-os reviewed Feb 6, 2025
View reviewed changes
dhrubo-os
dhrubo-os reviewed Feb 6, 2025
View reviewed changes
@dhrubo-os
Copy link
Collaborator

Thanks a lot for raising this PR; it's something I've been planning to raise for a while! :D

brianf-aws
brianf-aws suggested changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@brianf-aws brianf-aws left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the initiative! Left some comments to enhance the tutorial

ylwu-amzn
ylwu-amzn reviewed Feb 7, 2025
View reviewed changes
@ylwu-amzn
Copy link
Collaborator

How about move the docker compose file to docs/docker ?

@dhrubo-os
Copy link
Collaborator

dhrubo-os commented Feb 10, 2025 •
edited
Loading

@Yerzhaisang take updates from upstream for integ tests to pass.

@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 11, 2025 20:44 — with GitHub Actions Failure
@Yerzhaisang Yerzhaisang temporarily deployed to ml-commons-cicd-env-require-approval February 11, 2025 20:44 — with GitHub Actions Inactive
@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 11, 2025 22:26 — with GitHub Actions Failure
@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 11, 2025 22:26 — with GitHub Actions Failure
@Yerzhaisang Yerzhaisang requested a deployment to ml-commons-cicd-env-require-approval February 11, 2025 22:41 — with GitHub Actions Waiting
@Yerzhaisang Yerzhaisang requested a deployment to ml-commons-cicd-env-require-approval February 11, 2025 22:41 — with GitHub Actions Waiting
pyek-bot
pyek-bot reviewed Feb 12, 2025
View reviewed changes
ylwu-amzn
ylwu-amzn previously approved these changes Feb 19, 2025
View reviewed changes
pyek-bot
pyek-bot reviewed Feb 19, 2025
View reviewed changes
@Yerzhaisang Yerzhaisang temporarily deployed to ml-commons-cicd-env-require-approval February 22, 2025 20:00 — with GitHub Actions Inactive
@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 22, 2025 20:00 — with GitHub Actions Failure
@Yerzhaisang Yerzhaisang temporarily deployed to ml-commons-cicd-env-require-approval February 22, 2025 20:00 — with GitHub Actions Inactive
@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 22, 2025 20:00 — with GitHub Actions Error
@Yerzhaisang Yerzhaisang requested a deployment to ml-commons-cicd-env-require-approval February 22, 2025 20:20 — with GitHub Actions Waiting
@Yerzhaisang Yerzhaisang requested a deployment to ml-commons-cicd-env-require-approval February 22, 2025 20:20 — with GitHub Actions Waiting
@Yerzhaisang Yerzhaisang requested a deployment to ml-commons-cicd-env-require-approval February 22, 2025 20:20 — with GitHub Actions Waiting
@Yerzhaisang Yerzhaisang requested a deployment to ml-commons-cicd-env-require-approval February 22, 2025 20:20 — with GitHub Actions Waiting
@Yerzhaisang
Copy link
Contributor Author

I successfully managed OpenSearch Dashboards. @dhrubo-os, thank you!

@dhrubo-os
Copy link
Collaborator

overall looks good. Let's address [nit] comments and we are good to go to merge this PR. Thanks for working on this.

@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 23, 2025 22:01 — with GitHub Actions Failure
@Yerzhaisang Yerzhaisang temporarily deployed to ml-commons-cicd-env-require-approval February 23, 2025 22:01 — with GitHub Actions Inactive
@Yerzhaisang Yerzhaisang had a problem deploying to ml-commons-cicd-env-require-approval February 23, 2025 22:01 — with GitHub Actions Error
@Yerzhaisang Yerzhaisang temporarily deployed to ml-commons-cicd-env-require-approval February 23, 2025 22:01 — with GitHub Actions Inactive
@Yerzhaisang
Copy link
Contributor Author

overall looks good. Let's address [nit] comments and we are good to go to merge this PR. Thanks for working on this.

ready

@ylwu-amzn ylwu-amzn merged commit 4cc00b7 into opensearch-project:main Feb 24, 2025
8 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ylwu-amzn ylwu-amzn ylwu-amzn approved these changes

@dhrubo-os dhrubo-os dhrubo-os approved these changes

@b4sjoo b4sjoo Awaiting requested review from b4sjoo b4sjoo is a code owner

@mingshl mingshl Awaiting requested review from mingshl mingshl is a code owner

@jngz-es jngz-es Awaiting requested review from jngz-es jngz-es is a code owner

@model-collapse model-collapse Awaiting requested review from model-collapse model-collapse is a code owner

@rbhavna rbhavna Awaiting requested review from rbhavna rbhavna is a code owner

@zane-neo zane-neo Awaiting requested review from zane-neo zane-neo is a code owner

@Zhangxunmt Zhangxunmt Awaiting requested review from Zhangxunmt Zhangxunmt is a code owner

@austintlee austintlee Awaiting requested review from austintlee austintlee is a code owner

@HenryL27 HenryL27 Awaiting requested review from HenryL27 HenryL27 is a code owner

@xinyual xinyual Awaiting requested review from xinyual xinyual is a code owner

@brianf-aws brianf-aws Awaiting requested review from brianf-aws

@pyek-bot pyek-bot Awaiting requested review from pyek-bot

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Yerzhaisang @dhrubo-os @ylwu-amzn @brianf-aws @pyek-bot