Updates Dev guide #1590
Merged
Updates Dev guide #1590
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Darshit Chanpura <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #1590 +/- ##
============================================
- Coverage 64.57% 62.88% -1.70%
- Complexity 3215 3264 +49
============================================
Files 247 253 +6
Lines 17351 18102 +751
Branches 3082 3247 +165
============================================
+ Hits 11205 11383 +178
- Misses 4597 5064 +467
- Partials 1549 1655 +106
Continue to review full report at Codecov.
|
davidlago
previously approved these changes
Jan 28, 2022
Signed-off-by: Darshit Chanpura <[email protected]>
davidlago
previously approved these changes
Feb 17, 2022
peternied
reviewed
Feb 17, 2022
| @@ -84,7 +94,10 @@ Detected OpenSearch Security Version: * | |||
| ### (Ignore the SSL certificate warning because we installed self-signed demo certificates) | |||
| ``` | |||
|
|
|||
| Now if we start our server again and try the original `curl localhost:9200`, it will fail. Try this one instead: `curl -XGET https://localhost:9200 -u 'admin:admin' --insecure`. You can also make this call to return the authenticated user details: | |||
| Now if we start our server again and try the original `curl localhost:9200`, it will fail. | |||
| Try this one instead: `curl -XGET https://localhost:9200 -u 'admin:admin' --insecure`. It should succeed. | |||
There was a problem hiding this comment.
Feel free to create a new issue
--insecure feels like a bad option to advertise. After the script has finished running can we add a step to install the CA cert that was generated from the install script so this option can be removed?
There was a problem hiding this comment.
This is something that we can discuss and set what needs to be displayed here.
DEVELOPER_GUIDE.md
Outdated
|
|
||
| To get started, follow the [getting started section](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md#getting-started) of OpenSearch's developer guide. This will get you up and running with OpenSearch built from source code. Get to the point where you can run a successful `curl localhost:9200` call (you can skip the `./gradlew check` step to save some time. Great! now kill the server with `Ctrl+c` and copy the built code to a new folder somewhere else where you'll be running your service (run this from the base directory of the OpenSearch fork you cloned above): | ||
| >Please note:\ | ||
| > OpenSearch builds on `gradle`, and this plugin is packaged using `maven`. |
There was a problem hiding this comment.
Could we reference the instructions for how to install the jdk versions we support, OpenSearch has a markdown doc we could link?
Signed-off-by: Darshit Chanpura <[email protected]>
Signed-off-by: Darshit Chanpura <[email protected]>
|
@DarshitChanpura Could I help getting this PR merged? |
@peternied yes..that would be awesome! |
Signed-off-by: Peter Nied <[email protected]>
|
@DarshitChanpura I've created a PR with some of this feedback inside it, thanks for waiting for me to get around to this :) |
Recommendations for the dev guide
peternied
approved these changes
Apr 4, 2022
davidlago
approved these changes
Apr 5, 2022
3 tasks
wuychn
pushed a commit
to ochprince/security
that referenced
this pull request
Mar 16, 2023
* Updates Dev guide Signed-off-by: Darshit Chanpura <[email protected]> Co-authored-by: Peter Nied <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates Developer guide to add more explanation to the steps
Check List
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.