@parallelworks/client 7.86.1 → 7.88.0

package/dist/types/api.d.ts

@@ -904,6 +904,62 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/admin/products/compute/proxy-whitelist": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get compute proxy whitelist
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     > This is a platform-admin only route.
+         *
+         *     Returns whether platform routing is restricted, and the hosts, IPs, and CIDR ranges allowed to route SSH through the platform.
+         */
+        get: operations["get-compute-proxy-whitelist"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Update compute proxy whitelist
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     > This is a platform-admin only route.
+         *
+         *     Restricts platform routing and replaces the proxy whitelist. Once restricted, clusters outside the whitelist connect directly instead of proxying through the platform.
+         */
+        patch: operations["update-compute-proxy-whitelist"];
+        trace?: never;
+    };
+    "/api/admin/products/compute/proxy-whitelist/cluster-hosts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List existing-cluster hosts
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     > This is a platform-admin only route.
+         *
+         *     Lists the hosts existing clusters report, how many accounts use each, and how the current policy routes them. These are the exact values the whitelist matches against.
+         */
+        get: operations["list-compute-proxy-cluster-hosts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/admin/products/{product}": {
         parameters: {
             query?: never;
@@ -8890,6 +8946,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/organizations/{organization}/users/{user}/clusters/{clusterName}/disks": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Attach Cluster Disk
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Attaches a provisioned persistent disk to a cloud cluster. On a running cluster the cloud attachment happens asynchronously and its progress is reported on the disk's provision status.
+         */
+        post: operations["attach-cluster-disk"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/organizations/{organization}/users/{user}/clusters/{clusterName}/disks/{storageId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Detach Cluster Disk
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Detaches a persistent disk from a cloud cluster. On a running cluster the cloud detachment happens asynchronously and its progress is reported on the disk's provision status.
+         */
+        delete: operations["detach-cluster-disk"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/organizations/{organization}/users/{user}/clusters/{clusterName}/icon": {
         parameters: {
             query?: never;
@@ -8990,6 +9090,28 @@ export interface paths {
         patch: operations["update-user-cluster-permissions"];
         trace?: never;
     };
+    "/api/organizations/{organization}/users/{user}/clusters/{clusterName}/provision": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Provision cluster
+         * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
+         *
+         *     Provisions a cloud cluster for the first time, building its cloud infrastructure and starting the controller. Starting a stopped cluster again is the resume operation.
+         */
+        post: operations["provision-cluster"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/organizations/{organization}/users/{user}/clusters/{clusterName}/resume": {
         parameters: {
             query?: never;
@@ -13537,10 +13659,8 @@ export interface components {
             region?: string;
             /** @description Replace an existing version's variables instead of adding a new version. */
             replace?: boolean;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
-            snapshot?: string;
             /** Format: int64 */
             throughput?: number;
             type?: string;
@@ -13623,10 +13743,8 @@ export interface components {
             region?: string;
             /** @description Replace an existing version's variables instead of adding a new version. */
             replace?: boolean;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
-            snapshot?: string;
             type?: string;
             /** @description Version label to add (must start with v). */
             version: string;
@@ -13730,10 +13848,8 @@ export interface components {
             region?: string;
             /** @description Replace an existing version's variables instead of adding a new version. */
             replace?: boolean;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
-            snapshot?: string;
             type?: string;
             /** @description Version label to add (must start with v). */
             version: string;
@@ -14149,6 +14265,20 @@ export interface components {
             /** @description Refresh interval for bucket ingestion */
             refreshInterval: string;
         };
+        AttachClusterDiskBody: {
+            /**
+             * @description The path to mount the disk at on the cluster.
+             * @example /data
+             */
+            mountPoint: string;
+            /** @description Export the disk over NFS to the cluster's compute nodes. */
+            nfsExport?: boolean;
+            /**
+             * @description The id of the persistent disk to attach.
+             * @example 66f1a2b3c4d5e6f7a8b9c0d1
+             */
+            storageId: string;
+        };
         AttachmentResponse: {
             /** @description MIME type */
             contentType: string;
@@ -14374,10 +14504,8 @@ export interface components {
             provisionError?: string;
             /** @description Indicates if the storage has been provisioned. */
             provisioned: boolean;
-            /** @description Region the AWS bucket is in */
+            /** @description Region the AWS disk is in */
             region?: string;
-            /** @description Indicates if the disk is restored from a snapshot */
-            restoreSnapshot?: boolean;
             /** @description Runtime alert information for the storage. */
             runtimeAlert?: components["schemas"]["RunAlert"];
             /** @description Session cost limit information for the storage. */
@@ -14412,10 +14540,8 @@ export interface components {
             /** Format: int64 */
             iops?: number;
             region?: string;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
-            snapshot?: string;
             /**
              * @description Subtype discriminator. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -14889,6 +15015,8 @@ export interface components {
             currentlyProvisioning: boolean;
             /** @description Description of the storage. */
             description?: string;
+            /** @description Type of the disk */
+            diskType?: string;
             /** @description Display name of the storage. */
             displayName?: string;
             /** @description Indicates if the storage is a favorite for the requesting user. */
@@ -14909,6 +15037,8 @@ export interface components {
             provisionError?: string;
             /** @description Indicates if the storage has been provisioned. */
             provisioned: boolean;
+            /** @description Region the disk is in */
+            region?: string;
             /** @description Runtime alert information for the storage. */
             runtimeAlert?: components["schemas"]["RunAlert"];
             /** @description Session cost limit information for the storage. */
@@ -14922,6 +15052,11 @@ export interface components {
             sessionless: boolean;
             /** @description Sharing permissions of the storage. */
             shared: components["schemas"]["Shared"][] | null;
+            /**
+             * Format: int32
+             * @description Size of the disk in GiB
+             */
+            size?: number;
             /** @description Current status of the storage. */
             status?: string;
             /** @description Tags associated with the storage. */
@@ -14930,13 +15065,13 @@ export interface components {
             type: string;
             /** @description User associated with the storage. */
             user: string;
+            /** @description Zone the disk is in */
+            zone?: string;
         };
         AzureDiskVersionSettings: {
             region?: string;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
-            snapshot?: string;
             /**
              * @description Subtype discriminator. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -15413,7 +15548,7 @@ export interface components {
             enforcementMode: "off" | "audit" | "enforce";
             /** @description Disabled or removed base images with dependency counts */
             images: components["schemas"]["ImageComplianceItem"][] | null;
-            /** @description Clusters and instances configured to boot from an unusable base image */
+            /** @description Clusters and instances configured with an unusable image or snapshot, or with an image outside the catalog */
             resources: components["schemas"]["ResourceComplianceItem"][] | null;
             /** @description Root snapshots that can no longer be used */
             snapshots: components["schemas"]["SnapshotComplianceItem"][] | null;
@@ -15445,7 +15580,7 @@ export interface components {
             affectedSnapshots: number;
             /**
              * Format: int64
-             * @description Clusters and instances configured to boot from a disabled, removed, or unrecorded base image
+             * @description Clusters and instances configured to boot from a disabled, removed, unrecorded, or custom base image
              */
             atRiskResources: number;
             /**
@@ -16264,6 +16399,11 @@ export interface components {
             diskId?: string;
             encrypted?: boolean;
             iops?: number;
+            /**
+             * Format: int64
+             * @description Device slot the disk attaches at, assigned by the platform when the disk attaches.
+             */
+            lun?: number;
             mountPoint?: string;
             nfsExport?: boolean;
             /** @description Disk size in GiB. */
@@ -16324,6 +16464,17 @@ export interface components {
             throughput?: number;
             type?: string;
         };
+        ClusterDiskAttachment: {
+            /**
+             * Format: int64
+             * @description The device slot the disk attaches at, assigned by the platform. Absent on clouds that address the disk by its volume instead.
+             */
+            lun?: number;
+            /** @description The path the disk is mounted at on the cluster. */
+            mountPoint: string;
+            /** @description The id of the attached persistent disk. */
+            storageId: string;
+        };
         ClusterError: {
             /**
              * @description Cluster name
@@ -18026,8 +18177,6 @@ export interface components {
             network?: string;
             /** @description Region of the disk */
             region?: string;
-            /** @description Indicates if the disk was restored from a snapshot */
-            restoreSnapshot?: boolean;
             /**
              * Format: int64
              * @description Size of the disk in GiB
@@ -18666,7 +18815,7 @@ export interface components {
              * @example slurm
              */
             schedulerType?: string;
-            /** @description True when SSH to this cluster must route through the platform tunnel (private network, not peered). False for public-IP or peered-private clusters that the workspace can dial directly. */
+            /** @description True when SSH to this cluster routes through the platform. False when it is dialed directly, which a cluster on a public address does unless an administrator has whitelisted it. */
             shouldPlatformProxy: boolean;
             /**
              * @description The status of the resource.
@@ -18674,6 +18823,8 @@ export interface components {
              * @enum {string}
              */
             status: "on" | "off" | "active" | "provisioning" | "stopping" | "resuming" | "stopped" | "failed" | "updating" | "deleted" | "connecting" | "input_needed";
+            /** @description Human-readable explanation of the cluster's current status, present when the last provision was skipped or failed. */
+            statusDescription?: string;
             /**
              * @description The tags associated with the resource.
              * @example [
@@ -18865,6 +19016,8 @@ export interface components {
             currentlyProvisioning: boolean;
             /** @description Description of the storage. */
             description?: string;
+            /** @description Type of the disk */
+            diskType?: string;
             /** @description Display name of the storage. */
             displayName?: string;
             /** @description Indicates if the storage is a favorite for the requesting user. */
@@ -18885,6 +19038,8 @@ export interface components {
             provisionError?: string;
             /** @description Indicates if the storage has been provisioned. */
             provisioned: boolean;
+            /** @description Region the disk is in */
+            region?: string;
             /** @description Runtime alert information for the storage. */
             runtimeAlert?: components["schemas"]["RunAlert"];
             /** @description Session cost limit information for the storage. */
@@ -18898,6 +19053,11 @@ export interface components {
             sessionless: boolean;
             /** @description Sharing permissions of the storage. */
             shared: components["schemas"]["Shared"][] | null;
+            /**
+             * Format: int32
+             * @description Size of the disk in GiB
+             */
+            size?: number;
             /** @description Current status of the storage. */
             status?: string;
             /** @description Tags associated with the storage. */
@@ -18906,13 +19066,13 @@ export interface components {
             type: string;
             /** @description User associated with the storage. */
             user: string;
+            /** @description Zone the disk is in */
+            zone?: string;
         };
         GoogleDiskVersionSettings: {
             region?: string;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
-            snapshot?: string;
             /**
              * @description Subtype discriminator. (enum property replaced by openapi-typescript)
              * @enum {string}
@@ -23334,6 +23494,40 @@ export interface components {
              */
             status: "pending" | "provisioning" | "provisioned" | "failed" | "skipped" | "deleting" | "deleted" | "warning";
         };
+        ProxyClusterHost: {
+            /**
+             * Format: int64
+             * @description How many accounts have an existing cluster reporting this host
+             */
+            accounts: number;
+            /** @description The host an agent reports, which is the value the whitelist is matched against */
+            host: string;
+            /**
+             * @description Why the host routes the way it does
+             * @enum {string}
+             */
+            reason: "unrestricted" | "whitelisted" | "not-routable" | "direct";
+            /** @description Whether SSH to this host routes through the platform under the current policy */
+            shouldProxy: boolean;
+        };
+        ProxyClusterHostsOutputBody: {
+            /** @description Reported hosts, busiest first */
+            hosts: components["schemas"]["ProxyClusterHost"][] | null;
+            /**
+             * Format: int64
+             * @description Existing clusters whose agent has not reported a host; these always route through the platform
+             */
+            unreportedClusters: number;
+        };
+        ProxyWhitelistBody: {
+            /**
+             * @description Whether every existing cluster routes SSH through the platform, or only the hosts listed below
+             * @enum {string}
+             */
+            proxyScope: "all" | "specific";
+            /** @description Hosts, IP addresses, and CIDR ranges whose SSH traffic may route through the platform */
+            proxyWhitelist: string[] | null;
+        };
         PublishAwsBucketRequest: {
             /** @description Short summary of the item. */
             description?: string;
@@ -23382,12 +23576,10 @@ export interface components {
             /** @description Publish under the organization display name (org admins only). */
             publishedAsOrg?: boolean;
             region?: string;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
             /** @description URL-friendly identifier. */
             slug: string;
-            snapshot?: string;
             /** @description User-defined tags for categorization and search. */
             tags?: string[] | null;
             /** Format: int64 */
@@ -23594,12 +23786,10 @@ export interface components {
             /** @description Publish under the organization display name (org admins only). */
             publishedAsOrg?: boolean;
             region?: string;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
             /** @description URL-friendly identifier. */
             slug: string;
-            snapshot?: string;
             /** @description User-defined tags for categorization and search. */
             tags?: string[] | null;
             type?: string;
@@ -23822,12 +24012,10 @@ export interface components {
             /** @description Publish under the organization display name (org admins only). */
             publishedAsOrg?: boolean;
             region?: string;
-            restore_snapshot?: boolean;
             /** Format: int64 */
             size_gb?: number;
             /** @description URL-friendly identifier. */
             slug: string;
-            snapshot?: string;
             /** @description User-defined tags for categorization and search. */
             tags?: string[] | null;
             type?: string;
@@ -24749,13 +24937,13 @@ export interface components {
             baseImageCspId?: string;
             /** @description Catalog name of the base image, when it still exists */
             baseImageName?: string;
-            /** @description Partition name the image belongs to; empty for the resource's boot image */
+            /** @description Part of the resource the image belongs to, such as a partition or a controller disk; empty for the resource's boot image */
             component?: string;
             /** @description Cloud service provider */
             csp?: string;
             /** @description Resource ID */
             id: string;
-            /** @description The image value the component is configured with: a CSP image id or a boot snapshot's ID */
+            /** @description The value the component is configured with: a CSP image id or a snapshot ID */
             imageRef?: string;
             /** @description Resource name */
             name: string;
@@ -24763,13 +24951,13 @@ export interface components {
             organization?: string;
             /** @description Whether the resource is currently provisioned */
             running: boolean;
-            /** @description Name of the boot snapshot the resource is configured with, when it still exists */
+            /** @description Name of the snapshot the component is configured with, when it still exists */
             sourceSnapshot?: string;
             /**
-             * @description State of the resource's boot image
+             * @description State of the image or snapshot this component is configured with
              * @enum {string}
              */
-            state: "disabled" | "removed" | "missing" | "snapshot-removed";
+            state: "disabled" | "removed" | "missing" | "snapshot-removed" | "custom";
             /** @description Display status computed the same way the cluster and instance APIs compute it */
             status: string;
             /** @description cluster or instance */
@@ -26445,6 +26633,15 @@ export interface components {
             /** @description PEM private key matching the certificate; never returned by the API */
             privateKey?: string;
         };
+        UpdateProxyWhitelistInputBody: {
+            /**
+             * @description Set to specific to restrict platform routing to the whitelisted hosts, or all to route every existing cluster through the platform
+             * @enum {string}
+             */
+            proxyScope?: "all" | "specific";
+            /** @description Replaces the proxy whitelist; entries are hosts, IP addresses, or CIDR ranges */
+            proxyWhitelist?: string[];
+        };
         UpdateQuotaBody: {
             /**
              * @description CPU limit in cores
@@ -27170,6 +27367,11 @@ export interface components {
             };
             /** @description Session IDs assigned to this worker. */
             sessions?: string[] | null;
+            /**
+             * Format: int64
+             * @description Port of the worker's SSH server on the compute node. Present when the worker accepts SSH sessions through its own tunnel.
+             */
+            readonly sshServerPort?: number;
             /**
              * @description Worker status.
              * @enum {string}
@@ -28929,6 +29131,102 @@ export interface operations {
             };
         };
     };
+    "get-compute-proxy-whitelist": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProxyWhitelistBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "update-compute-proxy-whitelist": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateProxyWhitelistInputBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProxyWhitelistBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "list-compute-proxy-cluster-hosts": {
+        parameters: {
+            query?: {
+                /** @description Evaluate against this scope instead of the saved one */
+                scope?: "all" | "specific";
+                /** @description Evaluate against these whitelist entries; only read when scope is supplied */
+                entry?: string[] | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProxyClusterHostsOutputBody"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "set-platform-product-state": {
         parameters: {
             query?: never;
@@ -45022,6 +45320,82 @@ export interface operations {
             };
         };
     };
+    "attach-cluster-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The name of the organization. */
+                organization: string;
+                /** @description The username of the user that owns the cluster */
+                user: string;
+                /** @description The cluster name */
+                clusterName: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AttachClusterDiskBody"];
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClusterDiskAttachment"];
+                };
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    "detach-cluster-disk": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The name of the organization. */
+                organization: string;
+                /** @description The username of the user that owns the cluster */
+                user: string;
+                /** @description The cluster name */
+                clusterName: string;
+                /** @description The id of the attached persistent disk */
+                storageId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "delete-elastic-cluster-icon": {
         parameters: {
             query?: never;
@@ -45252,6 +45626,40 @@ export interface operations {
             };
         };
     };
+    "provision-cluster": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The name of the organization. */
+                organization: string;
+                /** @description Username of the target user. */
+                user: string;
+                /** @description The name of the cluster to provision */
+                clusterName: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     "resume-cluster": {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parallelworks/client",
-  "version": "7.86.1",
+  "version": "7.88.0",
   "description": "Official TypeScript client for Parallel Works ACTIVATE API",
   "type": "module",
   "exports": {