Add first draft of code walk-through doc #903
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
Codecov Report
@@ Coverage Diff @@
## main #903 +/- ##
=======================================
Coverage 79.01% 79.01%
=======================================
Files 133 133
Lines 9716 9716
=======================================
Hits 7677 7677
Misses 1779 1779
Partials 260 260 Continue to review full report at Codecov.
|
margocrawf
reviewed
Dec 3, 2021
|
|
||
| ## Supervisor API endpoints | ||
|
|
||
| The Supervisor's endpoints are: |
There was a problem hiding this comment.
Maybe it would be helpful to link to the OIDC spec here.
margocrawf
reviewed
Dec 3, 2021
| at runtime as a separate Deployment. It exists as a separate binary in the same container image as the other | ||
| Pinniped server components. When needed, the Concierge will exec into the Deployment's pods to invoke the cert agent | ||
| binary to query for data. This is to support the Token Credential Request API strategy described in the | ||
| [Supported Cluster Types document]({{< ref "../reference/supported-clusters" >}}). |
There was a problem hiding this comment.
This paragraph is a little vague. Maybe something like, "when needed, the concierge will exec into the kube-cert-agent deployment's pods to query for the keypair used to sign user credentials." rather than just "data" would make it clearer.
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.
Release note:
None, doc-only changes.