Rename "wrangler_ssh" to "ssh" in Containers configuration

[gpanders]

"wrangler_ssh" is redundant since this option is set in the Wrangler config file. Rename it to just "ssh", while still supporting "wrangler_ssh" for backward compatibility.

---

• Tests
  • Tests included/updated
• Public documentation
  • Cloudflare docs PR(s): Update containers SSH docs to use new Wrangler SSH config option name cloudflare-docs#29963

---

[changeset-bot]

🦋 Changeset detected

Latest commit: 7b2c8d4

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[workers-devprod]

Codeowners approval required for this PR:

• ✅ @cloudflare/cloudchamber
• ✅ @cloudflare/wrangler

Show detailed file reviewers

[github-actions]

✅ All changesets look good

[ask-bonk]

The review has been posted on PR #13567. Here's a summary of the findings:

Two issues identified:

1. Missing deprecation warning for wrangler_ssh — Every other deprecated container field in the validation code (instances, durable_objects, configuration) emits a diagnostics.warnings.push(...) to nudge users toward the new name. The wrangler_ssh backward-compat path is silent, so users will never learn to migrate. This is inconsistent with the codebase convention at validation.ts:3328-3338.

2. No diagnostic when both ssh and wrangler_ssh are specified — If a user provides both fields, ssh silently wins and the wrangler_ssh value is discarded at validation.ts:3398-3406. An error would prevent confusing behavior from conflicting values.

A concrete suggestion with both fixes was posted as a code suggestion on the PR.

github run

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 4 additional findings.

[pkg-pr-new]

create-cloudflare

npm i https://pkg.pr.new/create-cloudflare@13567

@cloudflare/kv-asset-handler

npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@13567

miniflare

npm i https://pkg.pr.new/miniflare@13567

@cloudflare/pages-shared

npm i https://pkg.pr.new/@cloudflare/pages-shared@13567

@cloudflare/unenv-preset

npm i https://pkg.pr.new/@cloudflare/unenv-preset@13567

@cloudflare/vite-plugin

npm i https://pkg.pr.new/@cloudflare/vite-plugin@13567

@cloudflare/vitest-pool-workers

npm i https://pkg.pr.new/@cloudflare/vitest-pool-workers@13567

@cloudflare/workers-editor-shared

npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@13567

wrangler

npm i https://pkg.pr.new/wrangler@13567

commit: 7b2c8d4

[gpanders]

/bonk rereview

[ask-bonk]

Re-reviewed after the update. The deprecation warning for wrangler_ssh has been added (lines 3339-3343) and is now consistent with the pattern used by the other deprecated container fields (instances, durable_objects, configuration). The backward-compat test at line 2052 verifies the warning is emitted.

The previous review also flagged the missing "both ssh and wrangler_ssh specified" error. Looking at the rest of the codebase, none of the other deprecated container fields (instances/max_instances, configuration/top-level fields) emit an error when both old and new forms are present — they just warn and move on. So the current behavior (deprecation warning + ssh wins) is consistent with the existing convention. I don't think adding a special-case error here is necessary.

Everything else looks good:

• Type definitions in environment.ts are clean — ssh is the primary field, wrangler_ssh is @deprecated and @hidden
• The rewrite logic (ssh → wrangler_ssh for the API) at lines 3403-3407 is correct
• Validation uses the user-facing field name in error messages via sshField
• Port validation correctly guards the range check with typeof sshPort === "number" (fixes a subtle bug from the original code where undefined < 1 would evaluate to false and silently pass)
• Test coverage is solid: new field, backward compat alias with deprecation warning assertion, validation errors, and schema test
• Changeset is well-formed

[ask-bonk]

Re-review posted on PR #13567 with an approval. The deprecation warning from the first review has been addressed, and the remaining suggestion (error when both ssh and wrangler_ssh are specified) isn't necessary since it would be inconsistent with how all other deprecated container fields are handled in this codebase.

github run

[nikitassharma]

Codeowners approval required for this PR:

* @cloudflare/wrangler

Show detailed file reviewers

* packages/workers-utils/src/config/environment.ts: [@cloudflare/wrangler]

* packages/workers-utils/src/config/validation.ts: [@cloudflare/wrangler]

* packages/wrangler/src/**tests**/containers/deploy.test.ts: [@cloudflare/wrangler]

* packages/wrangler/src/**tests**/containers/schema.test.ts: [@cloudflare/wrangler]

Looks like cloudchamber isn't listed as a codeowner for containers/ and cloudchamber/ tests? I wonder if this can be updated by us. It would be nice to get notifications about changes to those files.

[emily-shen]

will the diffs on deploy still show 'wrangler_ssh'?

[gpanders]

will the diffs on deploy still show 'wrangler_ssh'?

Yes, good catch. I just pushed a change to fix that so that it shows containers.configuration.ssh instead of containers.configuration.wrangler_ssh.

[workers-devprod]

Codeowners reviews satisfied

[emily-shen]

Looks like cloudchamber isn't listed as a codeowner for containers/ and cloudchamber/ tests? I wonder if this can be updated by us. It would be nice to get notifications about changes to those files.

#13573 here you go