diff --git a/pages/agent/v3/help/_lock_acquire.md b/pages/agent/v3/help/_lock_acquire.md index 0f4eeb0bb4..62a6d0a76f 100644 --- a/pages/agent/v3/help/_lock_acquire.md +++ b/pages/agent/v3/help/_lock_acquire.md @@ -44,7 +44,6 @@ buildkite-agent lock release llama "${token}" - diff --git a/pages/agent/v3/help/_lock_do.md b/pages/agent/v3/help/_lock_do.md index c8a96e011a..16ef124827 100644 --- a/pages/agent/v3/help/_lock_do.md +++ b/pages/agent/v3/help/_lock_do.md @@ -49,7 +49,6 @@ fi
--lock-wait-timeout value #

Sets a maximum duration to wait for a lock before giving up (default: 0s)
Environment variable: $BUILDKITE_LOCK_WAIT_TIMEOUT

--config value #

Path to a configuration file
Environment variable: $BUILDKITE_AGENT_CONFIG

--lock-scope value #

The scope for locks used in this operation. Currently only 'machine' scope is supported (default: "machine")
Environment variable: $BUILDKITE_LOCK_SCOPE

--sockets-path value #

Directory where the agent will place sockets (default: "$HOME/.buildkite-agent/sockets")
Environment variable: $BUILDKITE_SOCKETS_PATH

--no-color #

Don't show colors in logging
Environment variable: $BUILDKITE_AGENT_NO_COLOR

- diff --git a/pages/agent/v3/help/_lock_done.md b/pages/agent/v3/help/_lock_done.md index a3c1800424..075f799aad 100644 --- a/pages/agent/v3/help/_lock_done.md +++ b/pages/agent/v3/help/_lock_done.md @@ -44,7 +44,6 @@ fi -
--lock-wait-timeout value #

Sets a maximum duration to wait for a lock before giving up (default: 0s)
Environment variable: $BUILDKITE_LOCK_WAIT_TIMEOUT

--config value #

Path to a configuration file
Environment variable: $BUILDKITE_AGENT_CONFIG

--lock-scope value #

The scope for locks used in this operation. Currently only 'machine' scope is supported (default: "machine")
Environment variable: $BUILDKITE_LOCK_SCOPE

--sockets-path value #

Directory where the agent will place sockets (default: "$HOME/.buildkite-agent/sockets")
Environment variable: $BUILDKITE_SOCKETS_PATH

--no-color #

Don't show colors in logging
Environment variable: $BUILDKITE_AGENT_NO_COLOR

--log-level value #

Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice")
Environment variable: $BUILDKITE_AGENT_LOG_LEVEL

--experiment value #

Enable experimental features within the buildkite-agent
Environment variable: $BUILDKITE_AGENT_EXPERIMENT

--profile value #

Enable a profiling mode, either cpu, memory, mutex or block
Environment variable: $BUILDKITE_AGENT_PROFILE

--config value #

Path to a configuration file
Environment variable: $BUILDKITE_AGENT_CONFIG

--lock-scope value #

The scope for locks used in this operation. Currently only 'machine' scope is supported (default: "machine")
Environment variable: $BUILDKITE_LOCK_SCOPE

--sockets-path value #

Directory where the agent will place sockets (default: "$HOME/.buildkite-agent/sockets")
Environment variable: $BUILDKITE_SOCKETS_PATH

diff --git a/pages/agent/v3/help/_lock_get.md b/pages/agent/v3/help/_lock_get.md index f20073838f..4d5d9dbf63 100644 --- a/pages/agent/v3/help/_lock_get.md +++ b/pages/agent/v3/help/_lock_get.md @@ -45,7 +45,6 @@ Kuzco --log-level value #

Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice")
Environment variable: $BUILDKITE_AGENT_LOG_LEVEL

--experiment value #

Enable experimental features within the buildkite-agent
Environment variable: $BUILDKITE_AGENT_EXPERIMENT

--profile value #

Enable a profiling mode, either cpu, memory, mutex or block
Environment variable: $BUILDKITE_AGENT_PROFILE

---config value #

Path to a configuration file
Environment variable: $BUILDKITE_AGENT_CONFIG

--lock-scope value #

The scope for locks used in this operation. Currently only 'machine' scope is supported (default: "machine")
Environment variable: $BUILDKITE_LOCK_SCOPE

--sockets-path value #

Directory where the agent will place sockets (default: "$HOME/.buildkite-agent/sockets")
Environment variable: $BUILDKITE_SOCKETS_PATH

diff --git a/pages/agent/v3/help/_lock_release.md b/pages/agent/v3/help/_lock_release.md index bbef47dbd8..af535f08aa 100644 --- a/pages/agent/v3/help/_lock_release.md +++ b/pages/agent/v3/help/_lock_release.md @@ -45,7 +45,6 @@ buildkite-agent lock release llama "${token}" --log-level value #

Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice")
Environment variable: $BUILDKITE_AGENT_LOG_LEVEL

--experiment value #

Enable experimental features within the buildkite-agent
Environment variable: $BUILDKITE_AGENT_EXPERIMENT

--profile value #

Enable a profiling mode, either cpu, memory, mutex or block
Environment variable: $BUILDKITE_AGENT_PROFILE

---config value #

Path to a configuration file
Environment variable: $BUILDKITE_AGENT_CONFIG

--lock-scope value #

The scope for locks used in this operation. Currently only 'machine' scope is supported (default: "machine")
Environment variable: $BUILDKITE_LOCK_SCOPE

--sockets-path value #

Directory where the agent will place sockets (default: "$HOME/.buildkite-agent/sockets")
Environment variable: $BUILDKITE_SOCKETS_PATH

diff --git a/pages/agent/v3/help/_pipeline_upload.md b/pages/agent/v3/help/_pipeline_upload.md index 712ee3b6f1..288ccbcd08 100644 --- a/pages/agent/v3/help/_pipeline_upload.md +++ b/pages/agent/v3/help/_pipeline_upload.md @@ -56,10 +56,8 @@ $ ./script/dynamic_step_generator | buildkite-agent pipeline upload --format value #

In dry-run mode, specifies the form to output the pipeline in. Must be one of: json,yaml (default: "json")
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_DRY_RUN_FORMAT

--no-interpolation #

Skip variable interpolation the pipeline when uploaded
Environment variable: $BUILDKITE_PIPELINE_NO_INTERPOLATION

--reject-secrets #

When true, fail the pipeline upload early if the pipeline contains secrets
Environment variable: $BUILDKITE_AGENT_PIPELINE_UPLOAD_REJECT_SECRETS

---signing-key-path value #

Path to a file containing a signing key. Passing this flag enables pipeline signing. For hmac-sha256, the raw file content is used as the shared key
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_SIGNING_KEY_PATH

---jwks-file-path value #

Path to a file containing a JWKS. Passing this flag enables pipeline signing
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_JWKS_FILE_PATH

---signing-key-id value #

The JWKS key ID to use when signing the pipeline. Required when using a JWKS
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_SIGNING_KEY_ID

---signing-algorithm value #

The algorithm to use when signing the pipeline. Must be one of [HS256 HS384 HS512 PS256 PS384 PS512 ES256 ES384 ES512 EdDSA], and valid for the given signing key. Required if the JWK specified does not have an alg key
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_SIGNING_ALGORITHM

+--jwks-file-path value #

EXPERIMENTAL: Path to a file containing a JWKS. Passing this flag enables pipeline signing
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_JWKS_FILE_PATH

+--signing-key-id value #

EXPERIMENTAL: The JWKS key ID to use when signing the pipeline. Required when using a JWKS
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_SIGNING_KEY_ID

--agent-access-token value #

The access token used to identify the agent
Environment variable: $BUILDKITE_AGENT_ACCESS_TOKEN

--endpoint value #

The Agent API endpoint (default: "https://agent.buildkite.com/v3")
Environment variable: $BUILDKITE_AGENT_ENDPOINT

--no-http2 #

Disable HTTP2 when communicating with the Agent API.
Environment variable: $BUILDKITE_NO_HTTP2

@@ -69,7 +67,7 @@ $ ./script/dynamic_step_generator | buildkite-agent pipeline upload --log-level value #

Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice")
Environment variable: $BUILDKITE_AGENT_LOG_LEVEL

--experiment value #

Enable experimental features within the buildkite-agent
Environment variable: $BUILDKITE_AGENT_EXPERIMENT

--profile value #

Enable a profiling mode, either cpu, memory, mutex or block
Environment variable: $BUILDKITE_AGENT_PROFILE

---redacted-vars value #

Pattern of environment variable names containing sensitive values (default: "*_PASSWORD", "*_SECRET", "*_TOKEN", "*_PRIVATE_KEY", "*_ACCESS_KEY", "*_SECRET_KEY")
Environment variable: $BUILDKITE_REDACTED_VARS

+--redacted-vars value #

Pattern of environment variable names containing sensitive values (default: "*_PASSWORD", "*_SECRET", "*_TOKEN", "*_PRIVATE_KEY", "*_ACCESS_KEY", "*_SECRET_KEY", "*_CONNECTION_STRING")
Environment variable: $BUILDKITE_REDACTED_VARS

diff --git a/pages/agent/v3/help/_start.md b/pages/agent/v3/help/_start.md index 4894aa290d..885178a957 100644 --- a/pages/agent/v3/help/_start.md +++ b/pages/agent/v3/help/_start.md @@ -83,8 +83,9 @@ $ buildkite-agent start --token xxx --no-plugin-validation #

Don't validate plugin configuration and requirements
Environment variable: $BUILDKITE_NO_PLUGIN_VALIDATION

--no-local-hooks #

Don't allow local hooks to be run from checked out repositories
Environment variable: $BUILDKITE_NO_LOCAL_HOOKS

--no-git-submodules #

Don't automatically checkout git submodules [$BUILDKITE_NO_GIT_SUBMODULES, $BUILDKITE_DISABLE_GIT_SUBMODULES]
Environment variable: $BUILDKITE_NO_GIT_SUBMODULES

---metrics-datadog #

Send metrics to DogStatsD for Datadog
Environment variable: $BUILDKITE_METRICS_DATADOG

--no-feature-reporting #

Disables sending a list of enabled features back to the Buildkite mothership. We use this information to measure feature usage, but if you're not comfortable sharing that information then that's totally okay :)
Environment variable: $BUILDKITE_AGENT_NO_FEATURE_REPORTING

+--allowed-repositories value #

A comma-separated list of regular expressions representing repositories the agent is allowed to clone (for example, "^git@github.com:buildkite/.*" or "^https://github.com/buildkite/.*")
Environment variable: $BUILDKITE_ALLOWED_REPOSITORIES

+--metrics-datadog #

Send metrics to DogStatsD for Datadog
Environment variable: $BUILDKITE_METRICS_DATADOG

--metrics-datadog-host value #

The dogstatsd instance to send metrics to using udp (default: "127.0.0.1:8125")
Environment variable: $BUILDKITE_METRICS_DATADOG_HOST

--metrics-datadog-distributions #

Use Datadog Distributions for Timing metrics
Environment variable: $BUILDKITE_METRICS_DATADOG_DISTRIBUTIONS

--log-format value #

The format to use for the logger output (default: "text")
Environment variable: $BUILDKITE_LOG_FORMAT

@@ -94,13 +95,10 @@ $ buildkite-agent start --token xxx --signal-grace-period-seconds value #

The number of seconds given to a subprocess to handle being sent `cancel-signal`. After this period has elapsed, SIGKILL will be sent. (default: 0)
Environment variable: $BUILDKITE_SIGNAL_GRACE_PERIOD_SECONDS

--tracing-backend value #

Enable tracing for build jobs by specifying a backend, "datadog" or "opentelemetry"
Environment variable: $BUILDKITE_TRACING_BACKEND

--tracing-service-name value #

Service name to use when reporting traces. (default: "buildkite-agent")
Environment variable: $BUILDKITE_TRACING_SERVICE_NAME

---job-verification-key-path value #

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
Environment variable: $BUILDKITE_AGENT_JOB_VERIFICATION_KEY_PATH

---job-verification-jwks-path value #

Path to a file containing a JSON Web Key Set (JWKS), used to verify job signatures.
Environment variable: $BUILDKITE_AGENT_JWKS_FILE_PATH

---job-signing-jwks-path value #

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
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_JWKS_FILE_PATH

---job-signing-algorithm value #

The algorithm to use when signing pipelines. Must be an algorithm specified in RFC 7518: JWA. Required when using a JWKS, and the given key doesn't have an alg parameter
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_SIGNING_ALGORITHM

---job-signing-key-id value #

The JWKS key ID to use when signing the pipeline. Required when using a JWKS
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_SIGNING_KEY_ID

---job-verification-no-signature-behavior value #

The behavior when a job is received without a signature. One of: [block warn]
Environment variable: $BUILDKITE_AGENT_JOB_VERIFICATION_NO_SIGNATURE_BEHAVIOR

---job-verification-invalid-signature-behavior value #

The behavior when a job is received, and the signature calculated is different from the one specified. One of: [block warn]
Environment variable: $BUILDKITE_AGENT_JOB_VERIFICATION_INVALID_SIGNATURE_BEHAVIOR

+--job-verification-jwks-path value #

EXPERIMENTAL: Path to a file containing a JSON Web Key Set (JWKS), used to verify job signatures.
Environment variable: $BUILDKITE_AGENT_JWKS_FILE_PATH

+--job-signing-jwks-path value #

EXPERIMENTAL: 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
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_JWKS_FILE_PATH

+--job-signing-key-id value #

EXPERIMENTAL: The JWKS key ID to use when signing the pipeline. Required when using a JWKS
Environment variable: $BUILDKITE_PIPELINE_UPLOAD_SIGNING_KEY_ID

+--job-verification-failure-behavior value #

EXPERIMENTAL: The behavior when a job is received without a signature. One of: [block warn]. Defaults to block (default: "block")
Environment variable: $BUILDKITE_AGENT_JOB_VERIFICATION_NO_SIGNATURE_BEHAVIOR

--token value #

Your account agent token
Environment variable: $BUILDKITE_AGENT_TOKEN

--endpoint value #

The Agent API endpoint (default: "https://agent.buildkite.com/v3")
Environment variable: $BUILDKITE_AGENT_ENDPOINT

--no-http2 #

Disable HTTP2 when communicating with the Agent API.
Environment variable: $BUILDKITE_NO_HTTP2

@@ -110,7 +108,7 @@ $ buildkite-agent start --token xxx --log-level value #

Set the log level for the agent, making logging more or less verbose. Defaults to notice. Allowed values are: debug, info, error, warn, fatal (default: "notice")
Environment variable: $BUILDKITE_AGENT_LOG_LEVEL

--experiment value #

Enable experimental features within the buildkite-agent
Environment variable: $BUILDKITE_AGENT_EXPERIMENT

--profile value #

Enable a profiling mode, either cpu, memory, mutex or block
Environment variable: $BUILDKITE_AGENT_PROFILE

---redacted-vars value #

Pattern of environment variable names containing sensitive values (default: "*_PASSWORD", "*_SECRET", "*_TOKEN", "*_PRIVATE_KEY", "*_ACCESS_KEY", "*_SECRET_KEY")
Environment variable: $BUILDKITE_REDACTED_VARS

+--redacted-vars value #

Pattern of environment variable names containing sensitive values (default: "*_PASSWORD", "*_SECRET", "*_TOKEN", "*_PRIVATE_KEY", "*_ACCESS_KEY", "*_SECRET_KEY", "*_CONNECTION_STRING")
Environment variable: $BUILDKITE_REDACTED_VARS

--strict-single-hooks #

Enforces that only one checkout hook, and only one command hook, can be run
Environment variable: $BUILDKITE_STRICT_SINGLE_HOOKS

--tags-from-ec2 #

Include the host's EC2 meta-data as tags (instance-id, instance-type, and ami-id)
Environment variable: $BUILDKITE_AGENT_TAGS_FROM_EC2

--tags-from-gcp #

Include the host's Google Cloud instance meta-data as tags (instance-id, machine-type, preemptible, project-id, region, and zone)
Environment variable: $BUILDKITE_AGENT_TAGS_FROM_GCP