Update agent help docs for v3.51.0 #2378
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
|
Preview URL: https://2378--bk-docs-preview.netlify.app |
triarius
commented
Aug 15, 2023
triarius
commented
Aug 15, 2023
triarius
commented
Aug 15, 2023
triarius
commented
Aug 15, 2023
triarius
commented
Aug 15, 2023
triarius
commented
Aug 15, 2023
triarius
force-pushed
the
pdp-1464-update-agent-docs-for-v3510
branch
from
8130d72
to
bf2fb76
Compare
DrJosh9000
approved these changes
Aug 16, 2023
pages/agent/v3/help/_start.md
Outdated
| <tr id="job-verification-key-path"><th><code>--job-verification-key-path value</code> <a class="Docs__attribute__link" href="#job-verification-key-path">#</a></th><td><p>Path to a file containing a verification key. Passing this flag enables job verification. For hmac-sha256, the raw file content is used as the shared key<br /><strong>Environment variable</strong>: <code>$BUILDKITE_AGENT_JOB_VERIFICATION_KEY_PATH</code></p></td></tr> | ||
| <tr id="job-verification-jwks-path"><th><code>--job-verification-jwks-path value</code> <a class="Docs__attribute__link" href="#job-verification-jwks-path">#</a></th><td><p>Path to a file containing a JSON Web Key Set (JWKS), used to verify job signatures.<br /><strong>Environment variable</strong>: <code>$BUILDKITE_AGENT_JWKS_FILE_PATH</code></p></td></tr> | ||
| <tr id="job-signing-jwks-path"><th><code>--job-signing-jwks-path value</code> <a class="Docs__attribute__link" href="#job-signing-jwks-path">#</a></th><td><p>Path to a file containing a signing key. Passing this flag enables pipeline signing for all pipelines uploaded by this agent. For hmac-sha256, the raw file content is used as the shared key<br /><strong>Environment variable</strong>: <code>$BUILDKITE_PIPELINE_UPLOAD_JWKS_FILE_PATH</code></p></td></tr> | ||
| <tr id="job-signing-algorithm"><th><code>--job-signing-algorithm value</code> <a class="Docs__attribute__link" href="#job-signing-algorithm">#</a></th><td><p>The algorithm to use when signing pipelines. Must be a valid RF7518 JWA algorithm. Required when using a JWKS, and the given key doesn't have an alg parameter<br /><strong>Environment variable</strong>: <code>$BUILDKITE_PIPELINE_UPLOAD_SIGNING_ALGORITHM</code></p></td></tr> |
There was a problem hiding this comment.
Does this say, "JSON Web Algorithm algorithm?"
There was a problem hiding this comment.
Even worse, it's "JSON Web Algorithms algorithm" as the title of the RFC is "JSON Web Algorithms (JWA)"
triarius
commented
Aug 22, 2023
triarius
commented
Aug 22, 2023
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
mbelton-buildkite
approved these changes
Aug 22, 2023
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've made a few departures from the output of the script. I'll explain why in the comments.