Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Implement several documentation improvements to the Agent (for the Buildkite Docs). #3043

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Implement several documentation improvements to the Agent (for the Buildkite Docs). #3043

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
896b883
Add more info regarding 'environment propagation' for JWKS files.
gilesgas Oct 17, 2024
bc49bec
Reformat redactor CLI description for Buildkite Docs.
gilesgas Oct 17, 2024
9254753
Merge branch 'main' into documentation-improvements
gilesgas Oct 17, 2024
3d38eba
Clarify wording for environment variable propagation using Docker con…
gilesgas Oct 18, 2024
144518b
Fix spacing on redactor add CLI command description text.
gilesgas Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion clicommand/agent_start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ var AgentStartCommand = cli.Command{
},
cli.StringFlag{
Name: "signing-jwks-file",
Usage: "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",
Usage: "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. If using Docker containers to upload pipeline steps dynamically, turn on environment propagation to allow signing for the new steps generated.",
gilesgas marked this conversation as resolved.
Show resolved Hide resolved
EnvVar: "BUILDKITE_AGENT_SIGNING_JWKS_FILE",
},
cli.StringFlag{
Expand Down
23 changes: 20 additions & 3 deletions clicommand/redactor_add.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,26 @@ type RedactorAddConfig struct {
}

var RedactorAddCommand = cli.Command{
Name: "add",
Usage: "Add values to redact from a job's log output",
Description: "This may be used to parse a file for values to redact from a running job's log output. If you dynamically fetch secrets during a job, it is recommended that you use this command to ensure they will be redacted from subsequent logs. Secrets fetched with the builtin ′secret get′ command do not require the use of this command, they will be redacted automatically.",
Name: "add",
Usage: "Add values to redact from a job's log output",
Description: `Usage:

buildkite-agent redactor add [options...]

Description:

This command may be used to parse a file for values to redact from a
running job's log output. If you dynamically fetch secrets during a job,
it is recommended that you use this command to ensure they will be
redacted from subsequent logs. Secrets fetched with the builtin
′secret get′ command do not require the use of this command, they will
be redacted automatically.

Example:

$ buildkite-agent redactor add ...

Redacts something.`,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @wolfeidau ,

Could you (or would you know anyone who could) please provide an example of how this command is used? Just a typical example using some of the options would be great, and then I can provide a better explanation than what's currently provided in the agent.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I fixed the spacing in the Description section only, which is why this comment appears outdated, but it's actually not.

Flags: []cli.Flag{
cli.StringFlag{
Name: "format",
Expand Down
2 changes: 1 addition & 1 deletion clicommand/secret_get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Examples:
The following examples reference the same Buildkite secret ′key′:

$ buildkite-agent secret get deploy_key
$ buildkite-agent secret get DEPLOY_KEY`,
$ buildkite-agent secret get DEPLOY_KEY`,
Flags: []cli.Flag{
cli.StringFlag{
Name: "job",
Expand Down