@fabrika/provider-zerops 0.9.0-dev.3 → 0.9.0-dev.5
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/package.json +10 -9
- package/src/api/client.ts +12 -0
- package/src/api/readers.ts +29 -0
- package/src/api/types.ts +52 -0
- package/src/api.ts +2 -0
- package/src/cli.ts +11 -0
- package/src/collaborators.ts +0 -14
- package/src/compile.ts +1 -1
- package/src/control.ts +9 -57
- package/src/execution.ts +63 -185
- package/src/index.ts +2 -0
- package/src/installation/admin.ts +1 -1
- package/src/installation/deploy-options.ts +1 -2
- package/src/installation/deploy.ts +225 -80
- package/src/installation/generated/platform-console-schema.ts +3 -0
- package/src/installation/generated/platform-proxy-manifest.ts +1 -1
- package/src/installation/guide.md +48 -18
- package/src/installation/hosts.ts +1 -7
- package/src/installation/index.ts +13 -16
- package/src/installation/init-options.ts +2 -1
- package/src/installation/install-environment.ts +47 -108
- package/src/installation/install-options.ts +3 -1
- package/src/installation/install-secrets.ts +24 -68
- package/src/installation/install.ts +9 -4
- package/src/installation/sidecar.ts +5 -26
- package/src/installation/topology/setups.ts +15 -4
- package/src/installation/topology/topology.ts +31 -21
- package/src/installation/upgrade-options.ts +2 -2
- package/src/managed-env.ts +1 -174
- package/src/manifest.ts +2 -9
- package/src/namespace/claims.ts +56 -1
- package/src/namespace/errors.ts +1 -1
- package/src/namespace/manifest.ts +6 -19
- package/src/namespace/provisioning.ts +20 -2
- package/src/namespace/proxy-attempt.ts +14 -2
- package/src/namespace/proxy-reads.ts +12 -22
- package/src/namespace/types.ts +2 -0
- package/src/namespace-cli.ts +152 -0
- package/src/plan.ts +1 -6
- package/src/provider.ts +88 -126
- package/src/proxy-manifest-carrier.ts +18 -0
- package/src/types.ts +0 -2
- package/types/src/api/readers.d.ts +148 -10
- package/types/src/api/types.d.ts +49 -0
- package/types/src/api.d.ts +1 -1
- package/types/src/cli.d.ts +3 -0
- package/types/src/collaborators.d.ts +0 -2
- package/types/src/compile.d.ts +1 -1
- package/types/src/control.d.ts +3 -4
- package/types/src/execution.d.ts +5 -17
- package/types/src/index.d.ts +1 -1
- package/types/src/installation/deploy-options.d.ts +1 -1
- package/types/src/installation/deploy.d.ts +40 -0
- package/types/src/installation/generated/platform-proxy-manifest.d.ts +1 -1
- package/types/src/installation/hosts.d.ts +1 -5
- package/types/src/installation/index.d.ts +0 -2
- package/types/src/installation/install-environment.d.ts +11 -18
- package/types/src/installation/install-secrets.d.ts +3 -16
- package/types/src/installation/sidecar.d.ts +0 -2
- package/types/src/installation/topology/installation-schemas.d.ts +84 -84
- package/types/src/installation/topology/setups.d.ts +2 -1
- package/types/src/installation/topology/topology.d.ts +15 -10
- package/types/src/managed-env.d.ts +0 -33
- package/types/src/manifest.d.ts +0 -2
- package/types/src/namespace/claims.d.ts +14 -1
- package/types/src/namespace/codec.d.ts +4 -4
- package/types/src/namespace/errors.d.ts +1 -1
- package/types/src/namespace/proxy-attempt.d.ts +3 -0
- package/types/src/namespace/proxy-reads.d.ts +4 -15
- package/types/src/namespace/types.d.ts +2 -0
- package/types/src/namespace-cli.d.ts +2 -0
- package/types/src/plan.d.ts +2 -3
- package/types/src/provider.d.ts +0 -2
- package/types/src/proxy-manifest-carrier.d.ts +8 -0
- package/types/src/types.d.ts +0 -2
- package/src/installation/mcp.ts +0 -102
- package/src/installation/proxy-manifest.ts +0 -214
- package/src/installation/secrets.ts +0 -78
- package/types/src/installation/mcp.d.ts +0 -18
- package/types/src/installation/proxy-manifest.d.ts +0 -105
- package/types/src/installation/secrets.d.ts +0 -17
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
// `fabrika namespace` on Zerops: the provider options, the plan, and the namespace each command hands Control. The
|
|
2
|
+
// `fabrika` command holds Control's origin and credential, and prints the result.
|
|
3
|
+
|
|
4
|
+
import type { JsonValue, ProviderDeploymentNamespace, ProviderNamespacePlan } from '@fabrika/provider-contract'
|
|
5
|
+
import type { NamespaceCli, NamespaceCommandContext, NamespaceCommandResult } from '@fabrika/provider-contract/app-cli'
|
|
6
|
+
import { parseZeropsCliArgs, type ZeropsCliArgs } from './cli-args'
|
|
7
|
+
import {
|
|
8
|
+
createZeropsNamespaceOperator,
|
|
9
|
+
decodeZeropsNamespaceProxySource,
|
|
10
|
+
verifyZeropsNamespaceProxySource,
|
|
11
|
+
zeropsNamespaceTargetCodec,
|
|
12
|
+
} from './namespace'
|
|
13
|
+
import type { ZeropsNamespacePostgres } from './namespace'
|
|
14
|
+
import { postgresSchema } from './namespace/codec'
|
|
15
|
+
|
|
16
|
+
const NAMESPACE_USAGE = `fabrika namespace — Zerops deployment namespaces
|
|
17
|
+
|
|
18
|
+
Usage:
|
|
19
|
+
fabrika namespace plan --provider=zerops --id=<id> --env=<env> --preset=<cheap|mid|full> [namespace options]
|
|
20
|
+
fabrika namespace create --provider=zerops --id=<id> --env=<env> --preset=<cheap|mid|full> [namespace options] [--control-url=<url>]
|
|
21
|
+
fabrika namespace adopt --provider=zerops --id=<id> --env=<env> --preset=<cheap|mid|full> --project-id=<id> [namespace options] [--control-url=<url>]
|
|
22
|
+
fabrika namespace reconcile --provider=zerops --id=<id> [--control-url=<url>]
|
|
23
|
+
|
|
24
|
+
Options:
|
|
25
|
+
--id=<id> Namespace id.
|
|
26
|
+
--env=<env> Environment.
|
|
27
|
+
--preset=<cheap|mid|full> Provider-owned namespace preset.
|
|
28
|
+
--exclusive-app=<id> App reserved by a full namespace.
|
|
29
|
+
--project-id=<id> Existing Zerops project id for adoption.
|
|
30
|
+
--project-name=<name> Zerops project name (create: default fabrika-<env>-<id>;
|
|
31
|
+
adopt: the existing project's name, default the namespace id).
|
|
32
|
+
--core-package=<tier> LIGHT or SERIOUS.
|
|
33
|
+
--public-access=<mode> custom-domain or zerops-subdomain.
|
|
34
|
+
--postgres-type=<type> Cheap-tier PostgreSQL type.
|
|
35
|
+
--postgres-profile=<profile> Cheap-tier PostgreSQL profile.
|
|
36
|
+
--control-url=<url> Control origin; or FABRIKA_CONTROL_URL.
|
|
37
|
+
--json Print the result as JSON instead of rows.
|
|
38
|
+
-h, --help Show this help.
|
|
39
|
+
|
|
40
|
+
\`plan\` prints one \`<path>\\t<value>\` row per field of the plan, keyed by its path in --json; a multi-line
|
|
41
|
+
value such as the proxy's descriptor file is shown by size only. The other commands print one
|
|
42
|
+
\`<id>\\t<env>\\t<state>\\t<exclusive app>\` row.
|
|
43
|
+
|
|
44
|
+
Mutating namespace commands read the Bearer credential from FABRIKA_CONTROL_TOKEN.
|
|
45
|
+
Plan/create/adopt require FABRIKA_ZEROPS_PROXY_SOURCE_JSON:
|
|
46
|
+
{"repository":{"owner":"...","name":"..."},"commitSha":"...","descriptor":{"path":"zerops.yaml","contents":"...","sha256":"..."}}
|
|
47
|
+
Reconcile uses the persisted namespace source.
|
|
48
|
+
`
|
|
49
|
+
|
|
50
|
+
const required = (value: string | undefined, label: string): string => {
|
|
51
|
+
if (value === undefined || value.trim() === '') {
|
|
52
|
+
throw new Error(`${label} is required`)
|
|
53
|
+
}
|
|
54
|
+
return value.trim()
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
const postgres = (args: ZeropsCliArgs): ZeropsNamespacePostgres | undefined => {
|
|
58
|
+
const type = args.postgresType
|
|
59
|
+
const profile = args.postgresProfile
|
|
60
|
+
if (type === undefined && profile === undefined) return undefined
|
|
61
|
+
if (type === undefined) {
|
|
62
|
+
throw new Error('--postgres-type is required with --postgres-profile')
|
|
63
|
+
}
|
|
64
|
+
const result = postgresSchema.safeParse({ type, profile })
|
|
65
|
+
if (result.success) return result.data
|
|
66
|
+
if (result.error.issues[0]?.path[0] === 'type') throw new Error('--postgres-type must be postgresql:ha@18 or postgresql:single@18')
|
|
67
|
+
throw new Error(`--postgres-profile ${profile} is not supported by ${type}`)
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
const planOptions = (args: ZeropsCliArgs): { [key: string]: JsonValue } | undefined => {
|
|
71
|
+
const values: { [key: string]: JsonValue } = {}
|
|
72
|
+
if (args.projectName !== undefined) values['projectName'] = required(args.projectName, '--project-name')
|
|
73
|
+
if (args.corePackage !== undefined) values['corePackage'] = required(args.corePackage, '--core-package')
|
|
74
|
+
if (args.publicAccess !== undefined) values['publicAccess'] = required(args.publicAccess, '--public-access')
|
|
75
|
+
const database = postgres(args)
|
|
76
|
+
if (database !== undefined) {
|
|
77
|
+
values['postgres'] = database.profile === undefined ? { type: database.type } : { type: database.type, profile: database.profile }
|
|
78
|
+
}
|
|
79
|
+
return Object.keys(values).length === 0 ? undefined : values
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
const namespacePlan = async (
|
|
83
|
+
args: ZeropsCliArgs,
|
|
84
|
+
source: Readonly<Record<string, string | undefined>>,
|
|
85
|
+
): Promise<ProviderNamespacePlan> => {
|
|
86
|
+
// `FABRIKA_ZEROPS_*` because Zerops reserves the bare `ZEROPS_` prefix and refuses to store a custom
|
|
87
|
+
// variable using it (`userDataZeropsPrefixForbidden`).
|
|
88
|
+
const serialized = required(source['FABRIKA_ZEROPS_PROXY_SOURCE_JSON'], 'FABRIKA_ZEROPS_PROXY_SOURCE_JSON')
|
|
89
|
+
let value: unknown
|
|
90
|
+
try {
|
|
91
|
+
value = JSON.parse(serialized)
|
|
92
|
+
} catch {
|
|
93
|
+
throw new Error('FABRIKA_ZEROPS_PROXY_SOURCE_JSON must contain valid JSON')
|
|
94
|
+
}
|
|
95
|
+
const proxySource = decodeZeropsNamespaceProxySource(value)
|
|
96
|
+
await verifyZeropsNamespaceProxySource(proxySource)
|
|
97
|
+
const operator = createZeropsNamespaceOperator({ proxySource })
|
|
98
|
+
const options = planOptions(args)
|
|
99
|
+
return operator.plan({
|
|
100
|
+
id: required(args.namespaceId, '--id'),
|
|
101
|
+
env: required(args.env, '--env'),
|
|
102
|
+
preset: required(args.preset, '--preset'),
|
|
103
|
+
...(args.exclusiveAppId === undefined ? {} : { exclusiveAppId: required(args.exclusiveAppId, '--exclusive-app') }),
|
|
104
|
+
...(options === undefined ? {} : { options }),
|
|
105
|
+
})
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/** One namespace command. Every input is validated before `context.control()` is read. */
|
|
109
|
+
const runZeropsNamespaceCommand = async (
|
|
110
|
+
subcommand: string,
|
|
111
|
+
argv: readonly string[],
|
|
112
|
+
context: NamespaceCommandContext,
|
|
113
|
+
): Promise<NamespaceCommandResult> => {
|
|
114
|
+
const args = parseZeropsCliArgs(['namespace', subcommand, ...argv])
|
|
115
|
+
if (subcommand === 'plan') {
|
|
116
|
+
return { plan: await namespacePlan(args, context.source) }
|
|
117
|
+
}
|
|
118
|
+
if (subcommand === 'reconcile') {
|
|
119
|
+
const id = required(args.namespaceId, '--id')
|
|
120
|
+
return { namespace: await context.control().reconcile(id) }
|
|
121
|
+
}
|
|
122
|
+
if (subcommand !== 'create' && subcommand !== 'adopt') {
|
|
123
|
+
throw new Error(`Unknown namespace command: ${subcommand}`)
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
const planned = await namespacePlan(args, context.source)
|
|
127
|
+
const control = context.control()
|
|
128
|
+
if (subcommand === 'create') {
|
|
129
|
+
return { namespace: await control.create(planned.namespace) }
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
const projectId = required(args.projectId, '--project-id')
|
|
133
|
+
const decoded = zeropsNamespaceTargetCodec.decode(planned.namespace.target.payload)
|
|
134
|
+
const namespace: ProviderDeploymentNamespace = {
|
|
135
|
+
...planned.namespace,
|
|
136
|
+
target: {
|
|
137
|
+
provider: 'zerops',
|
|
138
|
+
version: zeropsNamespaceTargetCodec.version,
|
|
139
|
+
payload: zeropsNamespaceTargetCodec.encode({
|
|
140
|
+
...decoded,
|
|
141
|
+
// An adopted project keeps its own name, so the plan's default for a created one does not apply.
|
|
142
|
+
projectName: args.projectName ?? planned.namespace.id,
|
|
143
|
+
managed: false,
|
|
144
|
+
projectId,
|
|
145
|
+
ready: false,
|
|
146
|
+
}),
|
|
147
|
+
},
|
|
148
|
+
}
|
|
149
|
+
return { namespace: await control.adopt(namespace) }
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
export const zeropsNamespaceCli: NamespaceCli = { usage: NAMESPACE_USAGE, run: runZeropsNamespaceCommand }
|
package/src/plan.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { type FabrikaManifest, manifestServiceHostnames } from './manifest'
|
|
2
|
-
import type { ZeropsRuntimeTarget } from './types'
|
|
3
2
|
|
|
4
3
|
export type ZeropsStepKind =
|
|
5
4
|
| 'apply-import'
|
|
@@ -11,7 +10,6 @@ export type ZeropsStepKind =
|
|
|
11
10
|
| 'upload-source'
|
|
12
11
|
| 'trigger-build'
|
|
13
12
|
| 'await-version'
|
|
14
|
-
| 'reconcile-schema'
|
|
15
13
|
|
|
16
14
|
export interface ZeropsStep {
|
|
17
15
|
readonly id: string
|
|
@@ -30,7 +28,7 @@ export const resolveDeployHostname = (manifest: FabrikaManifest): string => {
|
|
|
30
28
|
}
|
|
31
29
|
|
|
32
30
|
/** Build the provider-owned deploy order without touching the platform. */
|
|
33
|
-
export const buildZeropsPlan = (manifest: FabrikaManifest
|
|
31
|
+
export const buildZeropsPlan = (manifest: FabrikaManifest): readonly ZeropsStep[] => {
|
|
34
32
|
const serviceHostnames = manifestServiceHostnames(manifest)
|
|
35
33
|
const steps: ZeropsStep[] = []
|
|
36
34
|
|
|
@@ -59,9 +57,6 @@ export const buildZeropsPlan = (manifest: FabrikaManifest, target: ZeropsRuntime
|
|
|
59
57
|
steps.push({ id: 'upload-source', kind: 'upload-source', description: 'Upload the resolved repository snapshot' })
|
|
60
58
|
steps.push({ id: 'trigger-build', kind: 'trigger-build', description: 'Trigger the Zerops build+deploy pipeline' })
|
|
61
59
|
steps.push({ id: 'await-version', kind: 'await-version', description: 'Await the Zerops pipeline and relay its build log' })
|
|
62
|
-
if (manifest.app.schema !== undefined && target.propustkaUrl !== undefined) {
|
|
63
|
-
steps.push({ id: 'reconcile-schema', kind: 'reconcile-schema', description: 'Reconcile authz schema into IAM' })
|
|
64
|
-
}
|
|
65
60
|
|
|
66
61
|
return steps
|
|
67
62
|
}
|
package/src/provider.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
// The Zerops provider owns its plan and every effect needed to execute it.
|
|
2
2
|
//
|
|
3
3
|
// A Zerops deploy is HTTP and nothing else (ADR-0003) — no container, no shell, no filesystem — so this
|
|
4
|
-
// driver's whole side-effect surface is one REST client
|
|
5
|
-
//
|
|
4
|
+
// driver's whole side-effect surface is one REST client (`./collaborators.ts`). It never spawns a process and has
|
|
5
|
+
// no `runCommand` to be handed.
|
|
6
6
|
//
|
|
7
7
|
// The interesting step is `await-version`: fabrika does not RUN the build, it WATCHES one the platform
|
|
8
8
|
// runs. Recovery never resumes a deploy (ADR-0044): a version reserved but never triggered is deleted, and
|
|
9
9
|
// one whose build may have been requested is settled only by polling it.
|
|
10
10
|
|
|
11
|
-
import {
|
|
11
|
+
import { FABRIKA_SOURCE_MAP_UPLOAD_KEY, managedValue, staleManagedVariables } from '@fabrika/auth-core'
|
|
12
12
|
import { type OperationsSourceMapUploadState, readSourceMapUploadReport } from '@fabrika/operations-contract/releases'
|
|
13
13
|
import {
|
|
14
14
|
type DeployStepResult,
|
|
@@ -66,20 +66,9 @@ import {
|
|
|
66
66
|
type StorageProvenanceMarker,
|
|
67
67
|
unprovenBucketReason,
|
|
68
68
|
} from './exposure'
|
|
69
|
-
import {
|
|
70
|
-
assertAuthoredManagedDocument,
|
|
71
|
-
assertAuthoredManagedInputs,
|
|
72
|
-
isFrameworkFamilyVariable,
|
|
73
|
-
isSensitiveFamilyVariable,
|
|
74
|
-
type ManagedValues,
|
|
75
|
-
overlayRelease,
|
|
76
|
-
parseManagedEnvironment,
|
|
77
|
-
SENSITIVE_MANAGED_KEYS,
|
|
78
|
-
SERVICE_MANAGED_KEYS,
|
|
79
|
-
} from './managed-env'
|
|
69
|
+
import { assertAuthoredManagedDocument, assertAuthoredManagedInputs, overlayRelease } from './managed-env'
|
|
80
70
|
import {
|
|
81
71
|
applicationDatabaseOf,
|
|
82
|
-
approvedSchemaOf,
|
|
83
72
|
type FabrikaImportDocument,
|
|
84
73
|
type FabrikaManifest,
|
|
85
74
|
lockedExecutionFor,
|
|
@@ -97,8 +86,6 @@ export const CANCELLED = 'deploy cancelled'
|
|
|
97
86
|
export interface ZeropsDeployRun {
|
|
98
87
|
readonly appId: string
|
|
99
88
|
readonly env: string
|
|
100
|
-
/** Every origin IAM may hand this app a session at; app-wide, because IAM's registry is keyed by app id. */
|
|
101
|
-
readonly returnOrigins?: readonly string[]
|
|
102
89
|
readonly secrets: Readonly<Record<string, string>>
|
|
103
90
|
readonly vars: Readonly<Record<string, string>>
|
|
104
91
|
/** Platform-owned runtime configuration, separate from operator-managed application vars. */
|
|
@@ -335,9 +322,8 @@ interface StepEnv {
|
|
|
335
322
|
signal: AbortSignal
|
|
336
323
|
dryRun: boolean
|
|
337
324
|
attempt: Attempt
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
familyVariables: Readonly<Record<string, string>>
|
|
325
|
+
/** What Control handed (`parseManagedEnvironment`). */
|
|
326
|
+
managed: ProviderManagedEnvironment
|
|
341
327
|
/** `await-version` gives up at this instant. */
|
|
342
328
|
deadlineMs: number
|
|
343
329
|
}
|
|
@@ -580,9 +566,9 @@ const verifyExposure = async (env: StepEnv): Promise<void> => {
|
|
|
580
566
|
}
|
|
581
567
|
}
|
|
582
568
|
if (findings.length > 0) {
|
|
583
|
-
const dsn = env.
|
|
569
|
+
const dsn = managedValue(env.managed, 'FABRIKA_OPERATIONS_DSN')
|
|
584
570
|
if (dsn !== null) {
|
|
585
|
-
const alert = { appId: run.appId, env: run.env, release: env.
|
|
571
|
+
const alert = { appId: run.appId, env: run.env, release: managedValue(env.managed, 'FABRIKA_RELEASE'), findings }
|
|
586
572
|
await zerops.alertExposure({ dsn, alert, signal }).then(
|
|
587
573
|
() => log(' raised an Operations alert'),
|
|
588
574
|
() => log(' [warn] the Operations alert could not be sent'),
|
|
@@ -598,86 +584,101 @@ const verifyExposure = async (env: StepEnv): Promise<void> => {
|
|
|
598
584
|
)
|
|
599
585
|
}
|
|
600
586
|
|
|
601
|
-
/** Write the
|
|
587
|
+
/** Write the managed variables Control handed; `FABRIKA_RELEASE` is never a service variable (ADR-0044). */
|
|
602
588
|
const writeServiceEnv = async (env: StepEnv): Promise<void> => {
|
|
603
|
-
const { zerops, log, signal,
|
|
589
|
+
const { zerops, log, signal, managed } = env
|
|
604
590
|
const serviceId = env.run.target.serviceId
|
|
591
|
+
const written = Object.entries(managed).flatMap(([key, { value, credential }]) =>
|
|
592
|
+
key === 'FABRIKA_RELEASE' || value === null ? [] : [{ key, value, credential }]
|
|
593
|
+
)
|
|
594
|
+
const writtenKeys = new Set(written.map(({ key }) => key))
|
|
605
595
|
if (env.dryRun) {
|
|
606
596
|
const upload = env.run.artifactUpload !== undefined
|
|
607
|
-
const
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
log(
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
597
|
+
const removed = Object.keys(managed).filter((key) => key !== 'FABRIKA_RELEASE' && !writtenKeys.has(key))
|
|
598
|
+
log(
|
|
599
|
+
` [dry-run] would write service variables on ${serviceId}: ${
|
|
600
|
+
[...writtenKeys, ...(upload ? [FABRIKA_SOURCE_MAP_UPLOAD_KEY] : [])].join(', ') || '(none)'
|
|
601
|
+
}`,
|
|
602
|
+
)
|
|
603
|
+
log(
|
|
604
|
+
` [dry-run] would remove service variables on ${serviceId} if present: ${
|
|
605
|
+
[...removed, ...(upload ? [] : [FABRIKA_SOURCE_MAP_UPLOAD_KEY])].join(', ') || '(none)'
|
|
606
|
+
}`,
|
|
607
|
+
)
|
|
608
|
+
log(` [dry-run] would remove every other job, webhook, connector, mail and platform variable on ${serviceId}`)
|
|
618
609
|
return
|
|
619
610
|
}
|
|
620
611
|
assertRunning(signal)
|
|
621
612
|
// One read: every write below waits for its own user-data sync, so the build request never meets `userDataSyncRunning`.
|
|
622
613
|
const records = await zerops.api.listServiceEnv({ serviceId, signal })
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
const sensitive = SENSITIVE_MANAGED_KEYS.has(key)
|
|
627
|
-
assertRunning(signal)
|
|
628
|
-
if (value !== null && (sensitive || readableContent(existing) !== value)) {
|
|
629
|
-
await zerops.api.putServiceEnv({ serviceId, key, value, sensitive, signal })
|
|
630
|
-
log(` ${key}: updated`)
|
|
631
|
-
} else if (value === null && existing !== undefined) {
|
|
632
|
-
await zerops.api.deleteServiceEnv({ envId: existing.id, signal })
|
|
633
|
-
log(` ${key}: removed`)
|
|
634
|
-
} else {
|
|
635
|
-
log(` ${key}: unchanged`)
|
|
636
|
-
}
|
|
614
|
+
const changes: ServiceEnvChange[] = []
|
|
615
|
+
const put = (key: string, value: string, sensitive: boolean): void => {
|
|
616
|
+
changes.push({ line: `${key}: updated`, apply: () => zerops.api.putServiceEnv({ serviceId, key, value, sensitive, signal }) })
|
|
637
617
|
}
|
|
638
|
-
const
|
|
639
|
-
|
|
640
|
-
if (typeof provenance === 'string' && readableContent(marker) !== provenance) {
|
|
641
|
-
assertRunning(signal)
|
|
642
|
-
// Not a credential, and the exposure read-back above reads it: it must stay readable.
|
|
643
|
-
await zerops.api.putServiceEnv({ serviceId, key: STORAGE_PROVENANCE_KEY, value: provenance, sensitive: false, signal })
|
|
644
|
-
log(` ${STORAGE_PROVENANCE_KEY}: updated`)
|
|
645
|
-
} else if (provenance === null && marker !== undefined) {
|
|
646
|
-
assertRunning(signal)
|
|
647
|
-
await zerops.api.deleteServiceEnv({ envId: marker.id, signal })
|
|
648
|
-
log(` ${STORAGE_PROVENANCE_KEY}: removed`)
|
|
618
|
+
const remove = (key: string, envId: string): void => {
|
|
619
|
+
changes.push({ line: `${key}: removed`, apply: () => zerops.api.deleteServiceEnv({ envId, signal }) })
|
|
649
620
|
}
|
|
650
|
-
// A
|
|
651
|
-
for (const
|
|
621
|
+
// A credential is written sensitive and never read back, so it is written every time.
|
|
622
|
+
for (const { key, value, credential } of written) {
|
|
652
623
|
const existing = records.find((record) => record.key === key)
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
if (sensitive || readableContent(existing) !== value) {
|
|
656
|
-
await zerops.api.putServiceEnv({ serviceId, key, value, sensitive, signal })
|
|
657
|
-
log(` ${key}: updated`)
|
|
658
|
-
} else {
|
|
659
|
-
log(` ${key}: unchanged`)
|
|
660
|
-
}
|
|
624
|
+
if (credential || readableContent(existing) !== value) put(key, value, credential)
|
|
625
|
+
else changes.push({ line: `${key}: unchanged`, apply: null })
|
|
661
626
|
}
|
|
627
|
+
// A variable Control no longer hands is removed, so no stale key stays readable. `/env` also reports the descriptor's
|
|
628
|
+
// `FABRIKA_RELEASE`, which Zerops refuses to delete.
|
|
629
|
+
const stale = new Set(staleManagedVariables(records.map((record) => record.key), new Set([...writtenKeys, 'FABRIKA_RELEASE'])))
|
|
662
630
|
for (const record of records) {
|
|
663
|
-
if (
|
|
664
|
-
assertRunning(signal)
|
|
665
|
-
await zerops.api.deleteServiceEnv({ envId: record.id, signal })
|
|
666
|
-
log(` ${record.key}: removed`)
|
|
667
|
-
}
|
|
631
|
+
if (stale.has(record.key)) remove(record.key, record.id)
|
|
668
632
|
}
|
|
633
|
+
const provenance = env.attempt.storageProvenance
|
|
634
|
+
const marker = records.find((record) => record.key === STORAGE_PROVENANCE_KEY)
|
|
635
|
+
// Not a credential, and the exposure read-back above reads it: it must stay readable.
|
|
636
|
+
if (typeof provenance === 'string' && readableContent(marker) !== provenance) put(STORAGE_PROVENANCE_KEY, provenance, false)
|
|
637
|
+
else if (provenance === null && marker !== undefined) remove(STORAGE_PROVENANCE_KEY, marker.id)
|
|
669
638
|
// The build lifts the upload's bearer from here (`${RUNTIME_…}`), so the descriptor never holds it.
|
|
670
639
|
const bearer = env.run.artifactUpload?.bearer ?? null
|
|
671
640
|
const uploadKey = records.find((record) => record.key === FABRIKA_SOURCE_MAP_UPLOAD_KEY)
|
|
672
|
-
if (bearer !== null)
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
641
|
+
if (bearer !== null) put(FABRIKA_SOURCE_MAP_UPLOAD_KEY, bearer, true)
|
|
642
|
+
else if (uploadKey !== undefined) remove(FABRIKA_SOURCE_MAP_UPLOAD_KEY, uploadKey.id)
|
|
643
|
+
await applyServiceEnvChanges(changes, log, signal)
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
/** One service variable write or removal `write-service-env` decided on, or a key it leaves as it is (`apply: null`). */
|
|
647
|
+
interface ServiceEnvChange {
|
|
648
|
+
readonly line: string
|
|
649
|
+
readonly apply: (() => Promise<void>) | null
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
/** Each write waits ~3 s for its own user-data sync; concurrent writes to one service do not conflict (zerops-platform.md). */
|
|
653
|
+
const SERVICE_ENV_WRITE_CONCURRENCY = 6
|
|
654
|
+
|
|
655
|
+
/**
|
|
656
|
+
* Applies the changes `SERVICE_ENV_WRITE_CONCURRENCY` at a time and waits for every started one, so no sync still runs
|
|
657
|
+
* when the step ends. A failure or a cancel starts no further write; lines follow the decision order.
|
|
658
|
+
*/
|
|
659
|
+
const applyServiceEnvChanges = async (changes: readonly ServiceEnvChange[], log: (line: string) => void, signal: AbortSignal): Promise<void> => {
|
|
660
|
+
const applied = new Set<number>()
|
|
661
|
+
const failures: unknown[] = []
|
|
662
|
+
let next = 0
|
|
663
|
+
const worker = async (): Promise<void> => {
|
|
664
|
+
while (next < changes.length && failures.length === 0 && !signal.aborted) {
|
|
665
|
+
const index = next++
|
|
666
|
+
const apply = changes[index]?.apply ?? null
|
|
667
|
+
if (apply === null) continue
|
|
668
|
+
try {
|
|
669
|
+
await apply()
|
|
670
|
+
applied.add(index)
|
|
671
|
+
} catch (error) {
|
|
672
|
+
failures.push(error)
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
}
|
|
676
|
+
await Promise.all(Array.from({ length: SERVICE_ENV_WRITE_CONCURRENCY }, worker))
|
|
677
|
+
for (const [index, change] of changes.entries()) {
|
|
678
|
+
if (change.apply === null || applied.has(index)) log(` ${change.line}`)
|
|
680
679
|
}
|
|
680
|
+
if (failures.length > 0) throw failures[0]
|
|
681
|
+
assertRunning(signal)
|
|
681
682
|
}
|
|
682
683
|
|
|
683
684
|
/** The custom autoscaling with its minimum RAM raised to `minRam`; every other field is sent back as it was read. */
|
|
@@ -817,7 +818,7 @@ const sizeDatabase = async (env: StepEnv): Promise<void> => {
|
|
|
817
818
|
const deploy = await zerops.api.getService({ serviceId: run.target.serviceId, signal })
|
|
818
819
|
const demand: ZeropsDatabaseDemand = {
|
|
819
820
|
maxContainers: deploy.currentAutoscaling?.horizontal.maxContainerCount ?? ZEROPS_MAX_CONTAINERS,
|
|
820
|
-
jobs: zeropsJobProcesses(locked
|
|
821
|
+
jobs: zeropsJobProcesses(locked),
|
|
821
822
|
}
|
|
822
823
|
const service = await zerops.api.findService({ projectId: run.target.projectId, hostname: database.hostname, signal })
|
|
823
824
|
if (service === null) throw new Error(`zerops: the database ${database.hostname} does not exist, so its connections cannot be sized`)
|
|
@@ -979,7 +980,7 @@ const runStep = async (spec: ZeropsStep, env: StepEnv): Promise<void> => {
|
|
|
979
980
|
const appVersionId = requireVersion(env, 'trigger-build')
|
|
980
981
|
await verifyZeropsArtifactSourceDescriptor(artifact.target.sourceDescriptor)
|
|
981
982
|
const { contents } = artifact.target.sourceDescriptor
|
|
982
|
-
const release = env.
|
|
983
|
+
const release = managedValue(env.managed, 'FABRIKA_RELEASE')
|
|
983
984
|
const descriptor = locked === null
|
|
984
985
|
? overlayRelease(contents, artifact.target.zeropsSetup, release)
|
|
985
986
|
: renderLockedExecutionDescriptor(contents, artifact.target.zeropsSetup, release, sizedExecution(locked, attempt))
|
|
@@ -1029,35 +1030,6 @@ const runStep = async (spec: ZeropsStep, env: StepEnv): Promise<void> => {
|
|
|
1029
1030
|
await awaitVersion(env, appVersionId, attempt.processId, locked !== null && locked.databaseUrl !== null)
|
|
1030
1031
|
return
|
|
1031
1032
|
}
|
|
1032
|
-
|
|
1033
|
-
case 'reconcile-schema': {
|
|
1034
|
-
const schema = approvedSchemaOf(run)
|
|
1035
|
-
const propustkaUrl = target.propustkaUrl
|
|
1036
|
-
if (schema === undefined || propustkaUrl === undefined) {
|
|
1037
|
-
return
|
|
1038
|
-
}
|
|
1039
|
-
// Return origins ride this step because `apps.setReturnOrigins` 404s for an app IAM has never
|
|
1040
|
-
// heard of, and the schema reconcile is what registers it. Separate call, same moment.
|
|
1041
|
-
const returnOrigins = run.returnOrigins !== undefined && run.returnOrigins.length > 0 ? run.returnOrigins : undefined
|
|
1042
|
-
const iamApp = appEnvironmentId(artifact.app.id, artifact.app.env)
|
|
1043
|
-
if (dryRun) {
|
|
1044
|
-
log(` [dry-run] would reconcile schema for \`${iamApp}\` against ${propustkaUrl}`)
|
|
1045
|
-
if (returnOrigins !== undefined) {
|
|
1046
|
-
log(` [dry-run] would register return origins for \`${iamApp}\`: ${returnOrigins.join(', ')}`)
|
|
1047
|
-
}
|
|
1048
|
-
return
|
|
1049
|
-
}
|
|
1050
|
-
assertRunning(signal)
|
|
1051
|
-
await zerops.reconcileSchema({
|
|
1052
|
-
url: propustkaUrl,
|
|
1053
|
-
app: iamApp,
|
|
1054
|
-
schema,
|
|
1055
|
-
...(returnOrigins === undefined ? {} : { returnOrigins }),
|
|
1056
|
-
adminKey: target.adminKey,
|
|
1057
|
-
signal,
|
|
1058
|
-
})
|
|
1059
|
-
return
|
|
1060
|
-
}
|
|
1061
1033
|
}
|
|
1062
1034
|
}
|
|
1063
1035
|
|
|
@@ -1079,15 +1051,6 @@ async (run: ZeropsDeployRun): Promise<ZeropsDeployResult> => {
|
|
|
1079
1051
|
throw new Error(`zerops: artifact environment drift: expected \`${run.env}\`, got \`${run.artifact.app.env}\``)
|
|
1080
1052
|
}
|
|
1081
1053
|
assertAuthoredManagedInputs({ variableNames: Object.keys(run.vars), secretNames: Object.keys(run.secrets) })
|
|
1082
|
-
// The proxy serves an endpoint table exactly when Control approved a contract, whatever the artifact says.
|
|
1083
|
-
const contractProxy = run.access !== undefined
|
|
1084
|
-
const { values: handed, familyVariables } = parseManagedEnvironment(run.managedEnvironment)
|
|
1085
|
-
// Only a contract application checks the secret; any other would merely hold a credential its own code can print.
|
|
1086
|
-
const managedValues: ManagedValues = contractProxy ? handed : { ...handed, FABRIKA_PROXY_SECRET: null }
|
|
1087
|
-
if (!run.dryRun && contractProxy && managedValues.FABRIKA_PROXY_SECRET === null) {
|
|
1088
|
-
// The application would refuse every request its proxy sends (ADR-0022 rule 5).
|
|
1089
|
-
throw new Error('zerops: a contract application needs its proxy secret, and Control supplied none')
|
|
1090
|
-
}
|
|
1091
1054
|
const hostnames = manifestServiceHostnames(run.artifact)
|
|
1092
1055
|
const document = interpolateManifest(run.artifact.target.importDocument, run.artifact.app.pipeline.vars, run.vars, hostnames)
|
|
1093
1056
|
const compiled = { yaml: renderYaml(document), hostnames }
|
|
@@ -1101,11 +1064,10 @@ async (run: ZeropsDeployRun): Promise<ZeropsDeployResult> => {
|
|
|
1101
1064
|
signal: run.signal,
|
|
1102
1065
|
dryRun: run.dryRun,
|
|
1103
1066
|
attempt: { triggered: false },
|
|
1104
|
-
|
|
1105
|
-
familyVariables,
|
|
1067
|
+
managed: run.managedEnvironment,
|
|
1106
1068
|
deadlineMs: Date.now() + ZEROPS_VERSION_DEADLINE_MS,
|
|
1107
1069
|
}
|
|
1108
|
-
const steps = buildZeropsPlan(run.artifact
|
|
1070
|
+
const steps = buildZeropsPlan(run.artifact)
|
|
1109
1071
|
const options = { appId: run.appId, env: run.env, dryRun: run.dryRun, signal: run.signal, log: run.events.log }
|
|
1110
1072
|
const result = await runSteps(steps, options, (step) => runStep(step, env))
|
|
1111
1073
|
const { appVersionId, triggered } = env.attempt
|
|
@@ -30,3 +30,21 @@ export const zeropsProxyManifestCarrier = (descriptorContents: string, setup = '
|
|
|
30
30
|
}
|
|
31
31
|
return 'archive'
|
|
32
32
|
}
|
|
33
|
+
|
|
34
|
+
/** The build variable that marks a proxy source whose manifest parser knows `brand` (ADR-0066). */
|
|
35
|
+
export const FABRIKA_PROXY_MANIFEST_BRAND = 'FABRIKA_PROXY_MANIFEST_BRAND'
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Whether a pinned descriptor's proxy reads a manifest that carries the installation's client logo. An older parser
|
|
39
|
+
* refuses the unknown key and fails the build, so a namespace kept on such a pin gets no logo and keeps the fabrika
|
|
40
|
+
* mark until it is re-pinned (`--proxy-source=current`). Decided by the build section Zerops applies, as the carrier is.
|
|
41
|
+
*/
|
|
42
|
+
export const zeropsProxyAcceptsBrand = (descriptorContents: string, setup = 'proxy'): boolean => {
|
|
43
|
+
const parsed = parseZeropsDescriptor(descriptorContents)
|
|
44
|
+
for (const entry of appliedZeropsSetups(parsed, selectZeropsDescriptorSetup(parsed, setup))) {
|
|
45
|
+
const read = buildSectionSchema.safeParse(entry)
|
|
46
|
+
if (!read.success) continue
|
|
47
|
+
return read.data.build.envVariables?.[FABRIKA_PROXY_MANIFEST_BRAND] === '1'
|
|
48
|
+
}
|
|
49
|
+
return false
|
|
50
|
+
}
|