feat: containers ssh command (#10582)

* feat: `containers ssh` command

Closes CC-4634

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

* fixup! feat: `containers ssh` command

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: emily-shen <69125074+emily-shen@users.noreply.github.com>
Co-authored-by: Victor Berchet <victor@suumit.com>

* code review

* Apply suggestions from code review

Co-authored-by: emily-shen <69125074+emily-shen@users.noreply.github.com>

* code review

* code review

* fix lock file

* fix tests

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

* fixes

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

* tmp

* Apply suggestions from code review

Co-authored-by: Nikita Sharma <54369599+nikitassharma@users.noreply.github.com>

* fix ci (hopefully)

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>

* resolve merge conflicts and hide ssh command

* move ssh code from containers-shared to wrangler

this code will only ever be used by wrangler and not vite/miniflare so it doesn't have to be in containers shared.

* Delete .changeset/five-drinks-stick.md

* lint

* fix up optional positional and update help text

---------

Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com>
Co-authored-by: emily-shen <69125074+emily-shen@users.noreply.github.com>
Co-authored-by: Victor Berchet <victor@suumit.com>
Co-authored-by: emily-shen <eshen@cloudflare.com>
Co-authored-by: Nikita Sharma <54369599+nikitassharma@users.noreply.github.com>

Author: 4 people

.changeset/spotty-plums-speak.md

@@ -0,0 +1,6 @@
+---
+"@cloudflare/containers-shared": minor
+"wrangler": patch
+---
+
+Add `containers ssh` command

packages/containers-shared/src/client/index.ts

@@ -17,6 +17,7 @@ export type { AddressAssignment } from "./models/AddressAssignment";
 export type { Application } from "./models/Application";
 export type { ApplicationAffinities } from "./models/ApplicationAffinities";
 export { ApplicationAffinityColocation } from "./models/ApplicationAffinityColocation";
+export { ApplicationAffinityHardwareGeneration } from "./models/ApplicationAffinityHardwareGeneration";
 export type { ApplicationConstraintPop } from "./models/ApplicationConstraintPop";
 export type { ApplicationConstraints } from "./models/ApplicationConstraints";
 export type { ApplicationHealth } from "./models/ApplicationHealth";
@@ -192,13 +193,16 @@ export { SecretNotFound } from "./models/SecretNotFound";
 export type { SSHPublicKey } from "./models/SSHPublicKey";
 export type { SSHPublicKeyID } from "./models/SSHPublicKeyID";
 export type { SSHPublicKeyItem } from "./models/SSHPublicKeyItem";
+export type { SSHPublicKeyItemV3 } from "./models/SSHPublicKeyItemV3";
 export { SSHPublicKeyNotFoundError } from "./models/SSHPublicKeyNotFoundError";
 export type { UnAuthorizedError } from "./models/UnAuthorizedError";
 export type { UnixTimestamp } from "./models/UnixTimestamp";
 export type { UnknownAccount } from "./models/UnknownAccount";
 export { UpdateApplicationRolloutRequest } from "./models/UpdateApplicationRolloutRequest";
 export type { UpdateRolloutResponse } from "./models/UpdateRolloutResponse";
 export type { UserDeploymentConfiguration } from "./models/UserDeploymentConfiguration";
+export type { WranglerSSHConfig } from "./models/WranglerSSHConfig";
+export type { WranglerSSHResponse } from "./models/WranglerSSHResponse";
 
 export { AccountService } from "./services/AccountService";
 export { ApplicationsService } from "./services/ApplicationsService";

packages/containers-shared/src/client/models/DeploymentV2.ts

@@ -27,6 +27,8 @@ import type { Observability } from "./Observability";
 import type { Placement } from "./Placement";
 import type { Ref } from "./Ref";
 import type { SSHPublicKeyID } from "./SSHPublicKeyID";
+import type { SSHPublicKeyItemV3 } from "./SSHPublicKeyItemV3";
+import type { WranglerSSHConfig } from "./WranglerSSHConfig";
 
 /**
  * A Deployment represents an intent to run one or many containers, with the same image, in a particular location or region.
@@ -41,6 +43,8 @@ export type DeploymentV2 = {
 	type: DeploymentType;
 	image: Image;
 	location: DeploymentLocation;
+	wrangler_ssh?: WranglerSSHConfig;
+	authorized_keys?: Array<SSHPublicKeyItemV3>;
 	/**
 	 * A list of SSH public key IDs from the account
 	 */

packages/containers-shared/src/client/models/ModifyUserDeploymentConfiguration.ts

@@ -18,12 +18,16 @@ import type { Observability } from "./Observability";
 import type { Port } from "./Port";
 import type { ProvisionerConfiguration } from "./ProvisionerConfiguration";
 import type { SSHPublicKeyID } from "./SSHPublicKeyID";
+import type { SSHPublicKeyItemV3 } from "./SSHPublicKeyItemV3";
+import type { WranglerSSHConfig } from "./WranglerSSHConfig";
 
 /**
  * Properties required to modify a cloudchamber deployment specified by the user.
  */
 export type ModifyUserDeploymentConfiguration = {
 	image?: Image;
+	wrangler_ssh?: WranglerSSHConfig;
+	authorized_keys?: Array<SSHPublicKeyItemV3>;
 	/**
 	 * A list of SSH public key IDs from the account
 	 */

packages/containers-shared/src/client/models/SSHPublicKeyItemV3.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { SSHPublicKey } from "./SSHPublicKey";
+
+/**
+ * An SSH public key attached to a specific application or account.
+ */
+export type SSHPublicKeyItemV3 = {
+	name: string;
+	public_key: SSHPublicKey;
+};

packages/containers-shared/src/client/models/UserDeploymentConfiguration.ts

@@ -18,12 +18,16 @@ import type { Observability } from "./Observability";
 import type { Port } from "./Port";
 import type { ProvisionerConfiguration } from "./ProvisionerConfiguration";
 import type { SSHPublicKeyID } from "./SSHPublicKeyID";
+import type { SSHPublicKeyItemV3 } from "./SSHPublicKeyItemV3";
+import type { WranglerSSHConfig } from "./WranglerSSHConfig";
 
 /**
  * Properties required to create a cloudchamber deployment specified by the user
  */
 export type UserDeploymentConfiguration = {
 	image: Image;
+	wrangler_ssh?: WranglerSSHConfig;
+	authorized_keys?: Array<SSHPublicKeyItemV3>;
 	/**
 	 * A list of SSH public key IDs from the account
 	 */

packages/containers-shared/src/client/models/WranglerSSHConfig.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Configuration properties for SSH'ing into a container with Wrangler
+ */
+export type WranglerSSHConfig = {
+	enabled: boolean;
+	port?: number;
+};

packages/containers-shared/src/client/models/WranglerSSHResponse.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type WranglerSSHResponse = {
+	url: string;
+	token: string;
+};

packages/containers-shared/src/client/services/DeploymentsService.ts

@@ -18,6 +18,7 @@ import type { ModifyDeploymentV2RequestBody } from "../models/ModifyDeploymentV2
 import type { ModifyUserDeploymentConfiguration } from "../models/ModifyUserDeploymentConfiguration";
 import type { PlacementID } from "../models/PlacementID";
 import type { ReplaceDeploymentRequestBody } from "../models/ReplaceDeploymentRequestBody";
+import type { WranglerSSHResponse } from "../models/WranglerSSHResponse";
 
 export class DeploymentsService {
 	/**
@@ -81,6 +82,31 @@ export class DeploymentsService {
 		});
 	}
 
+	/**
+	 * Get credentials to SSH into a Container
+	 * Get a JWT to hit the SSH port on a given container.
+	 * @param instanceId
+	 * @returns WranglerSSHResponse Credentials to SSH into a Container
+	 * @throws ApiError
+	 */
+	public static containerWranglerSsh(
+		instanceId: DeploymentID
+	): CancelablePromise<WranglerSSHResponse> {
+		return __request(OpenAPI, {
+			method: "GET",
+			url: "/instances/{instance_id}/ssh",
+			path: {
+				instance_id: instanceId,
+			},
+			errors: {
+				400: `Unknown account`,
+				401: `Unauthorized`,
+				404: `Deployment not found`,
+				500: `There has been an internal error`,
+			},
+		});
+	}
+
 	/**
 	 * Create a new deployment
 	 * Creates a new deployment. A Deployment represents an intent to run one container, with image, in a particular location

packages/containers-shared/src/types.ts

@@ -2,6 +2,8 @@ import type {
 	ApplicationAffinityColocation,
 	InstanceType,
 	SchedulingPolicy,
+	SSHPublicKeyItemV3,
+	WranglerSSHConfig,
 } from "./client";
 import type { ApplicationAffinityHardwareGeneration } from "./client/models/ApplicationAffinityHardwareGeneration";
 
@@ -76,6 +78,8 @@ export type SharedContainerConfig = {
 	/** if undefined in config, defaults to "full_auto" */
 	rollout_kind: "full_auto" | "full_manual" | "none";
 	rollout_active_grace_period: number;
+	wrangler_ssh?: WranglerSSHConfig;
+	authorized_keys?: Array<SSHPublicKeyItemV3>;
 	constraints: {
 		regions?: string[];
 		cities?: string[];