@intentius/chant-lexicon-k8s 0.0.14 → 0.0.16

package/src/composites/gke-fluent-bit-agent.ts

@@ -0,0 +1,219 @@
+/**
+ * GkeFluentBitAgent composite — DaemonSet + RBAC + ConfigMap for Fluent Bit on GKE.
+ *
+ * @gke Like FluentBitAgent but targets Cloud Logging via the stackdriver
+ * output plugin and uses GKE Workload Identity instead of IRSA.
+ */
+
+export interface GkeFluentBitAgentProps {
+  /** GKE cluster name — used as log stream prefix. */
+  clusterName: string;
+  /** GCP project ID. */
+  projectId: string;
+  /** GCP service account email for Workload Identity. */
+  gcpServiceAccountEmail?: string;
+  /** Agent name (default: "fluent-bit"). */
+  name?: string;
+  /** Fluent Bit image (default: "fluent/fluent-bit:latest"). */
+  image?: string;
+  /** Namespace (default: "gke-logging"). */
+  namespace?: string;
+  /** Additional labels. */
+  labels?: Record<string, string>;
+  /** CPU request (default: "50m"). */
+  cpuRequest?: string;
+  /** Memory request (default: "64Mi"). */
+  memoryRequest?: string;
+  /** CPU limit (default: "200m"). */
+  cpuLimit?: string;
+  /** Memory limit (default: "128Mi"). */
+  memoryLimit?: string;
+}
+
+export interface GkeFluentBitAgentResult {
+  daemonSet: Record<string, unknown>;
+  serviceAccount: Record<string, unknown>;
+  clusterRole: Record<string, unknown>;
+  clusterRoleBinding: Record<string, unknown>;
+  configMap: Record<string, unknown>;
+}
+
+/**
+ * Create a GkeFluentBitAgent composite — returns prop objects for
+ * a DaemonSet, ServiceAccount, ClusterRole, ClusterRoleBinding, and ConfigMap.
+ *
+ * @gke
+ * @example
+ * ```ts
+ * import { GkeFluentBitAgent } from "@intentius/chant-lexicon-k8s";
+ *
+ * const { daemonSet, serviceAccount, clusterRole, clusterRoleBinding, configMap } = GkeFluentBitAgent({
+ *   clusterName: "my-cluster",
+ *   projectId: "my-project",
+ *   gcpServiceAccountEmail: "fluent-bit@my-project.iam.gserviceaccount.com",
+ * });
+ * ```
+ */
+export function GkeFluentBitAgent(props: GkeFluentBitAgentProps): GkeFluentBitAgentResult {
+  const {
+    clusterName,
+    projectId,
+    gcpServiceAccountEmail,
+    name = "fluent-bit",
+    image = "fluent/fluent-bit:latest",
+    namespace = "gke-logging",
+    labels: extraLabels = {},
+    cpuRequest = "50m",
+    memoryRequest = "64Mi",
+    cpuLimit = "200m",
+    memoryLimit = "128Mi",
+  } = props;
+
+  const saName = `${name}-sa`;
+  const clusterRoleName = `${name}-role`;
+  const bindingName = `${name}-binding`;
+  const configMapName = `${name}-config`;
+
+  const commonLabels: Record<string, string> = {
+    "app.kubernetes.io/name": name,
+    "app.kubernetes.io/managed-by": "chant",
+    ...extraLabels,
+  };
+
+  const fluentBitConfig = `[SERVICE]
+    Flush         5
+    Log_Level     info
+    Daemon        off
+    Parsers_File  parsers.conf
+
+[INPUT]
+    Name              tail
+    Tag               kube.*
+    Path              /var/log/containers/*.log
+    Parser            docker
+    DB                /var/fluent-bit/state/flb_container.db
+    Mem_Buf_Limit     5MB
+    Skip_Long_Lines   On
+    Refresh_Interval  10
+
+[FILTER]
+    Name                kubernetes
+    Match               kube.*
+    Kube_URL            https://kubernetes.default.svc:443
+    Kube_CA_File        /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
+    Kube_Token_File     /var/run/secrets/kubernetes.io/serviceaccount/token
+    Merge_Log           On
+    K8S-Logging.Parser  On
+    K8S-Logging.Exclude Off
+
+[OUTPUT]
+    Name                stackdriver
+    Match               *
+    google_service_credentials /var/run/secrets/kubernetes.io/serviceaccount/token
+    resource            k8s_container
+    k8s_cluster_name    ${clusterName}
+    k8s_cluster_location ${projectId}
+`;
+
+  const container: Record<string, unknown> = {
+    name,
+    image,
+    resources: {
+      requests: { cpu: cpuRequest, memory: memoryRequest },
+      limits: { cpu: cpuLimit, memory: memoryLimit },
+    },
+    volumeMounts: [
+      { name: "varlog", mountPath: "/var/log", readOnly: true },
+      { name: "config", mountPath: `/etc/${name}`, readOnly: true },
+      { name: "state", mountPath: "/var/fluent-bit/state" },
+    ],
+    securityContext: {
+      runAsUser: 0,
+      readOnlyRootFilesystem: true,
+      allowPrivilegeEscalation: false,
+    },
+  };
+
+  const daemonSetProps: Record<string, unknown> = {
+    metadata: {
+      name,
+      namespace,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "agent" },
+    },
+    spec: {
+      selector: { matchLabels: { "app.kubernetes.io/name": name } },
+      template: {
+        metadata: { labels: { "app.kubernetes.io/name": name, ...extraLabels } },
+        spec: {
+          serviceAccountName: saName,
+          containers: [container],
+          volumes: [
+            { name: "varlog", hostPath: { path: "/var/log" } },
+            { name: "config", configMap: { name: configMapName } },
+            { name: "state", hostPath: { path: `/var/fluent-bit/state/${name}` } },
+          ],
+          tolerations: [{ operator: "Exists" }],
+        },
+      },
+    },
+  };
+
+  const serviceAccountProps: Record<string, unknown> = {
+    metadata: {
+      name: saName,
+      namespace,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "agent" },
+      ...(gcpServiceAccountEmail
+        ? { annotations: { "iam.gke.io/gcp-service-account": gcpServiceAccountEmail } }
+        : {}),
+    },
+  };
+
+  const clusterRoleProps: Record<string, unknown> = {
+    metadata: {
+      name: clusterRoleName,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "rbac" },
+    },
+    rules: [
+      { apiGroups: [""], resources: ["namespaces", "pods"], verbs: ["get", "list", "watch"] },
+    ],
+  };
+
+  const clusterRoleBindingProps: Record<string, unknown> = {
+    metadata: {
+      name: bindingName,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "rbac" },
+    },
+    roleRef: {
+      apiGroup: "rbac.authorization.k8s.io",
+      kind: "ClusterRole",
+      name: clusterRoleName,
+    },
+    subjects: [
+      {
+        kind: "ServiceAccount",
+        name: saName,
+        namespace,
+      },
+    ],
+  };
+
+  const configMapProps: Record<string, unknown> = {
+    metadata: {
+      name: configMapName,
+      namespace,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "config" },
+    },
+    data: {
+      "fluent-bit.conf": fluentBitConfig,
+    },
+  };
+
+  return {
+    daemonSet: daemonSetProps,
+    serviceAccount: serviceAccountProps,
+    clusterRole: clusterRoleProps,
+    clusterRoleBinding: clusterRoleBindingProps,
+    configMap: configMapProps,
+  };
+}

package/src/composites/gke-gateway.ts

@@ -0,0 +1,143 @@
+/**
+ * GkeGateway composite — Gateway + HTTPRoute for GKE Gateway API.
+ *
+ * @gke Creates a Gateway with a GKE-specific `gatewayClassName` and
+ * HTTPRoute resources for traffic routing.
+ */
+
+export interface GkeGatewayHost {
+  /** Hostname (e.g., "api.example.com"). */
+  hostname: string;
+  /** Path rules for this host. */
+  paths: Array<{
+    path: string;
+    serviceName: string;
+    servicePort: number;
+  }>;
+}
+
+export interface GkeGatewayProps {
+  /** Gateway name — used in metadata and labels. */
+  name: string;
+  /** GKE gateway class (default: "gke-l7-global-external-managed"). */
+  gatewayClassName?:
+    | "gke-l7-global-external-managed"
+    | "gke-l7-regional-external-managed"
+    | "gke-l7-rilb";
+  /** Host definitions with paths. */
+  hosts: GkeGatewayHost[];
+  /** Google-managed certificate name for TLS. */
+  certificateName?: string;
+  /** Additional labels to apply to all resources. */
+  labels?: Record<string, string>;
+  /** Namespace for all resources. */
+  namespace?: string;
+}
+
+export interface GkeGatewayResult {
+  gateway: Record<string, unknown>;
+  httpRoute: Record<string, unknown>;
+}
+
+/**
+ * Create a GkeGateway composite — returns prop objects for
+ * a Gateway and HTTPRoute with GKE-specific gateway class.
+ *
+ * @gke
+ * @example
+ * ```ts
+ * import { GkeGateway } from "@intentius/chant-lexicon-k8s";
+ *
+ * const { gateway, httpRoute } = GkeGateway({
+ *   name: "api-gateway",
+ *   hosts: [
+ *     {
+ *       hostname: "api.example.com",
+ *       paths: [{ path: "/", serviceName: "api", servicePort: 80 }],
+ *     },
+ *   ],
+ *   certificateName: "api-cert",
+ * });
+ * ```
+ */
+export function GkeGateway(props: GkeGatewayProps): GkeGatewayResult {
+  const {
+    name,
+    gatewayClassName = "gke-l7-global-external-managed",
+    hosts,
+    certificateName,
+    labels: extraLabels = {},
+    namespace,
+  } = props;
+
+  const routeName = `${name}-route`;
+
+  const commonLabels: Record<string, string> = {
+    "app.kubernetes.io/name": name,
+    "app.kubernetes.io/managed-by": "chant",
+    ...extraLabels,
+  };
+
+  // Build Gateway listeners
+  const listeners: Array<Record<string, unknown>> = [];
+
+  if (certificateName) {
+    listeners.push({
+      name: "https",
+      protocol: "HTTPS",
+      port: 443,
+      tls: {
+        mode: "Terminate",
+        certificateRefs: [{ kind: "ManagedCertificate", name: certificateName }],
+      },
+    });
+  } else {
+    listeners.push({
+      name: "http",
+      protocol: "HTTP",
+      port: 80,
+    });
+  }
+
+  const gatewayProps: Record<string, unknown> = {
+    metadata: {
+      name,
+      ...(namespace && { namespace }),
+      labels: { ...commonLabels, "app.kubernetes.io/component": "gateway" },
+    },
+    spec: {
+      gatewayClassName,
+      listeners,
+    },
+  };
+
+  // Build HTTPRoute rules
+  const hostnames = hosts.map((h) => h.hostname);
+
+  const rules = hosts.flatMap((host) =>
+    host.paths.map((p) => ({
+      matches: [{ path: { type: "PathPrefix", value: p.path } }],
+      backendRefs: [
+        { name: p.serviceName, port: p.servicePort },
+      ],
+    })),
+  );
+
+  const httpRouteProps: Record<string, unknown> = {
+    metadata: {
+      name: routeName,
+      ...(namespace && { namespace }),
+      labels: { ...commonLabels, "app.kubernetes.io/component": "route" },
+    },
+    spec: {
+      parentRefs: [{ name }],
+      hostnames,
+      rules,
+    },
+  };
+
+  return {
+    gateway: gatewayProps,
+    httpRoute: httpRouteProps,
+  };
+}

package/src/composites/gke-otel-collector.ts

@@ -0,0 +1,229 @@
+/**
+ * GkeOtelCollector composite — DaemonSet + RBAC + ConfigMap for OpenTelemetry on GKE.
+ *
+ * @gke Like AdotCollector but targets Cloud Trace + Cloud Monitoring via the
+ * googlecloud exporter and uses GKE Workload Identity instead of IRSA.
+ */
+
+export interface GkeOtelCollectorProps {
+  /** GKE cluster name. */
+  clusterName: string;
+  /** GCP project ID. */
+  projectId: string;
+  /** GCP service account email for Workload Identity. */
+  gcpServiceAccountEmail?: string;
+  /** Agent name (default: "gke-otel-collector"). */
+  name?: string;
+  /** OTel Collector image (default: "otel/opentelemetry-collector-contrib:latest"). */
+  image?: string;
+  /** Namespace (default: "gke-monitoring"). */
+  namespace?: string;
+  /** Additional labels. */
+  labels?: Record<string, string>;
+  /** CPU request (default: "100m"). */
+  cpuRequest?: string;
+  /** Memory request (default: "256Mi"). */
+  memoryRequest?: string;
+  /** CPU limit (default: "500m"). */
+  cpuLimit?: string;
+  /** Memory limit (default: "512Mi"). */
+  memoryLimit?: string;
+}
+
+export interface GkeOtelCollectorResult {
+  daemonSet: Record<string, unknown>;
+  serviceAccount: Record<string, unknown>;
+  clusterRole: Record<string, unknown>;
+  clusterRoleBinding: Record<string, unknown>;
+  configMap: Record<string, unknown>;
+}
+
+/**
+ * Create a GkeOtelCollector composite — returns prop objects for
+ * a DaemonSet, ServiceAccount, ClusterRole, ClusterRoleBinding, and ConfigMap.
+ *
+ * @gke
+ * @example
+ * ```ts
+ * import { GkeOtelCollector } from "@intentius/chant-lexicon-k8s";
+ *
+ * const { daemonSet, serviceAccount, clusterRole, clusterRoleBinding, configMap } = GkeOtelCollector({
+ *   clusterName: "my-cluster",
+ *   projectId: "my-project",
+ *   gcpServiceAccountEmail: "otel@my-project.iam.gserviceaccount.com",
+ * });
+ * ```
+ */
+export function GkeOtelCollector(props: GkeOtelCollectorProps): GkeOtelCollectorResult {
+  const {
+    clusterName,
+    projectId,
+    gcpServiceAccountEmail,
+    name = "gke-otel-collector",
+    image = "otel/opentelemetry-collector-contrib:latest",
+    namespace = "gke-monitoring",
+    labels: extraLabels = {},
+    cpuRequest = "100m",
+    memoryRequest = "256Mi",
+    cpuLimit = "500m",
+    memoryLimit = "512Mi",
+  } = props;
+
+  const saName = `${name}-sa`;
+  const clusterRoleName = `${name}-role`;
+  const bindingName = `${name}-binding`;
+  const configMapName = `${name}-config`;
+
+  const commonLabels: Record<string, string> = {
+    "app.kubernetes.io/name": name,
+    "app.kubernetes.io/managed-by": "chant",
+    ...extraLabels,
+  };
+
+  const otelConfig = `receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: 0.0.0.0:4317
+      http:
+        endpoint: 0.0.0.0:4318
+
+processors:
+  batch:
+    timeout: 30s
+    send_batch_size: 8192
+  resourcedetection:
+    detectors: [gcp]
+    timeout: 10s
+
+exporters:
+  googlecloud:
+    project: ${projectId}
+    metric:
+      prefix: custom.googleapis.com/${clusterName}
+    trace:
+      attribute_mappings:
+        - key: service.name
+          replacement: g.co/r/service/name
+
+service:
+  pipelines:
+    metrics:
+      receivers: [otlp]
+      processors: [batch, resourcedetection]
+      exporters: [googlecloud]
+    traces:
+      receivers: [otlp]
+      processors: [batch, resourcedetection]
+      exporters: [googlecloud]
+`;
+
+  const container: Record<string, unknown> = {
+    name,
+    image,
+    args: ["--config=/etc/otel/config.yaml"],
+    ports: [
+      { containerPort: 4317, name: "otlp-grpc" },
+      { containerPort: 4318, name: "otlp-http" },
+    ],
+    resources: {
+      requests: { cpu: cpuRequest, memory: memoryRequest },
+      limits: { cpu: cpuLimit, memory: memoryLimit },
+    },
+    volumeMounts: [
+      { name: "config", mountPath: "/etc/otel", readOnly: true },
+    ],
+    securityContext: {
+      runAsNonRoot: true,
+      runAsUser: 10001,
+      readOnlyRootFilesystem: true,
+      allowPrivilegeEscalation: false,
+    },
+  };
+
+  const daemonSetProps: Record<string, unknown> = {
+    metadata: {
+      name,
+      namespace,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "agent" },
+    },
+    spec: {
+      selector: { matchLabels: { "app.kubernetes.io/name": name } },
+      template: {
+        metadata: { labels: { "app.kubernetes.io/name": name, ...extraLabels } },
+        spec: {
+          serviceAccountName: saName,
+          containers: [container],
+          volumes: [
+            { name: "config", configMap: { name: configMapName } },
+          ],
+          tolerations: [{ operator: "Exists" }],
+        },
+      },
+    },
+  };
+
+  const serviceAccountProps: Record<string, unknown> = {
+    metadata: {
+      name: saName,
+      namespace,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "agent" },
+      ...(gcpServiceAccountEmail
+        ? { annotations: { "iam.gke.io/gcp-service-account": gcpServiceAccountEmail } }
+        : {}),
+    },
+  };
+
+  const clusterRoleProps: Record<string, unknown> = {
+    metadata: {
+      name: clusterRoleName,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "rbac" },
+    },
+    rules: [
+      { apiGroups: [""], resources: ["pods", "nodes", "endpoints"], verbs: ["get", "list", "watch"] },
+      { apiGroups: ["apps"], resources: ["replicasets"], verbs: ["get", "list", "watch"] },
+      { apiGroups: ["batch"], resources: ["jobs"], verbs: ["get", "list", "watch"] },
+      { apiGroups: [""], resources: ["nodes/proxy"], verbs: ["get"] },
+      { apiGroups: [""], resources: ["nodes/stats", "configmaps", "events"], verbs: ["create", "get"] },
+      { apiGroups: [""], resources: ["configmaps"], verbs: ["get", "update", "create"], resourceNames: ["otel-container-insight-clusterleader"] },
+    ],
+  };
+
+  const clusterRoleBindingProps: Record<string, unknown> = {
+    metadata: {
+      name: bindingName,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "rbac" },
+    },
+    roleRef: {
+      apiGroup: "rbac.authorization.k8s.io",
+      kind: "ClusterRole",
+      name: clusterRoleName,
+    },
+    subjects: [
+      {
+        kind: "ServiceAccount",
+        name: saName,
+        namespace,
+      },
+    ],
+  };
+
+  const configMapProps: Record<string, unknown> = {
+    metadata: {
+      name: configMapName,
+      namespace,
+      labels: { ...commonLabels, "app.kubernetes.io/component": "config" },
+    },
+    data: {
+      "config.yaml": otelConfig,
+    },
+  };
+
+  return {
+    daemonSet: daemonSetProps,
+    serviceAccount: serviceAccountProps,
+    clusterRole: clusterRoleProps,
+    clusterRoleBinding: clusterRoleBindingProps,
+    configMap: configMapProps,
+  };
+}

package/src/composites/index.ts

@@ -1,3 +1,4 @@
+export type { ContainerSecurityContext } from "./security-context";
 export { WebApp } from "./web-app";
 export type { WebAppProps, WebAppResult } from "./web-app";
 export { StatefulApp } from "./stateful-app";
@@ -40,3 +41,33 @@ export { AdotCollector } from "./adot-collector";
 export type { AdotCollectorProps, AdotCollectorResult } from "./adot-collector";
 export { MetricsServer } from "./metrics-server";
 export type { MetricsServerProps, MetricsServerResult } from "./metrics-server";
+export { WorkloadIdentityServiceAccount } from "./workload-identity-service-account";
+export type { WorkloadIdentityServiceAccountProps, WorkloadIdentityServiceAccountResult } from "./workload-identity-service-account";
+export { GcePdStorageClass } from "./gce-pd-storage-class";
+export type { GcePdStorageClassProps, GcePdStorageClassResult } from "./gce-pd-storage-class";
+export { FilestoreStorageClass } from "./filestore-storage-class";
+export type { FilestoreStorageClassProps, FilestoreStorageClassResult } from "./filestore-storage-class";
+export { GkeGateway } from "./gke-gateway";
+export type { GkeGatewayProps, GkeGatewayResult } from "./gke-gateway";
+export { ConfigConnectorContext } from "./config-connector-context";
+export type { ConfigConnectorContextProps, ConfigConnectorContextResult } from "./config-connector-context";
+export { GceIngress } from "./gce-ingress";
+export type { GceIngressProps, GceIngressResult } from "./gce-ingress";
+export { AgicIngress } from "./agic-ingress";
+export type { AgicIngressProps, AgicIngressResult } from "./agic-ingress";
+export { AzureDiskStorageClass } from "./azure-disk-storage-class";
+export type { AzureDiskStorageClassProps, AzureDiskStorageClassResult } from "./azure-disk-storage-class";
+export { AzureFileStorageClass } from "./azure-file-storage-class";
+export type { AzureFileStorageClassProps, AzureFileStorageClassResult } from "./azure-file-storage-class";
+export { AzureMonitorCollector } from "./azure-monitor-collector";
+export type { AzureMonitorCollectorProps, AzureMonitorCollectorResult } from "./azure-monitor-collector";
+export { WorkloadIdentityServiceAccount as AksWorkloadIdentityServiceAccount } from "./workload-identity-sa";
+export type { WorkloadIdentityServiceAccountProps as AksWorkloadIdentityServiceAccountProps, WorkloadIdentityServiceAccountResult as AksWorkloadIdentityServiceAccountResult } from "./workload-identity-sa";
+export { GkeFluentBitAgent } from "./gke-fluent-bit-agent";
+export type { GkeFluentBitAgentProps, GkeFluentBitAgentResult } from "./gke-fluent-bit-agent";
+export { GkeOtelCollector } from "./gke-otel-collector";
+export type { GkeOtelCollectorProps, GkeOtelCollectorResult } from "./gke-otel-collector";
+export { GkeExternalDnsAgent } from "./gke-external-dns-agent";
+export type { GkeExternalDnsAgentProps, GkeExternalDnsAgentResult } from "./gke-external-dns-agent";
+export { AksExternalDnsAgent } from "./aks-external-dns-agent";
+export type { AksExternalDnsAgentProps, AksExternalDnsAgentResult } from "./aks-external-dns-agent";

package/src/composites/metrics-server.ts

@@ -147,7 +147,7 @@ export function MetricsServer(props: MetricsServerProps): MetricsServerResult {
       labels: { ...commonLabels, "app.kubernetes.io/component": "rbac" },
     },
     rules: [
-      { apiGroups: [""], resources: ["pods", "nodes", "namespaces"], verbs: ["get", "list", "watch"] },
+      { apiGroups: [""], resources: ["pods", "nodes", "namespaces", "configmaps"], verbs: ["get", "list", "watch"] },
       { apiGroups: [""], resources: ["nodes/metrics", "nodes/stats"], verbs: ["get"] },
     ],
   };

package/src/composites/monitored-service.ts

@@ -6,6 +6,8 @@
  * as raw objects that can be serialized alongside native K8s resources.
  */
 
+import type { ContainerSecurityContext } from "./security-context";
+
 export interface AlertRule {
   /** Alert name. */
   name: string;
@@ -50,6 +52,8 @@ export interface MonitoredServiceProps {
   namespace?: string;
   /** Environment variables for the container. */
   env?: Array<{ name: string; value: string }>;
+  /** Container security context (supports PSS restricted fields). */
+  securityContext?: ContainerSecurityContext;
 }
 
 export interface MonitoredServiceResult {
@@ -95,6 +99,7 @@ export function MonitoredService(props: MonitoredServiceProps): MonitoredService
     memoryRequest = "128Mi",
     namespace,
     env,
+    securityContext,
   } = props;
 
   const commonLabels: Record<string, string> = {
@@ -132,6 +137,7 @@ export function MonitoredService(props: MonitoredServiceProps): MonitoredService
                 requests: { cpu: cpuRequest, memory: memoryRequest },
               },
               ...(env && { env }),
+              ...(securityContext && { securityContext }),
             },
           ],
         },