Skip to content

[CNXT-2526] Fix retired AIR documentation links - #7514

Merged
ben-hansen-db merged 2 commits into
mainfrom
benhansen/cnxt-2526-current-doc-links
Nov 12, 2026
Merged

ben-hansen-db merged 2 commits into
mainfrom
benhansen/cnxt-2526-current-doc-links

Conversation

@ben-hansen-db

Copy link
Copy Markdown
Contributor

Changes

Point AIR help and validation messages at the current CLI documentation paths; keep existing help snapshots in sync.

Why

CNXT-2526: Retired URLs add redirects or lead users away from the current AIR setup docs.

Tests

Checked destination URLs, Go formatting, and git diff --check. No tests added or run.

Prepared with Codex assistance.


This PR was created with GitHub MCP.

@ben-hansen-db
ben-hansen-db requested review from a team as code owners November 11, 2026 21:54
@github-actions github-actions Bot added the AIR Databricks AI Runtime CLI label Nov 11, 2026
@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Commit: ab5930fc6 | Workflow run

Regression test report

Selected 2 changed tests (limit=20, 0 not selected)

2 tests: regression=2 unreleased=0 coverage=0 failing=0
test branch main (a572447) latest (v1.26.0)
TestAccept/air/help ✅ ❌ ❌
TestAccept/air/run-submit-deps ✅ ❌ ❌
TestAccept/air/help: branch ✅ | main (a572447) ❌ | latest (v1.26.0) ❌

main (a572447):

acceptance_test.go:1373: Diff:
        --- air/help/output.txt
        +++ /tmp/TestAcceptairhelp3332660826/002/output.txt
        @@ -155,7 +155,7 @@
         
         >>> [CLI] air images push --help
         This CLI command is in Preview. For current feature status and requirements, see:
        -  AWS: https://docs.databricks.com/aws/en/machine-learning/ai-runtime/connecting/cli/docker-images
        +  AWS: https://docs.databricks.com/aws/en/machine-learning/ai-runtime/cli/docker-images
           Azure: https://learn.microsoft.com/azure/databricks/machine-learning/ai-runtime/connecting/cli/docker-images
         
         Push a container image to Databricks Artifact Registry under the specified Unity Catalog catalog and schema.
        
FAIL

latest (v1.26.0):

acceptance_test.go:1373: Diff:
        --- air/help/output.txt
        +++ /tmp/TestAcceptairhelp1107430003/002/output.txt
        @@ -2,31 +2,23 @@
         === help
         
         >>> [CLI] air --help
        -Run GPU workloads on Databricks serverless compute.
        +Run and manage AI Runtime training workloads on Databricks serverless GPU compute.
         
        -Describe a workload in a YAML file and submit it with "databricks air run".
        -Follow a run with "databricks air logs" and "databricks air get", or see your
        -active runs with "databricks air list".
        +These commands are under active development.
         
         Usage:
           databricks air [command]
         
        -Run workloads:
        -  run             Submit a workload from a YAML config
        -
        -Manage runs:
        +Available Commands:
           cancel          Cancel one or more runs
        -  get             Show a run's status, configuration, and timing
        -  list            List your active runs
        -  logs            Stream or fetch a run's logs
        +  convert-to-dabs Convert an AIR run YAML into a Databricks Asset Bundle
        +  get             Show status, configuration, and timing details for a specified run
        +  images          Manage container images for AI Runtime
        +  list            List active runs for the current user
        +  logs            Stream or fetch logs for a run
        +  pools           View provisioned GPU pools
        +  run             Submit a training workload from a YAML config
         
        -Package and deploy:
        -  convert-to-dabs Convert a workload YAML into a Databricks Asset Bundle
        -  images          Push container images for custom environments
        -
        -Provisioned capacity:
        -  pools           View GPU pools provisioned for your workspace
        -
         Flags:
           -h, --help   help for air
         
        @@ -38,12 +23,6 @@
         
         Use "databricks air [command] --help" for more information about a command.
         
        -Learn more:
        -  YAML fields and example  databricks air run -h config
        -  Quickstart (AWS)         https://docs.databricks.com/aws/en/machine-learning/ai-runtime/quickstart
        -  Quickstart (Azure)       https://learn.microsoft.com/azure/databricks/machine-learning/ai-runtime/quickstart
        -  Coding agent skill       databricks aitools install --skills-only --skills databricks-ai-runtime
        -
         === list help
         
         >>> [CLI] air list --help
        @@ -84,9 +63,9 @@
         === get help
         
         >>> [CLI] air get --help
        -Show a run's status, configuration, and timing.
        +Show status, configuration, and timing details for a specified run.
         
        -JOB_RUN_ID is the job run ID returned by "databricks air run".
        +JOB_RUN_ID is the job run ID returned by "air run".
         
         Usage:
           databricks air get JOB_RUN_ID [flags]
        @@ -103,18 +81,14 @@
         === pools help
         
         >>> [CLI] air pools --help
        -View GPU pools provisioned for your workspace.
        +View provisioned GPU pools
         
        -A GPU pool is dedicated accelerator capacity that your Databricks account team
        -provisions. Pools are optional: a run uses one only when its YAML sets
        -compute.pool_id.
        -
         Usage:
           databricks air pools [flags]
           databricks air pools [command]
         
         Available Commands:
        -  get         Show a GPU pool and its accelerator usage
        +  get         Show a GPU pool, including its accelerator usage (POOL_ID may be omitted when the workspace has exactly one pool)
           list        List the GPU pools available to the current workspace
         
         Flags:
        @@ -131,7 +99,7 @@
         === images help
         
         >>> [CLI] air images --help
        -Push container images for custom environments
        +Manage container images for AI Runtime
         
         Usage:
           databricks air images [flags]
        @@ -155,7 +123,7 @@
         
         >>> [CLI] air images push --help
         This CLI command is in Preview. For current feature status and requirements, see:
        -  AWS: https://docs.databricks.com/aws/en/machine-learning/ai-runtime/connecting/cli/docker-images
        +  AWS: https://docs.databricks.com/aws/en/machine-learning/ai-runtime/cli/docker-images
           Azure: https://learn.microsoft.com/azure/databricks/machine-learning/ai-runtime/connecting/cli/docker-images
         
         Push a container image to Databricks Artifact Registry under the specified Unity Catalog catalog and schema.
        @@ -191,7 +159,7 @@
         Stream logs from an active run until it completes, or fetch logs from a
         completed run.
         
        -JOB_RUN_ID is the job run ID returned by "databricks air run".
        +JOB_RUN_ID is the job run ID returned by "air run".
         
         Usage:
           databricks air logs JOB_RUN_ID [flags]
TestAccept/air/run-submit-deps: branch ✅ | main (a572447) ❌ | latest (v1.26.0) ❌

main (a572447):

acceptance_test.go:1373: Diff:
        --- air/run-submit-deps/output.txt
        +++ /tmp/TestAcceptairrun-submit-deps3447058681/002/output.txt
        @@ -66,7 +66,7 @@
         === a requirements.yaml file path is rejected; deps must be inline
         
         >>> [CLI] air run -f run-file.yaml
        -Error: invalid config run-file.yaml: environment.dependencies must be a list of packages or reference a requirements.txt (see https://docs.databricks.com/aws/en/machine-learning/ai-runtime/connecting/cli/yaml-config#reference). A direct file reference is not supported
        +Error: invalid config run-file.yaml: environment.dependencies must be a list of packages or reference a requirements.txt (see https://docs.databricks.com/aws/en/machine-learning/ai-runtime/cli/yaml-config#reference). A direct file reference is not supported
         
         Tip: use the --debug flag to see more details and a trace of this error:
           databricks --debug air run …

latest (v1.26.0):

acceptance_test.go:1373: Diff:
        --- air/run-submit-deps/output.txt
        +++ /tmp/TestAcceptairrun-submit-deps1970366629/002/output.txt
        @@ -66,7 +66,7 @@
         === a requirements.yaml file path is rejected; deps must be inline
         
         >>> [CLI] air run -f run-file.yaml
        -Error: invalid config run-file.yaml: environment.dependencies must be a list of packages or reference a requirements.txt (see https://docs.databricks.com/aws/en/machine-learning/ai-runtime/connecting/cli/yaml-config#reference). A direct file reference is not supported
        +Error: invalid config run-file.yaml: environment.dependencies must be a list of packages or reference a requirements.txt (see https://docs.databricks.com/aws/en/machine-learning/ai-runtime/cli/yaml-config#reference). A direct file reference is not supported
         
         Tip: use the --debug flag to see more details and a trace of this error:
           databricks --debug air run …
        
FAIL

@eng-dev-ecosystem-bot

eng-dev-ecosystem-bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Collaborator

✅ Integration test report

Commit: ab5930f

Run: 43288699109

Env 🔄​flaky 💚​RECOVERED ✅​pass 🙈​skip Time
💚​ aws linux-2core-8gb 1 270 17 10:01
💚​ aws-windows-latest-4core-16gb 1 272 15 6:21
🔄​ azure linux-2core-8gb 4 1 265 17 11:06
💚​ azure-windows-latest-4core-16gb 1 271 15 7:43
💚​ gcp linux-2core-8gb 1 270 17 10:08
💚​ gcp-windows-latest-4core-16gb 1 272 15 8:02
Test Name aws linux-2core-8gb aws-windows-latest-4core-16gb azure linux-2core-8gb azure-windows-latest-4core-16gb gcp linux-2core-8gb gcp-windows-latest-4core-16gb
💚​ TestAccept 💚​R 💚​R 💚​R 💚​R 💚​R 💚​R
🔄​ TestFsLs ✅​p ✅​p 🔄​f ✅​p ✅​p ✅​p
🔄​ TestFsLs/uc-volumes ✅​p ✅​p 🔄​f ✅​p ✅​p ✅​p
🔄​ TestFsLsWithAbsolutePaths ✅​p ✅​p 🔄​f ✅​p ✅​p ✅​p
🔄​ TestFsLsWithAbsolutePaths/uc-volumes ✅​p ✅​p 🔄​f ✅​p ✅​p ✅​p
Top 11 slowest tests (at least 2 minutes):
duration env testname
4:05 azure-windows-latest-4core-16gb TestAccept
3:59 gcp linux-2core-8gb TestAccept
3:54 aws linux-2core-8gb TestAccept
3:48 gcp-windows-latest-4core-16gb TestAccept
3:46 azure linux-2core-8gb TestAccept
3:43 aws-windows-latest-4core-16gb TestAccept
2:27 gcp-windows-latest-4core-16gb TestFilerWorkspaceFilesExtensionsDelete
2:17 aws linux-2core-8gb TestLock
2:15 azure-windows-latest-4core-16gb TestExportDir
2:12 gcp-windows-latest-4core-16gb TestFilerReadWrite/workspace_files_extensions
2:00 azure-windows-latest-4core-16gb TestFilerWorkspaceFilesExtensionsReadDir

Comment thread cmd/air/compute.go Outdated
Comment on lines +94 to +95
NumAccelerators int `yaml:"num_accelerators" help:"Total number of GPUs to allocate. Must be a positive multiple of the accelerator type's per-node GPU count. See https://docs.databricks.com/aws/en/machine-learning/ai-runtime/connecting/cli/yaml-config#reference for supported GPU types."`
AcceleratorType string `yaml:"accelerator_type" help:"Which accelerator to run on, e.g. GPU_1xA10. See https://docs.databricks.com/aws/en/machine-learning/ai-runtime/connecting/cli/yaml-config#reference for the current list of supported GPU types. Matched case-sensitively."`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is fine for now + for this PR but noting we should switch it over to databricks air run -h config.compute.accelerator_type once the safe flag is rolled out.

qq - do you think once workspace aware accelerator types is rolled out that we should just remove that table from references or is it worth keeping? it feels a little hard to keep track of (e.g. if/when to add rtx6000 to the table)

@ben-hansen-db
ben-hansen-db added this pull request to the merge queue Nov 12, 2026
Merged via the queue into main with commit 277d7cd Nov 12, 2026
27 checks passed
@ben-hansen-db
ben-hansen-db deleted the benhansen/cnxt-2526-current-doc-links branch November 12, 2026 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-assisted AIR Databricks AI Runtime CLI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants