Easing debugging for security not initialized error

[nagarajg17]

Description

If security index is not created during node bootup and if any API call is made we receive generic error OpenSearch Security is not initialized. Security index may not be created for various number of reasons but commonly seen due to master not initialized. To ease the debugging and fixing the issue, adding more details to error statement and possible cause will help. This PR starts with one of the possible cause, it can be extended in future appropriately

Future adding few debug lines to ease debugging during issues

• Category (Enhancement, New feature, Bug fix, Test fix, Refactoring, Maintenance, Documentation)

Maintenance

Issues Resolved

Easing debugging and fixing error

Testing

To minic the scenario added this setting in opensearch.yml node.roles: [data, ingest] to have no master node. Then made API calls to reproduce the error

curl -X GET "https://localhost:9200/my-index-000001/_search?pretty"  -H 'Content-Type: application/json' -u '<>:<>' --insecure

OpenSearch Security is not initialized. Cluster manager not present

Earlier

curl -X GET "https://localhost:9200/my-index-000001/_search?pretty"  -H 'Content-Type: application/json' -u '<>:<>' --insecure

OpenSearch Security is not initialized

Check List

• New functionality includes testing
• New functionality has been documented
• New Roles/Permissions have a corresponding security dashboards plugin PR
• API changes companion pull request created
• 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.

[codecov]

Codecov Report

Attention: Patch coverage is 85.18519% with 4 lines in your changes missing coverage. Please review.

Project coverage is 72.20%. Comparing base (28cb2c8) to head (54a8cfc).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
.../org/opensearch/security/auth/BackendRegistry.java	66.66%	1 Missing and 1 partial ⚠️
...org/opensearch/security/filter/SecurityFilter.java	71.42%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5370      +/-   ##
==========================================
+ Coverage   72.19%   72.20%   +0.01%     
==========================================
  Files         382      382              
  Lines       23697    23716      +19     
  Branches     3644     3649       +5     
==========================================
+ Hits        17107    17124      +17     
+ Misses       4794     4793       -1     
- Partials     1796     1799       +3     

Files with missing lines	Coverage Δ
.../opensearch/security/OpenSearchSecurityPlugin.java	84.68% <100.00%> (ø)
...arch/security/configuration/ClusterInfoHolder.java	79.31% <100.00%> (+21.61%)	⬆️
...earch/security/privileges/PrivilegesEvaluator.java	75.07% <100.00%> (+1.03%)	⬆️
...ch/security/securityconf/DynamicConfigFactory.java	62.58% <100.00%> (+0.25%)	⬆️
.../org/opensearch/security/auth/BackendRegistry.java	77.19% <66.66%> (-0.33%)	⬇️
...org/opensearch/security/filter/SecurityFilter.java	66.82% <71.42%> (-0.17%)	⬇️

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[cwperks]

@nagarajg17 can we also add a CHANGELOG entry for this? I think its a significant enough change to have an entry in the CHANGELOG.

[DarshitChanpura]

@nagarajg17 can we also add a CHANGELOG entry for this? I think its a significant enough change to have an entry in the CHANGELOG.

+1

[DarshitChanpura]

@nagarajg17 Would you mind checking the test failures?

[nagarajg17]

I see PR is merged. I didn't get a chance to check test failures yesterday, will check it and create another PR for CHANGELOG