Add notebook on Authenticating to Vespa Cloud #880
Merged
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
|
This will be a great help, and good to merge (so we can look at the links not displayed etc.) |
kkraune
previously approved these changes
Aug 19, 2024
| "Security is a top priority for the Vespa Team.\n", | ||
| "We understand that as a newcomer to Vespa, the different authentication methods may not always be immediately clear.\n", | ||
| "\n", | ||
| "This notebook is intended to provide some clarity on the different authentication methods needing when interacting with Vespa Cloud for different purposes.\n" |
There was a problem hiding this comment.
Suggested change
| "This notebook is intended to provide some clarity on the different authentication methods needing when interacting with Vespa Cloud for different purposes.\n" | |
| "This notebook is intended to provide some clarity on the different authentication methods needed when interacting with Vespa Cloud for different purposes.\n" |
| "metadata": {}, | ||
| "source": [ | ||
| "<div class=\"alert alert-info\">\n", | ||
| " Refer to <a href=\"https://pyvespa.readthedocs.io/en/latest/troubleshooting.html\">troubleshooting</a>\n", |
There was a problem hiding this comment.
troubleshooting link did not work inside the alert (when testing locally)
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.
I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.
Added a notebook to demonstrate and explain the different authentication methods, as this is something that is often a source of misunderstanding/misconfiguration, ref #862.
Please have a look at the table in the notebook to see if I missed something.
Adding below for convenience:
For background context, it is useful to read the Vespa Cloud Security Guide.
Control-plane vs Data-plane
This may be self-explanatory for some, but it is worth mentioning that Vespa Cloud has two main components: the control-plane and the data-plane, which provide access to different functionalities.
vespa auth loginvespa auth api-keyvespa auth certVespaCloudVespaCloudis a control-plane connection to Vespa CloudVespaDockerVespaDockeris a control-plane connection to a Vespa server running in DockerVespaVespais a data-plane connection to an existing Vespa applicationI also discovered that a lot of the recently added classes had not been added to the reference API-documentation, so included these.