@highstate/library 0.18.0 → 0.20.0

package/src/dns.ts

@@ -1,4 +1,10 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
+import {
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  z,
+} from "@highstate/contract"
 import { mapValues, pick } from "remeda"
 import { serverEntity } from "./common/server"
 import { implementationReferenceSchema } from "./impl-ref"
@@ -8,11 +14,6 @@ export const providerEntity = defineEntity({
   type: "dns.provider.v1",
 
   schema: z.object({
-    /**
-     * The ID of the DNS provider unique within the system.
-     */
-    id: z.string(),
-
     /**
      * The zones managed by the DNS provider.
      */
@@ -26,6 +27,9 @@ export const providerEntity = defineEntity({
 
   meta: {
     color: "#FF5722",
+    title: "DNS Provider",
+    icon: "mdi:dns",
+    iconColor: "#FF5722",
   },
 })
 
@@ -179,4 +183,5 @@ export const inputs = {
   },
 } as const
 
-export type Provider = z.infer<typeof providerEntity.schema>
+export type Provider = EntityValue<typeof providerEntity>
+export type ProviderInput = EntityInput<typeof providerEntity>

package/src/index.ts

@@ -3,7 +3,7 @@ import { noop } from "./abbreviations"
 noop()
 
 export * as common from "./common"
-export * as databases from "./databases"
+export * from "./databases"
 export * as distributions from "./distributions"
 export * as dns from "./dns"
 export * as git from "./git"

package/src/k3s.ts

@@ -63,6 +63,13 @@ export const cluster = defineUnit({
      */
     agentConfig: z.record(z.string(), z.unknown()).optional(),
 
+    /**
+     * The map of configuration per each node in the cluster, where the key is the hostname of the node.
+     *
+     * Note: if multiple nodes have the same hostname, the configuration will be applied to all of them.
+     */
+    nodeConfig: z.record(z.string(), z.record(z.string(), z.unknown())).optional(),
+
     /**
      * The configuration of the registries to use for the K3S cluster.
      *

package/src/k8s/apps/etcd.ts

@@ -1,6 +1,6 @@
 import { defineUnit } from "@highstate/contract"
 import { pick } from "remeda"
-import * as databases from "../../databases"
+import { connectionEntity } from "../../databases/etcd"
 import {
   appName,
   optionalSharedInputs,
@@ -31,7 +31,7 @@ export const etcd = defineUnit({
   },
 
   outputs: {
-    etcd: databases.etcdEntity,
+    connection: connectionEntity,
   },
 
   meta: {
@@ -42,5 +42,5 @@ export const etcd = defineUnit({
     category: "Databases",
   },
 
-  source: source("etcd/app"),
+  source: source("etcd"),
 })

package/src/k8s/apps/gitea.ts

@@ -12,7 +12,7 @@ export const gitea = defineUnit({
     ...appName("gitea"),
   },
   inputs: {
-    ...pick(sharedInputs, ["k8sCluster", "accessPoint", "mariadb"]),
+    ...pick(sharedInputs, ["k8sCluster", "accessPoint", "mysql"]),
   },
 
   meta: {

package/src/k8s/apps/grafana.ts

@@ -0,0 +1,48 @@
+import { defineUnit, z } from "@highstate/contract"
+import { pick } from "remeda"
+import { serviceEntity } from "../service"
+import { appName, sharedArgs, sharedInputs, source } from "./shared"
+
+/**
+ * Grafana deployed on Kubernetes.
+ */
+export const grafana = defineUnit({
+  type: "k8s.apps.grafana.v1",
+
+  args: {
+    ...appName("grafana"),
+    ...pick(sharedArgs, ["fqdn"]),
+
+    /**
+     * The list of plugins to install on Grafana.
+     *
+     * See https://grafana.com/grafana/plugins for available plugins and their names.
+     */
+    plugins: z.string().array().default([]),
+  },
+
+  secrets: {
+    /**
+     * The admin password used for Grafana.
+     *
+     * If not provided, a random password will be generated.
+     */
+    adminPassword: z.string().optional(),
+  },
+
+  inputs: {
+    ...pick(sharedInputs, ["k8sCluster", "accessPoint"]),
+  },
+
+  outputs: {
+    service: serviceEntity,
+  },
+
+  meta: {
+    title: "Grafana",
+    icon: "simple-icons:grafana",
+    category: "Observability",
+  },
+
+  source: source("grafana"),
+})

package/src/k8s/apps/index.ts

@@ -1,13 +1,15 @@
 export * from "./code-server"
 export * from "./etcd"
+export * from "./grafana"
 export * from "./grocy"
 export * from "./hubble"
-export * from "./kubernetes-dashboard"
 export * from "./mariadb"
-export * from "./maybe"
+export * from "./matrix-stack"
 export * from "./minio"
 export * from "./mongodb"
+export * from "./portal"
 export * from "./postgresql"
+export * from "./refluxdb"
 export * from "./remnawave"
 export {
   appName,

package/src/k8s/apps/mariadb.ts

@@ -1,13 +1,11 @@
 import { defineUnit } from "@highstate/contract"
 import { pick } from "remeda"
-import * as databases from "../../databases"
-import { serviceEntity } from "../service"
+import { connectionEntity } from "../../databases/mysql"
+import { statefulSetEntity } from "../workload"
 import {
   appName,
   optionalSharedInputs,
   sharedArgs,
-  sharedDatabaseArgs,
-  sharedDatabaseSecrets,
   sharedInputs,
   sharedSecrets,
   source,
@@ -18,13 +16,14 @@ import {
  */
 export const mariadb = defineUnit({
   type: "k8s.apps.mariadb.v1",
+
   args: {
     ...appName("mariadb"),
     ...pick(sharedArgs, ["external"]),
   },
 
   secrets: {
-    ...pick(sharedSecrets, ["rootPassword", "backupKey"]),
+    ...pick(sharedSecrets, ["adminPassword", "backupKey"]),
   },
 
   inputs: {
@@ -33,8 +32,8 @@ export const mariadb = defineUnit({
   },
 
   outputs: {
-    mariadb: databases.mariadbEntity,
-    service: serviceEntity,
+    connection: connectionEntity,
+    statefulSet: statefulSetEntity,
   },
 
   meta: {
@@ -44,35 +43,5 @@ export const mariadb = defineUnit({
     category: "Databases",
   },
 
-  source: source("mariadb/app"),
-})
-
-/**
- * The virtual MariaDB database created on the MariaDB instance.
- *
- * Requires a Kubernetes cluster to place init jobs and secrets.
- */
-export const mariadbDatabase = defineUnit({
-  type: "k8s.apps.mariadb.database.v1",
-
-  args: sharedDatabaseArgs,
-  secrets: sharedDatabaseSecrets,
-
-  inputs: {
-    ...pick(sharedInputs, ["k8sCluster", "mariadb"]),
-    ...pick(optionalSharedInputs, ["namespace"]),
-  },
-
-  outputs: {
-    mariadb: databases.mariadbEntity,
-  },
-
-  meta: {
-    title: "MariaDB Database",
-    icon: "simple-icons:mariadb",
-    secondaryIcon: "mdi:database-plus",
-    category: "Databases",
-  },
-
-  source: source("mariadb/database"),
+  source: source("mariadb"),
 })

package/src/k8s/apps/matrix-stack.ts

@@ -0,0 +1,62 @@
+import { defineUnit, z } from "@highstate/contract"
+import { pick } from "remeda"
+import { postgresql } from "../../databases"
+import { appName, sharedInputs, source } from "./shared"
+
+/**
+ * The Matrix stack deployed on Kubernetes.
+ */
+export const matrixStack = defineUnit({
+  type: "k8s.apps.matrix-stack.v1",
+
+  args: {
+    ...appName("matrix-stack"),
+
+    /**
+     * The base domain for the Matrix stack services.
+     *
+     * Subdomains for Matrix services are generated automatically.
+     * This value cannot be changed after the first deployment.
+     */
+    fqdn: z.string(),
+
+    /**
+     * Whether to enable cinny web client deployment.
+     *
+     * The FQDN will be generated as `cinny.${fqdn}`.
+     */
+    enableCinny: z.boolean().default(false),
+
+    /**
+     * The list of remote Matrix domains that are allowed for federation.
+     *
+     * Leave empty to allow federation with all domains.
+     */
+    federationDomainWhitelist: z.array(z.string()).default([]),
+  },
+
+  inputs: {
+    ...pick(sharedInputs, ["k8sCluster", "accessPoint"]),
+
+    /**
+     * The PostgreSQL connection for the Synapse server.
+     */
+    synapsePostgresql: postgresql.connectionEntity,
+
+    /**
+     * The PostgreSQL connection for the Matrix Authentication Service.
+     */
+    masPostgresql: postgresql.connectionEntity,
+  },
+
+  secrets: {},
+
+  meta: {
+    title: "Matrix Stack",
+    icon: "simple-icons:matrix",
+    secondaryIcon: "simple-icons:element",
+    category: "Communication",
+  },
+
+  source: source("matrix-stack"),
+})

package/src/k8s/apps/minio.ts

@@ -1,68 +1,61 @@
-import { $secrets, defineUnit, text, z } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { pick } from "remeda"
-import * as databases from "../../databases"
-import { serviceEntity } from "../service"
-import { appName, optionalSharedInputs, sharedArgs, sharedInputs, source } from "./shared"
-
-const minioSecrets = $secrets({
-  /**
-   * The secret key used to authenticate with MinIO.
-   */
-  secretKey: z.string().optional(),
-
-  /**
-   * The key that protects Restic backups.
-   */
-  backupKey: z.string().optional(),
-})
+import { connectionEntity } from "../../databases/minio"
+import { deploymentEntity } from "../workload"
+import {
+  appName,
+  optionalSharedArgs,
+  optionalSharedInputs,
+  sharedArgs,
+  sharedInputs,
+  sharedSecrets,
+  source,
+} from "./shared"
 
 /**
  * The MinIO object storage deployed on Kubernetes.
  */
 export const minio = defineUnit({
   type: "k8s.apps.minio.v1",
+
   args: {
     ...appName("minio"),
+    ...pick(optionalSharedArgs, ["fqdn"]),
     ...pick(sharedArgs, ["external"]),
 
-    accessKey: {
-      schema: z.string().default("admin"),
-      meta: {
-        description: text`
-          The access key used to authenticate with MinIO.
-          If not provided, defaults to "admin".
-        `,
-      },
-    },
+    /**
+     * The FQDN of the MinIO console.
+     *
+     * If not provided, the console will not be exposed and only the S3 API will be available.
+     */
+    consoleFqdn: z.string().optional(),
 
-    region: {
-      schema: z.string().optional(),
-      meta: {
-        description: text`The region associated with the MinIO deployment.`,
-      },
-    },
+    /**
+     * The name of the region to associate with the MinIO deployment.
+     *
+     * Defaults to "us-east-1".
+     */
+    region: z.string().default("us-east-1"),
 
-    buckets: {
-      schema: databases.s3BucketSchema.array().default([]),
-      meta: {
-        description: text`
-          The buckets that must exist on the MinIO instance.
-          Each entry can optionally include a bucket policy: none, download, upload, or public.
-        `,
-      },
-    },
+    /**
+     * Whether to use the [fork](https://github.com/huncrys/minio-console) of MinIO Console instead of the built-in console.
+     * The fork contains admin features that were removed from the original console.
+     */
+    useConsoleFork: z.boolean().default(false),
   },
 
-  secrets: minioSecrets,
+  secrets: {
+    ...pick(sharedSecrets, ["adminPassword", "backupKey"]),
+  },
 
   inputs: {
     ...pick(sharedInputs, ["k8sCluster"]),
-    ...pick(optionalSharedInputs, ["resticRepo"]),
+    ...pick(optionalSharedInputs, ["accessPoint", "resticRepo"]),
   },
 
   outputs: {
-    s3: databases.s3Entity,
-    service: serviceEntity,
+    connection: connectionEntity,
+    deployment: deploymentEntity,
   },
 
   meta: {
@@ -72,5 +65,5 @@ export const minio = defineUnit({
     category: "Databases",
   },
 
-  source: source("minio/app"),
+  source: source("minio"),
 })

package/src/k8s/apps/mongodb.ts

@@ -1,13 +1,11 @@
 import { defineUnit } from "@highstate/contract"
 import { pick } from "remeda"
-import * as databases from "../../databases"
-import { serviceEntity } from "../service"
+import { connectionEntity } from "../../databases/mongodb"
+import { statefulSetEntity } from "../workload"
 import {
   appName,
   optionalSharedInputs,
   sharedArgs,
-  sharedDatabaseArgs,
-  sharedDatabaseSecrets,
   sharedInputs,
   sharedSecrets,
   source,
@@ -25,7 +23,7 @@ export const mongodb = defineUnit({
   },
 
   secrets: {
-    ...pick(sharedSecrets, ["rootPassword", "backupKey"]),
+    ...pick(sharedSecrets, ["adminPassword", "backupKey"]),
   },
 
   inputs: {
@@ -34,8 +32,8 @@ export const mongodb = defineUnit({
   },
 
   outputs: {
-    mongodb: databases.mongodbEntity,
-    service: serviceEntity,
+    connection: connectionEntity,
+    statefulSet: statefulSetEntity,
   },
 
   meta: {
@@ -45,35 +43,5 @@ export const mongodb = defineUnit({
     category: "Databases",
   },
 
-  source: source("mongodb/app"),
-})
-
-/**
- * The virtual MongoDB database created on the MongoDB instance.
- *
- * Requires a Kubernetes cluster to place init jobs and secrets.
- */
-export const mongodbDatabase = defineUnit({
-  type: "k8s.apps.mongodb.database.v1",
-
-  args: sharedDatabaseArgs,
-  secrets: sharedDatabaseSecrets,
-
-  inputs: {
-    ...pick(sharedInputs, ["k8sCluster", "mongodb"]),
-    ...pick(optionalSharedInputs, ["namespace"]),
-  },
-
-  outputs: {
-    mongodb: databases.mongodbEntity,
-  },
-
-  meta: {
-    title: "MongoDB Database",
-    icon: "simple-icons:mongodb",
-    secondaryIcon: "mdi:database-plus",
-    category: "Databases",
-  },
-
-  source: source("mongodb/database"),
+  source: source("mongodb"),
 })

package/src/k8s/apps/portal.ts

@@ -0,0 +1,27 @@
+import { defineUnit } from "@highstate/contract"
+import { pick } from "remeda"
+import { appName, sharedArgs, sharedInputs, source } from "./shared"
+
+/**
+ * The Portal application deployed on Kubernetes.
+ */
+export const portal = defineUnit({
+  type: "k8s.apps.portal.v1",
+
+  args: {
+    ...appName("portal"),
+    ...pick(sharedArgs, ["fqdn"]),
+  },
+
+  inputs: {
+    ...pick(sharedInputs, ["k8sCluster", "accessPoint"]),
+  },
+
+  meta: {
+    title: "Portal",
+    icon: "mdi:application-outline",
+    category: "Services",
+  },
+
+  source: source("portal"),
+})

package/src/k8s/apps/postgresql.ts

@@ -1,13 +1,11 @@
 import { defineUnit } from "@highstate/contract"
 import { pick } from "remeda"
-import * as databases from "../../databases"
-import { serviceEntity } from "../service"
+import { connectionEntity } from "../../databases/postgresql"
+import { statefulSetEntity } from "../workload"
 import {
   appName,
   optionalSharedInputs,
   sharedArgs,
-  sharedDatabaseArgs,
-  sharedDatabaseSecrets,
   sharedInputs,
   sharedSecrets,
   source,
@@ -21,11 +19,11 @@ export const postgresql = defineUnit({
 
   args: {
     ...appName("postgresql"),
-    ...pick(sharedArgs, ["external"]),
+    ...pick(sharedArgs, ["namespace", "external"]),
   },
 
   secrets: {
-    ...pick(sharedSecrets, ["rootPassword", "backupKey"]),
+    ...pick(sharedSecrets, ["adminPassword", "backupKey"]),
   },
 
   inputs: {
@@ -34,8 +32,8 @@ export const postgresql = defineUnit({
   },
 
   outputs: {
-    postgresql: databases.postgresqlEntity,
-    service: serviceEntity,
+    connection: connectionEntity,
+    statefulSet: statefulSetEntity,
   },
 
   meta: {
@@ -45,37 +43,5 @@ export const postgresql = defineUnit({
     category: "Databases",
   },
 
-  source: source("postgresql/app"),
-})
-
-/**
- * The virtual PostgreSQL database created on the PostgreSQL instance.
- *
- * The provided database must be authorized to create databases and users.
- *
- * Requires a Kubernetes cluster to place init jobs and secrets.
- */
-export const postgresqlDatabase = defineUnit({
-  type: "k8s.apps.postgresql.database.v1",
-
-  args: sharedDatabaseArgs,
-  secrets: sharedDatabaseSecrets,
-
-  inputs: {
-    ...pick(sharedInputs, ["k8sCluster", "postgresql"]),
-    ...pick(optionalSharedInputs, ["namespace"]),
-  },
-
-  outputs: {
-    postgresql: databases.postgresqlEntity,
-  },
-
-  meta: {
-    title: "PostgreSQL Database",
-    icon: "simple-icons:postgresql",
-    secondaryIcon: "mdi:database-plus",
-    category: "Databases",
-  },
-
-  source: source("postgresql/database"),
+  source: source("postgresql"),
 })

package/src/k8s/apps/refluxdb.ts

@@ -0,0 +1,49 @@
+import { defineUnit, z } from "@highstate/contract"
+import { pick } from "remeda"
+import { influxdb3, s3 } from "../../databases"
+import { deploymentEntity } from "../workload"
+import { appName, sharedArgs, sharedInputs, source } from "./shared"
+
+/**
+ * The RefluxDB instance deployed on Kubernetes.
+ */
+export const refluxdb = defineUnit({
+  type: "k8s.apps.refluxdb.v1",
+
+  args: {
+    ...appName("refluxdb"),
+    ...pick(sharedArgs, ["external"]),
+
+    /**
+     * The ID of the node.
+     *
+     * Defaults to "local1".
+     */
+    nodeId: z.string().default("local1"),
+  },
+
+  secrets: {
+    /**
+     * The operator token of the RefluxDB instance.
+     */
+    operatorToken: z.string().optional(),
+  },
+
+  inputs: {
+    ...pick(sharedInputs, ["k8sCluster"]),
+    s3Bucket: s3.bucketEntity,
+  },
+
+  outputs: {
+    connection: influxdb3.connectionEntity,
+    deployment: deploymentEntity,
+  },
+
+  meta: {
+    title: "RefluxDB (InfluxDB 3)",
+    icon: "simple-icons:influxdb",
+    category: "Databases",
+  },
+
+  source: source("refluxdb"),
+})

package/src/k8s/apps/remnawave.ts

@@ -1,4 +1,10 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
+import {
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  z,
+} from "@highstate/contract"
 import { pick } from "remeda"
 import { optionalSharedInputs, sharedInputs, source } from "./shared"
 
@@ -11,6 +17,13 @@ export const remnawaveEntity = defineEntity({
      */
     instanceId: z.string(),
   }),
+
+  meta: {
+    color: "#0066cc",
+    title: "Remnawave",
+    icon: "mdi:waveform",
+    iconColor: "#0066cc",
+  },
 })
 
 /**
@@ -64,3 +77,6 @@ export const node = defineUnit({
 
   source: source("remnawave/node"),
 })
+
+export type Remnawave = EntityValue<typeof remnawaveEntity>
+export type RemnawaveInput = EntityInput<typeof remnawaveEntity>