@controlplane/schema 1.0.6 → 1.0.8

package/build/src/interfaces/workload.d.ts

@@ -1,64 +1,11 @@
-import { Port } from './port';
-import { Regex, Kind, Tags, Links } from './base';
-import { EnvVar } from './env';
-import { VolumeSpec } from './volumeSpec';
-import { DefaultOptions, LocalOptions } from './workloadOptions';
-import { EnvoyFilters } from './envoy';
-export type Memory = string;
-export type Cpu = string;
-export interface HealthCheckSpec {
-    exec?: {
-        command?: string[];
-    };
-    grpc?: {
-        port?: Port;
-    };
-    tcpSocket?: {
-        port?: number;
-    };
-    httpGet?: {
-        path?: string;
-        port?: number;
-        httpHeaders?: {
-            name: string;
-            value: string;
-        }[];
-        scheme?: 'HTTP' | 'HTTPS';
-    };
-    initialDelaySeconds?: number;
-    periodSeconds?: number;
-    timeoutSeconds?: number;
-    successThreshold?: number;
-    failureThreshold?: number;
-}
-export interface RolloutOptions {
-    minReadySeconds?: number;
-    maxUnavailableReplicas?: string;
-    maxSurgeReplicas?: string;
-    scalingPolicy?: 'OrderedReady' | 'Parallel';
-    terminationGracePeriodSeconds?: number;
-}
-export interface RolloutOptionsStateful {
-    minReadySeconds?: number;
-    maxSurgeReplicas?: string;
-    scalingPolicy?: 'OrderedReady' | 'Parallel';
-    terminationGracePeriodSeconds?: number;
-    maxUnavailableReplicas?: string;
-}
-export interface SecurityOptions {
-    filesystemGroupId?: number;
-}
-export interface GpuResource {
-    nvidia?: {
-        model?: any;
-        quantity?: number;
-    };
-    custom?: {
-        resource: string;
-        runtimeClass?: string;
-        quantity?: number;
-    };
-}
+import { Regex, Kind, Tags, Links } from './base.js';
+import { EnvVar } from './env.js';
+import { VolumeSpec } from './volumeSpec.js';
+import { DefaultOptions, LocalOptions } from './workloadOptions.js';
+import { AccessLog } from './envoyAccessLog.js';
+import { Cluster } from './envoyCluster.js';
+import { ExcExtAuth, ExcludedRateLimit } from './envoyExcExtAuth.js';
+import { HttpFilter } from './envoyHttp.js';
 export interface ContainerSpec {
     name?: string;
     image: string;
@@ -79,7 +26,7 @@ export interface ContainerSpec {
             command?: string[];
         };
         grpc?: {
-            port?: Port;
+            port?: number;
         };
         tcpSocket?: {
             port?: number;
@@ -104,7 +51,7 @@ export interface ContainerSpec {
             command?: string[];
         };
         grpc?: {
-            port?: Port;
+            port?: number;
         };
         tcpSocket?: {
             port?: number;
@@ -156,53 +103,11 @@ export interface ContainerSpec {
     };
     volumes?: VolumeSpec[];
 }
-export interface HealthCheckStatus {
-    active: boolean;
-    success?: boolean;
-    code?: number;
-    message?: string;
-    failures?: number;
-    successes?: number;
-    lastChecked?: Date;
-}
-export interface LoadBalancerStatus {
-    origin?: string;
-    url?: string;
-}
-export interface ResolvedImage {
-    digest?: string;
-    manifests?: {
-        image: string;
-        mediaType: string;
-        digest: string;
-        platform?: {
-            [x: string]: string;
-        };
-    }[];
-}
-export interface ResolvedImages {
-    resolvedForVersion?: number;
-    resolvedAt?: Date;
-    errorMessages?: string[];
-    nextRetryAt?: Date;
-    images?: ResolvedImage[];
-}
-export interface WorkloadStatus {
-    parentId?: string;
-    canonicalEndpoint?: string;
-    endpoint?: string;
-    internalName?: string;
-    replicaInternalNames?: string[];
-    healthCheck?: HealthCheckStatus;
-    currentReplicaCount?: number;
-    resolvedImages?: ResolvedImages;
-    loadBalancer?: LoadBalancerStatus[];
-    [x: string]: any;
-}
-export interface HeaderFilter {
-    key: string;
-    allowedValues?: Regex[];
-    blockedValues?: Regex[];
+export type Cpu = string;
+export interface Extras {
+    affinity?: any;
+    tolerations?: any[];
+    topologySpreadConstraints?: any[];
 }
 export interface FirewallSpec {
     external?: {
@@ -224,7 +129,56 @@ export interface FirewallSpec {
         inboundAllowWorkload?: string[];
     };
 }
-export type ScheduleType = string;
+export interface GpuResource {
+    nvidia?: {
+        model?: any;
+        quantity?: number;
+    };
+    custom?: {
+        resource: string;
+        runtimeClass?: string;
+        quantity?: number;
+    };
+}
+export interface HeaderFilter {
+    key: string;
+    allowedValues?: Regex[];
+    blockedValues?: Regex[];
+}
+export interface HealthCheckSpec {
+    exec?: {
+        command?: string[];
+    };
+    grpc?: {
+        port?: number;
+    };
+    tcpSocket?: {
+        port?: number;
+    };
+    httpGet?: {
+        path?: string;
+        port?: number;
+        httpHeaders?: {
+            name: string;
+            value: string;
+        }[];
+        scheme?: 'HTTP' | 'HTTPS';
+    };
+    initialDelaySeconds?: number;
+    periodSeconds?: number;
+    timeoutSeconds?: number;
+    successThreshold?: number;
+    failureThreshold?: number;
+}
+export interface HealthCheckStatus {
+    active: boolean;
+    success?: boolean;
+    code?: number;
+    message?: string;
+    failures?: number;
+    successes?: number;
+    lastChecked?: Date;
+}
 export interface JobSpec {
     schedule: ScheduleType;
     concurrencyPolicy?: 'Forbid' | 'Replace' | 'Allow';
@@ -255,83 +209,54 @@ export interface LoadBalancerSpec {
     };
     replicaDirect?: boolean;
 }
-export interface Extras {
-    affinity?: any;
-    tolerations?: any[];
-    topologySpreadConstraints?: any[];
+export interface LoadBalancerStatus {
+    origin?: string;
+    url?: string;
+}
+export type Memory = string;
+export interface PodZoneMap {
+    [x: string]: string;
 }
 export interface RequestRetryPolicy {
     attempts?: number;
     retryOn?: string[];
 }
-export type WorkloadType = 'serverless' | 'standard' | 'cron' | 'stateful';
-export interface WorkloadSpec {
-    type?: WorkloadType;
-    identityLink?: string;
-    containers: ContainerSpec[];
-    firewallConfig?: {
-        external?: {
-            inboundAllowCIDR?: string[];
-            inboundBlockedCIDR?: string[];
-            outboundAllowHostname?: string[];
-            outboundAllowPort?: ({
-                protocol: 'http' | 'https' | 'tcp';
-                number: number;
-            })[];
-            outboundAllowCIDR?: string[];
-            outboundBlockedCIDR?: string[];
-            http?: {
-                inboundHeaderFilter?: HeaderFilter[];
-            };
-        };
-        internal?: {
-            inboundAllowType?: 'none' | 'same-gvc' | 'same-org' | 'workload-list';
-            inboundAllowWorkload?: string[];
-        };
-    };
-    defaultOptions?: DefaultOptions;
-    localOptions?: LocalOptions;
-    job?: {
-        schedule: ScheduleType;
-        concurrencyPolicy?: 'Forbid' | 'Replace' | 'Allow';
-        historyLimit?: number;
-        restartPolicy?: 'OnFailure' | 'Never';
-        activeDeadlineSeconds?: number;
-    };
-    sidecar?: {
-        envoy?: EnvoyFilters;
-    };
-    supportDynamicTags?: boolean;
-    rolloutOptions?: any;
-    securityOptions?: {
-        filesystemGroupId?: number;
-    };
-    loadBalancer?: {
-        direct?: {
-            enabled: boolean;
-            ports?: LoadBalancerPort[];
-            ipSet?: string;
-        };
-        geoLocation?: {
-            enabled?: boolean;
-            headers?: {
-                asn?: string;
-                city?: string;
-                country?: string;
-                region?: string;
-            };
+export interface ResolvedImage {
+    digest?: string;
+    manifests?: {
+        image: string;
+        mediaType: string;
+        digest: string;
+        platform?: {
+            [x: string]: string;
         };
-        replicaDirect?: boolean;
-    };
-    extras?: {
-        affinity?: any;
-        tolerations?: any[];
-        topologySpreadConstraints?: any[];
-    };
-    requestRetryPolicy?: {
-        attempts?: number;
-        retryOn?: string[];
-    };
+    }[];
+}
+export interface ResolvedImages {
+    resolvedForVersion?: number;
+    resolvedAt?: Date;
+    errorMessages?: string[];
+    nextRetryAt?: Date;
+    images?: ResolvedImage[];
+}
+export interface RolloutOptions {
+    minReadySeconds?: number;
+    maxUnavailableReplicas?: string;
+    maxSurgeReplicas?: string;
+    scalingPolicy?: 'OrderedReady' | 'Parallel';
+    terminationGracePeriodSeconds?: number;
+}
+export interface RolloutOptionsStateful {
+    minReadySeconds?: number;
+    maxSurgeReplicas?: string;
+    scalingPolicy?: 'OrderedReady' | 'Parallel';
+    terminationGracePeriodSeconds?: number;
+    maxUnavailableReplicas?: string;
+}
+export type ScheduleType = string;
+export interface SecurityOptions {
+    filesystemGroupId?: number;
+    runAsUser?: number;
 }
 export interface Workload {
     id?: string;
@@ -378,12 +303,21 @@ export interface Workload {
             activeDeadlineSeconds?: number;
         };
         sidecar?: {
-            envoy?: EnvoyFilters;
+            envoy?: {
+                accessLog?: AccessLog[];
+                clusters?: Cluster[];
+                excludedExternalAuth?: ExcExtAuth[];
+                excludedRateLimit?: ExcludedRateLimit[];
+                http?: HttpFilter[];
+                network?: any[];
+                volumes?: VolumeSpec[];
+            };
         };
         supportDynamicTags?: boolean;
         rolloutOptions?: any;
         securityOptions?: {
             filesystemGroupId?: number;
+            runAsUser?: number;
         };
         loadBalancer?: {
             direct?: {
@@ -412,27 +346,134 @@ export interface Workload {
             retryOn?: string[];
         };
     };
-    status?: WorkloadStatus;
-}
-export interface PodZoneMap {
-    [x: string]: string;
+    status?: {
+        parentId?: string;
+        canonicalEndpoint?: string;
+        endpoint?: string;
+        internalName?: string;
+        replicaInternalNames?: string[];
+        healthCheck?: {
+            active: boolean;
+            success?: boolean;
+            code?: number;
+            message?: string;
+            failures?: number;
+            successes?: number;
+            lastChecked?: Date;
+        };
+        currentReplicaCount?: number;
+        resolvedImages?: {
+            resolvedForVersion?: number;
+            resolvedAt?: Date;
+            errorMessages?: string[];
+            nextRetryAt?: Date;
+            images?: ResolvedImage[];
+        };
+        loadBalancer?: LoadBalancerStatus[];
+        [x: string]: any;
+    };
 }
-export interface WorkloadConfig {
-    scheduling?: {
-        fingerprint?: string;
-        version?: number;
+export interface WorkloadSpec {
+    type?: WorkloadType;
+    identityLink?: string;
+    containers: ContainerSpec[];
+    firewallConfig?: {
+        external?: {
+            inboundAllowCIDR?: string[];
+            inboundBlockedCIDR?: string[];
+            outboundAllowHostname?: string[];
+            outboundAllowPort?: ({
+                protocol: 'http' | 'https' | 'tcp';
+                number: number;
+            })[];
+            outboundAllowCIDR?: string[];
+            outboundBlockedCIDR?: string[];
+            http?: {
+                inboundHeaderFilter?: HeaderFilter[];
+            };
+        };
+        internal?: {
+            inboundAllowType?: 'none' | 'same-gvc' | 'same-org' | 'workload-list';
+            inboundAllowWorkload?: string[];
+        };
     };
-    thinProvision?: number;
-    podZoneMap?: {
-        [x: string]: string;
+    defaultOptions?: DefaultOptions;
+    localOptions?: LocalOptions;
+    job?: {
+        schedule: ScheduleType;
+        concurrencyPolicy?: 'Forbid' | 'Replace' | 'Allow';
+        historyLimit?: number;
+        restartPolicy?: 'OnFailure' | 'Never';
+        activeDeadlineSeconds?: number;
     };
-    locationPodZoneMap?: {
-        [x: string]: PodZoneMap;
+    sidecar?: {
+        envoy?: {
+            accessLog?: AccessLog[];
+            clusters?: Cluster[];
+            excludedExternalAuth?: ExcExtAuth[];
+            excludedRateLimit?: ExcludedRateLimit[];
+            http?: HttpFilter[];
+            network?: any[];
+            volumes?: VolumeSpec[];
+        };
     };
-    proxy?: {
-        minCpu?: number;
+    supportDynamicTags?: boolean;
+    rolloutOptions?: any;
+    securityOptions?: {
+        filesystemGroupId?: number;
+        runAsUser?: number;
     };
-    subsets?: {
-        enabled?: boolean;
+    loadBalancer?: {
+        direct?: {
+            enabled: boolean;
+            ports?: LoadBalancerPort[];
+            ipSet?: string;
+        };
+        geoLocation?: {
+            enabled?: boolean;
+            headers?: {
+                asn?: string;
+                city?: string;
+                country?: string;
+                region?: string;
+            };
+        };
+        replicaDirect?: boolean;
+    };
+    extras?: {
+        affinity?: any;
+        tolerations?: any[];
+        topologySpreadConstraints?: any[];
+    };
+    requestRetryPolicy?: {
+        attempts?: number;
+        retryOn?: string[];
     };
 }
+export interface WorkloadStatus {
+    parentId?: string;
+    canonicalEndpoint?: string;
+    endpoint?: string;
+    internalName?: string;
+    replicaInternalNames?: string[];
+    healthCheck?: {
+        active: boolean;
+        success?: boolean;
+        code?: number;
+        message?: string;
+        failures?: number;
+        successes?: number;
+        lastChecked?: Date;
+    };
+    currentReplicaCount?: number;
+    resolvedImages?: {
+        resolvedForVersion?: number;
+        resolvedAt?: Date;
+        errorMessages?: string[];
+        nextRetryAt?: Date;
+        images?: ResolvedImage[];
+    };
+    loadBalancer?: LoadBalancerStatus[];
+    [x: string]: any;
+}
+export type WorkloadType = 'serverless' | 'standard' | 'cron' | 'stateful';

package/build/src/interfaces/workloadOptions.d.ts

@@ -1,15 +1,3 @@
-export interface KedaTrigger {
-    type: string;
-    metadata?: {
-        [x: string]: string | any;
-    };
-    name?: string;
-    useCachedMetrics?: boolean;
-    metricType?: 'AverageValue' | 'Value' | 'Utilization';
-    authenticationRef?: {
-        name: string;
-    };
-}
 export interface DefaultOptions {
     autoscaling?: {
         metric?: 'concurrency' | 'cpu' | 'memory' | 'rps' | 'latency' | 'keda' | 'disabled';
@@ -53,7 +41,20 @@ export interface DefaultOptions {
         enabled?: boolean;
     };
 }
-export type LocalOptions = ({
+export interface KedaTrigger {
+    type: string;
+    metadata?: {
+        [x: string]: string | any;
+    };
+    name?: string;
+    useCachedMetrics?: boolean;
+    metricType?: 'AverageValue' | 'Value' | 'Utilization';
+    authenticationRef?: {
+        name: string;
+    };
+}
+export type LocalOptions = LocalOptionsItem[];
+export interface LocalOptionsItem {
     autoscaling?: {
         metric?: 'concurrency' | 'cpu' | 'memory' | 'rps' | 'latency' | 'keda' | 'disabled';
         multi?: {
@@ -96,4 +97,36 @@ export type LocalOptions = ({
         enabled?: boolean;
     };
     location: string;
-})[];
+}
+export interface OptionsAutoscaling {
+    metric?: 'concurrency' | 'cpu' | 'memory' | 'rps' | 'latency' | 'keda' | 'disabled';
+    multi?: {
+        metric?: any;
+        target?: number;
+    }[];
+    metricPercentile?: 'p50' | 'p75' | 'p99';
+    target?: number;
+    maxScale?: number;
+    minScale?: number;
+    scaleToZeroDelay?: number;
+    maxConcurrency?: number;
+    keda?: {
+        triggers?: KedaTrigger[];
+        advanced?: {
+            scalingModifiers?: {
+                target?: string;
+                activationTarget?: string;
+                metricType?: 'AverageValue' | 'Value' | 'Utilization';
+                formula?: string;
+            };
+        };
+        fallback?: {
+            failureThreshold: number;
+            replicas: number;
+            behavior?: 'static' | 'currentReplicas' | 'currentReplicasIfHigher' | 'currentReplicasIfLower';
+        };
+        pollingInterval?: number;
+        cooldownPeriod?: number;
+        initialCooldownPeriod?: number;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@controlplane/schema",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Control Plane Corporation Schema",
   "scripts": {
     "build": "tsc",