k8ts 0.5.0 → 0.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k8ts",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "Powerful framwork for building Kubernetes manifests in TypeScript.",
   "keywords": [
     "kubernetes",
@@ -77,7 +77,7 @@
   },
   "devDependencies": {
     "@datreeio/datree-cdk8s": "^1.3.5",
-    "@k8ts/instruments": "^0.4.9",
+    "@k8ts/instruments": "^0.4.10",
     "@k8ts/metadata": "^0.4.6",
     "@swc/core": "^1.11.11",
     "@swc/jest": "^0.2.37",
@@ -98,7 +98,7 @@
     "yamprint": "^0.8.4"
   },
   "peerDependencies": {
-    "@k8ts/instruments": "^0.4.9",
+    "@k8ts/instruments": "^0.4.10",
     "@k8ts/metadata": "^0.4.6"
   },
   "packageManager": "yarn@4.1.1",

package/src/_imports/k8s.ts

@@ -15157,7 +15157,7 @@ export interface PodSpec {
      * @default false.
      * @schema io.k8s.api.core.v1.PodSpec#hostPID
      */
-    readonly hostPid?: boolean
+    readonly hostPID?: boolean
 
     /**
      * Use the host's user namespace. Optional: Default to true. If set to true or not present, the
@@ -15450,7 +15450,7 @@ export function toJson_PodSpec(obj: PodSpec | undefined): Record<string, any> |
         hostAliases: obj.hostAliases?.map(y => toJson_HostAlias(y)),
         hostIPC: obj.hostIpc,
         hostNetwork: obj.hostNetwork,
-        hostPID: obj.hostPid,
+        hostPID: obj.hostPID,
         hostUsers: obj.hostUsers,
         hostname: obj.hostname,
         imagePullSecrets: obj.imagePullSecrets?.map(y => toJson_LocalObjectReference(y)),

package/src/external/index.ts

@@ -8,7 +8,7 @@ export class External<K extends Kind> extends ManifestResource {
         origin: Origin,
         readonly kind: K,
         name: string,
-        namespace: string
+        namespace: string | undefined = undefined
     ) {
         super(
             origin,

package/src/kinds.ts

@@ -124,4 +124,19 @@ export namespace api {
             export type TlsRoute = typeof TlsRoute
         }
     }
+
+    export const storage = Kind.group("storage.k8s.io")
+    export type storage = typeof storage
+    export namespace storage_ {
+        export const v1 = storage.version("v1")
+        export type v1 = typeof v1
+
+        export namespace v1_ {
+            export const StorageClass = v1.kind("StorageClass")
+            export type StorageClass = typeof StorageClass
+
+            export const VolumeAttachment = v1.kind("VolumeAttachment")
+            export type VolumeAttachment = typeof VolumeAttachment
+        }
+    }
 }

package/src/node/abs-resource.ts

@@ -19,7 +19,7 @@ export abstract class AbsResource<Props extends object = object> implements Reso
     }
     protected constructor(
         origin: Origin,
-        readonly name: string,
+        public name: string,
         readonly props: Props
     ) {
         this._node = doddle(() => new ResourceNode(origin, this, RefKey.make(this.kind, this.name)))

package/src/resources/persistent/claim/pvc.ts

@@ -1,6 +1,8 @@
 import { manifest, relations, ResourcesSpec, Unit } from "@k8ts/instruments"
 import { CDK } from "../../../_imports"
 import { Prefix$ } from "../../../_type/prefix$"
+import { MakeError } from "../../../error"
+import { External } from "../../../external"
 import { k8ts } from "../../../kind-map"
 import { api } from "../../../kinds"
 import { ManifestResource } from "../../../node"
@@ -19,31 +21,38 @@ export namespace Pvc {
     export interface Props<Mode extends DataMode> extends PvcResources {
         $accessModes: Access
         $mode?: Mode
-        $bind: Pv.AbsPv<Mode>
+        $storageClass?: External<api.storage_.v1_.StorageClass>
+        $bind?: Pv.AbsPv<Mode>
     }
 
     @k8ts(api.v1_.PersistentVolumeClaim)
     @equiv_cdk8s(CDK.KubePersistentVolumeClaim)
     @relations({
         needs: self => ({
-            bind: self.bound
+            bind: self.bound,
+            storageClass: self.props.$storageClass
         })
     })
     @manifest({
         body(self): CDK.KubePersistentVolumeClaimProps {
-            const { $storage, $accessModes, $mode } = self.props
+            const { $storage, $accessModes, $mode, $storageClass, $bind } = self.props
             const nAccessModes = Access.parse($accessModes)
+            if (!$bind && !$storageClass) {
+                throw new MakeError(
+                    `While manifesting ${self.node.format("source")}, PVC that doesn't have a $bind must have a $storageClass.`
+                )
+            }
             return {
                 spec: {
                     accessModes: nAccessModes,
-                    volumeName: self.props.$bind!.name,
+                    volumeName: self.props.$bind?.name,
                     volumeMode: $mode,
                     resources: pvc_ResourcesSpec
                         .parse({
                             storage: $storage
                         })
                         .toObject(),
-                    storageClassName: "standard"
+                    storageClassName: self.props.$storageClass?.name ?? "standard"
                 }
             }
         }

package/src/resources/persistent/volume/parse-backend.ts

@@ -1,7 +1,10 @@
 import { MakeError } from "../../../error"
 import { Backend } from "./backend"
-export function parseBackend(backend: Backend) {
-    switch (backend.type) {
+export function parseBackend(backend?: Backend) {
+    switch (backend?.type) {
+        case undefined:
+        case null:
+            return {}
         case "HostPath":
             return {
                 hostPath: {

package/src/resources/persistent/volume/pv.ts

@@ -1,6 +1,7 @@
 import { manifest, Refable, relations, type Unit } from "@k8ts/instruments"
 import { CDK } from "../../../_imports"
 import { MakeError } from "../../../error"
+import { External } from "../../../external"
 import { k8ts } from "../../../kind-map"
 import { api } from "../../../kinds"
 import { equiv_cdk8s } from "../../../node/equiv-cdk8s"
@@ -15,11 +16,11 @@ export namespace Pv {
     export import Backend = Backend_
     export interface Props<Mode extends DataMode = DataMode> {
         $accessModes: Access
-        storageClassName?: string
+        $storageClass?: External<api.storage_.v1_.StorageClass>
         $mode?: Mode
         reclaimPolicy?: Reclaim
         $capacity: Unit.Data
-        $backend: Backend
+        $backend?: Backend
         nodeAffinity?: CDK.VolumeNodeAffinity
     }
     export type Reclaim = "Retain" | "Delete" | "Recycle"
@@ -31,16 +32,21 @@ export namespace Pv {
         body(self) {
             const pvProps = self.props
             const accessModes = Access.parse(pvProps.$accessModes)
-            if (self.props.$backend.type === "Local") {
+            if (self.props.$backend?.type === "Local") {
                 if (!pvProps.nodeAffinity) {
                     throw new MakeError(
                         `While manifesting ${self.node.format("source")}, PV with Local backend must have nodeAffinity.`
                     )
                 }
             }
+            if (!self.props.$backend && !self.props.$storageClass) {
+                throw new MakeError(
+                    `While manifesting ${self.node.format("source")}, PV that doesn't have a $backend must have a $storageClass.`
+                )
+            }
             let base: CDK.PersistentVolumeSpec = {
                 accessModes,
-                storageClassName: pvProps.storageClassName ?? "standard",
+                storageClassName: pvProps.$storageClass?.name ?? "standard",
                 capacity: pvProps.$capacity
                     ? {
                           storage: CDK.Quantity.fromString(pvProps.$capacity)
@@ -60,7 +66,13 @@ export namespace Pv {
         }
     })
     @k8ts(api.v1_.PersistentVolume)
-    @relations("none")
+    @relations({
+        needs(self) {
+            return {
+                storageClass: self.props.$storageClass
+            }
+        }
+    })
     export class Pv<Mode extends DataMode = DataMode> extends ManifestResource<Props<Mode>> {
         __MODE__!: Mode
         readonly kind = api.v1_.PersistentVolume

package/src/runner/exporter/progress-shower.ts

@@ -12,7 +12,9 @@ function typedOnAny(
     target: Assembler,
     handler: (
         typedEvent: {
-            [K in keyof AssemblerEventsTable]: AssemblerEventsTable[K] & { type: K }
+            [K in keyof AssemblerEventsTable]: AssemblerEventsTable[K] & {
+                type: K
+            }
         }[keyof AssemblerEventsTable]
     ) => void | Promise<void>
 ) {

package/src/world/world.ts

@@ -30,7 +30,7 @@ export namespace World {
             this._ExternalOrigin = new ExternalOriginEntity(this.node)
         }
 
-        External<K extends Kind>(kind: K, name: string, namespace: string) {
+        External<K extends Kind>(kind: K, name: string, namespace?: string) {
             return new External(this._ExternalOrigin.node, kind, name, namespace)
         }