@highstate/library 0.11.7 → 0.12.1

package/src/third-party/yandex.ts

@@ -1,17 +1,34 @@
 import { defineEntity, defineUnit, z } from "@highstate/contract"
 import { serverOutputs, vmSecrets, vmSshArgs } from "../common"
-import { ipv4PrefixSchema, ipv46Schema } from "../network"
 import * as ssh from "../ssh"
 
-export const cloudEntity = defineEntity({
-  type: "yandex.cloud.v0",
+export const connectionEntity = defineEntity({
+  type: "yandex.connection.v1",
 
   schema: z.object({
-    token: z.string().optional(),
+    /**
+     * The service account key file content (JSON).
+     */
     serviceAccountKeyFile: z.string().optional(),
+
+    /**
+     * The ID of the cloud.
+     */
     cloudId: z.string(),
+
+    /**
+     * The default folder ID.
+     */
     defaultFolderId: z.string(),
+
+    /**
+     * The default availability zone.
+     */
     defaultZone: z.string(),
+
+    /**
+     * The region ID.
+     */
     regionId: z.string().optional(),
   }),
 
@@ -24,23 +41,51 @@ export const cloudEntity = defineEntity({
  * The connection to a Yandex Cloud account.
  */
 export const connection = defineUnit({
-  type: "yandex.connection.v0",
+  type: "yandex.connection.v1",
 
   args: {
     /**
-     * The availability zone for resources.
+     * The region to create connection for.
+     *
+     * See [Regions](https://yandex.cloud/en/docs/overview/concepts/region) for details.
      */
-    defaultZone: z.string().default("ru-central1-d"),
+    region: z
+      .discriminatedUnion("id", [
+        z.object({
+          /**
+           * The ID of the region.
+           */
+          id: z.literal("ru-central1"),
 
-    /**
-     * The region ID for resources.
-     */
-    regionId: z.string().default("ru-central1"),
+          /**
+           * The default availability zone in ru-central1 to place resources in.
+           */
+          defaultZone: z
+            .enum(["ru-central1-a", "ru-central1-b", "ru-central1-d"])
+            .default("ru-central1-d"),
+        }),
+        z.object({
+          /**
+           * The ID of the region.
+           */
+          id: z.literal("kz1"),
+
+          /**
+           * The default availability zone in kz1 to place resources in.
+           */
+          defaultZone: z.enum(["kz1-a"]).default("kz1-a"),
+        }),
+      ])
+      .prefault({ id: "ru-central1" }),
   },
 
   secrets: {
     /**
      * The service account key file content (JSON).
+     *
+     * Important: service account must have `iam.serviceAccounts.user` role to work properly.
+     *
+     * See [Creating an authorized key](https://yandex.cloud/en/docs/iam/operations/authentication/manage-authorized-keys#create-authorized-key) for details.
      */
     serviceAccountKeyFile: {
       schema: z.string().meta({ language: "json" }),
@@ -58,11 +103,11 @@ export const connection = defineUnit({
     /**
      * The Yandex Cloud connection.
      */
-    yandexCloud: cloudEntity,
+    connection: connectionEntity,
   },
 
   meta: {
-    title: "Yandex Cloud Connection",
+    title: "YC Connection",
     category: "Yandex Cloud",
     icon: "simple-icons:yandexcloud",
     iconColor: "#0080ff",
@@ -74,17 +119,186 @@ export const connection = defineUnit({
   },
 })
 
+export const diskSchema = z.object({
+  /**
+   * The disk type.
+   *
+   * - Network SSD (network-ssd): Fast network drive; SSD network block storage.
+   * - Network HDD (network-hdd): Standard network drive; HDD network block storage.
+   * - Non-replicated SSD (network-ssd-nonreplicated): Enhanced performance network drive without redundancy.
+   * - Ultra high-speed network storage with three replicas (SSD) (network-ssd-io-m3): High-performance SSD offering the same speed as network-ssd-nonreplicated, plus redundancy.
+   */
+  type: z
+    .enum(["network-ssd", "network-hdd", "network-ssd-nonreplicated", "network-ssd-io-m3"])
+    .default("network-ssd"),
+
+  /**
+   * The disk size in GB.
+   *
+   * For `network-ssd-nonreplicated` and `network-ssd-io-m3` must be multiple of 93.
+   */
+  size: z.number().default(20),
+})
+
+export const diskEntity = defineEntity({
+  type: "yandex.disk.v1",
+
+  schema: z.object({
+    /**
+     * The global ID of the disk.
+     */
+    id: z.string(),
+  }),
+
+  meta: {
+    title: "YC Disk",
+    icon: "simple-icons:yandexcloud",
+    iconColor: "#0080ff",
+    secondaryIcon: "icon-park-outline:disk",
+  },
+})
+
+/**
+ * The disk on Yandex Cloud.
+ */
+export const disk = defineUnit({
+  type: "yandex.disk.v1",
+
+  args: {
+    /**
+     * The name of the disk in the folder.
+     * If not specified, the name of the unit will be used.
+     */
+    diskName: z.string().optional(),
+
+    ...diskSchema.shape,
+  },
+
+  inputs: {
+    connection: connectionEntity,
+  },
+
+  outputs: {
+    /**
+     * The disk entity.
+     */
+    disk: diskEntity,
+  },
+
+  meta: {
+    title: "YC Disk",
+    category: "Yandex Cloud",
+    icon: "icon-park-outline:disk",
+    iconColor: "#0080ff",
+    secondaryIcon: "mage:compact-disk-fill",
+  },
+
+  source: {
+    package: "@highstate/yandex",
+    path: "disk",
+  },
+})
+
+export const imageEntity = defineEntity({
+  type: "yandex.image.v1",
+
+  schema: z.object({
+    /**
+     * The global ID of the image.
+     */
+    id: z.string(),
+  }),
+
+  meta: {
+    title: "Yandex Cloud Image",
+    icon: "simple-icons:yandexcloud",
+    iconColor: "#0080ff",
+    secondaryIcon: "mage:compact-disk-fill",
+  },
+})
+
+/**
+ * The existing image from Yandex Cloud Marketplace or user images.
+ */
+export const existingImage = defineUnit({
+  type: "yandex.existing-image.v1",
+
+  args: {
+    /**
+     * The ID of the image.
+     *
+     * See [Yandex Cloud Marketplace Images](https://yandex.cloud/en/marketplace) to find available images and their IDs.
+     * You can also use user images by specifying their IDs.
+     */
+    id: z.string(),
+  },
+
+  inputs: {
+    connection: connectionEntity,
+  },
+
+  outputs: {
+    /**
+     * The image entity.
+     */
+    image: imageEntity,
+  },
+
+  meta: {
+    title: "YC Existing Image",
+    category: "Yandex Cloud",
+    icon: "simple-icons:yandexcloud",
+    iconColor: "#0080ff",
+    secondaryIcon: "mage:compact-disk-fill",
+  },
+
+  source: {
+    package: "@highstate/yandex",
+    path: "existing-image",
+  },
+})
+
 /**
  * The virtual machine on Yandex Cloud.
  */
 export const virtualMachine = defineUnit({
-  type: "yandex.virtual-machine.v0",
+  type: "yandex.virtual-machine.v1",
 
   args: {
+    /**
+     * The name of the virtual machine.
+     * If not specified, the name of the unit will be used.
+     */
+    vmName: z.string().optional(),
+
     /**
      * The platform ID for the instance.
+     *
+     * See [Platforms](https://yandex.cloud/en/docs/compute/concepts/vm-platforms) for details.
      */
-    platformId: z.string().default("standard-v3"),
+    platformId: z
+      .enum([
+        // standard platforms
+        "standard-v1",
+        "standard-v2",
+        "standard-v3",
+        "amd-v1",
+        "standard-v4a",
+
+        // high-performance platforms
+        "highfreq-v3",
+        "highfreq-v4a",
+
+        // with gpu
+        "gpu-standard-v1",
+        "gpu-standard-v2",
+        "gpu-standard-v3",
+        "gpu-standard-v3i",
+        "standard-v3-t4",
+        "standard-v3-t4i",
+        "gpu-platform-v4",
+      ])
+      .default("standard-v3"),
 
     /**
      * The resources to allocate to the virtual machine.
@@ -102,7 +316,7 @@ export const virtualMachine = defineUnit({
         memory: z.number().default(4),
 
         /**
-         * The core fraction (10-100).
+         * The guaranteed CPU core performance (10-100).
          */
         coreFraction: z.number().min(10).max(100).optional(),
       })
@@ -111,26 +325,7 @@ export const virtualMachine = defineUnit({
     /**
      * The boot disk configuration.
      */
-    disk: z
-      .object({
-        /**
-         * The disk size in GB.
-         *
-         * For `network-ssd-nonreplicated` must be multiple of 93.
-         */
-        size: z.number().default(20),
-
-        /**
-         * The disk type.
-         */
-        type: z.string().default("network-ssd-nonreplicated"),
-
-        /**
-         * The image family to use.
-         */
-        imageFamily: z.string().default("ubuntu-2204-lts"),
-      })
-      .prefault({}),
+    bootDisk: diskSchema.prefault({}),
 
     /**
      * The network configuration.
@@ -149,38 +344,20 @@ export const virtualMachine = defineUnit({
         assignPublicIp: z.boolean().default(true),
 
         /**
-         * The list of DNS servers.
+         * Whether to reserve the public IP permanently.
+         *
+         * If not set, the public IP can be changed when the VM is stopped and started again.
+         *
+         * Makes no sense if `assignPublicIp` is false.
          */
-        dns: ipv46Schema.array().default([]),
+        reservePublicIp: z.boolean().default(true),
       })
       .prefault({}),
 
-    /**
-     * The IPv4 address configuration.
-     */
-    ipv4: z
-      .discriminatedUnion("type", [
-        z.object({
-          type: z.literal("dhcp"),
-        }),
-        z.object({
-          type: z.literal("static"),
-          address: z.string(),
-          prefix: ipv4PrefixSchema.default(24),
-          gateway: z.string().optional(),
-        }),
-      ])
-      .default({ type: "dhcp" }),
-
     /**
      * The SSH configuration.
      */
     ssh: vmSshArgs,
-
-    /**
-     * Additional metadata for cloud-init.
-     */
-    metadata: z.record(z.string(), z.string()).default({}),
   },
 
   secrets: {
@@ -188,14 +365,15 @@ export const virtualMachine = defineUnit({
   },
 
   inputs: {
-    yandexCloud: cloudEntity,
+    connection: connectionEntity,
+    image: imageEntity,
     ...ssh.inputs,
   },
 
   outputs: serverOutputs,
 
   meta: {
-    title: "Yandex Cloud Virtual Machine",
+    title: "YC Virtual Machine",
     category: "Yandex Cloud",
     icon: "simple-icons:yandexcloud",
     iconColor: "#0080ff",
@@ -208,4 +386,4 @@ export const virtualMachine = defineUnit({
   },
 })
 
-export type Cloud = z.infer<typeof cloudEntity.schema>
+export type Connection = z.infer<typeof connectionEntity.schema>