@controlplane/schema 1.0.1 → 1.0.2

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

@@ -0,0 +1,26 @@
+import { Name, Kind, Tags, Links } from './base';
+export interface ClusterSpec {
+    version?: '1.14.1';
+    locations?: string[];
+}
+export interface ClusterStatus {
+    externalEndpoint?: string;
+    [x: string]: any;
+}
+export interface SpicedbCluster {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    spec: {
+        version?: '1.14.1';
+        locations?: string[];
+    };
+    alias?: string;
+    status?: ClusterStatus;
+}

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

@@ -0,0 +1,5 @@
+import { VolumeSetStatus } from './volumeSet';
+export interface StatefulSetStatus {
+    replicaCount?: number;
+    volumeSet?: VolumeSetStatus;
+}

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

@@ -0,0 +1,19 @@
+import { Link } from './base';
+export interface Task {
+    id?: string;
+    kind?: 'task';
+    description?: string;
+    created?: Date;
+    lastModified?: Date;
+    targetEmail?: string;
+    creatorLink?: string;
+    type?: string;
+    context?: {
+        [x: string]: any;
+    };
+    status?: 'pending' | 'complete' | 'canceled';
+    response?: {
+        [x: string]: any;
+    };
+    links?: Link[];
+}

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

@@ -0,0 +1,20 @@
+import { Name, Kind, Tags, Links } from './base';
+export interface TenantSpec {
+    orgs?: Name[];
+    clusters?: Name[];
+}
+export interface Tenant {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    spec: {
+        orgs?: Name[];
+        clusters?: Name[];
+    };
+}

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

@@ -0,0 +1,15 @@
+export interface LightstepTracing {
+    endpoint: string;
+    credentials?: string;
+}
+export interface OpenTelemetry {
+    endpoint: string;
+}
+export interface Tracing {
+    sampling: number;
+    lightstep?: LightstepTracing;
+    provider?: {
+        otel?: OpenTelemetry;
+        lightstep?: LightstepTracing;
+    };
+}

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

@@ -0,0 +1,24 @@
+import { Tags, Links, ApiError } from './base';
+export interface User {
+    id?: string;
+    name?: string;
+    kind?: 'user';
+    version?: number;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    idp?: string;
+    email?: string;
+}
+export interface InviteRequest {
+    emails?: string[];
+}
+export interface InviteResponse {
+    errors?: {
+        [x: string]: ApiError;
+    };
+    invitations?: {
+        [x: string]: string;
+    };
+}

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

@@ -0,0 +1,78 @@
+import { Name, Kind, Tags, Links } from './base';
+export interface PerformanceClass {
+    name: string;
+    minCapacity?: number;
+    maxCapacity: number;
+    featuresSupported?: ('automatic-expansion' | 'snapshots')[];
+}
+export interface VolumeSnapshot {
+    name: string;
+    id?: string;
+    created: Date;
+    expires?: Date;
+    size?: number;
+    tags?: {
+        [x: string]: string;
+    }[];
+}
+export interface PersistentVolumeStatus {
+    lifecycle?: 'creating' | 'unused' | 'unbound' | 'bound' | 'deleted' | 'repairing';
+    storageDeviceId?: string;
+    index: number;
+    currentSize: number;
+    iops?: number;
+    throughput?: number;
+    driver: string;
+    volumeSnapshots?: VolumeSnapshot[];
+}
+export interface VolumeSetStatusLocation {
+    name: string;
+    volumes?: PersistentVolumeStatus[];
+    desiredVolumeCount?: number;
+}
+export interface VolumeSetStatus {
+    parentId?: string;
+    usedByWorkload?: string;
+    locations?: VolumeSetStatusLocation[];
+}
+export interface VolumeSetSpec {
+    initialCapacity: number;
+    performanceClass: 'general-purpose-ssd' | 'high-throughput-ssd';
+    fileSystemType?: 'xfs' | 'ext4';
+    snapshots?: {
+        createFinalSnapshot?: boolean;
+        retentionDuration?: string;
+    };
+    autoscaling?: {
+        maxCapacity?: number;
+        minFreePercentage?: number;
+        scalingFactor?: number;
+    };
+}
+export interface VolumeSet {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    spec: {
+        initialCapacity: number;
+        performanceClass: 'general-purpose-ssd' | 'high-throughput-ssd';
+        fileSystemType?: 'xfs' | 'ext4';
+        snapshots?: {
+            createFinalSnapshot?: boolean;
+            retentionDuration?: string;
+        };
+        autoscaling?: {
+            maxCapacity?: number;
+            minFreePercentage?: number;
+            scalingFactor?: number;
+        };
+    };
+    status?: VolumeSetStatus;
+    gvc?: any;
+}

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

@@ -0,0 +1,305 @@
+import { EnvVar } from './env';
+import { Kind, Tags, Links } from './base';
+export type Port = number;
+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 VolumeSpec {
+    uri: string;
+    recoveryPolicy?: 'retain' | 'recycle';
+    path: string;
+}
+export interface RolloutOptions {
+    minReadySeconds?: number;
+    maxUnavailableReplicas?: string;
+    maxSurgeReplicas?: string;
+    scalingPolicy?: 'OrderedReady' | 'Parallel';
+}
+export interface SecurityOptions {
+    filesystemGroupId?: number;
+}
+export interface GpuResource {
+    nvidia: {
+        model?: any;
+        quantity?: number;
+    };
+}
+export interface ContainerSpec {
+    name?: string;
+    image: string;
+    workingDir?: string;
+    metrics?: {
+        port: number;
+        path: string;
+    };
+    port?: number;
+    ports?: ({
+        protocol?: 'http' | 'http2' | 'grpc' | 'tcp';
+        number: number;
+    })[];
+    memory?: string;
+    readinessProbe?: {
+        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;
+    };
+    livenessProbe?: {
+        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;
+    };
+    cpu?: string;
+    env?: EnvVar[];
+    gpu?: {
+        nvidia: {
+            model?: any;
+            quantity?: number;
+        };
+    };
+    inheritEnv?: boolean;
+    command?: string;
+    args?: string[];
+    lifecycle?: {
+        postStart?: {
+            exec?: {
+                command?: string[];
+            };
+        };
+        preStop?: {
+            exec?: {
+                command?: string[];
+            };
+        };
+    };
+    volumes?: VolumeSpec[];
+}
+export interface HealthCheckStatus {
+    active: boolean;
+    success?: boolean;
+    code?: number;
+    message?: string;
+    failures?: number;
+    successes?: number;
+    lastChecked?: Date;
+}
+export interface ResolvedImage {
+    digest?: string;
+    manifests?: {
+        image: string;
+        mediaType: string;
+        digest: string;
+        platform?: {
+            [x: string]: string;
+        };
+    }[];
+}
+export interface ResolvedImages {
+    resolvedForVersion?: number;
+    resolvedAt?: Date;
+    images?: ResolvedImage[];
+}
+export interface WorkloadStatus {
+    parentId?: string;
+    canonicalEndpoint?: string;
+    endpoint?: string;
+    internalName?: string;
+    healthCheck?: HealthCheckStatus;
+    currentReplicaCount?: number;
+    resolvedImages?: ResolvedImages;
+    [x: string]: any;
+}
+export interface Options {
+    autoscaling?: {
+        metric?: 'concurrency' | 'cpu' | 'rps' | 'latency' | 'disabled';
+        metricPercentile?: 'p50' | 'p75' | 'p99';
+        target?: number;
+        maxScale?: number;
+        minScale?: number;
+        scaleToZeroDelay?: number;
+        maxConcurrency?: number;
+    };
+    timeoutSeconds?: number;
+    capacityAI?: boolean;
+    spot?: boolean;
+    debug?: boolean;
+    suspend?: boolean;
+}
+export interface FirewallSpec {
+    external?: {
+        inboundAllowCIDR?: string[];
+        outboundAllowHostname?: string[];
+        outboundAllowPort?: ({
+            protocol: 'http' | 'https' | 'tcp';
+            number: number;
+        })[];
+        outboundAllowCIDR?: string[];
+    };
+    internal?: {
+        inboundAllowType?: 'none' | 'same-gvc' | 'same-org' | 'workload-list';
+        inboundAllowWorkload?: string[];
+    };
+}
+export interface JobSpec {
+    schedule: string;
+    concurrencyPolicy?: 'Forbid' | 'Replace';
+    historyLimit?: number;
+    restartPolicy?: 'OnFailure' | 'Never';
+    activeDeadlineSeconds?: number;
+}
+export interface WorkloadSpec {
+    type?: 'serverless' | 'standard' | 'cron' | 'stateful';
+    identityLink?: string;
+    containers?: ContainerSpec[];
+    firewallConfig?: {
+        external?: {
+            inboundAllowCIDR?: string[];
+            outboundAllowHostname?: string[];
+            outboundAllowPort?: ({
+                protocol: 'http' | 'https' | 'tcp';
+                number: number;
+            })[];
+            outboundAllowCIDR?: string[];
+        };
+        internal?: {
+            inboundAllowType?: 'none' | 'same-gvc' | 'same-org' | 'workload-list';
+            inboundAllowWorkload?: string[];
+        };
+    };
+    defaultOptions?: {
+        autoscaling?: {
+            metric?: 'concurrency' | 'cpu' | 'rps' | 'latency' | 'disabled';
+            metricPercentile?: 'p50' | 'p75' | 'p99';
+            target?: number;
+            maxScale?: number;
+            minScale?: number;
+            scaleToZeroDelay?: number;
+            maxConcurrency?: number;
+        };
+        timeoutSeconds?: number;
+        capacityAI?: boolean;
+        spot?: boolean;
+        debug?: boolean;
+        suspend?: boolean;
+    };
+    localOptions?: ({
+        autoscaling?: {
+            metric?: 'concurrency' | 'cpu' | 'rps' | 'latency' | 'disabled';
+            metricPercentile?: 'p50' | 'p75' | 'p99';
+            target?: number;
+            maxScale?: number;
+            minScale?: number;
+            scaleToZeroDelay?: number;
+            maxConcurrency?: number;
+        };
+        timeoutSeconds?: number;
+        capacityAI?: boolean;
+        spot?: boolean;
+        debug?: boolean;
+        suspend?: boolean;
+        location: string;
+    })[];
+    job?: {
+        schedule: string;
+        concurrencyPolicy?: 'Forbid' | 'Replace';
+        historyLimit?: number;
+        restartPolicy?: 'OnFailure' | 'Never';
+        activeDeadlineSeconds?: number;
+    };
+    sidecar?: {
+        envoy?: {
+            [x: string]: any;
+        };
+    };
+    supportDynamicTags?: boolean;
+    rolloutOptions?: {
+        minReadySeconds?: number;
+        maxUnavailableReplicas?: string;
+        maxSurgeReplicas?: string;
+        scalingPolicy?: 'OrderedReady' | 'Parallel';
+    };
+    securityOptions?: {
+        filesystemGroupId?: number;
+    };
+}
+export interface Workload {
+    id?: string;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    name?: string;
+    gvc?: any;
+    spec?: WorkloadSpec;
+    status?: WorkloadStatus;
+}
+export interface WorkloadConfig {
+    scheduling?: {
+        fingerprint?: string;
+        version?: number;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@controlplane/schema",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Control Plane Corporation Schema",
   "scripts": {
     "build": "tsc",
@@ -34,4 +34,4 @@
   "engines": {
     "node": ">= 16"
   }
-}
+}