@highstate/library 0.18.0 → 0.20.0

package/src/k8s/apps/shared.ts

@@ -12,13 +12,7 @@ import {
 } from "@highstate/contract"
 import { mapValues } from "remeda"
 import { accessPointEntity } from "../../common"
-import {
-  etcdEntity,
-  mariadbEntity,
-  mongodbEntity,
-  postgresqlEntity,
-  redisEntity,
-} from "../../databases"
+import { etcd, mongodb, mysql, postgresql, redis } from "../../databases"
 import { providerEntity } from "../../dns"
 import { repositoryEntity } from "../../restic"
 import { namespaceEntity, persistentVolumeClaimEntity } from "../resources"
@@ -46,6 +40,13 @@ export const sharedArgs = $args({
    * The number of replicas for the application.
    */
   replicas: z.number().default(1),
+
+  /**
+   * The name of  namespace to create for the application.
+   *
+   * If not provided, defaults to the appName.
+   */
+  namespace: z.string().optional(),
 })
 
 type ToOptionalArgs<T extends Record<string, FullComponentArgumentOptions>> = Simplify<{
@@ -80,9 +81,9 @@ export function appName(defaultAppName: string) {
 
 export const sharedSecrets = $secrets({
   /**
-   * The root password for the database instance. If not provided, a random password will be generated.
+   * The admin password for the application. If not provided, a random password will be generated.
    */
-  rootPassword: z.string().optional(),
+  adminPassword: z.string().optional(),
 
   /**
    * The key to use for backup encryption. If not provided, a random key will be generated.
@@ -135,20 +136,20 @@ export const sharedInputs = $inputs({
   volume: {
     entity: persistentVolumeClaimEntity,
   },
-  mariadb: {
-    entity: mariadbEntity,
+  mysql: {
+    entity: mysql.connectionEntity,
   },
   postgresql: {
-    entity: postgresqlEntity,
+    entity: postgresql.connectionEntity,
   },
   mongodb: {
-    entity: mongodbEntity,
+    entity: mongodb.connectionEntity,
   },
   redis: {
-    entity: redisEntity,
+    entity: redis.connectionEntity,
   },
   etcd: {
-    entity: etcdEntity,
+    entity: etcd.connectionEntity,
   },
 })
 

package/src/k8s/apps/traefik.ts

@@ -22,6 +22,11 @@ export const traefik = defineUnit({
      */
     className: z.string().default("traefik"),
 
+    /**
+     * The node selector to apply to all Traefik pods.
+     */
+    nodeSelector: z.record(z.string(), z.string()).default({}),
+
     /**
      * Whether to create and enable reconciliation for Traefik CRDs.
      */

package/src/k8s/apps/valkey.ts

@@ -1,7 +1,7 @@
 import { defineUnit } from "@highstate/contract"
 import { pick } from "remeda"
-import { databases } from "../.."
-import { serviceEntity } from "../service"
+import { redis } from "../../databases"
+import { statefulSetEntity } from "../workload"
 import {
   appName,
   optionalSharedInputs,
@@ -32,8 +32,8 @@ export const valkey = defineUnit({
   },
 
   outputs: {
-    redis: databases.redisEntity,
-    service: serviceEntity,
+    connection: redis.connectionEntity,
+    statefulSet: statefulSetEntity,
   },
 
   meta: {
@@ -43,5 +43,5 @@ export const valkey = defineUnit({
     category: "Databases",
   },
 
-  source: source("valkey/app"),
+  source: source("valkey"),
 })

package/src/k8s/apps/vaultwarden.ts

@@ -1,4 +1,4 @@
-import { defineUnit, z } from "@highstate/contract"
+import { defineUnit } from "@highstate/contract"
 import { pick } from "remeda"
 import { appName, sharedArgs, sharedInputs, source } from "./shared"
 
@@ -13,12 +13,8 @@ export const vaultwarden = defineUnit({
     ...pick(sharedArgs, ["fqdn"]),
   },
 
-  secrets: {
-    mariadbPassword: z.string().optional(),
-  },
-
   inputs: {
-    ...pick(sharedInputs, ["k8sCluster", "accessPoint", "mariadb"]),
+    ...pick(sharedInputs, ["k8sCluster", "accessPoint", "mysql"]),
   },
 
   meta: {

package/src/k8s/apps/workload.ts

@@ -2,8 +2,8 @@ import { defineUnit, z } from "@highstate/contract"
 import { pick } from "remeda"
 import { portSchema } from "../../network"
 import { namespaceEntity } from "../resources"
-import { serviceEntity, serviceTypeSchema } from "../service"
-import { exposableWorkloadEntity } from "../workload"
+import { serviceTypeSchema } from "../service"
+import { workloadEntity } from "../workload"
 import { optionalSharedInputs, sharedInputs, source } from "./shared"
 
 export const databaseConfigKeySchema = z.enum([
@@ -123,6 +123,11 @@ export const workload = defineUnit({
      */
     env: z.record(z.string(), environmentVariableSchema).default({}),
 
+    /**
+     * The files to mount in the workload from a config map.
+     */
+    files: z.record(z.string(), z.string()).default({}),
+
     /**
      * The configuration for the workload.
      *
@@ -195,19 +200,17 @@ export const workload = defineUnit({
 
   inputs: {
     ...pick(sharedInputs, ["k8sCluster"]),
-    ...pick(optionalSharedInputs, [
-      "accessPoint",
-      "resticRepo",
-      "mariadb",
-      "postgresql",
-      "mongodb",
-    ]),
+    ...pick(optionalSharedInputs, ["accessPoint", "resticRepo", "mysql", "postgresql", "mongodb"]),
+
+    workload: {
+      entity: workloadEntity,
+      required: false,
+    },
   },
 
   outputs: {
     namespace: namespaceEntity,
-    workload: exposableWorkloadEntity,
-    service: serviceEntity,
+    workload: workloadEntity,
   },
 
   meta: {

package/src/k8s/cert-manager.ts

@@ -56,6 +56,28 @@ export const certManager = defineUnit({
 export const dns01TlsIssuer = defineUnit({
   type: "k8s.dns01-issuer.v1",
 
+  args: {
+    /**
+     * The ACME server to use for issuing certificates.
+     */
+    acmeServer: z
+      .union([
+        z.object({
+          type: z.enum(["letsencrypt", "zerossl"]),
+        }),
+        z.object({
+          type: z.literal("custom"),
+          url: z.string(),
+        }),
+      ])
+      .default({ type: "letsencrypt" }),
+  },
+
+  secrets: {
+    eabKeyId: z.string().optional(),
+    eabKeySecret: z.string().optional(),
+  },
+
   inputs: {
     k8sCluster: clusterEntity,
     dnsProvider: dns.providerEntity,

package/src/k8s/cilium.ts

@@ -1,5 +1,5 @@
 import { defineUnit, z } from "@highstate/contract"
-import { clusterEntity } from "./shared"
+import { clusterEntity, tolerationSchema } from "./shared"
 
 /**
  * The Cilium CNI deployed on Kubernetes.
@@ -25,6 +25,21 @@ export const cilium = defineUnit({
      * To expose the Hubble UI, you can use `k8s.apps.hubble-ui` unit.
      */
     enableHubble: z.boolean().default(true),
+
+    /**
+     * The tolerations of the cilium agent in the cluster.
+     */
+    agentTolerations: tolerationSchema.array().optional(),
+
+    /**
+     * The tolerations of the cilium envoy in the cluster.
+     */
+    envoyTolerations: tolerationSchema.array().optional(),
+
+    /**
+     * The tolerations of the cilium operator in the cluster.
+     */
+    operatorTolerations: tolerationSchema.array().optional(),
   },
 
   inputs: {
@@ -49,7 +64,7 @@ export const cilium = defineUnit({
 })
 
 export const ciliumClusterMetadata = z.object({
-  cilium: z.object({
+  "cilium.cni": z.object({
     /**
      * If set to `true`, the generated network policy will allow
      * all DNS queries to be resolved, even if they are

package/src/k8s/resources.ts

@@ -1,5 +1,5 @@
 import type { Simplify, SimplifyDeep } from "type-fest"
-import { defineEntity, z } from "@highstate/contract"
+import { defineEntity, type EntityInput, type EntityValue, z } from "@highstate/contract"
 
 /**
  * The generic metadata schema for Kubernetes resources.
@@ -46,6 +46,13 @@ export const resourceEntity = defineEntity({
       }),
     ]),
   ),
+
+  meta: {
+    color: "#607D8B",
+    title: "Resource",
+    icon: "devicon:kubernetes",
+    iconColor: "#607D8B",
+  },
 })
 
 /**
@@ -59,6 +66,13 @@ export const namespacedResourceEntity = defineEntity({
   schema: z.object({
     isNamespaced: z.literal(true),
   }),
+
+  meta: {
+    color: "#78909C",
+    title: "Namespaced Resource",
+    icon: "devicon:kubernetes",
+    iconColor: "#78909C",
+  },
 })
 
 /**
@@ -72,6 +86,9 @@ export const namespaceEntity = defineEntity({
 
   meta: {
     color: "#9E9E9E",
+    title: "Namespace",
+    icon: "devicon:kubernetes",
+    iconColor: "#9E9E9E",
   },
 })
 
@@ -86,6 +103,9 @@ export const persistentVolumeClaimEntity = defineEntity({
 
   meta: {
     color: "#FFC107",
+    title: "Persistent Volume Claim",
+    icon: "devicon:kubernetes",
+    iconColor: "#FFC107",
   },
 })
 
@@ -100,6 +120,9 @@ export const gatewayEntity = defineEntity({
 
   meta: {
     color: "#4CAF50",
+    title: "Gateway",
+    icon: "devicon:kubernetes",
+    iconColor: "#4CAF50",
   },
 })
 
@@ -111,6 +134,9 @@ export const certificateEntity = defineEntity({
 
   meta: {
     color: "#3F51B5",
+    title: "Certificate",
+    icon: "devicon:kubernetes",
+    iconColor: "#3F51B5",
   },
 })
 
@@ -122,6 +148,9 @@ export const configMapEntity = defineEntity({
 
   meta: {
     color: "#FF9800",
+    title: "ConfigMap",
+    icon: "devicon:kubernetes",
+    iconColor: "#FF9800",
   },
 })
 
@@ -133,22 +162,34 @@ export const secretEntity = defineEntity({
 
   meta: {
     color: "#9C27B0",
+    title: "Secret",
+    icon: "devicon:kubernetes",
+    iconColor: "#9C27B0",
   },
 })
 
 export type Metadata = z.infer<typeof metadataSchema>
-export type Resource = z.infer<typeof resourceEntity.schema>
+export type Resource = EntityValue<typeof resourceEntity>
+export type ResourceInput = EntityInput<typeof resourceEntity>
 
 export type NamespacedMetadata = z.infer<typeof namespacedMetadataSchema>
 
 export type NamespacedResource = SimplifyDeep<
-  z.infer<typeof namespacedResourceEntity.schema>,
+  EntityValue<typeof namespacedResourceEntity>,
   Record<string, string>
 >
 
-export type Namespace = Simplify<z.infer<typeof namespaceEntity.schema>>
-export type PersistentVolumeClaim = z.infer<typeof persistentVolumeClaimEntity.schema>
-export type Gateway = z.infer<typeof gatewayEntity.schema>
-export type Certificate = z.infer<typeof certificateEntity.schema>
-export type ConfigMap = z.infer<typeof configMapEntity.schema>
-export type Secret = z.infer<typeof secretEntity.schema>
+export type NamespacedResourceInput = EntityInput<typeof namespacedResourceEntity>
+
+export type Namespace = Simplify<EntityValue<typeof namespaceEntity>>
+export type NamespaceInput = EntityInput<typeof namespaceEntity>
+export type PersistentVolumeClaim = EntityValue<typeof persistentVolumeClaimEntity>
+export type PersistentVolumeClaimInput = EntityInput<typeof persistentVolumeClaimEntity>
+export type Gateway = EntityValue<typeof gatewayEntity>
+export type GatewayInput = EntityInput<typeof gatewayEntity>
+export type Certificate = EntityValue<typeof certificateEntity>
+export type CertificateInput = EntityInput<typeof certificateEntity>
+export type ConfigMap = EntityValue<typeof configMapEntity>
+export type ConfigMapInput = EntityInput<typeof configMapEntity>
+export type Secret = EntityValue<typeof secretEntity>
+export type SecretInput = EntityInput<typeof secretEntity>

package/src/k8s/service.ts

@@ -1,5 +1,5 @@
 import type { Simplify } from "type-fest"
-import { defineEntity, z } from "@highstate/contract"
+import { defineEntity, type EntityInput, type EntityValue, z } from "@highstate/contract"
 import { l4EndpointEntity } from "../network"
 import { namespacedResourceEntity } from "./resources"
 
@@ -58,6 +58,7 @@ export const serviceEntity = defineEntity({
     endpoints: {
       entity: l4EndpointEntity,
       multiple: true,
+      required: false,
     },
   },
 
@@ -65,6 +66,9 @@ export const serviceEntity = defineEntity({
 
   meta: {
     color: "#2196F3",
+    title: "Service",
+    icon: "devicon:kubernetes",
+    iconColor: "#2196F3",
   },
 })
 
@@ -73,4 +77,5 @@ export const serviceTypeSchema = z.enum(["NodePort", "LoadBalancer", "ClusterIP"
 export type EndpointServiceMetadata = z.infer<typeof serviceEndpointMetadataSchema>
 export type ServiceEndpoint = Simplify<z.infer<typeof serviceEndpointSchema>>
 export type ServiceType = z.infer<typeof serviceTypeSchema>
-export type Service = z.infer<typeof serviceEntity.schema>
+export type Service = EntityValue<typeof serviceEntity>
+export type ServiceInput = EntityInput<typeof serviceEntity>

package/src/k8s/shared.ts

@@ -1,5 +1,12 @@
-import { $args, defineEntity, defineUnit, z } from "@highstate/contract"
-import { serverEntity } from "../common"
+import {
+  $args,
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  z,
+} from "@highstate/contract"
+import { fileEntity, serverEntity } from "../common"
 import { implementationReferenceSchema } from "../impl-ref"
 import { addressEntity, l3EndpointEntity, l4EndpointEntity } from "../network"
 import { metadataSchema } from "../utils"
@@ -78,20 +85,6 @@ export const clusterInfoProperties = {
    */
   networkPolicyImplRef: implementationReferenceSchema.optional(),
 
-  /**
-   * The endpoints of the API server.
-   *
-   * The entry may represent real node endpoint or virtual endpoint (like a load balancer).
-   *
-   * The same node may also be represented by multiple entries (e.g. a node with private and public IP).
-   */
-  apiEndpoints: l4EndpointEntity.schema.array(),
-
-  /**
-   * The external IPs of the cluster nodes allowed to be used for external access.
-   */
-  externalIps: addressEntity.schema.array(),
-
   /**
    * The extra quirks of the cluster to improve compatibility.
    */
@@ -107,6 +100,18 @@ export const clusterEntity = defineEntity({
   type: "k8s.cluster.v1",
 
   includes: {
+    /**
+     * The endpoints of the API server.
+     *
+     * The entry may represent real node endpoint or virtual endpoint (like a load balancer).
+     *
+     * The same node may also be represented by multiple entries (e.g. a node with private and public IP).
+     */
+    apiEndpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
+
     /**
      * The endpoints of the cluster nodes.
      *
@@ -117,16 +122,33 @@ export const clusterEntity = defineEntity({
     endpoints: {
       entity: l3EndpointEntity,
       multiple: true,
+      required: false,
+    },
+
+    /**
+     * The external IPs of the cluster nodes allowed to be used for external access.
+     */
+    externalIps: {
+      entity: addressEntity,
+      multiple: true,
+      required: false,
     },
+
+    /**
+     * The kubeconfig file to use for connecting to the cluster.
+     */
+    kubeconfig: fileEntity,
   },
 
   schema: z.object({
     ...clusterInfoProperties,
-    kubeconfig: z.string(),
   }),
 
   meta: {
     color: "#2196F3",
+    title: "K8S Cluster",
+    icon: "devicon:kubernetes",
+    iconColor: "#2196F3",
   },
 })
 
@@ -305,9 +327,19 @@ export const monitorWorkerParamsSchema = z.object({
   resources: namespacedResourceEntity.schema.array(),
 })
 
-export type Cluster = z.infer<typeof clusterEntity.schema>
+export const tolerationSchema = z.object({
+  key: z.string().optional(),
+  operator: z.enum(["Exists", "Equal"]),
+  value: z.string().optional(),
+  effect: z.enum(["NoSchedule", "PreferNoSchedule", "NoExecute"]).optional(),
+})
+
+export type Cluster = EntityValue<typeof clusterEntity>
+export type ClusterInput = EntityInput<typeof clusterEntity>
 
 export type InternalIpsPolicy = z.infer<typeof internalIpsPolicySchema>
 
 export type MonitorWorkerParams = z.infer<typeof monitorWorkerParamsSchema>
 export type MonitorWorkerResourceGroup = z.infer<typeof monitorWorkerResourceGroupSchema>
+
+export type Toleration = z.infer<typeof tolerationSchema>

package/src/k8s/workload.ts

@@ -1,19 +1,48 @@
-import { defineEntity, z } from "@highstate/contract"
-import { l4EndpointEntity } from "../network"
+import { defineEntity, type EntityInput, type EntityValue, z } from "@highstate/contract"
 import { namespacedResourceEntity } from "./resources"
 import { serviceEntity } from "./service"
 
 /**
  * The entity which represents a Kubernetes workload.
+ *
+ * Can optionally include a service associated with the workload.
  */
 export const workloadEntity = defineEntity({
   type: "k8s.workload.v1",
 
   extends: { namespacedResourceEntity },
-  schema: z.unknown(),
+
+  includes: {
+    service: {
+      entity: serviceEntity,
+      required: false,
+    },
+  },
+
+  schema: z.object({
+    spec: z.object({
+      template: z.object({
+        spec: z.object({
+          containers: z.array(
+            z.object({
+              name: z.string(),
+              ports: z.array(
+                z.object({
+                  containerPort: z.number(),
+                }),
+              ),
+            }),
+          ),
+        }),
+      }),
+    }),
+  }),
 
   meta: {
     color: "#9C27B0",
+    title: "Workload",
+    icon: "devicon:kubernetes",
+    iconColor: "#9C27B0",
   },
 })
 
@@ -29,6 +58,9 @@ export const jobEntity = defineEntity({
 
   meta: {
     color: "#FF5722",
+    title: "Job",
+    icon: "devicon:kubernetes",
+    iconColor: "#FF5722",
   },
 })
 
@@ -44,35 +76,9 @@ export const cronJobEntity = defineEntity({
 
   meta: {
     color: "#FF9800",
-  },
-})
-
-/**
- * The entity which represents a Kubernetes workload (optionally) exposed via a service.
- *
- * Includes both the workload and its associated service.
- */
-export const exposableWorkloadEntity = defineEntity({
-  type: "k8s.exposable-workload.v1",
-
-  extends: { workloadEntity },
-
-  includes: {
-    service: {
-      entity: serviceEntity,
-      required: false,
-    },
-
-    endpoints: {
-      entity: l4EndpointEntity,
-      multiple: true,
-    },
-  },
-
-  schema: z.unknown(),
-
-  meta: {
-    color: "#4CAF50",
+    title: "CronJob",
+    icon: "devicon:kubernetes",
+    iconColor: "#FF9800",
   },
 })
 
@@ -84,11 +90,14 @@ export const exposableWorkloadEntity = defineEntity({
 export const deploymentEntity = defineEntity({
   type: "k8s.deployment.v1",
 
-  extends: { exposableWorkloadEntity },
+  extends: { workloadEntity },
   schema: z.unknown(),
 
   meta: {
     color: "#4CAF50",
+    title: "Deployment",
+    icon: "devicon:kubernetes",
+    iconColor: "#4CAF50",
   },
 })
 
@@ -100,7 +109,7 @@ export const deploymentEntity = defineEntity({
 export const statefulSetEntity = defineEntity({
   type: "k8s.stateful-set.v1",
 
-  extends: { exposableWorkloadEntity },
+  extends: { workloadEntity },
 
   includes: {
     service: serviceEntity,
@@ -110,6 +119,9 @@ export const statefulSetEntity = defineEntity({
 
   meta: {
     color: "#FFC107",
+    title: "Stateful Set",
+    icon: "devicon:kubernetes",
+    iconColor: "#FFC107",
   },
 })
 
@@ -119,20 +131,31 @@ export const statefulSetEntity = defineEntity({
 export const networkInterfaceEntity = defineEntity({
   type: "k8s.network-interface.v1",
 
+  includes: {
+    workload: workloadEntity,
+  },
+
   schema: z.object({
     name: z.string(),
-    workload: workloadEntity.schema,
   }),
 
   meta: {
     color: "#2196F3",
+    title: "Network Interface",
+    icon: "devicon:kubernetes",
+    iconColor: "#2196F3",
   },
 })
 
-export type Workload = z.infer<typeof workloadEntity.schema>
-export type Job = z.infer<typeof jobEntity.schema>
-export type CronJob = z.infer<typeof cronJobEntity.schema>
-export type ExposableWorkload = z.infer<typeof exposableWorkloadEntity.schema>
-export type Deployment = z.infer<typeof deploymentEntity.schema>
-export type StatefulSet = z.infer<typeof statefulSetEntity.schema>
-export type NetworkInterface = z.infer<typeof networkInterfaceEntity.schema>
+export type Workload = EntityValue<typeof workloadEntity>
+export type WorkloadInput = EntityInput<typeof workloadEntity>
+export type Job = EntityValue<typeof jobEntity>
+export type JobInput = EntityInput<typeof jobEntity>
+export type CronJob = EntityValue<typeof cronJobEntity>
+export type CronJobInput = EntityInput<typeof cronJobEntity>
+export type Deployment = EntityValue<typeof deploymentEntity>
+export type DeploymentInput = EntityInput<typeof deploymentEntity>
+export type StatefulSet = EntityValue<typeof statefulSetEntity>
+export type StatefulSetInput = EntityInput<typeof statefulSetEntity>
+export type NetworkInterface = EntityValue<typeof networkInterfaceEntity>
+export type NetworkInterfaceInput = EntityInput<typeof networkInterfaceEntity>