-
Notifications
You must be signed in to change notification settings - Fork 44
[COPS-758] Error descriptions for secrets manager #520
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
Draft
mnd999
wants to merge
6
commits into
neo4j:dev
Choose a base branch
from
mnd999:dev-secrets-mgr
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
62d0c26
Error descriptions for secrets manager
mnd999 91a4897
Fix typo
mnd999 628a35f
Apply suggestions from code review
mnd999 93c9c68
Apply suggestions from code review
mnd999 15ea5a6
Apply suggestions from code review
mnd999 de40685
Update modules/ROOT/pages/errors/gql-errors/51N7C.adoc
renetapopova File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| = 51N7C | ||
|
|
||
| == Status description | ||
| error: system configuration or operation exception - secret provider is not enabled. Secret provider `{ <<secretProviderType>> }` is not available. Enable it with the setting `{ <<cfgSetting>> }`. | ||
|
|
||
| == Explanation | ||
| This error occurs when you call a secret provider that has not been configured. | ||
| The secret provider must be enabled in the _neo4j.conf_ file before calling any methods on it. | ||
|
|
||
| == Possible solutions | ||
|
|
||
| To resolve this issue, add the required secret provider to the list of active providers in the configuration setting `dbms.secretmanager.type`. | ||
|
|
||
| ifndef::backend-pdf[] | ||
| [discrete.glossary] | ||
| == Glossary | ||
|
|
||
| include::partial$glossary.adoc[] | ||
| endif::[] | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| = 51N7D | ||
|
|
||
| == Status description | ||
| error: system configuration or operation exception - secret provider error. Secret provider `{ <<secretProviderType>> }` returned an error. | ||
|
|
||
| == Explanation | ||
| This error occurs when a call to an upstream secret provider fails with an unexpected error. | ||
| This could be due to a misconfiguration of the secret provider, network issues, or other problems with the secret provider itself. | ||
|
|
||
| Related status code xref:errors/gql-errors/51N7C.adoc[51N7C]. | ||
|
|
||
| == Example scenarios | ||
|
|
||
| * The DBMS is configured to use Google Cloud Secret Manager, but the DBMS is prevented from making calls to Google Cloud due to a firewall. | ||
| * The length of the secret that you try to store in Google Cloud Secret Manager is not supported. | ||
|
|
||
| == Possible solutions | ||
|
|
||
| To resolve the issue, examine the logs to determine the underlying cause of the error. | ||
| You may need to resolve it within the underlying provider. | ||
|
|
||
|
|
||
|
|
||
| ifndef::backend-pdf[] | ||
| [discrete.glossary] | ||
| == Glossary | ||
|
|
||
| include::partial$glossary.adoc[] | ||
| endif::[] | ||
|
|
This file contains hidden or 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
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be wonderful to have at least one example. Otherwise, it is not clear what issue is solved in the next section Possible solutions.