@serve.zone/interfaces 32.44.0 → 32.46.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/changelog.md +57 -0
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/data/clusteringress.d.ts +37 -0
- package/dist_ts/data/clusteringress.js +43 -1
- package/dist_ts/data/index.d.ts +1 -0
- package/dist_ts/data/index.js +2 -1
- package/dist_ts/data/runtimeassignment.d.ts +24 -3
- package/dist_ts/data/runtimeassignment.js +19 -3
- package/dist_ts/data/serviceplatformownership.d.ts +55 -0
- package/dist_ts/data/serviceplatformownership.js +62 -0
- package/dist_ts/data/serviceruntime.d.ts +58 -1
- package/dist_ts/data/serviceruntime.js +45 -2
- package/dist_ts/requests/network.d.ts +76 -1
- package/package.json +4 -4
- package/readme.md +54 -2
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/data/clusteringress.ts +70 -0
- package/ts/data/index.ts +1 -0
- package/ts/data/runtimeassignment.ts +33 -5
- package/ts/data/serviceplatformownership.ts +95 -0
- package/ts/data/serviceruntime.ts +78 -1
- package/ts/requests/network.ts +65 -1
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { captureNetwork, networkCounter, networkId, networkRecord, requireNetwork } from '../private/networkcontract.js';
|
|
2
|
+
/**
|
|
3
|
+
* Every reason Cloudly answers instead of designating a service platform-owned or withdrawing the
|
|
4
|
+
* designation. Each travels by name as a `TypedResponseError`, and a refused request changes
|
|
5
|
+
* nothing.
|
|
6
|
+
*/
|
|
7
|
+
export const servicePlatformOwnershipRefusals = Object.freeze([
|
|
8
|
+
/** No service of that id belongs to the named organization. */
|
|
9
|
+
'service-unknown',
|
|
10
|
+
/** The service's deletion has begun; no new authority outlives it. */
|
|
11
|
+
'service-deleting',
|
|
12
|
+
/**
|
|
13
|
+
* The named organization is not a platform organization (`isPlatformOrganizationId`): an
|
|
14
|
+
* idp.global organization, whose owner keeps the authority over its runtime network policy, or an
|
|
15
|
+
* id that is no canonical identifier.
|
|
16
|
+
*/
|
|
17
|
+
'organization-not-platform',
|
|
18
|
+
/** Another write changed the service's designation first: read it again. */
|
|
19
|
+
'conflict',
|
|
20
|
+
]);
|
|
21
|
+
export const servicePlatformOwnershipContract = Object.freeze({
|
|
22
|
+
error: 'Service platform ownership contract rejected.',
|
|
23
|
+
});
|
|
24
|
+
/**
|
|
25
|
+
* Whether an organization id names a platform organization, the only kind whose service an
|
|
26
|
+
* administrator may designate platform-owned.
|
|
27
|
+
*
|
|
28
|
+
* Every organization Cloudly assigns outside idp.global is namespaced with `:` — a legacy service's
|
|
29
|
+
* own `legacy:Service:<id>`, a platform `Organization:<id>` — while idp.global names an
|
|
30
|
+
* organization by a 21-character nanoid in the URL alphabet (`A-Za-z0-9_-`), which never carries
|
|
31
|
+
* `:`. An id is a platform organization's exactly when it is a canonical identifier (an ASCII
|
|
32
|
+
* letter or digit, then up to 199 of letters, digits, `:`, `.`, `_` and `-`) and carries `:`.
|
|
33
|
+
* Everything else is not: an idp.global id, whichever character it starts with, and any value that
|
|
34
|
+
* is not a canonical identifier — empty, whitespace, a non-string. The answer fails closed: an id
|
|
35
|
+
* this rule cannot read never gains administrator authority.
|
|
36
|
+
*/
|
|
37
|
+
export const isPlatformOrganizationId = (organizationId) => {
|
|
38
|
+
try {
|
|
39
|
+
return networkId(organizationId).includes(':');
|
|
40
|
+
}
|
|
41
|
+
catch {
|
|
42
|
+
return false;
|
|
43
|
+
}
|
|
44
|
+
};
|
|
45
|
+
/** Detached exact-schema snapshot of a stored or answered designation. */
|
|
46
|
+
export const snapshotServicePlatformOwnership = (value) => {
|
|
47
|
+
try {
|
|
48
|
+
const item = networkRecord(captureNetwork(value), ['organizationId', 'serviceId', 'actorId', 'designatedAt']);
|
|
49
|
+
const organizationId = networkId(item.organizationId);
|
|
50
|
+
requireNetwork(isPlatformOrganizationId(organizationId));
|
|
51
|
+
return {
|
|
52
|
+
organizationId,
|
|
53
|
+
serviceId: networkId(item.serviceId),
|
|
54
|
+
actorId: networkId(item.actorId),
|
|
55
|
+
designatedAt: networkCounter(item.designatedAt),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
catch {
|
|
59
|
+
throw new Error(servicePlatformOwnershipContract.error);
|
|
60
|
+
}
|
|
61
|
+
};
|
|
62
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VydmljZXBsYXRmb3Jtb3duZXJzaGlwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9zZXJ2aWNlcGxhdGZvcm1vd25lcnNoaXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGNBQWMsRUFBRSxjQUFjLEVBQUUsU0FBUyxFQUFFLGFBQWEsRUFBRSxjQUFjLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQStCekg7Ozs7R0FJRztBQUNILE1BQU0sQ0FBQyxNQUFNLGdDQUFnQyxHQUFHLE1BQU0sQ0FBQyxNQUFNLENBQUM7SUFDNUQsK0RBQStEO0lBQy9ELGlCQUFpQjtJQUNqQixzRUFBc0U7SUFDdEUsa0JBQWtCO0lBQ2xCOzs7O09BSUc7SUFDSCwyQkFBMkI7SUFDM0IsNEVBQTRFO0lBQzVFLFVBQVU7Q0FDRixDQUFDLENBQUM7QUFLWixNQUFNLENBQUMsTUFBTSxnQ0FBZ0MsR0FBRyxNQUFNLENBQUMsTUFBTSxDQUFDO0lBQzVELEtBQUssRUFBRSwrQ0FBK0M7Q0FDOUMsQ0FBQyxDQUFDO0FBRVo7Ozs7Ozs7Ozs7OztHQVlHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sd0JBQXdCLEdBQUcsQ0FBQyxjQUFzQixFQUFXLEVBQUU7SUFDMUUsSUFBSSxDQUFDO1FBQ0gsT0FBTyxTQUFTLENBQUMsY0FBYyxDQUFDLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2pELENBQUM7SUFBQyxNQUFNLENBQUM7UUFDUCxPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7QUFDSCxDQUFDLENBQUM7QUFFRiwwRUFBMEU7QUFDMUUsTUFBTSxDQUFDLE1BQU0sZ0NBQWdDLEdBQUcsQ0FBQyxLQUFjLEVBQTZCLEVBQUU7SUFDNUYsSUFBSSxDQUFDO1FBQ0gsTUFBTSxJQUFJLEdBQUcsYUFBYSxDQUFDLGNBQWMsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLGdCQUFnQixFQUFFLFdBQVcsRUFBRSxTQUFTLEVBQUUsY0FBYyxDQUFDLENBQUMsQ0FBQztRQUM5RyxNQUFNLGNBQWMsR0FBRyxTQUFTLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQ3RELGNBQWMsQ0FBQyx3QkFBd0IsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDO1FBQ3pELE9BQU87WUFDTCxjQUFjO1lBQ2QsU0FBUyxFQUFFLFNBQVMsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDO1lBQ3BDLE9BQU8sRUFBRSxTQUFTLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztZQUNoQyxZQUFZLEVBQUUsY0FBYyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUM7U0FDaEQsQ0FBQztJQUNKLENBQUM7SUFBQyxNQUFNLENBQUM7UUFDUCxNQUFNLElBQUksS0FBSyxDQUFDLGdDQUFnQyxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzFELENBQUM7QUFDSCxDQUFDLENBQUMifQ==
|
|
@@ -73,7 +73,7 @@ export declare const serviceRuntimeContract: Readonly<{
|
|
|
73
73
|
readonly maximumAssignmentPageSize: 256;
|
|
74
74
|
}>;
|
|
75
75
|
declare const serviceRuntimeWaitingReasons: readonly ["node-network-pending", "conflict", "failure-backoff", "storage-import-pending", "bindings-pending", "legacy-adoption-pending", "objectstorage-retention-pending"];
|
|
76
|
-
declare const serviceRuntimeRefusals: readonly ["cluster-runtime-missing", "organization-missing", "image-plan-missing", "platform-unsupported", "secrets-unsupported", "volumes-unsupported", "port-protocol-unsupported", "ports-too-many", "readiness-target-undeclared", "environment-too-large", "no-eligible-node", "replica-limit", "node-authority-unsupported", "network-policy-missing", "network-policy-mismatch", "network-workload-pool-missing", "network-workload-pool-exhausted", "volume-driver-unsupported", "volume-options-unsupported", "volume-shared-unsupported", "volume-placement-unsupported", "volume-initialization-unknown", "volume-ownership-unknown", "objectstorage-endpoint-missing", "objectstorage-binding-invalid", "objectstorage-environment-conflict", "objectstorage-endpoint-unselected", "database-endpoint-missing", "database-endpoint-unselected", "published-port-reserved", "published-port-symmetric-without-egress"];
|
|
76
|
+
declare const serviceRuntimeRefusals: readonly ["cluster-runtime-missing", "organization-missing", "image-plan-missing", "platform-unsupported", "secrets-unsupported", "volumes-unsupported", "port-protocol-unsupported", "ports-too-many", "readiness-target-undeclared", "environment-too-large", "no-eligible-node", "replica-limit", "node-authority-unsupported", "network-policy-missing", "network-policy-mismatch", "network-workload-pool-missing", "network-workload-pool-exhausted", "volume-driver-unsupported", "volume-options-unsupported", "volume-shared-unsupported", "volume-placement-unsupported", "volume-initialization-unknown", "volume-ownership-unknown", "objectstorage-endpoint-missing", "objectstorage-binding-invalid", "objectstorage-environment-conflict", "objectstorage-endpoint-unselected", "database-endpoint-missing", "database-endpoint-unselected", "published-port-reserved", "published-port-symmetric-without-egress", "readiness-network-unsupported", "cluster-relay-missing", "cluster-ingress-environment-conflict"];
|
|
77
77
|
/**
|
|
78
78
|
* Why the producer is not converging yet, though nothing needs an administrator:
|
|
79
79
|
* `node-network-pending` waits for a node's network readiness, `conflict` for a sweep over inputs
|
|
@@ -137,6 +137,22 @@ export type TServiceRuntimeWaitingReason = typeof serviceRuntimeWaitingReasons[n
|
|
|
137
137
|
* which the handoff leases' `runtimeNetworkHandoffSnatPortRange` owns; a document written before
|
|
138
138
|
* that rule can hold one. `published-port-symmetric-without-egress` is a `symmetric` entry in a
|
|
139
139
|
* document whose `publicEgress` is false, which a projection endpoint refuses.
|
|
140
|
+
*
|
|
141
|
+
* `readiness-network-unsupported` is a spec whose network is `isolated` and whose readiness probe is
|
|
142
|
+
* `tcp` or `http`: an isolated workload has no address its node can dial, so the probe could never
|
|
143
|
+
* pass and the node refuses the run (`TRuntimeAssignmentFailureCause` `refused` for
|
|
144
|
+
* `unsupported-readiness`). `isServiceRuntimeReadinessReachable` is this rule; a producer answers
|
|
145
|
+
* what it returns. The spec snapshot still reads such a spec, so a stored one stays readable and
|
|
146
|
+
* is answered with this refusal rather than refused as data.
|
|
147
|
+
*
|
|
148
|
+
* The two `cluster-` refusals name why the environment of a cluster's designated ingress service
|
|
149
|
+
* cannot be composed (`composeClusterIngressEnvironment`); a service no designation names is never
|
|
150
|
+
* judged by them. `cluster-relay-missing` is a cluster that states no valid relay
|
|
151
|
+
* (`IClusterRelay`): the ingress registers through its relay's exact origin, so without one it has
|
|
152
|
+
* nothing to start with, and an administrator enables the relay (`enableClusterRelay`).
|
|
153
|
+
* `cluster-ingress-environment-conflict` is an ingress service whose own environment already sets
|
|
154
|
+
* one of `clusterIngressEnvironmentNames`: Cloudly owns those names, and a service value would
|
|
155
|
+
* otherwise silently replace Cloudly's or be replaced by it.
|
|
140
156
|
*/
|
|
141
157
|
export type TServiceRuntimeRefusal = typeof serviceRuntimeRefusals[number];
|
|
142
158
|
interface IServiceRuntimeStatusBase {
|
|
@@ -164,6 +180,32 @@ export type IServiceRuntimeStatus = IServiceRuntimeStatusBase & ({
|
|
|
164
180
|
* node admitted but has not yet reported on reads as undelivered.
|
|
165
181
|
*/
|
|
166
182
|
export type TServiceRuntimeAssignmentDelivery = 'undelivered' | 'delivered';
|
|
183
|
+
/**
|
|
184
|
+
* Why one dispatch of an assignment revision to its node ended as it did.
|
|
185
|
+
*
|
|
186
|
+
* The node holds the revision: `accepted`, `replay` or `historical` is what the node answered to
|
|
187
|
+
* the push, and `acknowledged` a revision the node's current session acknowledged before, answered
|
|
188
|
+
* from that acknowledgement without pushing it again.
|
|
189
|
+
*
|
|
190
|
+
* The node does not hold it from this dispatch: `node-busy` while the node already carries its limit
|
|
191
|
+
* of pushes in flight, `node-not-connected` while no live peer holds a session for the node,
|
|
192
|
+
* `session-moved` when the session the dispatch began on is no longer the node's current one,
|
|
193
|
+
* `intent-not-current` when the revision is no longer the one the controller wants on that node,
|
|
194
|
+
* `request-unbound` when the request does not bind to the session it would travel on,
|
|
195
|
+
* `node-refused` when the node (or the relay carrying it) answered the push with a refusal,
|
|
196
|
+
* `push-failed` when the push got no answer in time or its carrier failed, and
|
|
197
|
+
* `acknowledgement-unbound` when the answer names another revision.
|
|
198
|
+
*/
|
|
199
|
+
export declare const assignmentDispatchReasons: readonly ["accepted", "replay", "historical", "acknowledged", "node-busy", "node-not-connected", "session-moved", "intent-not-current", "request-unbound", "node-refused", "push-failed", "acknowledgement-unbound"];
|
|
200
|
+
export type TAssignmentDispatchReason = typeof assignmentDispatchReasons[number];
|
|
201
|
+
/** The last dispatch of a slot's current assignment, as the controller recorded it. Value-free. */
|
|
202
|
+
export interface IServiceRuntimeAssignmentDispatch {
|
|
203
|
+
/** Whether the node holds the revision after this dispatch. */
|
|
204
|
+
delivered: boolean;
|
|
205
|
+
reason: TAssignmentDispatchReason;
|
|
206
|
+
/** Unix milliseconds on the controller's clock when this dispatch ended. */
|
|
207
|
+
at: number;
|
|
208
|
+
}
|
|
167
209
|
/** One replica slot's current assignment, as an administrator reads it. */
|
|
168
210
|
export interface IServiceRuntimeAssignmentView {
|
|
169
211
|
serviceId: string;
|
|
@@ -180,12 +222,27 @@ export interface IServiceRuntimeAssignmentView {
|
|
|
180
222
|
/** Joined stop and remove receipts of this attempt. */
|
|
181
223
|
terminalReceiptCount: 0 | 1 | 2;
|
|
182
224
|
delivery: TServiceRuntimeAssignmentDelivery;
|
|
225
|
+
/**
|
|
226
|
+
* The last dispatch of the current revision while the controller still remembers one, null when
|
|
227
|
+
* it remembers none. Absent from a controller that does not report dispatches. Dispatch is the
|
|
228
|
+
* controller's push; `delivery` stays the node's own evidence.
|
|
229
|
+
*/
|
|
230
|
+
dispatch?: IServiceRuntimeAssignmentDispatch | null;
|
|
183
231
|
}
|
|
184
232
|
/**
|
|
185
233
|
* Structural snapshot for exact persistence and for a spec write. Whether the cluster, the nodes and
|
|
186
234
|
* the platform endpoints exist, and whether the service declares the readiness target, is Cloudly's.
|
|
187
235
|
*/
|
|
188
236
|
export declare const snapshotServiceRuntimeSpec: (value: unknown) => IServiceRuntimeSpec;
|
|
237
|
+
/**
|
|
238
|
+
* Whether a spec's readiness probe can reach its workload: false exactly for an `isolated` network
|
|
239
|
+
* with a `tcp` or `http` probe, which the producer answers as `readiness-network-unsupported`. The
|
|
240
|
+
* spec is read through `snapshotServiceRuntimeSpec`, so a value that is no spec is refused with its
|
|
241
|
+
* rejection rather than judged.
|
|
242
|
+
*/
|
|
243
|
+
export declare const isServiceRuntimeReadinessReachable: (value: unknown) => boolean;
|
|
244
|
+
/** Exactly a recorded dispatch of an assignment: a known reason and a positive Unix millisecond time. */
|
|
245
|
+
export declare const isServiceRuntimeAssignmentDispatch: (value: unknown) => value is IServiceRuntimeAssignmentDispatch;
|
|
189
246
|
/** Structural snapshot for exact persistence: a reason belongs to exactly one state. */
|
|
190
247
|
export declare const snapshotServiceRuntimeStatus: (value: unknown) => IServiceRuntimeStatus;
|
|
191
248
|
export {};
|
|
@@ -28,7 +28,29 @@ const serviceRuntimeRefusals = [
|
|
|
28
28
|
'volume-placement-unsupported', 'volume-initialization-unknown', 'volume-ownership-unknown',
|
|
29
29
|
'objectstorage-endpoint-missing', 'objectstorage-binding-invalid', 'objectstorage-environment-conflict',
|
|
30
30
|
'objectstorage-endpoint-unselected', 'database-endpoint-missing', 'database-endpoint-unselected',
|
|
31
|
-
'published-port-reserved', 'published-port-symmetric-without-egress',
|
|
31
|
+
'published-port-reserved', 'published-port-symmetric-without-egress', 'readiness-network-unsupported',
|
|
32
|
+
'cluster-relay-missing', 'cluster-ingress-environment-conflict',
|
|
33
|
+
];
|
|
34
|
+
/**
|
|
35
|
+
* Why one dispatch of an assignment revision to its node ended as it did.
|
|
36
|
+
*
|
|
37
|
+
* The node holds the revision: `accepted`, `replay` or `historical` is what the node answered to
|
|
38
|
+
* the push, and `acknowledged` a revision the node's current session acknowledged before, answered
|
|
39
|
+
* from that acknowledgement without pushing it again.
|
|
40
|
+
*
|
|
41
|
+
* The node does not hold it from this dispatch: `node-busy` while the node already carries its limit
|
|
42
|
+
* of pushes in flight, `node-not-connected` while no live peer holds a session for the node,
|
|
43
|
+
* `session-moved` when the session the dispatch began on is no longer the node's current one,
|
|
44
|
+
* `intent-not-current` when the revision is no longer the one the controller wants on that node,
|
|
45
|
+
* `request-unbound` when the request does not bind to the session it would travel on,
|
|
46
|
+
* `node-refused` when the node (or the relay carrying it) answered the push with a refusal,
|
|
47
|
+
* `push-failed` when the push got no answer in time or its carrier failed, and
|
|
48
|
+
* `acknowledgement-unbound` when the answer names another revision.
|
|
49
|
+
*/
|
|
50
|
+
export const assignmentDispatchReasons = [
|
|
51
|
+
'accepted', 'replay', 'historical', 'acknowledged',
|
|
52
|
+
'node-busy', 'node-not-connected', 'session-moved', 'intent-not-current', 'request-unbound', 'node-refused',
|
|
53
|
+
'push-failed', 'acknowledgement-unbound',
|
|
32
54
|
];
|
|
33
55
|
/** Sorted, duplicate-free and read by the vocabulary the ids belong to: a node's, or the canonical one. */
|
|
34
56
|
const sortedIds = (value, maximum, read) => networkSorted(networkList(value, maximum, read), id => id);
|
|
@@ -86,6 +108,27 @@ export const snapshotServiceRuntimeSpec = (value) => producerSafe(() => {
|
|
|
86
108
|
placement: placementOf(item.placement), replicasPerNode: item.replicasPerNode, hold: item.hold,
|
|
87
109
|
profile: profileOf(item.profile), network: networkOf(item.network), revision: networkCounter(item.revision) };
|
|
88
110
|
});
|
|
111
|
+
/**
|
|
112
|
+
* Whether a spec's readiness probe can reach its workload: false exactly for an `isolated` network
|
|
113
|
+
* with a `tcp` or `http` probe, which the producer answers as `readiness-network-unsupported`. The
|
|
114
|
+
* spec is read through `snapshotServiceRuntimeSpec`, so a value that is no spec is refused with its
|
|
115
|
+
* rejection rather than judged.
|
|
116
|
+
*/
|
|
117
|
+
export const isServiceRuntimeReadinessReachable = (value) => {
|
|
118
|
+
const { profile, network } = snapshotServiceRuntimeSpec(value);
|
|
119
|
+
return network.mode === 'attached' || profile.readiness.kind === 'process';
|
|
120
|
+
};
|
|
121
|
+
/** Exactly a recorded dispatch of an assignment: a known reason and a positive Unix millisecond time. */
|
|
122
|
+
export const isServiceRuntimeAssignmentDispatch = (value) => {
|
|
123
|
+
try {
|
|
124
|
+
const item = networkRecord(captureNetwork(value), ['delivered', 'reason', 'at']);
|
|
125
|
+
networkCounter(item.at);
|
|
126
|
+
return typeof item.delivered === 'boolean' && isOneOf(assignmentDispatchReasons, item.reason);
|
|
127
|
+
}
|
|
128
|
+
catch {
|
|
129
|
+
return false;
|
|
130
|
+
}
|
|
131
|
+
};
|
|
89
132
|
/** Structural snapshot for exact persistence: a reason belongs to exactly one state. */
|
|
90
133
|
export const snapshotServiceRuntimeStatus = (value) => producerSafe(() => {
|
|
91
134
|
const item = networkRecord(captureNetwork(value), ['id', 'specRevision', 'state', 'reason', 'changedAt']);
|
|
@@ -102,4 +145,4 @@ export const snapshotServiceRuntimeStatus = (value) => producerSafe(() => {
|
|
|
102
145
|
requireNetwork(item.state === 'refused' && isOneOf(serviceRuntimeRefusals, item.reason));
|
|
103
146
|
return { ...base, state: item.state, reason: item.reason };
|
|
104
147
|
});
|
|
105
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
148
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"serviceruntime.js","sourceRoot":"","sources":["../../ts/data/serviceruntime.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,+BAA+B,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAC5H,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAChG,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,kBAAkB,EAChH,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAyD5D,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC;IAClD,sBAAsB,EAAE,EAAE;IAC1B,+FAA+F;IAC/F,eAAe,EAAE,EAAE;IACnB,oHAAoH;IACpH,kBAAkB,EAAE,+BAA+B,CAAC,wBAAwB;IAC5E,wBAAwB,EAAE,+BAA+B,CAAC,wBAAwB;IAClF,0FAA0F;IAC1F,mBAAmB,EAAE,GAAG;IACxB,gGAAgG;IAChG,yBAAyB,EAAE,GAAG;CACtB,CAAC,CAAC;AAEZ,MAAM,4BAA4B,GAAG;IACnC,sBAAsB,EAAE,UAAU,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,kBAAkB;IACnG,yBAAyB,EAAE,iCAAiC;CACpD,CAAC;AACX,MAAM,sBAAsB,GAAG;IAC7B,yBAAyB,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,sBAAsB;IAC/F,qBAAqB,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,gBAAgB;IAC3F,6BAA6B,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,eAAe;IAC3F,4BAA4B,EAAE,wBAAwB,EAAE,yBAAyB;IACjF,+BAA+B,EAAE,iCAAiC;IAClE,2BAA2B,EAAE,4BAA4B,EAAE,2BAA2B;IACtF,8BAA8B,EAAE,+BAA+B,EAAE,0BAA0B;IAC3F,gCAAgC,EAAE,+BAA+B,EAAE,oCAAoC;IACvG,mCAAmC,EAAE,2BAA2B,EAAE,8BAA8B;IAChG,yBAAyB,EAAE,yCAAyC,EAAE,+BAA+B;IACrG,uBAAuB,EAAE,sCAAsC;CACvD,CAAC;AA4GX;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc;IAClD,WAAW,EAAE,oBAAoB,EAAE,eAAe,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,cAAc;IAC3G,aAAa,EAAE,yBAAyB;CAChC,CAAC;AAoCX,2GAA2G;AAC3G,MAAM,SAAS,GAAG,CAAC,KAAc,EAAE,OAAe,EAAE,IAA+B,EAAY,EAAE,CAC/F,aAAa,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AAE7D,MAAM,WAAW,GAAG,CAAC,KAAc,EAA4B,EAAE;IAC/D,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACtC,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;QAC1B,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/B,OAAO,EAAE,IAAI,EAAE,CAAC;IAClB,CAAC;IACD,cAAc,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;IACjC,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,sBAAsB,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IACvI,cAAc,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACnC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAc,EAAmC,EAAE;IAClE,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACrD,cAAc,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1F,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAc,EAA0B,EAAE;IAC3D,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;IAChH,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC;WACtF,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC;IAChF,4GAA4G;IAC5G,sBAAsB,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACjE,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;IAC1E,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW;QAC/D,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAA4B;QAClF,IAAI,EAAE,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,WAAW,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;AACrI,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,KAAc,EAA0B,EAAE;IAC3D,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACtC,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/B,OAAO,EAAE,IAAI,EAAE,CAAC;IAClB,CAAC;IACD,cAAc,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,qBAAqB,CAAC,CAAC,CAAC;IACnF,cAAc,CAAC,OAAO,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;IACvD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY;QAC5C,mBAAmB,EAAE,SAAS,CAAC,IAAI,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,wBAAwB,EAAE,SAAS,CAAC,EAAE,CAAC;AAC3H,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,KAAc,EAAuB,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE;IACnG,MAAM,IAAI,GAAG,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,WAAW,EAAE,WAAW;QACjG,iBAAiB,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IAChE,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,EAAE,sBAAsB,CAAC,sBAAsB,CAAC;WAClG,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACrC,OAAO,EAAE,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,cAAc,EAAE,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC;QACnH,SAAS,EAAE,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI;QAC9F,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;AAClH,CAAC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,KAAc,EAAW,EAAE;IAC5E,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;IAC/D,OAAO,OAAO,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC;AAC7E,CAAC,CAAC;AAEF,yGAAyG;AACzG,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,KAAc,EAA8C,EAAE;IAC/G,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;QACjF,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxB,OAAO,OAAO,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,yBAAyB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChG,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,wFAAwF;AACxF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,KAAc,EAAyB,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE;IACvG,MAAM,IAAI,GAAG,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;IAC1G,MAAM,IAAI,GAA8B,EAAE,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,YAAY,EAAE,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC;QAC/G,SAAS,EAAE,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;IAC9C,IAAI,IAAI,CAAC,KAAK,KAAK,WAAW,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;QAC9D,cAAc,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;QACrC,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACtD,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC7B,cAAc,CAAC,OAAO,CAAC,4BAA4B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACnE,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IAC7D,CAAC;IACD,cAAc,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACzF,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;AAC7D,CAAC,CAAC,CAAC"}
|
|
@@ -4,6 +4,7 @@ import type { IRuntimeNetworkAddressPlan, TRuntimeNetworkAddressPlanWritableData
|
|
|
4
4
|
import type { IRuntimeNetworkNodeReadiness, IRuntimeRouterIncarnation } from '../data/networknode.js';
|
|
5
5
|
import type { IPrivateNetwork, IServicePrivateNetworks, ISetServicePrivateNetworks, TPrivateNetworkMutation } from '../data/privatenetwork.js';
|
|
6
6
|
import type { IServiceNetworkEgress, IServicePublishedPorts, ISetServiceNetworkEgress, ISetServicePublishedPorts } from '../data/networkprojection.js';
|
|
7
|
+
import type { IServicePlatformOwnership } from '../data/serviceplatformownership.js';
|
|
7
8
|
/** Current organization picker data. Entries are never cached authorization grants. */
|
|
8
9
|
export interface IReq_Cloudly_ListOwnedOrganizations extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_ListOwnedOrganizations> {
|
|
9
10
|
method: 'listOwnedOrganizations';
|
|
@@ -97,7 +98,14 @@ export interface IReq_Cloudly_SetServicePrivateNetworks extends plugins.typedreq
|
|
|
97
98
|
replayed: boolean;
|
|
98
99
|
};
|
|
99
100
|
}
|
|
100
|
-
/**
|
|
101
|
+
/**
|
|
102
|
+
* null means the service has never had a policy document, neither published ports nor egress.
|
|
103
|
+
*
|
|
104
|
+
* The authority follows the service (`IServicePlatformOwnership`): a platform-owned service is read
|
|
105
|
+
* by a verified administrator, every other service by a federated sign-in holding the named
|
|
106
|
+
* organization's freshly introspected `owner` role. A caller without that authority, or naming no
|
|
107
|
+
* such service, is answered one denial text, whichever it is.
|
|
108
|
+
*/
|
|
101
109
|
export interface IReq_Cloudly_GetServicePublishedPorts extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_GetServicePublishedPorts> {
|
|
102
110
|
method: 'getServicePublishedPorts';
|
|
103
111
|
request: {
|
|
@@ -119,6 +127,15 @@ export interface IReq_Cloudly_GetServicePublishedPorts extends plugins.typedrequ
|
|
|
119
127
|
* attached spec stating `publicEgress: false` and `platformEndpointIds: []` matches it and reaches
|
|
120
128
|
* no public address and no platform endpoint; `network-policy-missing` means the service has no
|
|
121
129
|
* document at all.
|
|
130
|
+
*
|
|
131
|
+
* The authority follows the service (`IServicePlatformOwnership`): a platform-owned service is
|
|
132
|
+
* written by a verified administrator, every other service by a federated sign-in holding the named
|
|
133
|
+
* organization's freshly introspected `owner` role, and an administrator does not substitute for
|
|
134
|
+
* that owner. A caller without that authority, or naming no such service, is answered one denial
|
|
135
|
+
* text, whichever it is. A designation that changes while the write is staged refuses it as the
|
|
136
|
+
* policy write's own `conflict`, the refusal a stale `expectedRevision` is also answered (read the
|
|
137
|
+
* document and the authority again); it is a service network policy refusal, not one of
|
|
138
|
+
* `servicePlatformOwnershipRefusals`.
|
|
122
139
|
*/
|
|
123
140
|
export interface IReq_Cloudly_SetServicePublishedPorts extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Cloudly_SetServicePublishedPorts> {
|
|
124
141
|
method: 'setServicePublishedPorts';
|
|
@@ -183,6 +200,64 @@ export interface IReq_Admin_Cloudly_SetServiceNetworkEgress extends plugins.type
|
|
|
183
200
|
replayed: boolean;
|
|
184
201
|
};
|
|
185
202
|
}
|
|
203
|
+
/**
|
|
204
|
+
* Designates one service platform-owned (`IServicePlatformOwnership`), so that a verified
|
|
205
|
+
* administrator, and no organization owner, holds the authority over its published ports.
|
|
206
|
+
*
|
|
207
|
+
* Only a verified administrator calls it. Cloudly designates only a service of a platform
|
|
208
|
+
* organization (`isPlatformOrganizationId`: a canonical identifier carrying `:`, such as
|
|
209
|
+
* `legacy:Service:<id>` or `Organization:<id>`) and refuses every other organization id, an
|
|
210
|
+
* idp.global one or one that is no canonical identifier, as `organization-not-platform` before it
|
|
211
|
+
* reads the service. It refuses a service that is not the named organization's (`service-unknown`)
|
|
212
|
+
* and a deleting one (`service-deleting`); refusals are `servicePlatformOwnershipRefusals`. A
|
|
213
|
+
* service already designated answers its stored designation unchanged with `changed: false`.
|
|
214
|
+
*/
|
|
215
|
+
export interface IReq_Admin_Cloudly_DesignatePlatformOwnedService extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_Cloudly_DesignatePlatformOwnedService> {
|
|
216
|
+
method: 'designatePlatformOwnedService';
|
|
217
|
+
request: {
|
|
218
|
+
identity: IIdentityCredential;
|
|
219
|
+
organizationId: string;
|
|
220
|
+
serviceId: string;
|
|
221
|
+
};
|
|
222
|
+
response: {
|
|
223
|
+
platformOwnership: IServicePlatformOwnership;
|
|
224
|
+
changed: boolean;
|
|
225
|
+
};
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Withdraws a service's platform-owned designation; its published ports stay as they are, and from
|
|
229
|
+
* then on the organization-owner rule governs them. A designated service is always a platform
|
|
230
|
+
* organization's, which has no idp.global owner, so after the withdrawal nobody writes or reads its
|
|
231
|
+
* published ports until an administrator designates it again: the authority fails closed.
|
|
232
|
+
*
|
|
233
|
+
* Only a verified administrator calls it. Refusals are `service-unknown` and `conflict`; a service
|
|
234
|
+
* without a designation answers `changed: false`.
|
|
235
|
+
*/
|
|
236
|
+
export interface IReq_Admin_Cloudly_UndesignatePlatformOwnedService extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_Cloudly_UndesignatePlatformOwnedService> {
|
|
237
|
+
method: 'undesignatePlatformOwnedService';
|
|
238
|
+
request: {
|
|
239
|
+
identity: IIdentityCredential;
|
|
240
|
+
organizationId: string;
|
|
241
|
+
serviceId: string;
|
|
242
|
+
};
|
|
243
|
+
response: {
|
|
244
|
+
platformOwnership: null;
|
|
245
|
+
changed: boolean;
|
|
246
|
+
};
|
|
247
|
+
}
|
|
248
|
+
/** The service's platform-owned designation, or null when it has none. Only a verified administrator reads it. */
|
|
249
|
+
export interface IReq_Admin_Cloudly_GetServicePlatformOwnership extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_Admin_Cloudly_GetServicePlatformOwnership> {
|
|
250
|
+
method: 'getServicePlatformOwnership';
|
|
251
|
+
/** Refused `service-unknown` when no service of that id belongs to the named organization. */
|
|
252
|
+
request: {
|
|
253
|
+
identity: IIdentityCredential;
|
|
254
|
+
organizationId: string;
|
|
255
|
+
serviceId: string;
|
|
256
|
+
};
|
|
257
|
+
response: {
|
|
258
|
+
platformOwnership: IServicePlatformOwnership | null;
|
|
259
|
+
};
|
|
260
|
+
}
|
|
186
261
|
export interface IRequest_Any_Cloudly_GetNetworkNodes {
|
|
187
262
|
method: 'getNetworkNodes';
|
|
188
263
|
request: {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@serve.zone/interfaces",
|
|
3
|
-
"version": "32.
|
|
3
|
+
"version": "32.46.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.",
|
|
6
6
|
"exports": {
|
|
@@ -28,10 +28,10 @@
|
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@git.zone/tsbuild": "^5.1.2",
|
|
31
|
-
"@git.zone/tsdoc": "^3.0.
|
|
31
|
+
"@git.zone/tsdoc": "^3.0.2",
|
|
32
32
|
"@git.zone/tsrun": "^3.0.2",
|
|
33
|
-
"@git.zone/tstest": "
|
|
34
|
-
"@types/node": "26.6.
|
|
33
|
+
"@git.zone/tstest": "^7.1.0",
|
|
34
|
+
"@types/node": "26.6.3"
|
|
35
35
|
},
|
|
36
36
|
"files": [
|
|
37
37
|
"ts/**/*",
|
package/readme.md
CHANGED
|
@@ -515,6 +515,34 @@ list is a valid policy meaning the service publishes nothing. Callers never supp
|
|
|
515
515
|
from the accepted policy revision and digest, and node-level host-port placement
|
|
516
516
|
stays Cloudly's decision.
|
|
517
517
|
|
|
518
|
+
Who authors a service's published ports follows the service. A service of an
|
|
519
|
+
idp.global organization is that organization's: only a federated sign-in holding
|
|
520
|
+
its freshly introspected `owner` role reads and writes them, and an
|
|
521
|
+
infrastructure administrator does not substitute for it. A platform-owned
|
|
522
|
+
service (`data.IServicePlatformOwnership`: `organizationId`, `serviceId`, the
|
|
523
|
+
designating administrator's `actorId`, `designatedAt`) belongs to no idp.global
|
|
524
|
+
organization, such as the cluster ingress or a platform call router; only a
|
|
525
|
+
verified administrator reads and writes its published ports, as only an
|
|
526
|
+
administrator writes its egress. An administrator designates such a service
|
|
527
|
+
with `designatePlatformOwnedService`, withdraws it with
|
|
528
|
+
`undesignatePlatformOwnedService` and reads it with `getServicePlatformOwnership`
|
|
529
|
+
(`requests.network.IReq_Admin_Cloudly_DesignatePlatformOwnedService`,
|
|
530
|
+
`IReq_Admin_Cloudly_UndesignatePlatformOwnedService`,
|
|
531
|
+
`IReq_Admin_Cloudly_GetServicePlatformOwnership`). Only a platform
|
|
532
|
+
organization's service is designated: `data.isPlatformOrganizationId` is true
|
|
533
|
+
exactly for a canonical identifier that carries `:` (`legacy:Service:<id>`,
|
|
534
|
+
`Organization:<id>`), and false for an idp.global nanoid, whichever character it
|
|
535
|
+
starts with, and for any value that is not a canonical identifier, such as an
|
|
536
|
+
empty or whitespace id. Cloudly refuses every other id as
|
|
537
|
+
`organization-not-platform`, and further designation refusals are
|
|
538
|
+
`service-unknown`, `service-deleting` and `conflict`
|
|
539
|
+
(`data.servicePlatformOwnershipRefusals`). The designation grants no port, egress
|
|
540
|
+
or placement by itself. Withdrawing it leaves the service's published ports as
|
|
541
|
+
they are with no writer, because a platform organization has no idp.global
|
|
542
|
+
owner, until an administrator designates the service again. A published-port
|
|
543
|
+
write staged while the designation changes is refused as the policy write's
|
|
544
|
+
`conflict`.
|
|
545
|
+
|
|
518
546
|
A published entry with `hostPortEnd` publishes every port from `hostPort` to
|
|
519
547
|
`hostPortEnd` inclusive, each to the same port inside the workload, so its
|
|
520
548
|
`targetPort` equals `hostPort` and a one-port range is written without the member.
|
|
@@ -1878,7 +1906,8 @@ evidence has not arrived). `refused` carries a `TServiceRuntimeRefusal`:
|
|
|
1878
1906
|
`volume-options-unsupported`, `volume-shared-unsupported`, `volume-placement-unsupported`,
|
|
1879
1907
|
`volume-initialization-unknown`, `volume-ownership-unknown`, `objectstorage-endpoint-missing`,
|
|
1880
1908
|
`objectstorage-binding-invalid`, `objectstorage-environment-conflict`,
|
|
1881
|
-
`objectstorage-endpoint-unselected`, `database-endpoint-missing
|
|
1909
|
+
`objectstorage-endpoint-unselected`, `database-endpoint-missing`, `database-endpoint-unselected`,
|
|
1910
|
+
`cluster-relay-missing` or `cluster-ingress-environment-conflict`.
|
|
1882
1911
|
The first four volume
|
|
1883
1912
|
refusals name what a local storage claim cannot express: a volume driver other than a node-local
|
|
1884
1913
|
directory, driver or mount options, one volume mounted by more than one replica or service, and a
|
|
@@ -1888,7 +1917,12 @@ refusals, `objectstorage-endpoint-missing`, `objectstorage-binding-invalid` and
|
|
|
1888
1917
|
`objectstorage-environment-conflict` name why a binding's environment cannot be composed, see
|
|
1889
1918
|
[Object-Storage Binding Environment](#object-storage-binding-environment), and
|
|
1890
1919
|
`objectstorage-endpoint-unselected`, like `database-endpoint-unselected`, names an endpoint the
|
|
1891
|
-
workload's network does not select (below).
|
|
1920
|
+
workload's network does not select (below). The two `cluster-` refusals concern only a cluster's
|
|
1921
|
+
designated ingress service, whose environment `composeClusterIngressEnvironment` composes, see
|
|
1922
|
+
[Cluster Ingress](#cluster-ingress): `cluster-relay-missing` is a cluster that states no valid
|
|
1923
|
+
relay, which an administrator enables with `enableClusterRelay`, and
|
|
1924
|
+
`cluster-ingress-environment-conflict` an ingress service whose own environment already sets one of
|
|
1925
|
+
`clusterIngressEnvironmentNames`. `ports-too-many` is a service declaring more target ports than the
|
|
1892
1926
|
`runtimeConfigContract.maximumTargetPorts` (64) a config carries, where `port-protocol-unsupported`
|
|
1893
1927
|
is about one port's protocol; `node-authority-unsupported` is a node whose session resolved fewer
|
|
1894
1928
|
workload authorities than the spec needs, refused at the admit step rather than handed to a node
|
|
@@ -3217,6 +3251,24 @@ already applied and ignores a hint that is not newer, so a lost or repeated hint
|
|
|
3217
3251
|
`SERVEZONE_CLUSTER_RELAY_ORIGIN` (the exact `IClusterRelay.origin`) and `SERVEZONE_CLUSTER_NODE_ID`
|
|
3218
3252
|
(the node the assignment runs on). Cloudly writes them; the ingress reads them.
|
|
3219
3253
|
|
|
3254
|
+
`composeClusterIngressEnvironment(serviceEnvironment, { relayOrigin, nodeId })` is how Cloudly
|
|
3255
|
+
writes the two non-secret names for one replica of the designated ingress service: the service's
|
|
3256
|
+
own environment with `SERVEZONE_CLUSTER_RELAY_ORIGIN` and `SERVEZONE_CLUSTER_NODE_ID` added
|
|
3257
|
+
(`IClusterIngressLaunchFacts`; `relayOrigin` is the cluster's `IClusterRelay.origin` or `null`,
|
|
3258
|
+
`nodeId` the node the replica's assignment runs on). The bearer is not added: it reaches the
|
|
3259
|
+
workload through its secret manifest. The answer is a `TClusterIngressEnvironmentComposition`:
|
|
3260
|
+
|
|
3261
|
+
| `status` | `reason` | When |
|
|
3262
|
+
| --- | --- | --- |
|
|
3263
|
+
| `composed` | — | `environment` is the service's own with both names added. |
|
|
3264
|
+
| `refused` | `cluster-relay-missing` | `relayOrigin` is `null` or `validateClusterRelay` refuses it. Answered first. |
|
|
3265
|
+
| `refused` | `cluster-ingress-environment-conflict` | The service's own environment already sets one of the three names; the message names every such key and no value. |
|
|
3266
|
+
|
|
3267
|
+
`refused` carries the contract's `message`, and both reasons are `TClusterIngressEnvironmentRefusal`,
|
|
3268
|
+
members of `TServiceRuntimeRefusal`. A `nodeId` that is not a node id is the caller's error and is
|
|
3269
|
+
thrown. Both values are part of what the replica runs, so a moved relay or another node is another
|
|
3270
|
+
environment. The inputs are not changed.
|
|
3271
|
+
|
|
3220
3272
|
A cluster born on Pallet has no cutover scope, census or target set, so its ingress is designated by
|
|
3221
3273
|
`IClusterIngressDesignation { id, generation, previous, clusterId, runtime, ingressServiceId,
|
|
3222
3274
|
preparedSpecRevision, credential, actorId, acceptedAt, digest }` instead of the fleet-cutover
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -3,6 +3,8 @@ import { isUtcCalendarDay } from '../private/utccalendarday.js';
|
|
|
3
3
|
import { validateProtocolOfferOn } from '../protocol.js';
|
|
4
4
|
import { hasExactKeys, readExactDataRecord } from '../private/dataproperties.js';
|
|
5
5
|
import { isClusterNodeId } from '../private/nodeidentifier.js';
|
|
6
|
+
import { validateClusterRelay } from './cluster.js';
|
|
7
|
+
import type { TServiceRuntimeRefusal } from './serviceruntime.js';
|
|
6
8
|
|
|
7
9
|
/**
|
|
8
10
|
* The cluster ingress contracts.
|
|
@@ -440,6 +442,74 @@ export const clusterIngressEnvironmentNames = Object.freeze({
|
|
|
440
442
|
nodeId: 'SERVEZONE_CLUSTER_NODE_ID',
|
|
441
443
|
} as const);
|
|
442
444
|
|
|
445
|
+
/**
|
|
446
|
+
* The service runtime refusals the ingress environment reports: `cluster-relay-missing`, a cluster
|
|
447
|
+
* that states no valid relay, and `cluster-ingress-environment-conflict`, a service environment
|
|
448
|
+
* that already sets one of `clusterIngressEnvironmentNames`.
|
|
449
|
+
*/
|
|
450
|
+
export type TClusterIngressEnvironmentRefusal = Extract<
|
|
451
|
+
TServiceRuntimeRefusal,
|
|
452
|
+
'cluster-relay-missing' | 'cluster-ingress-environment-conflict'
|
|
453
|
+
>;
|
|
454
|
+
|
|
455
|
+
/** What the designated ingress service runs with, or the one reason it cannot be composed. */
|
|
456
|
+
export type TClusterIngressEnvironmentComposition =
|
|
457
|
+
| { status: 'composed'; environment: Record<string, string> }
|
|
458
|
+
| { status: 'refused'; reason: TClusterIngressEnvironmentRefusal; message: string };
|
|
459
|
+
|
|
460
|
+
/** The facts Cloudly states about one replica of the designated ingress service. */
|
|
461
|
+
export interface IClusterIngressLaunchFacts {
|
|
462
|
+
/** The cluster's `IClusterRelay.origin`, or `null` when the cluster states no relay. */
|
|
463
|
+
relayOrigin: string | null;
|
|
464
|
+
/** The node the replica's assignment runs on. */
|
|
465
|
+
nodeId: string;
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* The environment one replica of a cluster's designated ingress service runs with: the service's
|
|
470
|
+
* own values with `relayOrigin` and `nodeId` added under their `clusterIngressEnvironmentNames`.
|
|
471
|
+
*
|
|
472
|
+
* The bearer is not added here: it is a secret and reaches the workload through its secret manifest.
|
|
473
|
+
* Its name is still Cloudly's, so a service environment that sets any of the three names is
|
|
474
|
+
* refused `cluster-ingress-environment-conflict`, naming every such key and none of their values,
|
|
475
|
+
* rather than having one value silently replace another. A relay origin that is `null` or that
|
|
476
|
+
* `validateClusterRelay` refuses is `cluster-relay-missing`, answered before a conflict. A node id
|
|
477
|
+
* that is not a node id is the caller's error, not a refusal: the assignment named it, and it is
|
|
478
|
+
* thrown. The inputs are not changed. Both values are part of what the replica runs, so a relay or
|
|
479
|
+
* node that changes is a new environment.
|
|
480
|
+
*/
|
|
481
|
+
export const composeClusterIngressEnvironment = (
|
|
482
|
+
serviceEnvironmentArg: Readonly<Record<string, string>>,
|
|
483
|
+
launchArg: IClusterIngressLaunchFacts,
|
|
484
|
+
): TClusterIngressEnvironmentComposition => {
|
|
485
|
+
const { relayOrigin, nodeId } = launchArg;
|
|
486
|
+
if (!isClusterNodeId(nodeId)) {
|
|
487
|
+
throw new Error('cluster ingress environment requires a node id');
|
|
488
|
+
}
|
|
489
|
+
if (relayOrigin === null) {
|
|
490
|
+
return { status: 'refused', reason: 'cluster-relay-missing',
|
|
491
|
+
message: 'cluster ingress has no relay origin: the cluster states no relay' };
|
|
492
|
+
}
|
|
493
|
+
const relayErrors = validateClusterRelay({ origin: relayOrigin });
|
|
494
|
+
if (relayErrors.length > 0) {
|
|
495
|
+
return { status: 'refused', reason: 'cluster-relay-missing',
|
|
496
|
+
message: `cluster ingress has no relay origin: ${relayErrors.join('; ')}` };
|
|
497
|
+
}
|
|
498
|
+
const collisions = Object.values(clusterIngressEnvironmentNames)
|
|
499
|
+
.filter((nameArg) => Object.hasOwn(serviceEnvironmentArg, nameArg))
|
|
500
|
+
.sort();
|
|
501
|
+
if (collisions.length > 0) {
|
|
502
|
+
return { status: 'refused', reason: 'cluster-ingress-environment-conflict',
|
|
503
|
+
message: `cluster ingress environment collides with ${collisions.join(', ')} already set on the `
|
|
504
|
+
+ 'service' };
|
|
505
|
+
}
|
|
506
|
+
return { status: 'composed', environment: {
|
|
507
|
+
...serviceEnvironmentArg,
|
|
508
|
+
[clusterIngressEnvironmentNames.relayOrigin]: relayOrigin,
|
|
509
|
+
[clusterIngressEnvironmentNames.nodeId]: nodeId,
|
|
510
|
+
} };
|
|
511
|
+
};
|
|
512
|
+
|
|
443
513
|
/**
|
|
444
514
|
* Every reason Cloudly refuses a cluster ingress registration, in the order it judges them.
|
|
445
515
|
*
|
package/ts/data/index.ts
CHANGED
|
@@ -76,6 +76,7 @@ export * from './sparklegacyretirement.js';
|
|
|
76
76
|
export * from './sparknodereport.js';
|
|
77
77
|
export * from './service.js';
|
|
78
78
|
export * from './servicecredential.js';
|
|
79
|
+
export * from './serviceplatformownership.js';
|
|
79
80
|
export * from './serviceports.js';
|
|
80
81
|
export * from './serviceruntime.js';
|
|
81
82
|
export * from './servicevolumeinitialization.js';
|