APISix Factories

Experimental

APISix factories are experimental. The API may change in future releases.

Factory functions for deploying APISix Ingress Controller via Helm.

Installation

import * as apisix from 'typekro/apisix';

Quick Example

import * as apisix from 'typekro/apisix';

// Bootstrap APISix with Helm
const bootstrap = apisix.apisixBootstrap({
  namespace: 'apisix',
  config: {
    gateway: { type: 'LoadBalancer' },
    dashboard: { enabled: true }
  }
});

Available Factories

Factory	Description
apisixBootstrap	Deploy APISix via Helm with sensible defaults
apisixHelmRelease	Full HelmRelease configuration for APISix

Bootstrap Configuration

interface APISixBootstrapConfig {
  namespace?: string;
  version?: string;
  config?: {
    gateway?: {
      type?: 'ClusterIP' | 'NodePort' | 'LoadBalancer';
      replicas?: number;
    };
    dashboard?: {
      enabled?: boolean;
    };
    ingress?: {
      enabled?: boolean;
      className?: string;
    };
  };
}

Usage in Compositions

import { kubernetesComposition } from 'typekro';
import * as apisix from 'typekro/apisix';

const infrastructure = kubernetesComposition(definition, (spec) => {
  apisix.apisixBootstrap({
    namespace: 'apisix',
    config: {
      gateway: { type: 'LoadBalancer', replicas: spec.replicas }
    }
  });

  return { ready: true };
});

Prerequisites

APISix bootstrap requires Flux CD installed in your cluster. See Kro Runtime Bootstrap for setup.

Next Steps

• Kubernetes Factories - Core Kubernetes resources
• Helm Integration - More Helm patterns