Remove default admin credential references in DEVELOPER_GUIDE #1415

ryanbogan · 2024-01-24T23:24:25Z

Description

Remove references to admin:admin default security credentials in the developer guide.

Issues Resolved

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed as 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.

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

codecov · 2024-01-24T23:42:43Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (89fc267) 84.92% compared to head (76de267) 84.82%.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1415      +/-   ##
============================================
- Coverage     84.92%   84.82%   -0.10%     
  Complexity     1274     1274              
============================================
  Files           167      167              
  Lines          5186     5186              
  Branches        491      491              
============================================
- Hits           4404     4399       -5     
- Misses          573      578       +5     
  Partials        209      209

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

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

ryanbogan · 2024-01-25T00:29:27Z

k-NN does not use the demo install security script for integration tests, so modifying the integration test setup is not necessary, per opensearch-project/neural-search#551 (comment)

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

junqiu-lei · 2024-01-25T01:06:09Z

build.gradle

        user = user == null ? "admin" : user
        password = password == null ? "admin" : password


Do we need update here? Since I saw 2.12 k-NN build is failed with:

Suite: Test class org.opensearch.knn.index.AdvancedFilteringUseCasesIT 2> REPRODUCE WITH: ./gradlew ':integTest' --tests "org.opensearch.knn.index.AdvancedFilteringUseCasesIT.testFiltering_whenNonNestedKNNAndNestedFilterAndNonNestedFieldWithNestedAndNonNestedFilterQuery_thenSuccess" -Dtests.seed=30AE712710CE3FFB -Dtests.security.manager=false -Dtests.locale=zh-TW -Dtests.timezone=Asia/Almaty -Druntime.java=21 2> org.opensearch.client.ResponseException: method [DELETE], host [https://localhost:9200], URI [/.plugins-ml-config], status line [HTTP/1.1 403 Forbidden] {"error":{"root_cause":[{"type":"security_exception","reason":"no permissions for [] and User [name=admin, backend_roles=[admin], requestedTenant=null]"}],"type":"security_exception","reason":"no permissions for [] and User [name=admin, backend_roles=[admin], requestedTenant=null]"},"status":403}

https://build.ci.opensearch.org/blue/rest/organizations/jenkins/pipelines/integ-test/runs/7131/nodes/96/steps/456/log/?start=0

https://build.ci.opensearch.org/blue/organizations/jenkins/integ-test/detail/integ-test/7131/pipeline/96

I had that change implemented but based on the comment I linked above the change isn't necessary

From what I understand k-NN doesn't use demo configuration to setup security. Instead it manually configures the required files/settings. Hence the internal_users.yml is never modified and the old password of admin is picked when cluster is spun-up and the config is written to security index.

DEVELOPER_GUIDE.md

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

DarshitChanpura

Ty @ryanbogan . I have left a few comments around using place-holder instead of myStrongPassword123!

DEVELOPER_GUIDE.md

DarshitChanpura · 2024-01-25T17:04:36Z

build.gradle

        user = user == null ? "admin" : user
        password = password == null ? "admin" : password


From what I understand k-NN doesn't use demo configuration to setup security. Instead it manually configures the required files/settings. Hence the internal_users.yml is never modified and the old password of admin is picked when cluster is spun-up and the config is written to security index.

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

DarshitChanpura

LGTM!

* Remove default admin credentials Signed-off-by: Ryan Bogan <rbogan@amazon.com> * Update developer guide Signed-off-by: Ryan Bogan <rbogan@amazon.com> * Debug Signed-off-by: Ryan Bogan <rbogan@amazon.com> * Revert build.gradle changes Signed-off-by: Ryan Bogan <rbogan@amazon.com> * Update developer guide Signed-off-by: Ryan Bogan <rbogan@amazon.com> * Remove default password in favor of <admin-password> Signed-off-by: Ryan Bogan <rbogan@amazon.com> --------- Signed-off-by: Ryan Bogan <rbogan@amazon.com> (cherry picked from commit 0c000ad)

…#1420) * Remove default admin credentials Signed-off-by: Ryan Bogan <rbogan@amazon.com> (cherry picked from commit 0c000ad) Co-authored-by: Ryan Bogan <rbogan@amazon.com>

ryanbogan added 2 commits January 24, 2024 15:24

Remove default admin credentials

8dca144

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

Update developer guide

e5e2f39

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

Debug

e6a01eb

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

Revert build.gradle changes

2d39a50

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

ryanbogan changed the title ~~Remove default admin credentials~~ Remove default admin credential references in DEVELOPER_GUIDE Jan 25, 2024

ryanbogan added backport 2.x skip-changelog labels Jan 25, 2024

ryanbogan marked this pull request as ready for review January 25, 2024 00:54

ryanbogan requested review from heemin32, navneet1v, VijayanB, vamshin, jmazanec15, naveentatikonda, junqiu-lei and martin-gaievski as code owners January 25, 2024 00:54

junqiu-lei reviewed Jan 25, 2024

View reviewed changes

martin-gaievski reviewed Jan 25, 2024

View reviewed changes

DEVELOPER_GUIDE.md Show resolved Hide resolved

Update developer guide

02958d3

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

jmazanec15 previously approved these changes Jan 25, 2024

View reviewed changes

DarshitChanpura reviewed Jan 25, 2024

View reviewed changes

DarshitChanpura mentioned this pull request Jan 25, 2024

[META] Update all instances of admin:admin across different repositories opensearch-project/security#3624

Closed

2 tasks

Remove default password in favor of <admin-password>

76de267

Signed-off-by: Ryan Bogan <rbogan@amazon.com>

ryanbogan dismissed jmazanec15’s stale review via 76de267 January 25, 2024 17:12

ryanbogan requested review from DarshitChanpura, junqiu-lei, martin-gaievski and jmazanec15 January 25, 2024 17:14

thor-the-great approved these changes Jan 25, 2024

View reviewed changes

martin-gaievski approved these changes Jan 25, 2024

View reviewed changes

martin-gaievski requested a review from thor-the-great January 25, 2024 17:23

junqiu-lei approved these changes Jan 25, 2024

View reviewed changes

DarshitChanpura approved these changes Jan 25, 2024

View reviewed changes

ryanbogan merged commit 0c000ad into opensearch-project:main Jan 25, 2024
54 checks passed

ryanbogan deleted the remove_default_admin_credentials branch January 25, 2024 21:01

opensearch-trigger-bot bot mentioned this pull request Jan 25, 2024

[Backport 2.x] Remove default admin credential references in DEVELOPER_GUIDE #1420

Merged

DarshitChanpura mentioned this pull request Jan 26, 2024

[v2.12.0] Ensure CI/documentation reflect changes to default admin credentials #1359

Closed

2 tasks

ryanbogan mentioned this pull request Jan 26, 2024

Fix markdown formatting in developer guide #1426

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove default admin credential references in DEVELOPER_GUIDE #1415

Remove default admin credential references in DEVELOPER_GUIDE #1415

ryanbogan commented Jan 24, 2024 •

edited

Loading

codecov bot commented Jan 24, 2024 •

edited

Loading

ryanbogan commented Jan 25, 2024

junqiu-lei Jan 25, 2024 •

edited

Loading

ryanbogan Jan 25, 2024

DarshitChanpura Jan 25, 2024

DarshitChanpura left a comment

DarshitChanpura Jan 25, 2024

DarshitChanpura left a comment

		user = user == null ? "admin" : user
		password = password == null ? "admin" : password

Remove default admin credential references in DEVELOPER_GUIDE #1415

Remove default admin credential references in DEVELOPER_GUIDE #1415

Conversation

ryanbogan commented Jan 24, 2024 • edited Loading

Description

Issues Resolved

Check List

codecov bot commented Jan 24, 2024 • edited Loading

Codecov Report

ryanbogan commented Jan 25, 2024

junqiu-lei Jan 25, 2024 • edited Loading

Choose a reason for hiding this comment

ryanbogan Jan 25, 2024

Choose a reason for hiding this comment

DarshitChanpura Jan 25, 2024

Choose a reason for hiding this comment

DarshitChanpura left a comment

Choose a reason for hiding this comment

DarshitChanpura Jan 25, 2024

Choose a reason for hiding this comment

DarshitChanpura left a comment

Choose a reason for hiding this comment

ryanbogan commented Jan 24, 2024 •

edited

Loading

codecov bot commented Jan 24, 2024 •

edited

Loading

junqiu-lei Jan 25, 2024 •

edited

Loading