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

[Security] Updates dev guide for security #5736

Merged

Conversation

ashwin-pc
Copy link
Member

@ashwin-pc ashwin-pc commented Jan 25, 2024

Description

The instructions in the dev guide were insufficient to setup OSD with security for development. Updated the instructions to what worked for me.

Issues Resolved

Screenshot

Testing the changes

Follow the instructions and see of you can setup OSD with security for development.

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

Signed-off-by: Ashwin P Chandran <[email protected]>
Signed-off-by: Ashwin P Chandran <[email protected]>
@ashwin-pc ashwin-pc removed docs Improvements or additions to documentation Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry labels Jan 25, 2024
@ashwin-pc ashwin-pc changed the title [Docs] Updates dev guide for security [Security] Updates dev guide for security Jan 25, 2024
Signed-off-by: Ashwin P Chandran <[email protected]>
Copy link

codecov bot commented Jan 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (058dfbc) 67.03% compared to head (58fbbeb) 67.03%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5736   +/-   ##
=======================================
  Coverage   67.03%   67.03%           
=======================================
  Files        3296     3296           
  Lines       63343    63343           
  Branches    10087    10087           
=======================================
  Hits        42465    42465           
  Misses      18429    18429           
  Partials     2449     2449           
Flag Coverage Δ
Linux_1 35.23% <ø> (ø)
Linux_2 55.18% <ø> (ø)
Linux_3 43.92% <ø> (ø)
Linux_4 35.33% <ø> (ø)
Windows_1 35.26% <ø> (ø)
Windows_2 55.15% <ø> (ø)
Windows_3 43.93% <ø> (ø)
Windows_4 35.33% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

kavilla
kavilla previously approved these changes Jan 25, 2024
Signed-off-by: Ashwin P Chandran <[email protected]>
@manasvinibs manasvinibs merged commit 1a0cf47 into opensearch-project:main Jan 26, 2024
67 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-5736-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 1a0cf47fe646458938e0892e4ed73326d581a122
# Push it to GitHub
git push --set-upstream origin backport/backport-5736-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-5736-to-2.x.

AMoo-Miki pushed a commit to AMoo-Miki/OpenSearch-Dashboards that referenced this pull request Feb 3, 2024
* [Docs] Updates dev guide for security

Signed-off-by: Ashwin P Chandran <[email protected]>

* better default creds

Signed-off-by: Ashwin P Chandran <[email protected]>

* undo changelog changes

Signed-off-by: Ashwin P Chandran <[email protected]>

* Adds sample password

Signed-off-by: Ashwin P Chandran <[email protected]>

---------

Signed-off-by: Ashwin P Chandran <[email protected]>

(cherry picked from commit 1a0cf47)
Signed-off-by: Miki <[email protected]>
yujin-emma pushed a commit to yujin-emma/OpenSearch-Dashboards that referenced this pull request Feb 5, 2024
* [Docs] Updates dev guide for security

Signed-off-by: Ashwin P Chandran <[email protected]>

* better default creds

Signed-off-by: Ashwin P Chandran <[email protected]>

* undo changelog changes

Signed-off-by: Ashwin P Chandran <[email protected]>

* Adds sample password

Signed-off-by: Ashwin P Chandran <[email protected]>

---------

Signed-off-by: Ashwin P Chandran <[email protected]>
Signed-off-by: yujin-emma <[email protected]>
abbyhu2000 pushed a commit that referenced this pull request Feb 6, 2024
* [Docs] Updates dev guide for security



* better default creds



* undo changelog changes



* Adds sample password



---------



(cherry picked from commit 1a0cf47)

Signed-off-by: Ashwin P Chandran <[email protected]>
Signed-off-by: Miki <[email protected]>
Co-authored-by: Ashwin P Chandran <[email protected]>
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.

4 participants