Factory Functions

TypeKro provides factory functions for creating Kubernetes resources with full type safety.

Quick Example

import { Deployment, Service } from 'typekro/simple';

const deploy = Deployment({
  id: 'app',  // Required for cross-resource references
  name: 'my-app',
  image: 'nginx:latest',
  replicas: 3,
  ports: [{ containerPort: 80 }]
});

const svc = Service({
  id: 'svc',
  name: 'my-app-svc',
  selector: { app: 'my-app' },
  ports: [{ port: 80, targetPort: 80 }]
});

Import Patterns

See Import Patterns for complete import documentation.

// Recommended: direct imports from typekro/simple
import { Deployment, Service, ConfigMap, Secret, YamlFile, HelmChart } from 'typekro/simple';

// Alternative: namespace import from main package
import { simple } from 'typekro';
const deploy = simple.Deployment({ id: 'app', name: 'app', image: 'nginx' });

// Core factories (full Kubernetes API)
import { deployment, service, role, roleBinding } from 'typekro';

Categories

Category	Description
Workloads	Deployment, StatefulSet, DaemonSet, Job, CronJob
Networking	Service, Ingress, NetworkPolicy
Config	ConfigMap, Secret
Storage	PersistentVolumeClaim, PersistentVolume
RBAC	Role, RoleBinding, ServiceAccount, ClusterRole
YAML	yamlFile for external manifests

Simple vs Core Factories

Simple Factories - Minimal configuration with sensible defaults:

import { Deployment } from 'typekro/simple';

const deploy = Deployment({
  id: 'app',
  name: 'app',
  image: 'nginx',
  replicas: 3
});

Core Factories - Full Kubernetes API access:

import { deployment } from 'typekro';

const deploy = deployment({
  id: 'app',
  metadata: { name: 'app', namespace: 'prod' },
  spec: {
    replicas: 3,
    selector: { matchLabels: { app: 'my-app' } },
    template: { /* full pod template */ }
  }
});

The id Parameter

Every resource that needs to be referenced requires an id. See Resource IDs for complete documentation.

import { Deployment } from 'typekro/simple';

// ✅ With id - can be referenced in status expressions
const deploy = Deployment({ id: 'app', name: 'app', image: 'nginx' });
return { ready: deploy.status.readyReplicas > 0 };

// ❌ Without id - cannot be referenced
const deploy = Deployment({ name: 'app', image: 'nginx' });
// deploy.status.readyReplicas won't generate correct CEL

Next Steps

• Workloads - Deployment, StatefulSet, DaemonSet
• Networking - Service, Ingress, NetworkPolicy
• YAML - External manifest integration