@controlplane/schema 1.0.1 → 1.0.2

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

@@ -0,0 +1,18 @@
+import { Links } from './base';
+export interface PrincipalBinding {
+    principalLink?: string;
+    grantingPolicyLink?: string;
+    grantedPermissions?: string[];
+    match?: 'link' | 'query' | 'all';
+}
+export interface GrantedPermission {
+    name?: string;
+    description?: string;
+    bindings?: PrincipalBinding[];
+}
+export interface AccessReport {
+    kind?: 'accessreport';
+    permissions?: GrantedPermission[];
+    created?: Date;
+    links?: Links;
+}

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

@@ -0,0 +1,30 @@
+import { Name, Kind, Tags, Links } from './base';
+export interface BootstrapConfig {
+    registrationToken: string;
+    agentId: string;
+    agentLink: string;
+    hubEndpoint: string;
+}
+export interface AgentStatus {
+    bootstrapConfig?: BootstrapConfig;
+}
+export interface Agent {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    status?: AgentStatus;
+}
+export interface AgentInfo {
+    lastActive?: Date;
+    env?: {
+        [x: string]: any;
+    };
+    peerCount?: number;
+    serviceCount?: number;
+}

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

@@ -0,0 +1,17 @@
+import { Name, Kind, Tags, Links } from './base';
+export interface AuditContextStatus {
+    [x: string]: any;
+}
+export interface AuditContext {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    status?: AuditContextStatus;
+    origin?: 'default' | 'builtin';
+}

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

@@ -0,0 +1,37 @@
+export type LocalLink = string;
+export type ImageLink = string;
+export type Kind = 'org' | 'cloudaccount' | 'policy' | 'user' | 'group' | 'resource' | 'task' | 'permissions' | 'serviceaccount' | 'secret' | 'location' | 'gvc' | 'workload' | 'quota' | 'identity' | 'deployment' | 'event' | 'domain' | 'image' | 'resourcepolicy' | 'agent' | 'accessreport' | 'policymembership' | 'dbcluster' | 'auditctx' | 'memcachecluster' | 'spicedbcluster' | 'tenant' | 'mk8s' | 'command' | 'imagesummary' | 'volumeset';
+export type CloudProvider = 'aws' | 'gcp' | 'azure' | 'ngs';
+export type Name = string;
+export interface Tags {
+    [x: string]: any;
+}
+export interface Link {
+    rel: string;
+    href: string;
+}
+export type Links = Link[];
+export interface Base {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+}
+export interface List {
+    kind?: 'list';
+    itemKind?: 'org' | 'cloudaccount' | 'policy' | 'user' | 'group' | 'resource' | 'task' | 'permissions' | 'serviceaccount' | 'secret' | 'location' | 'gvc' | 'workload' | 'quota' | 'identity' | 'deployment' | 'event' | 'account' | 'domain' | 'image' | 'resourcepolicy' | 'accessreport' | 'agent' | 'auditctx' | 'dbcluster' | 'memcachecluster' | 'spicedbcluster' | 'tenant' | 'mk8s' | 'command' | 'policymembership' | 'primitive' | 'foreign' | 'link' | 'imagesummary' | 'volumeset';
+    items: any[];
+    links: Link[];
+}
+export interface ApiError {
+    status?: number;
+    message?: string;
+    code?: string;
+    details?: any;
+    id?: string;
+}

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

@@ -0,0 +1,37 @@
+import { Name, Kind, Tags, Links, CloudProvider } from './base';
+export interface AwsConfig {
+    roleArn: string;
+}
+export interface GcpConfig {
+    projectId: string;
+}
+export interface NgsConfig {
+    secretLink: string;
+}
+export interface AzureConfig {
+    secretLink: string;
+}
+export interface CloudAccount {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    provider?: CloudProvider;
+    data?: GcpConfig | AwsConfig | AzureConfig | NgsConfig;
+    status?: {
+        usable?: boolean;
+        lastChecked?: Date;
+        lastError?: string;
+    };
+}
+export interface Instructions {
+    message?: string;
+    data?: {
+        [x: string]: any;
+    };
+}

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

@@ -0,0 +1,29 @@
+import { Kind, Links } from './base';
+import { EnvVar } from './env';
+export type CommandLifecycleStage = 'pending' | 'running' | 'cancelled' | 'completed' | 'failed';
+export interface Command {
+    id?: string;
+    kind?: Kind;
+    version?: number;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    type: string;
+    lifecycleStage?: CommandLifecycleStage;
+    spec?: {
+        [x: string]: any;
+    };
+    status?: {
+        [x: string]: any;
+    };
+}
+export interface CronWorkloadContainerOverrides {
+    name: string;
+    env?: EnvVar[];
+    command?: string;
+    args?: string[];
+}
+export interface RunCronWorkloadSpec {
+    location: string;
+    containerOverrides?: CronWorkloadContainerOverrides[];
+}

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

@@ -0,0 +1,11 @@
+import { Links } from './base';
+export interface Config {
+    kind?: 'config';
+    id?: string;
+    lastModified?: Date;
+    version?: number;
+    data?: {
+        [x: string]: any;
+    };
+    links?: Links;
+}

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

@@ -0,0 +1,13 @@
+export interface DeploymentResources {
+    replicas?: number;
+    replicasReady?: number;
+    cpu?: number;
+    memory?: number;
+}
+export interface ContainerStatus {
+    name?: string;
+    image?: string;
+    ready?: boolean;
+    resources?: DeploymentResources;
+    message?: string;
+}

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

@@ -0,0 +1,20 @@
+import { ContainerStatus } from './containerstatus';
+export interface JobExecutionCondition {
+    status?: 'True' | 'False' | 'Unknown';
+    type: 'Complete' | 'Failed' | 'Suspended';
+    lastDetectionTime?: Date;
+    lastTransitionTime?: Date;
+    message?: string;
+    reason?: string;
+}
+export interface JobExecutionStatus {
+    workloadVersion: number;
+    status?: 'successful' | 'failed' | 'active' | 'pending' | 'invalid' | 'removed' | '';
+    startTime?: Date;
+    completionTime?: Date;
+    conditions?: JobExecutionCondition[];
+    name: string;
+    containers?: {
+        [x: string]: ContainerStatus;
+    };
+}

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

@@ -0,0 +1,42 @@
+import { Name, Kind, Tags, Links } from './base';
+export interface ClusterSpec {
+    externalAccessEnabled?: boolean;
+    postgres: {
+        version?: '12.8' | '13.4';
+        storageGB: number;
+        defaults?: {
+            size: 'developer-2c-4g' | 'small-2c-8g' | 'standard-4c-16g' | 'large-8c-32g' | 'xlarge-16c-64g';
+            instances: number;
+        };
+        locations?: ({
+            name?: string;
+            writable?: boolean;
+            size?: 'developer-2c-4g' | 'small-2c-8g' | 'standard-4c-16g' | 'large-8c-32g' | 'xlarge-16c-64g';
+            instances?: number;
+        })[];
+    };
+}
+export interface ClusterStatus {
+    parentId?: string;
+    externalEndpoint?: string;
+    [x: string]: any;
+}
+export interface DbCluster {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    spec?: ClusterSpec;
+    status?: ClusterStatus;
+    alias?: string;
+}
+export interface DbClusterStatus {
+    data?: ClusterStatus;
+    lastModified?: Date;
+    version?: number;
+}

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

@@ -0,0 +1,33 @@
+import { ContainerStatus } from './containerstatus';
+import { JobExecutionStatus } from './cronjob';
+import { Kind, Links } from './base';
+export interface DeploymentVersion {
+    name?: string;
+    created?: Date;
+    workload?: number;
+    gvc?: number;
+    containers?: {
+        [x: string]: ContainerStatus;
+    };
+    ready?: boolean;
+    message?: string;
+}
+export interface DeploymentStatus {
+    endpoint?: string;
+    remote?: string;
+    lastProcessedVersion?: number;
+    expectedDeploymentVersion?: number;
+    internal?: any;
+    ready?: boolean;
+    deploying?: boolean;
+    versions?: DeploymentVersion[];
+    jobExecutions?: JobExecutionStatus[];
+    message?: string;
+}
+export interface Deployment {
+    name: string;
+    kind?: Kind;
+    links?: Links;
+    lastModified?: Date;
+    status?: DeploymentStatus;
+}

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

@@ -0,0 +1,21 @@
+export interface Discovery {
+    endpoints?: {
+        billing?: string;
+        console?: string;
+        browser?: string;
+        hub?: string;
+        registry?: string;
+        audit?: string;
+        logs?: string;
+        metrics?: string;
+        metering?: string;
+        "billing-ng"?: string;
+        grafana?: string;
+        "terraform-exporter"?: string;
+    };
+    firebase?: {
+        apiKey?: string;
+        authDomain?: string;
+        projectId?: string;
+    };
+}

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

@@ -0,0 +1,82 @@
+import { LocalLink, Kind, Tags, Links } from './base';
+export interface Route {
+    prefix?: string;
+    replacePrefix?: string;
+    workloadLink: string;
+    port?: number;
+    hostPrefix?: string;
+}
+export interface ExternalPortTLS {
+    minProtocolVersion?: 'TLSV1_2' | 'TLSV1_1' | 'TLSV1_0';
+    cipherSuites?: ('ECDHE-ECDSA-AES256-GCM-SHA384' | 'ECDHE-ECDSA-CHACHA20-POLY1305' | 'ECDHE-ECDSA-AES128-GCM-SHA256' | 'ECDHE-RSA-AES256-GCM-SHA384' | 'ECDHE-RSA-CHACHA20-POLY1305' | 'ECDHE-RSA-AES128-GCM-SHA256' | 'AES256-GCM-SHA384' | 'AES128-GCM-SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_CHACHA20_POLY1305_SHA256' | 'TLS_AES_256_GCM_SHA384' | 'TLS_AES_128_GCM_SHA256' | 'DES-CBC3-SHA' | 'ECDHE-RSA-AES128-SHA' | 'ECDHE-RSA-AES256-SHA' | 'AES128-SHA' | 'AES256-SHA')[];
+    clientCertificate?: {
+        secretLink?: string;
+    };
+    serverCertificate?: {
+        secretLink?: string;
+    };
+}
+export interface ExternalPort {
+    number?: number;
+    protocol?: 'http' | 'http2' | 'tcp';
+    routes?: Route[];
+    cors?: {
+        allowOrigins?: {
+            exact?: string;
+        }[];
+        allowMethods?: string[];
+        allowHeaders?: string[];
+        exposeHeaders?: string[];
+        maxAge?: string;
+        allowCredentials?: boolean;
+    };
+    tls?: {
+        minProtocolVersion?: 'TLSV1_2' | 'TLSV1_1' | 'TLSV1_0';
+        cipherSuites?: ('ECDHE-ECDSA-AES256-GCM-SHA384' | 'ECDHE-ECDSA-CHACHA20-POLY1305' | 'ECDHE-ECDSA-AES128-GCM-SHA256' | 'ECDHE-RSA-AES256-GCM-SHA384' | 'ECDHE-RSA-CHACHA20-POLY1305' | 'ECDHE-RSA-AES128-GCM-SHA256' | 'AES256-GCM-SHA384' | 'AES128-GCM-SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_CHACHA20_POLY1305_SHA256' | 'TLS_AES_256_GCM_SHA384' | 'TLS_AES_128_GCM_SHA256' | 'DES-CBC3-SHA' | 'ECDHE-RSA-AES128-SHA' | 'ECDHE-RSA-AES256-SHA' | 'AES128-SHA' | 'AES256-SHA')[];
+        clientCertificate?: {
+            secretLink?: string;
+        };
+        serverCertificate?: {
+            secretLink?: string;
+        };
+    };
+}
+export interface DomainSpec {
+    dnsMode?: 'cname' | 'ns';
+    gvcLink?: string;
+    acceptAllHosts?: boolean;
+    ports?: ExternalPort[];
+}
+export interface DnsConfigRecord {
+    type?: string;
+    ttl?: number;
+    host?: string;
+    value?: string;
+}
+export interface DomainStatus {
+    endpoints?: {
+        url: string;
+        workloadLink?: LocalLink;
+    }[];
+    status?: 'initializing' | 'ready' | 'pendingDnsConfig' | 'pendingCertificate' | 'usedByGvc' | 'warning';
+    warning?: string;
+    locations?: ({
+        name: string;
+        certificateStatus?: 'initializing' | 'ready' | 'pendingDnsConfig' | 'pendingCertificate' | 'ignored';
+    })[];
+    fingerprint?: string;
+    dnsConfig?: DnsConfigRecord[];
+}
+export interface Domain {
+    id?: string;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    name?: string;
+    spec?: DomainSpec;
+    status?: DomainStatus;
+}

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

@@ -0,0 +1,6 @@
+export type EnvName = string;
+export interface EnvVar {
+    name: string;
+    value?: string;
+}
+export type EnvCollection = EnvVar[];

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

@@ -0,0 +1,25 @@
+export interface EventContext {
+    category?: string;
+    component?: 'actuator' | 'dns-updater' | 'scheduler' | 'iam-broker' | 'metadata-proxy';
+    cloudProvider?: 'aws' | 'gcp' | 'azure' | 'linode' | 'byok';
+    cluster?: string;
+    principalLink?: string;
+    fingerprint?: string;
+    [x: string]: any;
+}
+export interface Event {
+    id?: string;
+    created?: Date;
+    kind?: string;
+    status: string;
+    pinned?: boolean;
+    context?: {
+        category?: string;
+        component?: 'actuator' | 'dns-updater' | 'scheduler' | 'iam-broker' | 'metadata-proxy';
+        cloudProvider?: 'aws' | 'gcp' | 'azure' | 'linode' | 'byok';
+        cluster?: string;
+        principalLink?: string;
+        fingerprint?: string;
+        [x: string]: any;
+    };
+}

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

@@ -0,0 +1,20 @@
+import { Name, Kind, Tags, Links } from './base';
+import { Query } from './query';
+export interface Group {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    memberLinks?: string[];
+    memberQuery?: Query;
+    identityMatcher?: {
+        expression: string;
+        language: 'jmespath' | 'javascript';
+    };
+    origin?: 'synthetic' | 'default' | 'builtin';
+}

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

@@ -0,0 +1,53 @@
+import { Query } from './query';
+import { Tracing } from './tracing';
+import { EnvVar } from './env';
+import { Name, Kind, Tags, Links } from './base';
+export interface GvcStatus {
+    [x: string]: any;
+}
+export interface StaticPlacement {
+    locationLinks?: string[];
+    locationQuery?: Query;
+}
+export interface GvcSpec {
+    staticPlacement?: StaticPlacement;
+    pullSecretLinks?: string[];
+    domain?: string;
+    tracing?: Tracing;
+    sidecar?: {
+        envoy?: {
+            [x: string]: any;
+        };
+    };
+    env?: EnvVar[];
+    loadBalancer?: {
+        dedicated?: boolean;
+    };
+}
+export interface Gvc {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    alias?: string;
+    spec?: GvcSpec;
+    status?: GvcStatus;
+}
+export interface GvcConfig {
+    clusters?: {
+        [x: string]: {
+            clusterId?: string;
+            since?: Date;
+        };
+    };
+    preferredClusters?: {
+        [x: string]: {
+            clusterId?: string;
+        };
+    };
+}

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

@@ -0,0 +1,102 @@
+import { Name, Kind, Tags, Links } from './base';
+export type AwsRoleName = string;
+export type PolicyRef = string;
+export type GcpRoleName = string;
+export interface AwsPolicyDocument {
+    Version?: string;
+    Statement?: {
+        [x: string]: any;
+    }[];
+}
+export interface AwsIdentity {
+    cloudAccountLink: string;
+    policyRefs?: PolicyRef[];
+    trustPolicy?: AwsPolicyDocument;
+    roleName?: AwsRoleName;
+}
+export interface GcpIdentity {
+    cloudAccountLink: string;
+    scopes?: string[];
+    serviceAccount?: string;
+    bindings?: {
+        resource?: string;
+        roles?: GcpRoleName[];
+    }[];
+}
+export interface NgsIdentity {
+    cloudAccountLink: string;
+    pub?: {
+        allow?: string[];
+        deny?: string[];
+    };
+    sub?: {
+        allow?: string[];
+        deny?: string[];
+    };
+    resp?: {
+        max?: number;
+        ttl?: string;
+    };
+    subs?: number;
+    data?: number;
+    payload?: number;
+}
+export interface AzureRoleAssignment {
+    scope?: string;
+    roles?: string[];
+}
+export interface AzureIdentity {
+    cloudAccountLink: string;
+    roleAssignments?: AzureRoleAssignment[];
+}
+export interface Status {
+    objectName?: string;
+}
+export interface NetworkResource {
+    name: Name | string;
+    agentLink?: string;
+    IPs?: string[];
+    FQDN?: string;
+    resolverIP?: string;
+    ports: number[];
+}
+export interface NativeNetworkResource {
+    name: Name | string;
+    FQDN?: string;
+    ports: number[];
+    awsPrivateLink?: {
+        endpointServiceName: string;
+    };
+    gcpServiceConnect?: {
+        targetService: string;
+    };
+}
+export interface SpicedbAccess {
+    clusterLink: string;
+    role: 'checkPermission' | 'read' | 'write';
+}
+export interface MemcacheAccess {
+    clusterLink: string;
+    role: 'readWrite';
+}
+export interface Identity {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    aws?: AwsIdentity;
+    gcp?: GcpIdentity;
+    azure?: AzureIdentity;
+    ngs?: NgsIdentity;
+    networkResources?: NetworkResource[];
+    nativeNetworkResources?: NativeNetworkResource[];
+    memcacheAccess?: MemcacheAccess[];
+    spicedbAccess?: SpicedbAccess[];
+    status?: Status;
+    gvc?: any;
+}

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

@@ -0,0 +1,25 @@
+import { Kind, Tags, Links } from './base';
+export interface Image {
+    id?: string;
+    name?: string;
+    kind?: Kind;
+    version?: number;
+    created?: Date;
+    lastModified?: Date;
+    tags?: Tags;
+    links?: Links;
+    repository?: string;
+    tag?: string;
+    manifest?: {
+        [x: string]: any;
+    };
+    digest?: string;
+}
+export interface ImageSummary {
+    kind?: Kind;
+    links?: Links;
+    repositories?: {
+        name?: string;
+        tagsCount?: number;
+    }[];
+}

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

@@ -0,0 +1,31 @@
+import { Name, Kind, Tags, Links } from './base';
+export interface LocationSpec {
+    enabled?: boolean;
+}
+export interface LocationStatus {
+    geo?: {
+        lat?: number;
+        lon?: number;
+        country?: string;
+        state?: string;
+        city?: string;
+        continent?: string;
+    };
+    ipRanges?: string[];
+}
+export interface Location {
+    id?: string;
+    name?: Name;
+    kind?: Kind;
+    version?: number;
+    description?: string;
+    tags?: Tags;
+    created?: Date;
+    lastModified?: Date;
+    links?: Links;
+    origin?: 'builtin' | 'default' | 'custom';
+    provider?: 'aws' | 'gcp' | 'azure' | 'byok' | 'linode' | 'vultr' | 'equinix';
+    region?: string;
+    spec?: LocationSpec;
+    status?: LocationStatus;
+}