@xeonr/pipelines-sdk 0.0.0-stage → 0.2.0
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 +334 -2
- package/dist/auth.d.ts +72 -0
- package/dist/auth.d.ts.map +1 -0
- package/dist/auth.js +139 -0
- package/dist/auth.js.map +1 -0
- package/dist/client.d.ts +129 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +106 -0
- package/dist/client.js.map +1 -0
- package/dist/errors.d.ts +113 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +115 -0
- package/dist/errors.js.map +1 -0
- package/dist/gen/buf/validate/validate_pb.d.ts +4828 -0
- package/dist/gen/buf/validate/validate_pb.d.ts.map +1 -0
- package/dist/gen/buf/validate/validate_pb.js +357 -0
- package/dist/gen/buf/validate/validate_pb.js.map +1 -0
- package/dist/gen/gnostic/openapi/v3/annotations_pb.d.ts +24 -0
- package/dist/gen/gnostic/openapi/v3/annotations_pb.d.ts.map +1 -0
- package/dist/gen/gnostic/openapi/v3/annotations_pb.js +37 -0
- package/dist/gen/gnostic/openapi/v3/annotations_pb.js.map +1 -0
- package/dist/gen/gnostic/openapi/v3/openapiv3_pb.d.ts +2245 -0
- package/dist/gen/gnostic/openapi/v3/openapiv3_pb.d.ts.map +1 -0
- package/dist/gen/gnostic/openapi/v3/openapiv3_pb.js +410 -0
- package/dist/gen/gnostic/openapi/v3/openapiv3_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.d.ts +1031 -0
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.js +219 -0
- package/dist/gen/xeonr/pipelines/private/v1/attempt_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/runners_pb.d.ts +190 -0
- package/dist/gen/xeonr/pipelines/private/v1/runners_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/runners_pb.js +53 -0
- package/dist/gen/xeonr/pipelines/private/v1/runners_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.d.ts +1161 -0
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.js +269 -0
- package/dist/gen/xeonr/pipelines/private/v1/step_local_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.d.ts +1061 -0
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.js +221 -0
- package/dist/gen/xeonr/pipelines/private/v1/worker_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/common_pb.d.ts +580 -0
- package/dist/gen/xeonr/pipelines/v1/common_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/common_pb.js +483 -0
- package/dist/gen/xeonr/pipelines/v1/common_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/definition_pb.d.ts +762 -0
- package/dist/gen/xeonr/pipelines/v1/definition_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/definition_pb.js +190 -0
- package/dist/gen/xeonr/pipelines/v1/definition_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/pools_pb.d.ts +919 -0
- package/dist/gen/xeonr/pipelines/v1/pools_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/pools_pb.js +272 -0
- package/dist/gen/xeonr/pipelines/v1/pools_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/registry_pb.d.ts +895 -0
- package/dist/gen/xeonr/pipelines/v1/registry_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/registry_pb.js +277 -0
- package/dist/gen/xeonr/pipelines/v1/registry_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/runs_pb.d.ts +1237 -0
- package/dist/gen/xeonr/pipelines/v1/runs_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/runs_pb.js +204 -0
- package/dist/gen/xeonr/pipelines/v1/runs_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/secrets_pb.d.ts +647 -0
- package/dist/gen/xeonr/pipelines/v1/secrets_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/secrets_pb.js +181 -0
- package/dist/gen/xeonr/pipelines/v1/secrets_pb.js.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/sinks_pb.d.ts +381 -0
- package/dist/gen/xeonr/pipelines/v1/sinks_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/pipelines/v1/sinks_pb.js +145 -0
- package/dist/gen/xeonr/pipelines/v1/sinks_pb.js.map +1 -0
- package/dist/gen/xeonr/platform/v1/options_pb.d.ts +313 -0
- package/dist/gen/xeonr/platform/v1/options_pb.d.ts.map +1 -0
- package/dist/gen/xeonr/platform/v1/options_pb.js +235 -0
- package/dist/gen/xeonr/platform/v1/options_pb.js.map +1 -0
- package/dist/handler.d.ts +94 -0
- package/dist/handler.d.ts.map +1 -0
- package/dist/handler.js +18 -0
- package/dist/handler.js.map +1 -0
- package/dist/index.d.ts +30 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +24 -0
- package/dist/index.js.map +1 -0
- package/dist/internal/time.d.ts +8 -0
- package/dist/internal/time.d.ts.map +1 -0
- package/dist/internal/time.js +25 -0
- package/dist/internal/time.js.map +1 -0
- package/dist/logship.d.ts +117 -0
- package/dist/logship.d.ts.map +1 -0
- package/dist/logship.js +319 -0
- package/dist/logship.js.map +1 -0
- package/dist/testing/index.d.ts +215 -0
- package/dist/testing/index.d.ts.map +1 -0
- package/dist/testing/index.js +1015 -0
- package/dist/testing/index.js.map +1 -0
- package/dist/transport.d.ts +43 -0
- package/dist/transport.d.ts.map +1 -0
- package/dist/transport.js +44 -0
- package/dist/transport.js.map +1 -0
- package/dist/worker.d.ts +236 -0
- package/dist/worker.d.ts.map +1 -0
- package/dist/worker.js +733 -0
- package/dist/worker.js.map +1 -0
- package/package.json +70 -3
|
@@ -0,0 +1,762 @@
|
|
|
1
|
+
import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
|
|
2
|
+
import type { Duration, Value } from "@bufbuild/protobuf/wkt";
|
|
3
|
+
import type { FailureClass, PackageRef, ResourceRef, Resources, SecretType } from "./common_pb.js";
|
|
4
|
+
import type { JsonObject, Message } from "@bufbuild/protobuf";
|
|
5
|
+
/**
|
|
6
|
+
* Describes the file xeonr/pipelines/v1/definition.proto.
|
|
7
|
+
*/
|
|
8
|
+
export declare const file_xeonr_pipelines_v1_definition: GenFile;
|
|
9
|
+
/**
|
|
10
|
+
* Definition is a pipeline: a DAG of nodes.
|
|
11
|
+
*
|
|
12
|
+
* @generated from message xeonr.pipelines.v1.Definition
|
|
13
|
+
*/
|
|
14
|
+
export type Definition = Message<"xeonr.pipelines.v1.Definition"> & {
|
|
15
|
+
/**
|
|
16
|
+
* Name is for people; it identifies nothing.
|
|
17
|
+
*
|
|
18
|
+
* @generated from field: string name = 1;
|
|
19
|
+
*/
|
|
20
|
+
name: string;
|
|
21
|
+
/**
|
|
22
|
+
* Nodes is the graph. Order carries no meaning beyond display. Ids are
|
|
23
|
+
* unique; a cycle, an unknown need or a reference outside a node's
|
|
24
|
+
* dependency closure refuses the definition.
|
|
25
|
+
*
|
|
26
|
+
* @generated from field: repeated xeonr.pipelines.v1.Node nodes = 2;
|
|
27
|
+
*/
|
|
28
|
+
nodes: Node[];
|
|
29
|
+
/**
|
|
30
|
+
* Config is static data frozen in the snapshot, read as
|
|
31
|
+
* `${{ config.<path> }}`. At most 64 KiB encoded.
|
|
32
|
+
*
|
|
33
|
+
* @generated from field: google.protobuf.Struct config = 3;
|
|
34
|
+
*/
|
|
35
|
+
config?: JsonObject | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* MaxParallelNodes caps how many nodes of one run execute at once. Zero is
|
|
38
|
+
* the platform default.
|
|
39
|
+
*
|
|
40
|
+
* @generated from field: uint32 max_parallel_nodes = 4;
|
|
41
|
+
*/
|
|
42
|
+
maxParallelNodes: number;
|
|
43
|
+
/**
|
|
44
|
+
* Timeout bounds the whole run from its start; when it passes the run is
|
|
45
|
+
* cancelled. Unset is the platform default. Milestone 2.
|
|
46
|
+
*
|
|
47
|
+
* @generated from field: google.protobuf.Duration timeout = 5;
|
|
48
|
+
*/
|
|
49
|
+
timeout?: Duration | undefined;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* Describes the message xeonr.pipelines.v1.Definition.
|
|
53
|
+
* Use `create(DefinitionSchema)` to create a new message.
|
|
54
|
+
*/
|
|
55
|
+
export declare const DefinitionSchema: GenMessage<Definition>;
|
|
56
|
+
/**
|
|
57
|
+
* Node is one step of the graph: what to run, with which inputs, after what,
|
|
58
|
+
* and where.
|
|
59
|
+
*
|
|
60
|
+
* @generated from message xeonr.pipelines.v1.Node
|
|
61
|
+
*/
|
|
62
|
+
export type Node = Message<"xeonr.pipelines.v1.Node"> & {
|
|
63
|
+
/**
|
|
64
|
+
* ID is unique in the definition and is how expressions, needs, events and
|
|
65
|
+
* RetryNode address the node.
|
|
66
|
+
*
|
|
67
|
+
* @generated from field: string id = 1;
|
|
68
|
+
*/
|
|
69
|
+
id: string;
|
|
70
|
+
/**
|
|
71
|
+
* Name is for people; empty shows the id.
|
|
72
|
+
*
|
|
73
|
+
* @generated from field: string name = 2;
|
|
74
|
+
*/
|
|
75
|
+
name: string;
|
|
76
|
+
/**
|
|
77
|
+
* Action is what the node does.
|
|
78
|
+
*
|
|
79
|
+
* @generated from oneof xeonr.pipelines.v1.Node.action
|
|
80
|
+
*/
|
|
81
|
+
action: {
|
|
82
|
+
/**
|
|
83
|
+
* Uses runs one exact version of a step package from the registry. An
|
|
84
|
+
* `exec` package runs as a container on a runner pool chosen by
|
|
85
|
+
* `runs_on`; a `worker` package runs as a handler in an SDK worker.
|
|
86
|
+
*
|
|
87
|
+
* @generated from field: xeonr.pipelines.v1.PackageRef uses = 3;
|
|
88
|
+
*/
|
|
89
|
+
value: PackageRef;
|
|
90
|
+
case: "uses";
|
|
91
|
+
} | {
|
|
92
|
+
/**
|
|
93
|
+
* Handler runs a worker handler by name: the `<namespace>/<name>` of a
|
|
94
|
+
* `worker` package, at its newest READY version when the snapshot is
|
|
95
|
+
* made. It is claimed by SDK workers that registered the handler, and
|
|
96
|
+
* never by a runner pool. Milestone 2.
|
|
97
|
+
*
|
|
98
|
+
* @generated from field: string handler = 4;
|
|
99
|
+
*/
|
|
100
|
+
value: string;
|
|
101
|
+
case: "handler";
|
|
102
|
+
} | {
|
|
103
|
+
/**
|
|
104
|
+
* Trigger starts a downstream run instead of running a step.
|
|
105
|
+
* Milestone 2.
|
|
106
|
+
*
|
|
107
|
+
* @generated from field: xeonr.pipelines.v1.Trigger trigger = 5;
|
|
108
|
+
*/
|
|
109
|
+
value: Trigger;
|
|
110
|
+
case: "trigger";
|
|
111
|
+
} | {
|
|
112
|
+
case: undefined;
|
|
113
|
+
value?: undefined;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* With gives the step its inputs, by the input names its manifest
|
|
117
|
+
* declares. A value is a literal or a whole-value `${{ }}` reference (see
|
|
118
|
+
* the file comment); inside a list or an object, each string element may
|
|
119
|
+
* be one too. Inputs are checked against the manifest when the run starts
|
|
120
|
+
* and again when the node is dispatched.
|
|
121
|
+
*
|
|
122
|
+
* @generated from field: map<string, google.protobuf.Value> with = 6;
|
|
123
|
+
*/
|
|
124
|
+
with: {
|
|
125
|
+
[key: string]: Value;
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* Needs are the nodes that must be terminal before this one is considered.
|
|
129
|
+
*
|
|
130
|
+
* @generated from field: repeated xeonr.pipelines.v1.Need needs = 7;
|
|
131
|
+
*/
|
|
132
|
+
needs: Need[];
|
|
133
|
+
/**
|
|
134
|
+
* RunsOn says what the pool running this node must offer. Only for a node
|
|
135
|
+
* that `uses` an exec package. It never names a pool or a tier.
|
|
136
|
+
*
|
|
137
|
+
* @generated from field: xeonr.pipelines.v1.RunsOn runs_on = 8;
|
|
138
|
+
*/
|
|
139
|
+
runsOn?: RunsOn | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* Secrets grants secrets to this node by name. What is delivered is the
|
|
142
|
+
* grant, intersected with the manifest's `required_secrets` and with each
|
|
143
|
+
* secret's own policy. That policy denies by default: a grant is not
|
|
144
|
+
* enough for a secret whose policy does not allow this attempt's facts,
|
|
145
|
+
* step package and tier, each by a list that matches or by its wildcard.
|
|
146
|
+
*
|
|
147
|
+
* @generated from field: repeated xeonr.pipelines.v1.SecretGrant secrets = 9;
|
|
148
|
+
*/
|
|
149
|
+
secrets: SecretGrant[];
|
|
150
|
+
/**
|
|
151
|
+
* ContinueOnError, when set, lets the run go on after this node fails: the
|
|
152
|
+
* node ends FAILED_ALLOWED, its dependents proceed, and the run can still
|
|
153
|
+
* succeed.
|
|
154
|
+
*
|
|
155
|
+
* @generated from field: xeonr.pipelines.v1.ContinueOnError continue_on_error = 10;
|
|
156
|
+
*/
|
|
157
|
+
continueOnError?: ContinueOnError | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* RunAfterFailure makes the node run once its needs are terminal even if
|
|
160
|
+
* one of them failed or was skipped (the compiled form of "when: always").
|
|
161
|
+
* It still does not run once the run is cancelled.
|
|
162
|
+
*
|
|
163
|
+
* validate:skip a bool has no bounds
|
|
164
|
+
*
|
|
165
|
+
* @generated from field: bool run_after_failure = 11;
|
|
166
|
+
*/
|
|
167
|
+
runAfterFailure: boolean;
|
|
168
|
+
/**
|
|
169
|
+
* Retry says when a failed attempt is followed by another. Unset is the
|
|
170
|
+
* platform default: transient classes only, with backoff.
|
|
171
|
+
*
|
|
172
|
+
* @generated from field: xeonr.pipelines.v1.Retry retry = 12;
|
|
173
|
+
*/
|
|
174
|
+
retry?: Retry | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* Timeout bounds one attempt from its start. Unset is the platform
|
|
177
|
+
* default; the upper bound is the platform's policy, not this schema's.
|
|
178
|
+
*
|
|
179
|
+
* @generated from field: google.protobuf.Duration timeout = 13;
|
|
180
|
+
*/
|
|
181
|
+
timeout?: Duration | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* Interruptible says the node may be stopped when a newer run supersedes
|
|
184
|
+
* this one. A run is superseded only while none of its non-interruptible
|
|
185
|
+
* nodes has started. It also says the node may be stopped by its worker
|
|
186
|
+
* shutting down without spending a retry (FAILURE_CLASS_INTERRUPTED).
|
|
187
|
+
* Milestone 2.
|
|
188
|
+
*
|
|
189
|
+
* validate:skip a bool has no bounds
|
|
190
|
+
*
|
|
191
|
+
* @generated from field: bool interruptible = 14;
|
|
192
|
+
*/
|
|
193
|
+
interruptible: boolean;
|
|
194
|
+
/**
|
|
195
|
+
* Lock is a queuing mutex: at most one node holding the same key, within
|
|
196
|
+
* the run's resource, runs at a time. Others wait as BLOCKED in creation
|
|
197
|
+
* order, and are never cancelled by it. Empty takes no lock. Milestone 2.
|
|
198
|
+
*
|
|
199
|
+
* @generated from field: string lock = 15;
|
|
200
|
+
*/
|
|
201
|
+
lock: string;
|
|
202
|
+
/**
|
|
203
|
+
* Manual, when set, makes the node wait for ReleaseNode before it runs.
|
|
204
|
+
* Milestone 2.
|
|
205
|
+
*
|
|
206
|
+
* @generated from field: xeonr.pipelines.v1.Manual manual = 16;
|
|
207
|
+
*/
|
|
208
|
+
manual?: Manual | undefined;
|
|
209
|
+
/**
|
|
210
|
+
* Services are containers started beside the step for the length of the
|
|
211
|
+
* attempt, reachable by alias. They need a pool with the `services`
|
|
212
|
+
* capability. Milestone 2 runs them; milestone 1 carries the shape.
|
|
213
|
+
*
|
|
214
|
+
* @generated from field: repeated xeonr.pipelines.v1.Service services = 17;
|
|
215
|
+
*/
|
|
216
|
+
services: Service[];
|
|
217
|
+
/**
|
|
218
|
+
* Caches are directories restored before the step and saved after it.
|
|
219
|
+
* Milestone 2.
|
|
220
|
+
*
|
|
221
|
+
* @generated from field: repeated xeonr.pipelines.v1.Cache caches = 18;
|
|
222
|
+
*/
|
|
223
|
+
caches: Cache[];
|
|
224
|
+
/**
|
|
225
|
+
* Artifacts are files the step leaves behind that the platform commits as
|
|
226
|
+
* blob outputs without the step calling anything. Milestone 2.
|
|
227
|
+
*
|
|
228
|
+
* @generated from field: repeated xeonr.pipelines.v1.Artifact artifacts = 19;
|
|
229
|
+
*/
|
|
230
|
+
artifacts: Artifact[];
|
|
231
|
+
/**
|
|
232
|
+
* IDTokenAudiences are the audiences this node may ask job identity tokens
|
|
233
|
+
* for. Each must also be allowed by the platform's policy for the run.
|
|
234
|
+
* Milestone 2.
|
|
235
|
+
*
|
|
236
|
+
* @generated from field: repeated string id_token_audiences = 20;
|
|
237
|
+
*/
|
|
238
|
+
idTokenAudiences: string[];
|
|
239
|
+
};
|
|
240
|
+
/**
|
|
241
|
+
* Describes the message xeonr.pipelines.v1.Node.
|
|
242
|
+
* Use `create(NodeSchema)` to create a new message.
|
|
243
|
+
*/
|
|
244
|
+
export declare const NodeSchema: GenMessage<Node>;
|
|
245
|
+
/**
|
|
246
|
+
* Need is one edge of the graph.
|
|
247
|
+
*
|
|
248
|
+
* @generated from message xeonr.pipelines.v1.Need
|
|
249
|
+
*/
|
|
250
|
+
export type Need = Message<"xeonr.pipelines.v1.Need"> & {
|
|
251
|
+
/**
|
|
252
|
+
* Node is the id of the node needed.
|
|
253
|
+
*
|
|
254
|
+
* @generated from field: string node = 1;
|
|
255
|
+
*/
|
|
256
|
+
node: string;
|
|
257
|
+
/**
|
|
258
|
+
* Optional says a skipped need does not skip this node: the edge only
|
|
259
|
+
* orders. A failed need still does, unless the node sets
|
|
260
|
+
* `run_after_failure`.
|
|
261
|
+
*
|
|
262
|
+
* validate:skip a bool has no bounds
|
|
263
|
+
*
|
|
264
|
+
* @generated from field: bool optional = 2;
|
|
265
|
+
*/
|
|
266
|
+
optional: boolean;
|
|
267
|
+
/**
|
|
268
|
+
* Artifacts says whether the needed node's artifacts are staged into this
|
|
269
|
+
* node's work directory. Unset means true; set false to take the ordering
|
|
270
|
+
* without the files.
|
|
271
|
+
*
|
|
272
|
+
* validate:skip a bool has no bounds
|
|
273
|
+
*
|
|
274
|
+
* @generated from field: optional bool artifacts = 3;
|
|
275
|
+
*/
|
|
276
|
+
artifacts?: boolean | undefined;
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* Describes the message xeonr.pipelines.v1.Need.
|
|
280
|
+
* Use `create(NeedSchema)` to create a new message.
|
|
281
|
+
*/
|
|
282
|
+
export declare const NeedSchema: GenMessage<Need>;
|
|
283
|
+
/**
|
|
284
|
+
* RunsOn is what a node requires of the pool that runs it. A pool may claim
|
|
285
|
+
* the node's attempts only when it covers all of it, is allowed to serve the
|
|
286
|
+
* run's tenant, and is of the tier the platform computed for the attempt.
|
|
287
|
+
*
|
|
288
|
+
* @generated from message xeonr.pipelines.v1.RunsOn
|
|
289
|
+
*/
|
|
290
|
+
export type RunsOn = Message<"xeonr.pipelines.v1.RunsOn"> & {
|
|
291
|
+
/**
|
|
292
|
+
* Labels must all be among the pool's labels.
|
|
293
|
+
*
|
|
294
|
+
* @generated from field: repeated string labels = 1;
|
|
295
|
+
*/
|
|
296
|
+
labels: string[];
|
|
297
|
+
/**
|
|
298
|
+
* Capabilities must all be among the pool's, beyond those the step's
|
|
299
|
+
* manifest already asks for.
|
|
300
|
+
*
|
|
301
|
+
* @generated from field: repeated string capabilities = 2;
|
|
302
|
+
*/
|
|
303
|
+
capabilities: string[];
|
|
304
|
+
/**
|
|
305
|
+
* Resources is the least one slot of the pool must offer.
|
|
306
|
+
*
|
|
307
|
+
* @generated from field: xeonr.pipelines.v1.Resources resources = 3;
|
|
308
|
+
*/
|
|
309
|
+
resources?: Resources | undefined;
|
|
310
|
+
/**
|
|
311
|
+
* OS the pool must run (`linux`, `darwin`). Empty accepts any.
|
|
312
|
+
*
|
|
313
|
+
* @generated from field: string os = 4;
|
|
314
|
+
*/
|
|
315
|
+
os: string;
|
|
316
|
+
/**
|
|
317
|
+
* Arch the pool must run (`amd64`, `arm64`). Empty accepts any.
|
|
318
|
+
*
|
|
319
|
+
* @generated from field: string arch = 5;
|
|
320
|
+
*/
|
|
321
|
+
arch: string;
|
|
322
|
+
};
|
|
323
|
+
/**
|
|
324
|
+
* Describes the message xeonr.pipelines.v1.RunsOn.
|
|
325
|
+
* Use `create(RunsOnSchema)` to create a new message.
|
|
326
|
+
*/
|
|
327
|
+
export declare const RunsOnSchema: GenMessage<RunsOn>;
|
|
328
|
+
/**
|
|
329
|
+
* SecretGrant asks for one secret, by name, for one node.
|
|
330
|
+
*
|
|
331
|
+
* @generated from message xeonr.pipelines.v1.SecretGrant
|
|
332
|
+
*/
|
|
333
|
+
export type SecretGrant = Message<"xeonr.pipelines.v1.SecretGrant"> & {
|
|
334
|
+
/**
|
|
335
|
+
* Name is the secret's name. A resource-scoped secret of the run's
|
|
336
|
+
* resource takes precedence over a tenant-wide one of the same name.
|
|
337
|
+
*
|
|
338
|
+
* @generated from field: string name = 1;
|
|
339
|
+
*/
|
|
340
|
+
name: string;
|
|
341
|
+
/**
|
|
342
|
+
* Type is how the step receives it. It must be the type the secret was
|
|
343
|
+
* stored with.
|
|
344
|
+
*
|
|
345
|
+
* @generated from field: xeonr.pipelines.v1.SecretType type = 2;
|
|
346
|
+
*/
|
|
347
|
+
type: SecretType;
|
|
348
|
+
/**
|
|
349
|
+
* Target is the environment variable that carries the value (ENV) or the
|
|
350
|
+
* file's path (FILE). Empty uses the secret's name.
|
|
351
|
+
*
|
|
352
|
+
* @generated from field: string target = 3;
|
|
353
|
+
*/
|
|
354
|
+
target: string;
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* Describes the message xeonr.pipelines.v1.SecretGrant.
|
|
358
|
+
* Use `create(SecretGrantSchema)` to create a new message.
|
|
359
|
+
*/
|
|
360
|
+
export declare const SecretGrantSchema: GenMessage<SecretGrant>;
|
|
361
|
+
/**
|
|
362
|
+
* ContinueOnError allows a node's failure.
|
|
363
|
+
*
|
|
364
|
+
* @generated from message xeonr.pipelines.v1.ContinueOnError
|
|
365
|
+
*/
|
|
366
|
+
export type ContinueOnError = Message<"xeonr.pipelines.v1.ContinueOnError"> & {
|
|
367
|
+
/**
|
|
368
|
+
* ExitCodes limits the allowance to these exit codes. Empty allows any
|
|
369
|
+
* failure of the node, whatever its class.
|
|
370
|
+
*
|
|
371
|
+
* @generated from field: repeated int32 exit_codes = 1;
|
|
372
|
+
*/
|
|
373
|
+
exitCodes: number[];
|
|
374
|
+
};
|
|
375
|
+
/**
|
|
376
|
+
* Describes the message xeonr.pipelines.v1.ContinueOnError.
|
|
377
|
+
* Use `create(ContinueOnErrorSchema)` to create a new message.
|
|
378
|
+
*/
|
|
379
|
+
export declare const ContinueOnErrorSchema: GenMessage<ContinueOnError>;
|
|
380
|
+
/**
|
|
381
|
+
* Retry is a node's retry policy. Retries are attempts of the same node and
|
|
382
|
+
* are invisible to the graph.
|
|
383
|
+
*
|
|
384
|
+
* @generated from message xeonr.pipelines.v1.Retry
|
|
385
|
+
*/
|
|
386
|
+
export type Retry = Message<"xeonr.pipelines.v1.Retry"> & {
|
|
387
|
+
/**
|
|
388
|
+
* Max is how many attempts may follow the first. Zero never retries, which
|
|
389
|
+
* is what a step with outside effects (a deploy, a migration) declares.
|
|
390
|
+
*
|
|
391
|
+
* @generated from field: uint32 max = 1;
|
|
392
|
+
*/
|
|
393
|
+
max: number;
|
|
394
|
+
/**
|
|
395
|
+
* When lists the failure classes that are retried. Empty is the platform's
|
|
396
|
+
* transient set. CANCELLED is never retried.
|
|
397
|
+
*
|
|
398
|
+
* @generated from field: repeated xeonr.pipelines.v1.FailureClass when = 2;
|
|
399
|
+
*/
|
|
400
|
+
when: FailureClass[];
|
|
401
|
+
/**
|
|
402
|
+
* Backoff spaces the retries. Unset is the platform default.
|
|
403
|
+
*
|
|
404
|
+
* @generated from field: xeonr.pipelines.v1.Backoff backoff = 3;
|
|
405
|
+
*/
|
|
406
|
+
backoff?: Backoff | undefined;
|
|
407
|
+
};
|
|
408
|
+
/**
|
|
409
|
+
* Describes the message xeonr.pipelines.v1.Retry.
|
|
410
|
+
* Use `create(RetrySchema)` to create a new message.
|
|
411
|
+
*/
|
|
412
|
+
export declare const RetrySchema: GenMessage<Retry>;
|
|
413
|
+
/**
|
|
414
|
+
* Backoff is exponential: the n-th retry waits initial * multiplier^(n-1),
|
|
415
|
+
* capped at max.
|
|
416
|
+
*
|
|
417
|
+
* @generated from message xeonr.pipelines.v1.Backoff
|
|
418
|
+
*/
|
|
419
|
+
export type Backoff = Message<"xeonr.pipelines.v1.Backoff"> & {
|
|
420
|
+
/**
|
|
421
|
+
* @generated from field: google.protobuf.Duration initial = 1;
|
|
422
|
+
*/
|
|
423
|
+
initial?: Duration | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* @generated from field: google.protobuf.Duration max = 2;
|
|
426
|
+
*/
|
|
427
|
+
max?: Duration | undefined;
|
|
428
|
+
/**
|
|
429
|
+
* Multiplier of at least 1; zero means 2.
|
|
430
|
+
*
|
|
431
|
+
* @generated from field: double multiplier = 3;
|
|
432
|
+
*/
|
|
433
|
+
multiplier: number;
|
|
434
|
+
};
|
|
435
|
+
/**
|
|
436
|
+
* Describes the message xeonr.pipelines.v1.Backoff.
|
|
437
|
+
* Use `create(BackoffSchema)` to create a new message.
|
|
438
|
+
*/
|
|
439
|
+
export declare const BackoffSchema: GenMessage<Backoff>;
|
|
440
|
+
/**
|
|
441
|
+
* Manual makes a node wait for a release. Who may release is the consuming
|
|
442
|
+
* product's decision: it calls ReleaseNode for a person or a standing
|
|
443
|
+
* grant. The wait is always bounded; this is not a way to park a run for
|
|
444
|
+
* good. Milestone 2.
|
|
445
|
+
*
|
|
446
|
+
* @generated from message xeonr.pipelines.v1.Manual
|
|
447
|
+
*/
|
|
448
|
+
export type Manual = Message<"xeonr.pipelines.v1.Manual"> & {
|
|
449
|
+
/**
|
|
450
|
+
* Wait is how long the node may stay WAITING_MANUAL.
|
|
451
|
+
*
|
|
452
|
+
* @generated from field: google.protobuf.Duration wait = 1;
|
|
453
|
+
*/
|
|
454
|
+
wait?: Duration | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* OnExpiry defaults to FAIL.
|
|
457
|
+
*
|
|
458
|
+
* @generated from field: xeonr.pipelines.v1.ManualExpiry on_expiry = 2;
|
|
459
|
+
*/
|
|
460
|
+
onExpiry: ManualExpiry;
|
|
461
|
+
};
|
|
462
|
+
/**
|
|
463
|
+
* Describes the message xeonr.pipelines.v1.Manual.
|
|
464
|
+
* Use `create(ManualSchema)` to create a new message.
|
|
465
|
+
*/
|
|
466
|
+
export declare const ManualSchema: GenMessage<Manual>;
|
|
467
|
+
/**
|
|
468
|
+
* Trigger starts a run for another resource. Milestone 2.
|
|
469
|
+
*
|
|
470
|
+
* The definition and the attested facts of the downstream run are NOT taken
|
|
471
|
+
* from here: a definition is untrusted, and facts are what secret policies
|
|
472
|
+
* and tiers are decided from. They come from the consuming product that owns
|
|
473
|
+
* the downstream resource; how the platform asks it is settled with the
|
|
474
|
+
* milestone 2 implementation. The downstream run's tier is the lower of its
|
|
475
|
+
* own and the triggering run's.
|
|
476
|
+
*
|
|
477
|
+
* @generated from message xeonr.pipelines.v1.Trigger
|
|
478
|
+
*/
|
|
479
|
+
export type Trigger = Message<"xeonr.pipelines.v1.Trigger"> & {
|
|
480
|
+
/**
|
|
481
|
+
* Resource is what the downstream run is about. Its tenant is the
|
|
482
|
+
* triggering run's.
|
|
483
|
+
*
|
|
484
|
+
* @generated from field: xeonr.pipelines.v1.ResourceRef resource = 1;
|
|
485
|
+
*/
|
|
486
|
+
resource?: ResourceRef | undefined;
|
|
487
|
+
/**
|
|
488
|
+
* Variables are passed to the downstream run. Values may be whole-value
|
|
489
|
+
* references.
|
|
490
|
+
*
|
|
491
|
+
* @generated from field: map<string, google.protobuf.Value> variables = 2;
|
|
492
|
+
*/
|
|
493
|
+
variables: {
|
|
494
|
+
[key: string]: Value;
|
|
495
|
+
};
|
|
496
|
+
/**
|
|
497
|
+
* Wait makes this node take the downstream run's result: it succeeds or
|
|
498
|
+
* fails (FAILURE_CLASS_DOWNSTREAM_FAILED) with it. When false the node
|
|
499
|
+
* succeeds as soon as the downstream run is accepted.
|
|
500
|
+
*
|
|
501
|
+
* validate:skip a bool has no bounds
|
|
502
|
+
*
|
|
503
|
+
* @generated from field: bool wait = 3;
|
|
504
|
+
*/
|
|
505
|
+
wait: boolean;
|
|
506
|
+
};
|
|
507
|
+
/**
|
|
508
|
+
* Describes the message xeonr.pipelines.v1.Trigger.
|
|
509
|
+
* Use `create(TriggerSchema)` to create a new message.
|
|
510
|
+
*/
|
|
511
|
+
export declare const TriggerSchema: GenMessage<Trigger>;
|
|
512
|
+
/**
|
|
513
|
+
* Service is a container that runs beside a step.
|
|
514
|
+
*
|
|
515
|
+
* @generated from message xeonr.pipelines.v1.Service
|
|
516
|
+
*/
|
|
517
|
+
export type Service = Message<"xeonr.pipelines.v1.Service"> & {
|
|
518
|
+
/**
|
|
519
|
+
* Image is an OCI reference. A tag is resolved to a digest when the
|
|
520
|
+
* snapshot is made, and the digest is what runs.
|
|
521
|
+
*
|
|
522
|
+
* @generated from field: string image = 1;
|
|
523
|
+
*/
|
|
524
|
+
image: string;
|
|
525
|
+
/**
|
|
526
|
+
* Alias is the hostname the step reaches the service by. The step is
|
|
527
|
+
* reachable from the service too.
|
|
528
|
+
*
|
|
529
|
+
* @generated from field: string alias = 2;
|
|
530
|
+
*/
|
|
531
|
+
alias: string;
|
|
532
|
+
/**
|
|
533
|
+
* Entrypoint overrides the image's; empty keeps it.
|
|
534
|
+
*
|
|
535
|
+
* @generated from field: repeated string entrypoint = 3;
|
|
536
|
+
*/
|
|
537
|
+
entrypoint: string[];
|
|
538
|
+
/**
|
|
539
|
+
* Command overrides the image's; empty keeps it.
|
|
540
|
+
*
|
|
541
|
+
* @generated from field: repeated string command = 4;
|
|
542
|
+
*/
|
|
543
|
+
command: string[];
|
|
544
|
+
/**
|
|
545
|
+
* Env is the service's environment. Values are literals: a service never
|
|
546
|
+
* receives a secret.
|
|
547
|
+
*
|
|
548
|
+
* @generated from field: map<string, string> env = 5;
|
|
549
|
+
*/
|
|
550
|
+
env: {
|
|
551
|
+
[key: string]: string;
|
|
552
|
+
};
|
|
553
|
+
};
|
|
554
|
+
/**
|
|
555
|
+
* Describes the message xeonr.pipelines.v1.Service.
|
|
556
|
+
* Use `create(ServiceSchema)` to create a new message.
|
|
557
|
+
*/
|
|
558
|
+
export declare const ServiceSchema: GenMessage<Service>;
|
|
559
|
+
/**
|
|
560
|
+
* Cache is a set of paths kept between runs. Caches are keyed and stored per
|
|
561
|
+
* tenant, resource and tier: an attempt reads and writes only the caches of
|
|
562
|
+
* its own tier, so a trusted or deploy attempt never reads one an untrusted
|
|
563
|
+
* attempt wrote. A saved key is immutable: the first writer wins. The runner
|
|
564
|
+
* restores and saves them through the private AttemptService (GetCache,
|
|
565
|
+
* CreateCache). Milestone 2.
|
|
566
|
+
*
|
|
567
|
+
* @generated from message xeonr.pipelines.v1.Cache
|
|
568
|
+
*/
|
|
569
|
+
export type Cache = Message<"xeonr.pipelines.v1.Cache"> & {
|
|
570
|
+
/**
|
|
571
|
+
* Key names the cache. With `key_files` set, the digest of those files is
|
|
572
|
+
* appended to it at run time, as `<key>-<hex SHA-256>`.
|
|
573
|
+
*
|
|
574
|
+
* @generated from field: string key = 1;
|
|
575
|
+
*/
|
|
576
|
+
key: string;
|
|
577
|
+
/**
|
|
578
|
+
* KeyFiles are paths in the work directory hashed into the key.
|
|
579
|
+
*
|
|
580
|
+
* @generated from field: repeated string key_files = 2;
|
|
581
|
+
*/
|
|
582
|
+
keyFiles: string[];
|
|
583
|
+
/**
|
|
584
|
+
* FallbackKeys are tried in order when the key misses.
|
|
585
|
+
*
|
|
586
|
+
* @generated from field: repeated string fallback_keys = 3;
|
|
587
|
+
*/
|
|
588
|
+
fallbackKeys: string[];
|
|
589
|
+
/**
|
|
590
|
+
* Paths are the directories and files cached, relative to the work
|
|
591
|
+
* directory.
|
|
592
|
+
*
|
|
593
|
+
* @generated from field: repeated string paths = 4;
|
|
594
|
+
*/
|
|
595
|
+
paths: string[];
|
|
596
|
+
/**
|
|
597
|
+
* Policy defaults to PULL_PUSH.
|
|
598
|
+
*
|
|
599
|
+
* @generated from field: xeonr.pipelines.v1.CachePolicy policy = 5;
|
|
600
|
+
*/
|
|
601
|
+
policy: CachePolicy;
|
|
602
|
+
/**
|
|
603
|
+
* SaveWhen defaults to SUCCESS.
|
|
604
|
+
*
|
|
605
|
+
* @generated from field: xeonr.pipelines.v1.CacheSaveWhen save_when = 6;
|
|
606
|
+
*/
|
|
607
|
+
saveWhen: CacheSaveWhen;
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* Describes the message xeonr.pipelines.v1.Cache.
|
|
611
|
+
* Use `create(CacheSchema)` to create a new message.
|
|
612
|
+
*/
|
|
613
|
+
export declare const CacheSchema: GenMessage<Cache>;
|
|
614
|
+
/**
|
|
615
|
+
* Artifact commits files matching path globs as a named blob output of the
|
|
616
|
+
* node, with an expiry. It is how a free-form step produces blobs without
|
|
617
|
+
* calling the platform. Milestone 2.
|
|
618
|
+
*
|
|
619
|
+
* @generated from message xeonr.pipelines.v1.Artifact
|
|
620
|
+
*/
|
|
621
|
+
export type Artifact = Message<"xeonr.pipelines.v1.Artifact"> & {
|
|
622
|
+
/**
|
|
623
|
+
* Name is the blob output's name, unique in the node. Downstream nodes
|
|
624
|
+
* read it as `${{ steps.<node>.outputs.blobs.<name> }}`.
|
|
625
|
+
*
|
|
626
|
+
* @generated from field: string name = 1;
|
|
627
|
+
*/
|
|
628
|
+
name: string;
|
|
629
|
+
/**
|
|
630
|
+
* Paths are globs relative to the work directory.
|
|
631
|
+
*
|
|
632
|
+
* @generated from field: repeated string paths = 2;
|
|
633
|
+
*/
|
|
634
|
+
paths: string[];
|
|
635
|
+
/**
|
|
636
|
+
* When defaults to SUCCESS.
|
|
637
|
+
*
|
|
638
|
+
* @generated from field: xeonr.pipelines.v1.ArtifactWhen when = 3;
|
|
639
|
+
*/
|
|
640
|
+
when: ArtifactWhen;
|
|
641
|
+
/**
|
|
642
|
+
* ExpireIn is how long the blob is kept after the run finishes. Unset is
|
|
643
|
+
* the platform's retention.
|
|
644
|
+
*
|
|
645
|
+
* @generated from field: google.protobuf.Duration expire_in = 4;
|
|
646
|
+
*/
|
|
647
|
+
expireIn?: Duration | undefined;
|
|
648
|
+
};
|
|
649
|
+
/**
|
|
650
|
+
* Describes the message xeonr.pipelines.v1.Artifact.
|
|
651
|
+
* Use `create(ArtifactSchema)` to create a new message.
|
|
652
|
+
*/
|
|
653
|
+
export declare const ArtifactSchema: GenMessage<Artifact>;
|
|
654
|
+
/**
|
|
655
|
+
* ManualExpiry is what becomes of a manual node nobody released in time.
|
|
656
|
+
*
|
|
657
|
+
* @generated from enum xeonr.pipelines.v1.ManualExpiry
|
|
658
|
+
*/
|
|
659
|
+
export declare enum ManualExpiry {
|
|
660
|
+
/**
|
|
661
|
+
* @generated from enum value: MANUAL_EXPIRY_UNSPECIFIED = 0;
|
|
662
|
+
*/
|
|
663
|
+
UNSPECIFIED = 0,
|
|
664
|
+
/**
|
|
665
|
+
* The node fails with FAILURE_CLASS_MANUAL_EXPIRED.
|
|
666
|
+
*
|
|
667
|
+
* @generated from enum value: MANUAL_EXPIRY_FAIL = 1;
|
|
668
|
+
*/
|
|
669
|
+
FAIL = 1,
|
|
670
|
+
/**
|
|
671
|
+
* The node is skipped, and its dependents with it.
|
|
672
|
+
*
|
|
673
|
+
* @generated from enum value: MANUAL_EXPIRY_SKIP = 2;
|
|
674
|
+
*/
|
|
675
|
+
SKIP = 2
|
|
676
|
+
}
|
|
677
|
+
/**
|
|
678
|
+
* Describes the enum xeonr.pipelines.v1.ManualExpiry.
|
|
679
|
+
*/
|
|
680
|
+
export declare const ManualExpirySchema: GenEnum<ManualExpiry>;
|
|
681
|
+
/**
|
|
682
|
+
* CachePolicy is what a node does with a cache.
|
|
683
|
+
*
|
|
684
|
+
* @generated from enum xeonr.pipelines.v1.CachePolicy
|
|
685
|
+
*/
|
|
686
|
+
export declare enum CachePolicy {
|
|
687
|
+
/**
|
|
688
|
+
* @generated from enum value: CACHE_POLICY_UNSPECIFIED = 0;
|
|
689
|
+
*/
|
|
690
|
+
UNSPECIFIED = 0,
|
|
691
|
+
/**
|
|
692
|
+
* Restore only.
|
|
693
|
+
*
|
|
694
|
+
* @generated from enum value: CACHE_POLICY_PULL = 1;
|
|
695
|
+
*/
|
|
696
|
+
PULL = 1,
|
|
697
|
+
/**
|
|
698
|
+
* Restore, then save.
|
|
699
|
+
*
|
|
700
|
+
* @generated from enum value: CACHE_POLICY_PULL_PUSH = 2;
|
|
701
|
+
*/
|
|
702
|
+
PULL_PUSH = 2
|
|
703
|
+
}
|
|
704
|
+
/**
|
|
705
|
+
* Describes the enum xeonr.pipelines.v1.CachePolicy.
|
|
706
|
+
*/
|
|
707
|
+
export declare const CachePolicySchema: GenEnum<CachePolicy>;
|
|
708
|
+
/**
|
|
709
|
+
* CacheSaveWhen is when a pull-push cache is saved.
|
|
710
|
+
*
|
|
711
|
+
* @generated from enum xeonr.pipelines.v1.CacheSaveWhen
|
|
712
|
+
*/
|
|
713
|
+
export declare enum CacheSaveWhen {
|
|
714
|
+
/**
|
|
715
|
+
* @generated from enum value: CACHE_SAVE_WHEN_UNSPECIFIED = 0;
|
|
716
|
+
*/
|
|
717
|
+
UNSPECIFIED = 0,
|
|
718
|
+
/**
|
|
719
|
+
* Only when the step succeeded.
|
|
720
|
+
*
|
|
721
|
+
* @generated from enum value: CACHE_SAVE_WHEN_SUCCESS = 1;
|
|
722
|
+
*/
|
|
723
|
+
SUCCESS = 1,
|
|
724
|
+
/**
|
|
725
|
+
* Whatever the step's result.
|
|
726
|
+
*
|
|
727
|
+
* @generated from enum value: CACHE_SAVE_WHEN_ALWAYS = 2;
|
|
728
|
+
*/
|
|
729
|
+
ALWAYS = 2
|
|
730
|
+
}
|
|
731
|
+
/**
|
|
732
|
+
* Describes the enum xeonr.pipelines.v1.CacheSaveWhen.
|
|
733
|
+
*/
|
|
734
|
+
export declare const CacheSaveWhenSchema: GenEnum<CacheSaveWhen>;
|
|
735
|
+
/**
|
|
736
|
+
* ArtifactWhen is which results of a step commit an artifact.
|
|
737
|
+
*
|
|
738
|
+
* @generated from enum xeonr.pipelines.v1.ArtifactWhen
|
|
739
|
+
*/
|
|
740
|
+
export declare enum ArtifactWhen {
|
|
741
|
+
/**
|
|
742
|
+
* @generated from enum value: ARTIFACT_WHEN_UNSPECIFIED = 0;
|
|
743
|
+
*/
|
|
744
|
+
UNSPECIFIED = 0,
|
|
745
|
+
/**
|
|
746
|
+
* @generated from enum value: ARTIFACT_WHEN_SUCCESS = 1;
|
|
747
|
+
*/
|
|
748
|
+
SUCCESS = 1,
|
|
749
|
+
/**
|
|
750
|
+
* @generated from enum value: ARTIFACT_WHEN_FAILURE = 2;
|
|
751
|
+
*/
|
|
752
|
+
FAILURE = 2,
|
|
753
|
+
/**
|
|
754
|
+
* @generated from enum value: ARTIFACT_WHEN_ALWAYS = 3;
|
|
755
|
+
*/
|
|
756
|
+
ALWAYS = 3
|
|
757
|
+
}
|
|
758
|
+
/**
|
|
759
|
+
* Describes the enum xeonr.pipelines.v1.ArtifactWhen.
|
|
760
|
+
*/
|
|
761
|
+
export declare const ArtifactWhenSchema: GenEnum<ArtifactWhen>;
|
|
762
|
+
//# sourceMappingURL=definition_pb.d.ts.map
|