diff --git a/.buildkite/pipeline.graphql.yml b/.buildkite/pipeline.graphql.yml index d20355fff8..941078e6d3 100644 --- a/.buildkite/pipeline.graphql.yml +++ b/.buildkite/pipeline.graphql.yml @@ -1,3 +1,10 @@ steps: - label: Update GraphQL docs command: .buildkite/update_graphql_docs + plugins: + - aws-assume-role-with-web-identity#v1.0.0: + role-arn: arn:aws:iam::445615400570:role/pipeline-buildkite-docs-private + - aws-ssm#v1.0.0: + parameters: + GH_TOKEN: /pipelines/buildkite/docs-private/gh-token + API_ACCESS_TOKEN: /pipelines/buildkite/docs-private/api-access-token diff --git a/.buildkite/pipeline.preview.yml b/.buildkite/pipeline.preview.yml index 5928773b98..98af9979de 100644 --- a/.buildkite/pipeline.preview.yml +++ b/.buildkite/pipeline.preview.yml @@ -12,6 +12,14 @@ steps: env: RAILS_ENV: "production" plugins: + - aws-assume-role-with-web-identity#v1.0.0: + role-arn: arn:aws:iam::445615400570:role/pipeline-buildkite-docs-private + - aws-ssm#v1.0.0: + parameters: + GH_TOKEN: /pipelines/buildkite/docs-private/gh-token + BUILDKITE_ANALYTICS_TOKEN: /pipelines/buildkite/docs-private/buildkite-analytics-token + NETLIFY_AUTH_TOKEN: /pipelines/buildkite/docs-private/netlify-auth-token + NETLIFY_SITE_ID: /pipelines/buildkite/docs-private/netlify-site-id - docker-compose#v3.9.0: run: app dependencies: false diff --git a/.buildkite/pipeline.sync.yml b/.buildkite/pipeline.sync.yml index 95081b7fa1..6d334200c6 100644 --- a/.buildkite/pipeline.sync.yml +++ b/.buildkite/pipeline.sync.yml @@ -1,3 +1,4 @@ +#docs-private-to-public-sync notify: - slack: "$SLACK_CHANNEL" if: build.state != "passed" diff --git a/.buildkite/pipeline.sync_public_pr.yml b/.buildkite/pipeline.sync_public_pr.yml index 5b2fe4976d..63e65fd330 100644 --- a/.buildkite/pipeline.sync_public_pr.yml +++ b/.buildkite/pipeline.sync_public_pr.yml @@ -11,6 +11,11 @@ steps: - label: ":git: Sync Public PR to Private Repo" command: "bin/sync-public-pr" plugins: + - aws-assume-role-with-web-identity#v1.0.0: + role-arn: arn:aws:iam::445615400570:role/pipeline-buildkite-docs-private + - aws-ssm#v1.0.0: + parameters: + GH_TOKEN: /pipelines/buildkite/docs-private/gh-token - docker#v5.11.0: image: "ruby:3.3-bookworm" propagate-environment: true diff --git a/pages/agent/v3.md b/pages/agent/v3.md index 4dccb4a5ce..bddffa7353 100644 --- a/pages/agent/v3.md +++ b/pages/agent/v3.md @@ -189,72 +189,27 @@ The agent also accepts the following two signals directly: The agent reports its activity to Buildkite using exit codes. The most common exit codes and their descriptions can be found in the table below. - - - - - - - - - - - - - - - - - - - - - -
0The job exited with a status of 0 (success)
1The job exited with a status of 1 (most common error status)
128 + signal numberThe job was terminated by a signal (see note below)
255The agent was gracefully terminated
-1Buildkite lost contact with the agent or it stopped reporting to us
+Exit code | Description +------------------- | ------------------------------------------------------------------- +0 | The job exited with a status of 0 (success) +1 | The job exited with a status of 1 (most common error status) +94 | The checkout timed out waiting for a Git mirrors lock +128 + signal number | The job was terminated by a signal (see note below) +255 | The agent was gracefully terminated +-1 | Buildkite lost contact with the agent or it stopped reporting to us > 📘 Jobs terminated by signals > When a job is terminated by a signal, the exit code will be set to 128 + the signal number. For more information about how shells manage commands terminated by signals, see the Wiki page on Exit Signals. Exit codes for common signals: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Exit codeSignalNameDescription
1302SIGINTTerminal interrupt signal
1379SIGKILLKill (cannot be caught or ignored)
13911SIGSEGVSegmentation fault; Invalid memory reference
14113SIGPIPEWrite on a pipe with no one to read it
14315SIGTERMTermination signal (graceful)
+Exit code | Signal | Name | Description +--------- | ------ | ------- | -------------------------------------------- +130 | 2 | SIGINT | Terminal interrupt signal +137 | 9 | SIGKILL | Kill (cannot be caught or ignored) +139 | 11 | SIGSEGV | Segmentation fault; Invalid memory reference +141 | 13 | SIGPIPE | Write on a pipe with no one to read it +143 | 15 | SIGTERM | Termination signal (graceful) ## Troubleshooting diff --git a/pages/agent/v3/help/_artifact_search.md b/pages/agent/v3/help/_artifact_search.md index c1a2bc6768..d2425a9d7c 100644 --- a/pages/agent/v3/help/_artifact_search.md +++ b/pages/agent/v3/help/_artifact_search.md @@ -87,4 +87,6 @@ Format specifiers: %S SHA1 checksum of the artifact +%T SHA256 checksum of the artifact + %u Download URL for the artifact, though consider using 'buildkite-agent artifact download' instead diff --git a/pages/agent/v3/help/_artifact_upload.md b/pages/agent/v3/help/_artifact_upload.md index 2e1718edde..381cae646b 100644 --- a/pages/agent/v3/help/_artifact_upload.md +++ b/pages/agent/v3/help/_artifact_upload.md @@ -102,6 +102,7 @@ $ buildkite-agent upload log.tar --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

+--no-multipart-artifact-upload #

For Buildkite-hosted artifacts, disables the use of multipart uploads. Has no effect on uploads to other destinations such as custom cloud buckets
Environment variable: $BUILDKITE_NO_MULTIPART_ARTIFACT_UPLOAD

diff --git a/pages/agent/v3/help/_oidc_request_token.md b/pages/agent/v3/help/_oidc_request_token.md index 4df95a3347..0cdddb6434 100644 --- a/pages/agent/v3/help/_oidc_request_token.md +++ b/pages/agent/v3/help/_oidc_request_token.md @@ -40,6 +40,7 @@ Requests and prints an OIDC token from Buildkite that claims the Job ID --lifetime value #

The time (in seconds) the OIDC token will be valid for before expiry. Must be a non-negative integer. If the flag is omitted or set to 0, the API will choose a default finite lifetime. (default: 0)

--job value #

Buildkite Job Id to claim in the OIDC token
Environment variable: $BUILDKITE_JOB_ID

--claim value #

Claims to add to the OIDC token
Environment variable: $BUILDKITE_OIDC_TOKEN_CLAIMS

+--aws-session-tag value #

Add claims as AWS Session Tags
Environment variable: $BUILDKITE_OIDC_TOKEN_AWS_SESSION_TAGS

--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

diff --git a/pages/agent/v3/help/_start.md b/pages/agent/v3/help/_start.md index 00cfe3c249..983df8ba5d 100644 --- a/pages/agent/v3/help/_start.md +++ b/pages/agent/v3/help/_start.md @@ -105,12 +105,13 @@ $ buildkite-agent start --token xxx --signing-jwks-key-id value #

The JWKS key ID to use when signing the pipeline. If omitted, and the signing JWKS contains only one key, that key will be used.
Environment variable: $BUILDKITE_AGENT_SIGNING_JWKS_KEY_ID

--signing-aws-kms-key value #

The KMS KMS key ID, or key alias used when signing and verifying the pipeline.
Environment variable: $BUILDKITE_AGENT_SIGNING_AWS_KMS_KEY

--debug-signing #

Enable debug logging for pipeline signing. This can potentially leak secrets to the logs as it prints each step in full before signing. Requires debug logging to be enabled
Environment variable: $BUILDKITE_AGENT_DEBUG_SIGNING

---verification-failure-behavior value #

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

+--verification-failure-behavior value #

The behavior when a job is received without a valid verifiable signature (without a signature, with an invalid signature, or with a signature that fails verification). One of: [block warn]. Defaults to block (default: "block")
Environment variable: $BUILDKITE_AGENT_JOB_VERIFICATION_NO_SIGNATURE_BEHAVIOR

--disable-warnings-for value #

A list of warning IDs to disable
Environment variable: $BUILDKITE_AGENT_DISABLE_WARNINGS_FOR

--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

--debug-http #

Enable HTTP debug mode, which dumps all request and response bodies to the log
Environment variable: $BUILDKITE_AGENT_DEBUG_HTTP

+--trace-http #

Enable HTTP trace mode, which logs timings for each HTTP request. Timings are logged at the debug level unless a request fails at the network level in which case they are logged at the error level
Environment variable: $BUILDKITE_AGENT_TRACE_HTTP

--no-color #

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

--debug #

Enable debug mode. Synonym for `--log-level debug`. Takes precedence over `--log-level`
Environment variable: $BUILDKITE_AGENT_DEBUG

--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

@@ -120,6 +121,7 @@ $ buildkite-agent start --token xxx --strict-single-hooks #

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

--kubernetes-exec #

This is intended to be used only by the Buildkite k8s stack (github.com/buildkite/agent-stack-k8s); it enables a Unix socket for transporting logs and exit statuses between containers in a pod
Environment variable: $BUILDKITE_KUBERNETES_EXEC

--trace-context-encoding value #

Sets the inner encoding for BUILDKITE_TRACE_CONTEXT. Must be either json or gob (default: "gob")
Environment variable: $BUILDKITE_TRACE_CONTEXT_ENCODING

+--no-multipart-artifact-upload #

For Buildkite-hosted artifacts, disables the use of multipart uploads. Has no effect on uploads to other destinations such as custom cloud buckets
Environment variable: $BUILDKITE_NO_MULTIPART_ARTIFACT_UPLOAD

--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