Add documentation examples for loading credentials externally #2299
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
added 2 commits
February 8, 2023 09:59
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
added 2 commits
February 8, 2023 10:11
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
stichbury
reviewed
Feb 8, 2023
| @@ -113,3 +113,70 @@ def after_dataset_loaded(self, dataset_name: str, data: Any) -> None: | |||
| end = time.time() | |||
| self._logger.info("Loading dataset %s ended at %0.3f", dataset_name, end) | |||
| ``` | |||
|
|
|||
| ## Use Hooks to load external credentials | |||
| We recommend using the `after_context_created` Hook to add credentials to the session's config loader instance. In this example we show how to load credentials from Azure KeyVault. | |||
There was a problem hiding this comment.
Is it worth saying something like other stores are supported (examples) and explain what differences there may be (if any)?
stichbury
reviewed
Feb 8, 2023
stichbury
reviewed
Feb 8, 2023
stichbury
approved these changes
Feb 8, 2023
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
SajidAlamQB
approved these changes
Feb 8, 2023
| } | ||
| ``` | ||
|
|
||
| And finally, don't forget to add the hook to your `settings.py` file: |
There was a problem hiding this comment.
Maybe add this link here to our docs on how to register hook implementations.
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
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.
Signed-off-by: Ahdra Merali ahdra.merali@quantumblack.com
Description
This PR resolves issue #2148.
Checklist
RELEASE.mdfile