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

Update DEVELOPER_GUIDE.md #113

Merged
merged 2 commits into from
Mar 20, 2023

Conversation

Merey1508
Copy link
Contributor

Description

New contributors to the project have been facing an issue with nox testing, which has been causing delays and difficulties in their development process.

Issues Resolved

To address this, an update has been made to the Developer Guide that provides more detailed instructions before running nox tests and troubleshooting common errors. Specifically, during the office hour session, there was a discussion about updating the cluster settings.

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

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.

Comment on lines +81 to +101
After navigating to OpenSearch Dashboards you should update the persistent settings for the cluster. The settings will update the behavior of the machine learning plugin, specifically the ml_commons plugin. ML Commons cluster settings: https://opensearch.org/docs/latest/ml-commons-plugin/cluster-settings/

You should paste this settings in the `Dev Tools` window and run it:

```yml
PUT /_cluster/settings
{
"persistent" : {
"plugins.ml_commons.only_run_on_ml_node" : false,
"plugins.ml_commons.native_memory_threshold" : 100,
"plugins.ml_commons.max_model_on_node": 20
}
}
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

After looking at it again, I feel like we should move it to theNext Steps section, because this step is applicable after installing opensearch through way 1 (docker compose) or way 2 (tarball). So let's not put it under way 1.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, thanks a lot for your guidance!

@dhrubo-os
Copy link
Collaborator

Thanks for solving the DCO issue.

Signed-off-by: Merey <orazaly1508@gmail.com>
Signed-off-by: Merey <orazaly1508@gmail.com>
@dhrubo-os dhrubo-os merged commit f6cf39f into opensearch-project:main Mar 20, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 20, 2023
* Dev guide update

Signed-off-by: Merey <orazaly1508@gmail.com>

* Edited the developer guide

Signed-off-by: Merey <orazaly1508@gmail.com>

---------

Signed-off-by: Merey <orazaly1508@gmail.com>
(cherry picked from commit f6cf39f)
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 20, 2023
* Dev guide update

Signed-off-by: Merey <orazaly1508@gmail.com>

* Edited the developer guide

Signed-off-by: Merey <orazaly1508@gmail.com>

---------

Signed-off-by: Merey <orazaly1508@gmail.com>
(cherry picked from commit f6cf39f)
dhrubo-os pushed a commit that referenced this pull request Mar 20, 2023
* Dev guide update

Signed-off-by: Merey <orazaly1508@gmail.com>

* Edited the developer guide

Signed-off-by: Merey <orazaly1508@gmail.com>

---------

Signed-off-by: Merey <orazaly1508@gmail.com>
(cherry picked from commit f6cf39f)

Co-authored-by: Merey <orazaly1508@gmail.com>
dhrubo-os pushed a commit that referenced this pull request Mar 20, 2023
* Dev guide update

Signed-off-by: Merey <orazaly1508@gmail.com>

* Edited the developer guide

Signed-off-by: Merey <orazaly1508@gmail.com>

---------

Signed-off-by: Merey <orazaly1508@gmail.com>
(cherry picked from commit f6cf39f)

Co-authored-by: Merey <orazaly1508@gmail.com>
dhrubo-os pushed a commit to dhrubo-os/opensearch-py-ml that referenced this pull request Mar 30, 2023
* Dev guide update

Signed-off-by: Merey <orazaly1508@gmail.com>

* Edited the developer guide

Signed-off-by: Merey <orazaly1508@gmail.com>

---------

Signed-off-by: Merey <orazaly1508@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants