@highstate/library 0.20.0 → 0.25.0

package/src/common/server.ts

@@ -7,7 +7,7 @@ import {
   type EntityValue,
   z,
 } from "@highstate/contract"
-import { l3EndpointContainer, l3EndpointEntity } from "../network"
+import { l3EndpointContainer, l3EndpointEntity, networkEntity } from "../network"
 import * as ssh from "../ssh"
 
 /**
@@ -108,6 +108,12 @@ export const existingServer = defineUnit({
       multiple: true,
     },
 
+    networks: {
+      entity: networkEntity,
+      required: false,
+      multiple: true,
+    },
+
     ...ssh.inputs,
   },
 
@@ -206,5 +212,129 @@ export const script = defineUnit({
   },
 })
 
+/**
+ * Runs a shell script on multiple servers.
+ */
+export const scriptV2 = defineUnit({
+  type: "common.script.v2",
+
+  args: {
+    /**
+     * The script to run when the unit is created.
+     */
+    script: z.string().meta({ language: "shell" }),
+
+    /**
+     * The script to run when the unit is updated.
+     */
+    updateScript: z.string().optional().meta({ language: "shell" }),
+
+    /**
+     * The script to run when the unit is deleted.
+     */
+    deleteScript: z.string().optional().meta({ language: "shell" }),
+  },
+
+  inputs: {
+    servers: {
+      entity: serverEntity,
+      multiple: true,
+    },
+  },
+
+  outputs: {
+    servers: {
+      entity: serverEntity,
+      multiple: true,
+    },
+  },
+
+  meta: {
+    title: "Shell Script",
+    icon: "mdi:bash",
+    category: "Infrastructure",
+  },
+
+  source: {
+    package: "@highstate/common",
+    path: "units/script-v2",
+  },
+})
+
+/**
+ * Runs a shell script as a systemd service on multiple servers.
+ */
+export const systemdUnit = defineUnit({
+  type: "common.systemd.unit.v1",
+
+  args: {
+    /**
+     * The script to run as the systemd service.
+     */
+    script: z.string().meta({ language: "shell" }),
+
+    /**
+     * The name of the systemd service.
+     *
+     * By default, the Highstate unit name is used with dots replaced by hyphens.
+     */
+    serviceName: z.string().optional(),
+
+    /**
+     * The systemd service type.
+     *
+     * Oneshot services remain active after the script exits and run again after each boot.
+     */
+    type: z.enum(["simple", "oneshot"]).default("simple"),
+
+    /**
+     * The systemd units that must be started before this service.
+     */
+    after: z.string().array().default(["network-online.target"]),
+
+    /**
+     * The systemd units that should be started with this service.
+     */
+    wants: z.string().array().default(["network-online.target"]),
+
+    /**
+     * The systemd units that are required by this service.
+     */
+    requires: z.string().array().default([]),
+
+    /**
+     * Additional systemd INI configuration appended to the generated service file.
+     *
+     * It can add sections or override generated directives using systemd's normal INI semantics.
+     */
+    extraConfig: z.string().default("").meta({ language: "ini" }),
+  },
+
+  inputs: {
+    servers: {
+      entity: serverEntity,
+      multiple: true,
+    },
+  },
+
+  outputs: {
+    servers: {
+      entity: serverEntity,
+      multiple: true,
+    },
+  },
+
+  meta: {
+    title: "Systemd Unit",
+    icon: "material-icon-theme:systemd",
+    category: "Infrastructure",
+  },
+
+  source: {
+    package: "@highstate/common",
+    path: "units/systemd/unit",
+  },
+})
+
 export type Server = EntityValue<typeof serverEntity>
 export type ServerInput = EntityInput<typeof serverEntity>

package/src/databases/etcd.ts

@@ -6,8 +6,8 @@ import {
   secretSchema,
   z,
 } from "@highstate/contract"
+import { fileEntity } from "../common"
 import { l4EndpointContainer, l4EndpointEntity } from "../network"
-import { certificateEntity } from "../tls"
 
 /**
  * The credentials for authenticating to the etcd cluster.
@@ -38,10 +38,10 @@ export const connectionEntity = defineEntity({
 
   includes: {
     /**
-     * The TLS certificate of the server if any.
+     * The CA certificate file used to verify the server if any.
      */
-    certificate: {
-      entity: certificateEntity,
+    ca: {
+      entity: fileEntity,
       required: false,
     },
   },
@@ -92,6 +92,14 @@ export const connection = defineUnit({
       multiple: true,
       required: false,
     },
+
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
   },
 
   outputs: {

package/src/databases/index.ts

@@ -5,4 +5,5 @@ export * as mongodb from "./mongodb"
 export * as mysql from "./mysql"
 export * as postgresql from "./postgresql"
 export * as redis from "./redis"
+export * as rustfs from "./rustfs"
 export * as s3 from "./s3"

package/src/databases/minio.ts

@@ -6,6 +6,7 @@ import {
   secretSchema,
   z,
 } from "@highstate/contract"
+import { fileEntity } from "../common"
 import { l7EndpointContainer, l7EndpointEntity } from "../network"
 import { bucketEntity } from "./s3"
 
@@ -29,6 +30,16 @@ export const connectionEntity = defineEntity({
 
   extends: { l7EndpointContainer },
 
+  includes: {
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
+  },
+
   schema: z.object({
     /**
      * The region of the MinIO instance.
@@ -80,6 +91,14 @@ export const connection = defineUnit({
       multiple: true,
       required: false,
     },
+
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
   },
 
   secrets: {

package/src/databases/mongodb.ts

@@ -6,8 +6,8 @@ import {
   secretSchema,
   z,
 } from "@highstate/contract"
+import { fileEntity } from "../common"
 import { l4EndpointContainer, l4EndpointEntity } from "../network"
-import { certificateEntity } from "../tls"
 
 export const credentialsSchema = z.discriminatedUnion("type", [
   z.object({
@@ -35,10 +35,10 @@ export const connectionEntity = defineEntity({
 
   includes: {
     /**
-     * The TLS certificate of the server if any.
+     * The CA certificate file used to verify the server if any.
      */
-    certificate: {
-      entity: certificateEntity,
+    ca: {
+      entity: fileEntity,
       required: false,
     },
   },
@@ -87,6 +87,14 @@ export const connection = defineUnit({
       multiple: true,
       required: false,
     },
+
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
   },
 
   secrets: {

package/src/databases/mysql.ts

@@ -6,8 +6,8 @@ import {
   secretSchema,
   z,
 } from "@highstate/contract"
+import { fileEntity } from "../common"
 import { l4EndpointContainer, l4EndpointEntity } from "../network"
-import { certificateEntity } from "../tls"
 
 export const credentialsSchema = z.discriminatedUnion("type", [
   z.object({
@@ -35,10 +35,10 @@ export const connectionEntity = defineEntity({
 
   includes: {
     /**
-     * The TLS certificate of the server if any.
+     * The CA certificate file used to verify the server if any.
      */
-    certificate: {
-      entity: certificateEntity,
+    ca: {
+      entity: fileEntity,
       required: false,
     },
   },
@@ -87,6 +87,14 @@ export const connection = defineUnit({
       multiple: true,
       required: false,
     },
+
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
   },
 
   secrets: {

package/src/databases/postgresql.ts

@@ -6,8 +6,8 @@ import {
   secretSchema,
   z,
 } from "@highstate/contract"
+import { fileEntity } from "../common"
 import { l4EndpointContainer, l4EndpointEntity } from "../network"
-import { certificateEntity } from "../tls"
 
 export const credentialsSchema = z.discriminatedUnion("type", [
   z.object({
@@ -35,10 +35,10 @@ export const connectionEntity = defineEntity({
 
   includes: {
     /**
-     * The TLS certificate of the server if any.
+     * The CA certificate file used to verify the server if any.
      */
-    certificate: {
-      entity: certificateEntity,
+    ca: {
+      entity: fileEntity,
       required: false,
     },
   },
@@ -92,6 +92,14 @@ export const connection = defineUnit({
       multiple: true,
       required: false,
     },
+
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
   },
 
   secrets: {

package/src/databases/rustfs.ts

@@ -0,0 +1,169 @@
+import {
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  secretSchema,
+  z,
+} from "@highstate/contract"
+import { fileEntity } from "../common"
+import { l7EndpointContainer, l7EndpointEntity } from "../network"
+import { bucketEntity } from "./s3"
+
+export const credentialsSchema = z.object({
+  /**
+   * The access key used to authenticate against RustFS.
+   */
+  accessKey: z.string(),
+
+  /**
+   * The secret key used to authenticate against RustFS.
+   */
+  secretKey: secretSchema(z.string()),
+})
+
+/**
+ * Represents a connection to a RustFS instance.
+ */
+export const connectionEntity = defineEntity({
+  type: "rustfs.connection.v1",
+
+  extends: { l7EndpointContainer },
+
+  includes: {
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
+  },
+
+  schema: z.object({
+    /**
+     * The S3 region of the RustFS instance.
+     */
+    region: z.string(),
+
+    /**
+     * The credentials for authenticating to RustFS.
+     */
+    credentials: credentialsSchema,
+  }),
+
+  meta: {
+    color: "#D34516",
+  },
+})
+
+/**
+ * An existing RustFS connection hosted on a server or Kubernetes cluster.
+ */
+export const connection = defineUnit({
+  type: "rustfs.connection.v1",
+
+  args: {
+    /**
+     * The access key to authenticate with.
+     */
+    accessKey: z.string(),
+
+    /**
+     * The S3 region of the RustFS instance.
+     */
+    region: z.string().default("us-east-1"),
+
+    /**
+     * The endpoints to connect to the RustFS instance.
+     */
+    endpoints: z.string().array().default([]),
+  },
+
+  inputs: {
+    /**
+     * The endpoints to connect to the RustFS instance.
+     */
+    endpoints: {
+      entity: l7EndpointEntity,
+      multiple: true,
+      required: false,
+    },
+
+    /**
+     * The CA certificate file used to verify the server if any.
+     */
+    ca: {
+      entity: fileEntity,
+      required: false,
+    },
+  },
+
+  secrets: {
+    /**
+     * The secret key to authenticate with.
+     */
+    secretKey: z.string(),
+  },
+
+  outputs: {
+    connection: connectionEntity,
+  },
+
+  source: {
+    package: "@highstate/rustfs",
+    path: "connection",
+  },
+
+  meta: {
+    title: "RustFS Connection",
+    icon: "simple-icons:rust",
+    secondaryIcon: "mdi:database",
+    category: "Databases",
+  },
+})
+
+/**
+ * Creates a bucket and bucket-scoped service account on a RustFS instance.
+ */
+export const bucket = defineUnit({
+  type: "rustfs.bucket.v1",
+
+  args: {
+    /**
+     * The name of the bucket to create.
+     *
+     * Defaults to the name of the unit if not provided.
+     */
+    bucketName: z.string().optional(),
+  },
+
+  inputs: {
+    /**
+     * The RustFS instance where the bucket should be created.
+     */
+    connection: connectionEntity,
+  },
+
+  outputs: {
+    /**
+     * The created S3-compatible bucket with scoped credentials.
+     */
+    bucket: bucketEntity,
+  },
+
+  source: {
+    package: "@highstate/rustfs",
+    path: "bucket",
+  },
+
+  meta: {
+    title: "RustFS Bucket",
+    icon: "simple-icons:rust",
+    secondaryIcon: "mdi:bucket",
+    category: "Databases",
+  },
+})
+
+export type Connection = EntityValue<typeof connectionEntity>
+export type ConnectionInput = EntityInput<typeof connectionEntity>

package/src/dns.ts

@@ -8,7 +8,7 @@ import {
 import { mapValues, pick } from "remeda"
 import { serverEntity } from "./common/server"
 import { implementationReferenceSchema } from "./impl-ref"
-import { l3EndpointEntity, l4EndpointEntity, networkArgs } from "./network"
+import { l3EndpointEntity, l4EndpointEntity, l7EndpointEntity, networkArgs } from "./network"
 
 export const providerEntity = defineEntity({
   type: "dns.provider.v1",
@@ -122,7 +122,7 @@ export const recordSet = defineUnit({
      * The L7 endpoints to use as values of the DNS records.
      */
     l7Endpoints: {
-      entity: l4EndpointEntity,
+      entity: l7EndpointEntity,
       required: false,
       multiple: true,
     },
@@ -152,7 +152,7 @@ export const recordSet = defineUnit({
      * The duplicates are removed and metadata is merged.
      */
     l7Endpoints: {
-      entity: l4EndpointEntity,
+      entity: l7EndpointEntity,
       multiple: true,
     },
   },

package/src/index.ts

@@ -2,6 +2,7 @@ import { noop } from "./abbreviations"
 
 noop()
 
+export * from "./apps"
 export * as common from "./common"
 export * from "./databases"
 export * as distributions from "./distributions"
@@ -10,6 +11,7 @@ export * as git from "./git"
 export * from "./impl-ref"
 export * as k3s from "./k3s"
 export * as k8s from "./k8s"
+export * as netaminity from "./netaminity"
 export * as network from "./network"
 export * as nixos from "./nixos"
 export * as proxmox from "./proxmox"
@@ -18,5 +20,6 @@ export * as sops from "./sops"
 export * as ssh from "./ssh"
 export * as talos from "./talos"
 export * from "./third-party"
+export * as tls from "./tls"
 export * from "./utils"
 export * as wireguard from "./wireguard"