@kici-dev/orchestrator 0.1.14 → 0.1.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -1
- package/dist/__test-helpers__/mock-db.d.ts +2 -0
- package/dist/agent/dispatcher.d.ts +110 -6
- package/dist/agent/registry.d.ts +14 -0
- package/dist/app.d.ts +11 -0
- package/dist/cache/agent-job-failed-error.d.ts +13 -0
- package/dist/cache/dispatch-cache-ref-tracker.d.ts +45 -0
- package/dist/cache/index.d.ts +2 -0
- package/dist/cache/user-cache.d.ts +116 -0
- package/dist/cancel/cancel-run.d.ts +56 -0
- package/dist/cli/commands/environment.d.ts +1 -0
- package/dist/cli.js +523 -111
- package/dist/cluster/peer-registry.d.ts +6 -0
- package/dist/config/schema.d.ts +4 -0
- package/dist/config.d.ts +13 -0
- package/dist/dashboard/handler.d.ts +92 -1
- package/dist/db/migrations/026_event_log_lockfile_corrupt.d.ts +11 -0
- package/dist/db/migrations/027_workflow_timeout.d.ts +20 -0
- package/dist/db/migrations/028_org_settings_user_cache.d.ts +4 -0
- package/dist/db/migrations/029_dispatch_queue_attempts.d.ts +16 -0
- package/dist/db/migrations/030_held_runs_env_set_null.d.ts +13 -0
- package/dist/db/migrations/031_dispatch_queue_ack_deadline.d.ts +19 -0
- package/dist/db/migrations/032_org_settings_dispatch_ack_timeout.d.ts +14 -0
- package/dist/db/types.d.ts +37 -2
- package/dist/environments/environment-store.d.ts +14 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.js +362 -40
- package/dist/lockfile-cache.d.ts +1 -1
- package/dist/metrics/prometheus.d.ts +8 -0
- package/dist/orchestrator-core.d.ts +4 -1
- package/dist/pipeline/dispatch-matched-workflow.d.ts +9 -0
- package/dist/pipeline/inline-eval.d.ts +17 -2
- package/dist/pipeline/process-webhook.d.ts +19 -0
- package/dist/pipeline/processor.d.ts +6 -1
- package/dist/pipeline/test-pipeline.d.ts +10 -0
- package/dist/providers/github/lock-file.d.ts +1 -1
- package/dist/providers/internal/lock-file-fetcher.d.ts +3 -2
- package/dist/queue/job-queue.d.ts +53 -1
- package/dist/reporting/execution-tracker.d.ts +3 -1
- package/dist/routes/admin-environments.d.ts +1 -0
- package/dist/scaler/bare-metal-backend.d.ts +1 -0
- package/dist/scaler/container-backend.d.ts +3 -2
- package/dist/scaler/firecracker-backend.d.ts +17 -0
- package/dist/scaler/manager.d.ts +2 -0
- package/dist/scaler/nftables.d.ts +25 -3
- package/dist/scaler/types.d.ts +26 -1
- package/dist/server.js +3981 -1421
- package/dist/stale-detector/workflow-deadline-detector.d.ts +49 -0
- package/dist/standalone.js +16819 -14768
- package/dist/storage/filesystem.d.ts +12 -3
- package/dist/storage/s3.d.ts +17 -4
- package/dist/storage/types.d.ts +25 -5
- package/dist/worker/in-memory-job-queue.d.ts +40 -7
- package/dist/ws/agent-handler.d.ts +13 -0
- package/dist/ws/dashboard-env-handler.d.ts +1 -0
- package/dist/ws/platform-client.d.ts +10 -1
- package/package.json +13 -10
- package/sbom.spdx.json +47 -47
|
@@ -5,11 +5,12 @@
|
|
|
5
5
|
* in a sandboxed VM context at dispatch time, eliminating the init-job
|
|
6
6
|
* round-trip for pure functions.
|
|
7
7
|
*/
|
|
8
|
+
import type { LockJob } from '@kici-dev/engine';
|
|
8
9
|
/**
|
|
9
10
|
* Evaluate an inline expression that returns a string.
|
|
10
11
|
*
|
|
11
12
|
* @param expression - Serialized arrow function, e.g. '(event) => event.ref.split("/").pop()'
|
|
12
|
-
* @param event - Normalized
|
|
13
|
+
* @param event - Normalized event envelope (SimulatedEvent shape; raw provider payload at event.payload)
|
|
13
14
|
* @returns The string result
|
|
14
15
|
* @throws TypeError if result is not a string
|
|
15
16
|
* @throws Error on timeout or sandbox violation
|
|
@@ -19,10 +20,24 @@ export declare function evaluateInlineString(expression: string, event: object):
|
|
|
19
20
|
* Evaluate an inline expression that returns a Record<string, string>.
|
|
20
21
|
*
|
|
21
22
|
* @param expression - Serialized arrow function, e.g. '(event) => ({ NODE_ENV: event.env })'
|
|
22
|
-
* @param event - Normalized
|
|
23
|
+
* @param event - Normalized event envelope (SimulatedEvent shape; raw provider payload at event.payload)
|
|
23
24
|
* @returns The record result
|
|
24
25
|
* @throws TypeError if result is not a plain object
|
|
25
26
|
* @throws Error on timeout or sandbox violation
|
|
26
27
|
*/
|
|
27
28
|
export declare function evaluateInlineRecord(expression: string, event: object): Record<string, string>;
|
|
29
|
+
/**
|
|
30
|
+
* Evaluate a lock job's inline (pure-function) dynamic fields against the
|
|
31
|
+
* normalized event envelope (SimulatedEvent shape: { type, action,
|
|
32
|
+
* targetBranch, sourceBranch, payload, … }). The raw provider webhook body is
|
|
33
|
+
* nested at `event.payload` — the same shape rules and step contexts see.
|
|
34
|
+
*
|
|
35
|
+
* Throws a job-attributed Error when any expression throws; inline evaluation
|
|
36
|
+
* failures are immediate dispatch failures (no init-job fallback).
|
|
37
|
+
*/
|
|
38
|
+
export declare function evaluateInlineFields(lockJob: LockJob, event: object): {
|
|
39
|
+
inlineEnvironmentName: string | undefined;
|
|
40
|
+
inlineEnv: Record<string, string> | undefined;
|
|
41
|
+
inlineConcurrencyGroup: string | undefined;
|
|
42
|
+
};
|
|
28
43
|
//# sourceMappingURL=inline-eval.d.ts.map
|
|
@@ -16,8 +16,26 @@
|
|
|
16
16
|
* Internal helpers are pure phase functions returning typed results; the only
|
|
17
17
|
* top-level export is `processWebhook`, callable from server.ts / app.ts.
|
|
18
18
|
*/
|
|
19
|
+
import type { SimulatedEvent } from '@kici-dev/engine';
|
|
19
20
|
import type { WebhookInfo } from '../webhook/handler.js';
|
|
21
|
+
import type { ProviderBundle } from '../provider-registry.js';
|
|
22
|
+
import type { TrustResolution } from '../security/trust-resolver.js';
|
|
20
23
|
import { type ProcessingDeps } from './processor.js';
|
|
24
|
+
interface TrustOutcome {
|
|
25
|
+
trustResolution: TrustResolution | undefined;
|
|
26
|
+
/** Default 'base' for PR events; trust resolution may override to 'head'. */
|
|
27
|
+
lockFileSource: 'head' | 'base';
|
|
28
|
+
}
|
|
29
|
+
export declare function resolveTrustForPR(args: {
|
|
30
|
+
info: WebhookInfo;
|
|
31
|
+
deps: ProcessingDeps;
|
|
32
|
+
bundle: ProviderBundle;
|
|
33
|
+
event: SimulatedEvent;
|
|
34
|
+
payload: Record<string, unknown>;
|
|
35
|
+
resolvedOrgId: string;
|
|
36
|
+
repoIdentifier: string;
|
|
37
|
+
credentials: Record<string, unknown>;
|
|
38
|
+
}): Promise<TrustOutcome>;
|
|
21
39
|
/**
|
|
22
40
|
* Process a webhook through the complete pipeline.
|
|
23
41
|
*
|
|
@@ -35,4 +53,5 @@ import { type ProcessingDeps } from './processor.js';
|
|
|
35
53
|
* 10. Forward Platform trace + record event log
|
|
36
54
|
*/
|
|
37
55
|
export declare function processWebhook(info: WebhookInfo, deps: ProcessingDeps): Promise<void>;
|
|
56
|
+
export {};
|
|
38
57
|
//# sourceMappingURL=process-webhook.d.ts.map
|
|
@@ -34,6 +34,7 @@ import type { LogStorage } from '../reporting/log-storage.js';
|
|
|
34
34
|
import type { SecretResolver } from '../secrets/secret-resolver.js';
|
|
35
35
|
import type { ContributorCache } from '../security/contributor-cache.js';
|
|
36
36
|
import type { LockFile as FullLockFile, LockWorkflow, SimulatedEvent, WebhookNormalizer } from '@kici-dev/engine';
|
|
37
|
+
import { LockFileParseError } from '@kici-dev/engine';
|
|
37
38
|
import type { EventRouter } from '../events/event-router.js';
|
|
38
39
|
import type { RegistrationStore } from '../registration/registration-store.js';
|
|
39
40
|
import type { RegistrationIndex } from '../registration/registration-index.js';
|
|
@@ -158,7 +159,7 @@ export declare function resolveLockFileWithFallback(args: {
|
|
|
158
159
|
deliveryId: string;
|
|
159
160
|
}): Promise<{
|
|
160
161
|
lockFile: FullLockFile | null;
|
|
161
|
-
resolvedVia: 'inbound' | 'fallback' | 'miss';
|
|
162
|
+
resolvedVia: 'inbound' | 'fallback' | 'miss' | 'corrupt';
|
|
162
163
|
fallbackRoutingKey?: string;
|
|
163
164
|
/** The winning provider bundle when resolvedVia='fallback'. Used by the dispatch
|
|
164
165
|
* site to swap repoUrlBuilder and cloneTokenProvider (Layer 4 cross-provider fix). */
|
|
@@ -166,6 +167,10 @@ export declare function resolveLockFileWithFallback(args: {
|
|
|
166
167
|
/** The winning registration's providerContext when resolvedVia='fallback'.
|
|
167
168
|
* Carries installationId etc. for clone token issuance. */
|
|
168
169
|
fallbackCredentials?: Record<string, unknown>;
|
|
170
|
+
/** Set when resolvedVia='corrupt': the parse error seen while attempting to
|
|
171
|
+
* resolve a lock file. A valid fallback always wins over a corrupt inbound,
|
|
172
|
+
* so this is only surfaced when NOTHING resolved. */
|
|
173
|
+
corruptError?: LockFileParseError;
|
|
169
174
|
}>;
|
|
170
175
|
/**
|
|
171
176
|
* Resolve the customer/org ID for a routing key.
|
|
@@ -25,6 +25,8 @@ import type { BuildCoordinator } from '../cache/index.js';
|
|
|
25
25
|
import type { DepCache } from '../cache/index.js';
|
|
26
26
|
import type { PendingBuildTracker } from '../cache/index.js';
|
|
27
27
|
import type { SecretResolver } from '../secrets/secret-resolver.js';
|
|
28
|
+
import type { EnvironmentStore } from '../environments/environment-store.js';
|
|
29
|
+
import type { VariableStore } from '../environments/variable-store.js';
|
|
28
30
|
import type { LogStorage } from '../reporting/log-storage.js';
|
|
29
31
|
import type { Kysely } from 'kysely';
|
|
30
32
|
import type { Database } from '../db/types.js';
|
|
@@ -49,6 +51,10 @@ export interface TestTriggerInput {
|
|
|
49
51
|
uploadId?: string;
|
|
50
52
|
/** Fixture secret context mappings (optional). */
|
|
51
53
|
secrets?: Record<string, string>;
|
|
54
|
+
/** Base64 X25519+AES-GCM blob of the developer's local secrets ({flat, contexts}). */
|
|
55
|
+
encryptedSecrets?: string;
|
|
56
|
+
/** Base64 ephemeral CLI public key that encrypted `encryptedSecrets`. */
|
|
57
|
+
encryptedSecretsKey?: string;
|
|
52
58
|
/** Direct workflow run -- bypass triggers (optional). */
|
|
53
59
|
workflowName?: string;
|
|
54
60
|
/** Resolved overlay metadata for tarball download + decryption. */
|
|
@@ -97,6 +103,10 @@ export interface TestPipelineDeps {
|
|
|
97
103
|
logStorage?: LogStorage;
|
|
98
104
|
/** Database connection for environment protection checks. Optional. */
|
|
99
105
|
db?: Kysely<Database>;
|
|
106
|
+
/** Environment store for resolving environment ids in test dispatch parity. Optional. */
|
|
107
|
+
environmentStore?: EnvironmentStore;
|
|
108
|
+
/** Variable store for resolving environment variables in test dispatch parity. Optional. */
|
|
109
|
+
variableStore?: VariableStore;
|
|
100
110
|
}
|
|
101
111
|
/**
|
|
102
112
|
* Process a test trigger through the existing pipeline.
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* NOTE: This is the raw fetcher without caching. The orchestrator wraps
|
|
8
8
|
* this with an LRU cache (LockFileCache) for production use.
|
|
9
9
|
*/
|
|
10
|
-
import type
|
|
10
|
+
import { type LockFileFetcher, type LockFile } from '@kici-dev/engine';
|
|
11
11
|
import { type GitHubAppConfig } from './auth.js';
|
|
12
12
|
/**
|
|
13
13
|
* GitHub-specific implementation of LockFileFetcher.
|
|
@@ -25,10 +25,11 @@ export declare class InternalLockFileFetcher implements LockFileFetcher {
|
|
|
25
25
|
* Fetch the lock file from the local filesystem.
|
|
26
26
|
*
|
|
27
27
|
* @param repoIdentifier - Either a file:// URL or a relative path under repoBasePath
|
|
28
|
-
* @param
|
|
28
|
+
* @param ref - Git ref (ignored for filesystem access -- always reads current state)
|
|
29
29
|
* @param _credentials - Not used (file:// access needs no auth)
|
|
30
30
|
* @returns Parsed LockFile, or null if not found
|
|
31
|
+
* @throws LockFileParseError when the file is present but unparseable/invalid
|
|
31
32
|
*/
|
|
32
|
-
fetchLockFile(repoIdentifier: string,
|
|
33
|
+
fetchLockFile(repoIdentifier: string, ref: string, _credentials: unknown): Promise<LockFile | null>;
|
|
33
34
|
}
|
|
34
35
|
//# sourceMappingURL=lock-file-fetcher.d.ts.map
|
|
@@ -43,6 +43,13 @@ export declare enum DispatchQueueStatus {
|
|
|
43
43
|
Expired = "expired",
|
|
44
44
|
Recovering = "recovering"
|
|
45
45
|
}
|
|
46
|
+
/**
|
|
47
|
+
* Maximum delivery attempts for a single dispatch_queue job. A job whose
|
|
48
|
+
* `dispatch_attempts` reaches this value is failed permanently instead of
|
|
49
|
+
* being requeued again. Bounds requeue loops from repeated job.reject /
|
|
50
|
+
* pre-start agent loss; `expires_at` is the time-based backstop.
|
|
51
|
+
*/
|
|
52
|
+
export declare const MAX_DISPATCH_ATTEMPTS = 5;
|
|
46
53
|
/**
|
|
47
54
|
* Input for enqueuing a job. Callers provide these fields;
|
|
48
55
|
* the queue generates id, status, created_at, and expires_at.
|
|
@@ -307,6 +314,34 @@ export declare class JobQueue {
|
|
|
307
314
|
* the leader-gated sweep (`sweepExpiredRecoveries()`).
|
|
308
315
|
*/
|
|
309
316
|
markRecovering(jobId: string, deadline?: Date, agentId?: string): Promise<void>;
|
|
317
|
+
/**
|
|
318
|
+
* Stamp the dispatch-acknowledgment deadline for a dispatched job.
|
|
319
|
+
* Only touches rows still in 'dispatched' for safety.
|
|
320
|
+
*/
|
|
321
|
+
setAckDeadline(jobId: string, deadline: Date, agentId: string): Promise<void>;
|
|
322
|
+
/** Clear the ack deadline (agent answered, or the job left 'dispatched'). */
|
|
323
|
+
clearAckDeadline(jobId: string): Promise<void>;
|
|
324
|
+
/**
|
|
325
|
+
* List dispatched rows still awaiting an ack (non-null deadline). Used at
|
|
326
|
+
* coord boot (`Dispatcher.recoverState()`) to re-arm in-memory timers.
|
|
327
|
+
*/
|
|
328
|
+
getDispatchedAwaitingAck(): Promise<Array<{
|
|
329
|
+
id: string;
|
|
330
|
+
runId: string;
|
|
331
|
+
agentId: string | null;
|
|
332
|
+
deadline: Date;
|
|
333
|
+
}>>;
|
|
334
|
+
/**
|
|
335
|
+
* List every dispatched row whose ack deadline is in the past. The caller
|
|
336
|
+
* (leader-gated `Dispatcher.sweepExpiredAckDeadlines`) requeues each via
|
|
337
|
+
* the atomic `requeue()` (WHERE status='dispatched'), so racing coords
|
|
338
|
+
* cannot double-requeue.
|
|
339
|
+
*/
|
|
340
|
+
listExpiredAckDeadlines(now: Date): Promise<Array<{
|
|
341
|
+
id: string;
|
|
342
|
+
runId: string;
|
|
343
|
+
agentId: string | null;
|
|
344
|
+
}>>;
|
|
310
345
|
/**
|
|
311
346
|
* List every job currently in `recovering` state with its persisted
|
|
312
347
|
* recovery deadline. Used at coord boot (`Dispatcher.recoverState()`)
|
|
@@ -325,7 +360,7 @@ export declare class JobQueue {
|
|
|
325
360
|
/**
|
|
326
361
|
* Sweep every `recovering` row whose `recovery_deadline` is in the
|
|
327
362
|
* past, marking them `failed`. Returns the rows that flipped so the
|
|
328
|
-
* caller can fire the per-job `
|
|
363
|
+
* caller can fire the per-job `onJobFailedPermanently` hook in process.
|
|
329
364
|
*
|
|
330
365
|
* Intended for the leader-gated `Dispatcher.sweepExpiredRecoveries`
|
|
331
366
|
* tick — running on N coords would still be correct (the WHERE
|
|
@@ -343,6 +378,23 @@ export declare class JobQueue {
|
|
|
343
378
|
* @returns true if the update affected a row (job was still recovering).
|
|
344
379
|
*/
|
|
345
380
|
markFailedIfRecovering(jobId: string, _reason: string): Promise<boolean>;
|
|
381
|
+
/**
|
|
382
|
+
* Return a dispatched job to the pending queue for re-dispatch, bumping
|
|
383
|
+
* its attempt counter. Used when an agent explicitly rejects a dispatch
|
|
384
|
+
* (job.reject) and when a scaler-managed agent disconnects before the
|
|
385
|
+
* job started. Only flips rows still in 'dispatched' — a job that was
|
|
386
|
+
* concurrently completed / failed / cancelled is left untouched.
|
|
387
|
+
*
|
|
388
|
+
* @returns the post-increment dispatch_attempts, or null when the row
|
|
389
|
+
* was not in 'dispatched' state (nothing requeued).
|
|
390
|
+
*/
|
|
391
|
+
requeue(jobId: string): Promise<number | null>;
|
|
392
|
+
/**
|
|
393
|
+
* Get the full QueuedJob row by ID regardless of status. Used by the
|
|
394
|
+
* dispatcher's redispatch path, which needs runsOnLabels / excludeLabels /
|
|
395
|
+
* resources to pick an agent or consult the scaler for a requeued job.
|
|
396
|
+
*/
|
|
397
|
+
getFullJobById(jobId: string): Promise<QueuedJob | null>;
|
|
346
398
|
/**
|
|
347
399
|
* Mark a job as dispatched only if it is still in 'recovering' state.
|
|
348
400
|
* Used when an agent reconnects and claims a recovering job.
|
|
@@ -219,7 +219,9 @@ export declare class ExecutionTracker {
|
|
|
219
219
|
concurrency?: {
|
|
220
220
|
cancelInProgress?: boolean;
|
|
221
221
|
max?: number;
|
|
222
|
-
}
|
|
222
|
+
},
|
|
223
|
+
/** Workflow-level wall-clock timeout in ms from the lock file. Sets the run deadline. */
|
|
224
|
+
workflowTimeoutMs?: number): Promise<void>;
|
|
223
225
|
/**
|
|
224
226
|
* Add additional jobs to an already-started execution run.
|
|
225
227
|
* Used when build jobs are tracked early and regular jobs are dispatched later.
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* PATCH /api/v1/admin/environments/:name/policy — update policy fields
|
|
7
7
|
* GET /api/v1/admin/environments?orgId=<id> — list environments
|
|
8
8
|
* GET /api/v1/admin/environments/:name?orgId=<id> — show env + vars + bindings
|
|
9
|
+
* DELETE /api/v1/admin/environments/:name?orgId=<id> — delete env (cascades bindings/variables/overrides; pending held runs block with 409)
|
|
9
10
|
* POST /api/v1/admin/environments/templates — create/update a template
|
|
10
11
|
* GET /api/v1/admin/environments/:name/variables?orgId=<id> — list org-level variables
|
|
11
12
|
* PUT /api/v1/admin/environments/:name/variables/:key?orgId=<id> — upsert variable
|
|
@@ -39,6 +39,7 @@ export interface BareMetalScalerBackendOptions {
|
|
|
39
39
|
}
|
|
40
40
|
export declare class BareMetalScalerBackend implements ScalerBackend {
|
|
41
41
|
readonly type: "bare-metal";
|
|
42
|
+
readonly spawnsOnLocalHost = true;
|
|
42
43
|
readonly logsSource = "bare-metal";
|
|
43
44
|
readonly maxAgents: number;
|
|
44
45
|
private _labelSets;
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
*/
|
|
9
9
|
import { type ToolRequirement } from '@kici-dev/shared';
|
|
10
10
|
import type { AgentTokenStore } from '../agent/token-store.js';
|
|
11
|
-
import type { ScalerBackend, ManagedAgent, LabelSetConfig, LogCapture, ResourceRequest, EffectiveLimits, ScalerEventCallback, ValidationResult, ScalerEntry } from './types.js';
|
|
11
|
+
import type { ScalerBackend, ManagedAgent, LabelSetConfig, LogCapture, ResourceRequest, EffectiveLimits, SpawnContext, ScalerEventCallback, ValidationResult, ScalerEntry } from './types.js';
|
|
12
12
|
/**
|
|
13
13
|
* Result of runtime detection.
|
|
14
14
|
*/
|
|
@@ -49,6 +49,7 @@ export interface ContainerScalerBackendOptions {
|
|
|
49
49
|
}
|
|
50
50
|
export declare class ContainerScalerBackend implements ScalerBackend {
|
|
51
51
|
readonly type: "container";
|
|
52
|
+
readonly spawnsOnLocalHost: boolean;
|
|
52
53
|
readonly maxAgents: number;
|
|
53
54
|
private _labelSets;
|
|
54
55
|
private readonly name;
|
|
@@ -112,7 +113,7 @@ export declare class ContainerScalerBackend implements ScalerBackend {
|
|
|
112
113
|
get logsSource(): string;
|
|
113
114
|
get labelSets(): LabelSetConfig[];
|
|
114
115
|
getActiveCount(): number;
|
|
115
|
-
spawn(labelSet: string[], agentId: string, orchestratorUrl: string, onEvent?: ScalerEventCallback, effectiveLimits?: EffectiveLimits): Promise<ManagedAgent>;
|
|
116
|
+
spawn(labelSet: string[], agentId: string, orchestratorUrl: string, onEvent?: ScalerEventCallback, effectiveLimits?: EffectiveLimits, spawnContext?: SpawnContext): Promise<ManagedAgent>;
|
|
116
117
|
getScalerContext(agentId: string): Record<string, unknown> | undefined;
|
|
117
118
|
destroy(managedId: string): Promise<void>;
|
|
118
119
|
/**
|
|
@@ -82,6 +82,7 @@ export interface FirecrackerScalerBackendOptions {
|
|
|
82
82
|
}
|
|
83
83
|
export declare class FirecrackerScalerBackend implements ScalerBackend {
|
|
84
84
|
readonly type: "firecracker";
|
|
85
|
+
readonly spawnsOnLocalHost = true;
|
|
85
86
|
readonly maxAgents: number;
|
|
86
87
|
readonly logsSource = "firecracker-serial";
|
|
87
88
|
/** AbortControllers for file tailing per managed VM (keyed by agent ID) */
|
|
@@ -211,6 +212,22 @@ export declare class FirecrackerScalerBackend implements ScalerBackend {
|
|
|
211
212
|
* Promisified execFile wrapper with 30s timeout.
|
|
212
213
|
*/
|
|
213
214
|
private execAsync;
|
|
215
|
+
/**
|
|
216
|
+
* Remove a VM's jailer chroot directory.
|
|
217
|
+
*
|
|
218
|
+
* On rootless nodes (requireSudo), the jailer chowns the chroot contents to
|
|
219
|
+
* the jailer uid/gid, leaving the inner directories owned by that uid with
|
|
220
|
+
* mode 0755 — so the orchestrator process (a different, non-root uid) has no
|
|
221
|
+
* write permission on them and a plain `rm` fails with EACCES. destroy() and
|
|
222
|
+
* both cleanupOrphans passes treat removal as best-effort and swallow that
|
|
223
|
+
* failure, so each spawn would otherwise leak a multi-GiB chroot until the
|
|
224
|
+
* data disk fills and the orchestrator crash-loops on ENOSPC (it can no
|
|
225
|
+
* longer write its own files to start, so the in-process orphan sweep never
|
|
226
|
+
* runs to recover). Reclaim ownership via the same sudo-wrapped `chown` path
|
|
227
|
+
* used for `ip` before the `rm` runs as ourselves. On root nodes (requireSudo
|
|
228
|
+
* false) the chown is skipped and `rm` works directly.
|
|
229
|
+
*/
|
|
230
|
+
private removeChrootDir;
|
|
214
231
|
/**
|
|
215
232
|
* Get the API socket path for an agent's Firecracker VM.
|
|
216
233
|
*/
|
package/dist/scaler/manager.d.ts
CHANGED
|
@@ -59,6 +59,8 @@ export interface ScalerStatus {
|
|
|
59
59
|
type: string;
|
|
60
60
|
activeCount: number;
|
|
61
61
|
maxAgents: number;
|
|
62
|
+
/** Whether this backend spawns its agents on the orchestrator's own host. */
|
|
63
|
+
spawnsOnLocalHost: boolean;
|
|
62
64
|
/** Label sets this backend can provision (each entry is a string[] of labels) */
|
|
63
65
|
labelSets: string[][];
|
|
64
66
|
/** Sum of `requests` reserved by this scaler's active agents. */
|
|
@@ -41,13 +41,35 @@ export declare function validateNftablesAvailability(opts?: NftOptions): Promise
|
|
|
41
41
|
* Idempotent -- safe to call multiple times.
|
|
42
42
|
*/
|
|
43
43
|
export declare function ensureKiciTable(opts?: NftOptions): Promise<void>;
|
|
44
|
+
/** A single nft rule operation: the verb decides chain placement. */
|
|
45
|
+
export interface NftRuleOp {
|
|
46
|
+
/** 'insert' prepends to the chain head; 'add' appends to the tail. */
|
|
47
|
+
verb: 'insert' | 'add';
|
|
48
|
+
/** Tokens after `nft <verb> rule ip kici forward`. */
|
|
49
|
+
tokens: string[];
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Build the per-identifier isolation rule operations.
|
|
53
|
+
*
|
|
54
|
+
* Placement matters because nftables is first-match-wins and the `kici`
|
|
55
|
+
* forward chain is shared: it accumulates rules for every live agent plus
|
|
56
|
+
* any host-level baseline (e.g. wildcard `iifname "kici-*"` RFC1918 drops
|
|
57
|
+
* installed at host bootstrap). Accepts therefore go in via `insert`
|
|
58
|
+
* (chain head) so they beat any pre-existing drop that also matches the
|
|
59
|
+
* traffic; an appended accept after a wildcard drop is dead code. Drops go
|
|
60
|
+
* in via `add` (tail) — they only need to beat the chain's accept policy.
|
|
61
|
+
*
|
|
62
|
+
* Effective per-identifier order: gateway + allowlist accepts (head),
|
|
63
|
+
* RFC1918 / metadata / denyAll drops (tail).
|
|
64
|
+
*/
|
|
65
|
+
export declare function buildIsolationRuleOps(matchClause: string[], gatewayIp: string, networkPolicy?: NetworkPolicy): NftRuleOp[];
|
|
44
66
|
/**
|
|
45
67
|
* Add network isolation rules for a specific network interface.
|
|
46
68
|
* Used by Firecracker and container backends.
|
|
47
69
|
*
|
|
48
|
-
* Rule
|
|
49
|
-
* 1. Accept gateway traffic (
|
|
50
|
-
* 2. Accept allowlisted CIDRs (
|
|
70
|
+
* Rule placement (see buildIsolationRuleOps):
|
|
71
|
+
* 1. Accept gateway traffic (inserted at chain head)
|
|
72
|
+
* 2. Accept allowlisted CIDRs (inserted at chain head)
|
|
51
73
|
* 3. Drop RFC1918 ranges (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16)
|
|
52
74
|
* 4. Drop cloud metadata (169.254.0.0/16)
|
|
53
75
|
* 5. Drop all remaining traffic (only if denyAll is true)
|
package/dist/scaler/types.d.ts
CHANGED
|
@@ -50,6 +50,20 @@ export interface EffectiveLimits {
|
|
|
50
50
|
cpus?: number;
|
|
51
51
|
memBytes?: number;
|
|
52
52
|
}
|
|
53
|
+
/**
|
|
54
|
+
* Identity of the work a spawn was provisioned for, passed to
|
|
55
|
+
* `ScalerBackend.spawn()`. Backends surface it on the provisioned resource
|
|
56
|
+
* (container labels today) so an operator inspecting the backend — e.g.
|
|
57
|
+
* `podman ps` — can tell which job/run each agent serves, and so tests can
|
|
58
|
+
* select the exact container a trigger produced instead of guessing among
|
|
59
|
+
* concurrent kici-managed containers. Absent for unbound spawns (warm pool).
|
|
60
|
+
*/
|
|
61
|
+
export interface SpawnContext {
|
|
62
|
+
/** Execution job id the spawn is bound to. */
|
|
63
|
+
boundJobId?: string;
|
|
64
|
+
/** Execution run id the bound job belongs to. */
|
|
65
|
+
runId?: string;
|
|
66
|
+
}
|
|
53
67
|
/**
|
|
54
68
|
* Network policy controlling RFC1918 and internet access for agents in this label set.
|
|
55
69
|
*/
|
|
@@ -165,6 +179,14 @@ export interface ScalerBackend {
|
|
|
165
179
|
readonly labelSets: LabelSetConfig[];
|
|
166
180
|
/** Per-backend maximum agents */
|
|
167
181
|
readonly maxAgents: number;
|
|
182
|
+
/**
|
|
183
|
+
* Whether this backend spawns its agents on the orchestrator's own host.
|
|
184
|
+
* True for bare-metal and Firecracker (local processes / local VMs) and for
|
|
185
|
+
* container backends using a local runtime socket; false when the backend
|
|
186
|
+
* provisions elsewhere (remote container runtime, future cloud backends).
|
|
187
|
+
* Drives the static spawning-host display on the diagnostics page.
|
|
188
|
+
*/
|
|
189
|
+
readonly spawnsOnLocalHost: boolean;
|
|
168
190
|
/** Current count of agents managed by this backend (including spawning) */
|
|
169
191
|
getActiveCount(): number;
|
|
170
192
|
/**
|
|
@@ -177,10 +199,13 @@ export interface ScalerBackend {
|
|
|
177
199
|
* for this spawn. Computed by ScalerManager from the job/label-set/scaler
|
|
178
200
|
* default chain. When omitted (or both fields zero), the backend falls
|
|
179
201
|
* back to its label-set / default limits the same way it always has.
|
|
202
|
+
* @param spawnContext - Identity of the bound job/run this spawn serves
|
|
203
|
+
* (omitted for unbound spawns, e.g. warm pool). Backends surface it on
|
|
204
|
+
* the provisioned resource for operator inspection.
|
|
180
205
|
* @returns The managed agent tracking object
|
|
181
206
|
* @throws If the label set is not supported by this backend
|
|
182
207
|
*/
|
|
183
|
-
spawn(labelSet: string[], agentId: string, orchestratorUrl: string, onEvent?: ScalerEventCallback, effectiveLimits?: EffectiveLimits): Promise<ManagedAgent>;
|
|
208
|
+
spawn(labelSet: string[], agentId: string, orchestratorUrl: string, onEvent?: ScalerEventCallback, effectiveLimits?: EffectiveLimits, spawnContext?: SpawnContext): Promise<ManagedAgent>;
|
|
184
209
|
/**
|
|
185
210
|
* Destroy a specific managed agent.
|
|
186
211
|
* Docker: docker rm -f; Bare-metal: SIGTERM -> SIGKILL
|