@fjall/components-infrastructure 0.100.0 → 1.1.0

package/dist/lib/lambda-assets/cert-generator/asset/package.json

@@ -0,0 +1,4 @@
+{
+  "type": "commonjs",
+  "private": true
+}

package/dist/lib/patterns/aws/clickhouseDatabase.d.ts

@@ -4,7 +4,9 @@ import { type IBucket } from "aws-cdk-lib/aws-s3";
 import { Construct } from "constructs";
 import { Secret } from "../../resources/aws/secrets/secret.js";
 import { type ClickHouseSchemaAdmin, type ProfileSpec } from "../../resources/aws/database/clickhouseSchemas.js";
-import { type IClickHouseDatabase } from "./interfaces/database.js";
+import { type ISecret } from "aws-cdk-lib/aws-secretsmanager";
+import type { ClickHouseTlsOptions } from "./clickhouseTls/index.js";
+import { type ClickHouseMigrationsConfig, type IClickHouseDatabase } from "./interfaces/database.js";
 import { type ISecurityGroupConnector } from "./interfaces/connector.js";
 import { type MigrationContributions } from "./interfaces/migrationContributor.js";
 /**
@@ -95,6 +97,24 @@ export interface ClickHouseDatabaseProps {
      * non-snake_case names.
      */
     profiles?: Record<string, ProfileSpec>;
+    /**
+     * Schema-version gate. When set, every container of every service whose
+     * `connections:` includes this database receives `EXPECTED_CH_SCHEMA_VERSION`
+     * baked into its env at synth, unless the service sets `schemaGate: false`.
+     * The default resolver picks the lexicographically-latest `*.sql` filename
+     * under `dir` (skipping `*.dev.sql`), matching what `runSqlMigrations`
+     * records in `_schema_migrations.ch_version`.
+     */
+    migrations?: ClickHouseMigrationsConfig;
+    /**
+     * TLS configuration. Default: `{ mode: "self-signed" }` — mints an ECDSA
+     * P-256 CA + leaf cert at deploy via a Lambda custom resource, stores both
+     * PEMs in Secrets Manager, and the EC2 user-data materialises them at boot
+     * for the CH server to read. Set `mode: "imported"` to bring your own CA;
+     * `mode: "none"` (acknowledgement literal required) opts out of TLS.
+     * See ./clickhouseTls/types.ts.
+     */
+    tls?: ClickHouseTlsOptions;
 }
 /**
  * ClickHouse analytics database wrapper implementing IClickHouseDatabase.
@@ -112,6 +132,25 @@ export declare class ClickHouseDatabase extends Construct implements IClickHouse
     readonly additionalTcpPorts: number[];
     readonly id: string;
     readonly connections: Connections;
+    /**
+     * CA cert secret. Self-signed: minted by `TlsCertGenerator`. Imported: the
+     * user-supplied ISecret. `undefined` when `tls.mode === "none"`.
+     * SecretString shape: raw PEM (single cert, no JSON wrapping).
+     */
+    readonly tlsCaSecret: ISecret | undefined;
+    /**
+     * Server cert + key secret. Self-signed: minted by `TlsCertGenerator`.
+     * Imported: the user-supplied ISecret. `undefined` when `tls.mode === "none"`.
+     * SecretString shape: JSON `{ "cert": "<leaf-pem>", "key": "<key-pem>" }`.
+     */
+    readonly tlsServerSecret: ISecret | undefined;
+    /**
+     * SHA-256 of the CA cert PEM. CFN token in self-signed mode (from the cert
+     * generator custom resource Data attribute). Plain string in imported mode
+     * when supplied. `undefined` when `tls.mode === "none"` or when imported
+     * without a digest. Surface on consumers as a task-replacement trigger.
+     */
+    readonly caCertSha256: string | undefined;
     constructor(scope: Construct, id: string, props: ClickHouseDatabaseProps);
     /**
      * Returns the Fjall `Secret` wrapper for the named user. Throws with a
@@ -129,11 +168,20 @@ export declare class ClickHouseDatabase extends Construct implements IClickHouse
     getHttpPort(): number;
     getNativePort(): number;
     getHostEndpoint(): string;
+    /**
+     * Canonical URL for the HTTP(S) interface. Scheme is `https` when TLS is
+     * active (default), `http` only when `tls: { mode: "none", … }` is set.
+     * Port matches: HTTPS (8443) under TLS, HTTP (8123) otherwise.
+     */
+    getUrl(): string;
+    /** @deprecated Alias for {@link getUrl}. Removed in a follow-up landing. */
     getHttpUrl(): string;
     getNativeUrl(): string;
     getDatabaseName(): string;
     getBackupBucket(): IBucket;
     getColdTierBucket(): IBucket | undefined;
+    getMigrationsConfig(): ClickHouseMigrationsConfig | undefined;
+    getExpectedSchemaVersion(): string | undefined;
     grantConnect(grantee: IConnectable): void;
     /**
      * Migration contributions for a task connecting to this ClickHouse cluster

package/dist/lib/patterns/aws/clickhouseDatabase.js

@@ -1,4 +1,4 @@
-import { CLICKHOUSE_MANAGED_USERS_ENV } from "@fjall/util/migration";
+import { CLICKHOUSE_MANAGED_USERS_ENV, pickLatestClickHouseMigration } from "@fjall/util/migration";
 import { Annotations, CfnOutput, Duration, Fn, Stack } from "aws-cdk-lib";
 import { Connections, Port, UserData } from "aws-cdk-lib/aws-ec2";
 import { Monitoring } from "aws-cdk-lib/aws-autoscaling";
@@ -20,7 +20,8 @@ import { buildClickHouseEntrypointWrapper, buildClickHouseUserData, generateUser
 import { toPascalCase } from "../../utils/capitaliseString.js";
 import { ClickHouseSchemaAdminSchema, ManagedPasswordNameSchema, ProfileSpecSchema, ClickHouseDefaultProfiles, PROFILE_NAME_PATTERN } from "../../resources/aws/database/clickhouseSchemas.js";
 import { inferAmiHardwareType } from "../../resources/aws/compute/ecsConstants.js";
-import { CLICKHOUSE_DATABASE_NAME, DEFAULT_CLICKHOUSE_INSTANCE_TYPE, CLICKHOUSE_IMAGE, CLICKHOUSE_EBS_VOLUME_SIZE_GB, CLICKHOUSE_EBS_IOPS, CLICKHOUSE_EBS_THROUGHPUT_MBPS, CLICKHOUSE_TASK_MEMORY_MIB, CLICKHOUSE_HTTP_PORT, CLICKHOUSE_NATIVE_PORT, CLICKHOUSE_PROMETHEUS_PORT, CLICKHOUSE_DATA_MOUNT_PATH, CLICKHOUSE_SECRET_OPTIONS, CLICKHOUSE_SERVER_ROLE_TAG, clickHouseUserSecretName, CLICKHOUSE_HEALTH_CHECK, CLICKHOUSE_STOP_TIMEOUT_SECONDS, CLICKHOUSE_EBS_DEVICE_NAME, CLICKHOUSE_CONFIG_SUBDIR, CLICKHOUSE_USERS_SUBDIR, userPasswordEnvName, OPTIMISE_FINAL_SCHEDULE, REPLACING_MERGE_TREE_TABLES, OPTIMISE_MV_TABLES, CLICKHOUSE_CLOUDMAP_SERVICE_NAME, CLICKHOUSE_SERVER_CONTAINER_NAME, OPTIMISE_TASK_MEMORY_MIB, OPTIMISE_TASK_CPU_UNITS, BACKUP_SCHEDULE, BACKUP_TASK_MEMORY_MIB, BACKUP_TASK_CPU_UNITS, BACKUP_RETENTION_DAYS } from "../../resources/aws/database/clickhouseConstants.js";
+import { CLICKHOUSE_DATABASE_NAME, DEFAULT_CLICKHOUSE_INSTANCE_TYPE, CLICKHOUSE_IMAGE, CLICKHOUSE_EBS_VOLUME_SIZE_GB, CLICKHOUSE_EBS_IOPS, CLICKHOUSE_EBS_THROUGHPUT_MBPS, CLICKHOUSE_TASK_MEMORY_MIB, CLICKHOUSE_HTTP_PORT, CLICKHOUSE_HTTPS_PORT, CLICKHOUSE_NATIVE_PORT, CLICKHOUSE_TCP_SECURE_PORT, CLICKHOUSE_TLS_CERT_MOUNT_PATH, CLICKHOUSE_PROMETHEUS_PORT, CLICKHOUSE_DATA_MOUNT_PATH, CLICKHOUSE_SECRET_OPTIONS, CLICKHOUSE_SERVER_ROLE_TAG, clickHouseUserSecretName, CLICKHOUSE_HEALTH_CHECK, CLICKHOUSE_STOP_TIMEOUT_SECONDS, CLICKHOUSE_EBS_DEVICE_NAME, CLICKHOUSE_CONFIG_SUBDIR, CLICKHOUSE_USERS_SUBDIR, userPasswordEnvName, OPTIMISE_FINAL_SCHEDULE, REPLACING_MERGE_TREE_TABLES, OPTIMISE_MV_TABLES, CLICKHOUSE_CLOUDMAP_SERVICE_NAME, CLICKHOUSE_SERVER_CONTAINER_NAME, OPTIMISE_TASK_MEMORY_MIB, OPTIMISE_TASK_CPU_UNITS, BACKUP_SCHEDULE, BACKUP_TASK_MEMORY_MIB, BACKUP_TASK_CPU_UNITS, BACKUP_RETENTION_DAYS } from "../../resources/aws/database/clickhouseConstants.js";
+import { TlsCertGenerator } from "../../resources/aws/utilities/tlsCertGenerator.js";
 import { EcsCompute } from "./computeEcs.js";
 /**
  * Resolve the ECS desired task count for the ClickHouse service.
@@ -81,14 +82,36 @@ function createClickHouseUserSecret(scope, name) {
 export class ClickHouseDatabase extends Construct {
     databaseType = "ClickHouse";
     connectorType = "relational";
-    additionalTcpPorts = [CLICKHOUSE_NATIVE_PORT];
+    additionalTcpPorts;
     id;
     connections;
+    /**
+     * CA cert secret. Self-signed: minted by `TlsCertGenerator`. Imported: the
+     * user-supplied ISecret. `undefined` when `tls.mode === "none"`.
+     * SecretString shape: raw PEM (single cert, no JSON wrapping).
+     */
+    tlsCaSecret;
+    /**
+     * Server cert + key secret. Self-signed: minted by `TlsCertGenerator`.
+     * Imported: the user-supplied ISecret. `undefined` when `tls.mode === "none"`.
+     * SecretString shape: JSON `{ "cert": "<leaf-pem>", "key": "<key-pem>" }`.
+     */
+    tlsServerSecret;
+    /**
+     * SHA-256 of the CA cert PEM. CFN token in self-signed mode (from the cert
+     * generator custom resource Data attribute). Plain string in imported mode
+     * when supplied. `undefined` when `tls.mode === "none"` or when imported
+     * without a digest. Surface on consumers as a task-replacement trigger.
+     */
+    caCertSha256;
+    #httpPort;
+    #nativePort;
     #users;
     #schemaAdmin;
     #managedPasswordNames;
     #backupBucket;
     #coldTierBucket;
+    #migrationsConfig;
     constructor(scope, id, props) {
         super(scope, id);
         this.id = id;
@@ -156,7 +179,46 @@ export class ClickHouseDatabase extends Construct {
             (props.backupRetentionDays < 1 || props.backupRetentionDays > 3650)) {
             throw new Error(`ClickHouseDatabase: backupRetentionDays must be between 1 and 3650; got ${props.backupRetentionDays}.`);
         }
-        const securityGroup = createClickHouseSecurityGroup(this, vpc, CLICKHOUSE_NATIVE_PORT);
+        const tlsOptions = props.tls ?? {
+            mode: "self-signed"
+        };
+        const tlsActive = tlsOptions.mode !== "none";
+        const httpPort = tlsActive ? CLICKHOUSE_HTTPS_PORT : CLICKHOUSE_HTTP_PORT;
+        const nativePort = tlsActive
+            ? CLICKHOUSE_TCP_SECURE_PORT
+            : CLICKHOUSE_NATIVE_PORT;
+        let tlsCaSecret;
+        let tlsServerSecret;
+        let caCertSha256;
+        if (tlsOptions.mode === "self-signed") {
+            const namespaceName = App.getInstance().getNamespace().namespaceName;
+            const hostname = `${CLICKHOUSE_CLOUDMAP_SERVICE_NAME}.${namespaceName}`;
+            const certGen = new TlsCertGenerator(this, "TlsCertGenerator", {
+                appName: App.getInstance().getName(),
+                hostname,
+                ...(tlsOptions.caValidityYears !== undefined && {
+                    caValidityYears: tlsOptions.caValidityYears
+                }),
+                ...(tlsOptions.leafValidityYears !== undefined && {
+                    leafValidityYears: tlsOptions.leafValidityYears
+                })
+            });
+            tlsCaSecret = certGen.caSecret.secret;
+            tlsServerSecret = certGen.serverSecret.secret;
+            caCertSha256 = certGen.caCertSha256;
+        }
+        else if (tlsOptions.mode === "imported") {
+            tlsCaSecret = tlsOptions.caCertSecret;
+            tlsServerSecret = tlsOptions.serverCertSecret;
+            caCertSha256 = tlsOptions.caCertSha256;
+        }
+        this.tlsCaSecret = tlsCaSecret;
+        this.tlsServerSecret = tlsServerSecret;
+        this.caCertSha256 = caCertSha256;
+        this.additionalTcpPorts = [nativePort];
+        this.#httpPort = httpPort;
+        this.#nativePort = nativePort;
+        const securityGroup = createClickHouseSecurityGroup(this, vpc, nativePort);
         const userSecrets = new Map();
         for (const name of allUserNames) {
             userSecrets.set(name, createClickHouseUserSecret(this, name));
@@ -185,6 +247,7 @@ export class ClickHouseDatabase extends Construct {
             : undefined;
         this.#backupBucket = backupBucket;
         this.#coldTierBucket = coldTierBucket;
+        this.#migrationsConfig = props.migrations;
         const backupTaskLogGroup = backupEnabled
             ? new LogGroup(this, "ClickHouseBackupTaskLogGroup", {
                 retention: RetentionDays.TWO_WEEKS
@@ -198,6 +261,13 @@ export class ClickHouseDatabase extends Construct {
                     bucketName: coldTierBucket.bucketName,
                     region: Stack.of(this).region
                 }
+            }),
+            tlsActive,
+            ...(tlsActive &&
+                tlsCaSecret !== undefined &&
+                tlsServerSecret !== undefined && {
+                caSecretArn: tlsCaSecret.secretArn,
+                serverSecretArn: tlsServerSecret.secretArn
             })
         }));
         // Source.data wraps the content in a zip; the default `extract: true`
@@ -237,9 +307,10 @@ export class ClickHouseDatabase extends Construct {
                     "--host",
                     clickHouseHost,
                     "--port",
-                    String(CLICKHOUSE_NATIVE_PORT),
+                    String(nativePort),
                     "--user",
                     schemaAdmin.name,
+                    ...(tlsActive ? ["--secure", "--accept-invalid-certificate"] : []),
                     "--query",
                     `${optimiseQuery};`
                 ],
@@ -261,7 +332,7 @@ export class ClickHouseDatabase extends Construct {
                     "sh",
                     "-c",
                     // Password via CLICKHOUSE_PASSWORD env, not --password on argv (argv → /proc/<pid>/cmdline).
-                    `STAMP=$(date +%Y%m%d-%H%M%S) && clickhouse-client --host ${clickHouseHost} --port ${CLICKHOUSE_NATIVE_PORT} --user ${schemaAdmin.name} --query "BACKUP DATABASE ${CLICKHOUSE_DATABASE_NAME} TO S3('${backupDestUrl}weekly-$STAMP/')"`
+                    `STAMP=$(date +%Y%m%d-%H%M%S) && clickhouse-client --host ${clickHouseHost} --port ${nativePort} --user ${schemaAdmin.name}${tlsActive ? " --secure --accept-invalid-certificate" : ""} --query "BACKUP DATABASE ${CLICKHOUSE_DATABASE_NAME} TO S3('${backupDestUrl}weekly-$STAMP/')"`
                 ],
                 secrets: {
                     CLICKHOUSE_PASSWORD: EcsSecret.fromSecretsManager(adminSecret.secret, "password")
@@ -329,12 +400,12 @@ export class ClickHouseDatabase extends Construct {
                             secretsImport: clickHouseContainerSecrets,
                             portMappings: [
                                 {
-                                    containerPort: CLICKHOUSE_HTTP_PORT,
-                                    hostPort: CLICKHOUSE_HTTP_PORT
+                                    containerPort: httpPort,
+                                    hostPort: httpPort
                                 },
                                 {
-                                    containerPort: CLICKHOUSE_NATIVE_PORT,
-                                    hostPort: CLICKHOUSE_NATIVE_PORT
+                                    containerPort: nativePort,
+                                    hostPort: nativePort
                                 },
                                 {
                                     containerPort: CLICKHOUSE_PROMETHEUS_PORT,
@@ -358,12 +429,24 @@ export class ClickHouseDatabase extends Construct {
                                     hostSourcePath: `${CLICKHOUSE_DATA_MOUNT_PATH}/${CLICKHOUSE_USERS_SUBDIR}`,
                                     mountPath: "/etc/clickhouse-server/users.d",
                                     readOnly: true
-                                }
+                                },
+                                ...(tlsActive
+                                    ? [
+                                        {
+                                            name: "clickhouse-certs",
+                                            hostSourcePath: `${CLICKHOUSE_DATA_MOUNT_PATH}/server-certs`,
+                                            mountPath: CLICKHOUSE_TLS_CERT_MOUNT_PATH,
+                                            readOnly: true
+                                        }
+                                    ]
+                                    : [])
                             ],
                             healthCheck: {
                                 command: [
                                     "CMD-SHELL",
-                                    `wget -q -O /dev/null http://127.0.0.1:${CLICKHOUSE_HTTP_PORT}/ping || exit 1`
+                                    tlsActive
+                                        ? `wget -q --no-check-certificate -O /dev/null https://127.0.0.1:${httpPort}/ping || exit 1`
+                                        : `wget -q -O /dev/null http://127.0.0.1:${httpPort}/ping || exit 1`
                                 ],
                                 interval: CLICKHOUSE_HEALTH_CHECK.INTERVAL_SECONDS,
                                 timeout: CLICKHOUSE_HEALTH_CHECK.TIMEOUT_SECONDS,
@@ -388,6 +471,10 @@ export class ClickHouseDatabase extends Construct {
         instanceRole.addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName("AmazonSSMManagedInstanceCore"));
         backupBucket.grantRead(instanceRole, "config/*");
         adminSecret.secret.grantRead(instanceRole);
+        if (tlsCaSecret !== undefined)
+            tlsCaSecret.grantRead(instanceRole);
+        if (tlsServerSecret !== undefined)
+            tlsServerSecret.grantRead(instanceRole);
         const adminSecretName = clickHouseUserSecretName(schemaAdmin.name);
         // Password via CLICKHOUSE_CLIENT_PASSWORD env, not --password on argv
         // (argv → /proc/<pid>/cmdline). `jq -r .password` on an empty pipeline
@@ -402,7 +489,7 @@ export class ClickHouseDatabase extends Construct {
             `ADMIN_PASSWORD=$(aws secretsmanager get-secret-value --secret-id "${adminSecretName}" --query SecretString --output text | jq -r .password)`,
             `if [ -z "$ADMIN_PASSWORD" ] || [ "$ADMIN_PASSWORD" = "null" ]; then echo "fjall:reload:status=failed reason=password-fetch" >&2; exit 1; fi`,
             `mv /var/lib/clickhouse/users.d/fjall.xml.new /var/lib/clickhouse/users.d/fjall.xml`,
-            `docker exec -i -e CLICKHOUSE_CLIENT_PASSWORD="$ADMIN_PASSWORD" "$CONTAINER" clickhouse-client --port 9000 --user ${schemaAdmin.name} -q "SYSTEM RELOAD USERS"`
+            `docker exec -i -e CLICKHOUSE_CLIENT_PASSWORD="$ADMIN_PASSWORD" "$CONTAINER" clickhouse-client${tlsActive ? " --secure --accept-invalid-certificate" : ""} --port ${nativePort} --user ${schemaAdmin.name} -q "SYSTEM RELOAD USERS"`
         ].join("\n");
         const region = Stack.of(this).region;
         const account = Stack.of(this).account;
@@ -454,15 +541,21 @@ export class ClickHouseDatabase extends Construct {
         reloadCustomResource.node.addDependency(usersConfigDeployment);
         this.connections = new Connections({
             securityGroups: [securityGroup],
-            defaultPort: Port.tcp(CLICKHOUSE_HTTP_PORT)
+            defaultPort: Port.tcp(httpPort)
         });
         const declareOutput = (name, value) => {
             const output = new CfnOutput(this, name, { value });
             output.overrideLogicalId(name);
         };
         declareOutput("Endpoint", clickHouseHost);
-        declareOutput("HttpPort", String(CLICKHOUSE_HTTP_PORT));
-        declareOutput("NativePort", String(CLICKHOUSE_NATIVE_PORT));
+        declareOutput("HttpPort", String(httpPort));
+        declareOutput("NativePort", String(nativePort));
+        if (tlsActive) {
+            declareOutput("TlsActive", "true");
+        }
+        if (caCertSha256 !== undefined) {
+            declareOutput("CaCertSha256", caCertSha256);
+        }
         declareOutput("DatabaseName", CLICKHOUSE_DATABASE_NAME);
         for (const [name, secret] of userSecrets) {
             declareOutput(`${toPascalCase(name)}SecretArn`, secret.secret.secretArn);
@@ -495,19 +588,29 @@ export class ClickHouseDatabase extends Construct {
         return this.#users.get(name);
     }
     getHttpPort() {
-        return CLICKHOUSE_HTTP_PORT;
+        return this.#httpPort;
     }
     getNativePort() {
-        return CLICKHOUSE_NATIVE_PORT;
+        return this.#nativePort;
     }
     getHostEndpoint() {
         return `${CLICKHOUSE_CLOUDMAP_SERVICE_NAME}.${App.getInstance().getNamespace().namespaceName}`;
     }
+    /**
+     * Canonical URL for the HTTP(S) interface. Scheme is `https` when TLS is
+     * active (default), `http` only when `tls: { mode: "none", … }` is set.
+     * Port matches: HTTPS (8443) under TLS, HTTP (8123) otherwise.
+     */
+    getUrl() {
+        const scheme = this.tlsCaSecret !== undefined ? "https" : "http";
+        return `${scheme}://${this.getHostEndpoint()}:${this.#httpPort}`;
+    }
+    /** @deprecated Alias for {@link getUrl}. Removed in a follow-up landing. */
     getHttpUrl() {
-        return `http://${this.getHostEndpoint()}:${this.getHttpPort()}`;
+        return this.getUrl();
     }
     getNativeUrl() {
-        return `tcp://${this.getHostEndpoint()}:${this.getNativePort()}`;
+        return `tcp://${this.getHostEndpoint()}:${this.#nativePort}`;
     }
     getDatabaseName() {
         return CLICKHOUSE_DATABASE_NAME;
@@ -518,6 +621,20 @@ export class ClickHouseDatabase extends Construct {
     getColdTierBucket() {
         return this.#coldTierBucket;
     }
+    getMigrationsConfig() {
+        return this.#migrationsConfig;
+    }
+    getExpectedSchemaVersion() {
+        const config = this.#migrationsConfig;
+        if (config === undefined)
+            return undefined;
+        const resolver = config.versionResolver ?? pickLatestClickHouseMigration;
+        const version = resolver(config.dir);
+        if (version.trim() === "") {
+            throw new Error(`ClickHouseDatabase '${this.id}': migrations.versionResolver returned an empty string for dir '${config.dir}' — refusing to inject an empty EXPECTED_CH_SCHEMA_VERSION.`);
+        }
+        return version;
+    }
     grantConnect(grantee) {
         this.connections.allowDefaultPortFrom(grantee);
         this.connections.allowFrom(grantee, Port.tcp(CLICKHOUSE_NATIVE_PORT));

package/dist/lib/patterns/aws/clickhouseTls/index.d.ts

@@ -0,0 +1 @@
+export * from "./types.js";

package/dist/lib/patterns/aws/clickhouseTls/index.js

@@ -0,0 +1 @@
+export * from "./types.js";

package/dist/lib/patterns/aws/clickhouseTls/types.d.ts

@@ -0,0 +1,48 @@
+import type { ISecret } from "aws-cdk-lib/aws-secretsmanager";
+/**
+ * Self-signed mode (default). The construct mints an ECDSA P-256 CA + leaf
+ * cert at stack deploy via a custom-resource Lambda. Bumping
+ * `caValidityYears` / `leafValidityYears` triggers re-issuance on the next
+ * deploy.
+ */
+export interface ClickHouseSelfSignedTls {
+    readonly mode: "self-signed";
+    readonly caValidityYears?: number;
+    readonly leafValidityYears?: number;
+}
+/**
+ * Imported mode. Caller owns the CA + server-cert secrets in Secrets
+ * Manager. `serverCertSecret`'s SecretString MUST be JSON of the shape
+ * `{ "cert": "<pem>", "key": "<pem>" }`. `caCertSha256` is optional — when
+ * supplied the construct surfaces it as a CFN env-var token so consumers
+ * can wire it into containers for rotation-triggers-task-replacement
+ * parity with self-signed mode. Omit it and rotation requires manual task
+ * restart (documented in `aiDocs/patterns/clickhouse-tls-pattern.md § "Imported mode"`).
+ */
+export interface ClickHouseImportedTls {
+    readonly mode: "imported";
+    readonly caCertSecret: ISecret;
+    readonly serverCertSecret: ISecret;
+    readonly caCertSha256?: string;
+}
+/**
+ * Plaintext escape hatch. Disables TLS entirely. The acknowledgement is a
+ * literal-string type so misuse fails at compile time — passing any other
+ * string fails `tsc --noEmit`.
+ */
+export interface ClickHouseNoTls {
+    readonly mode: "none";
+    readonly acknowledgement: "I understand plaintext-only ClickHouse fails SOC2 DP5";
+}
+export type ClickHouseTlsOptions = ClickHouseSelfSignedTls | ClickHouseImportedTls | ClickHouseNoTls;
+/**
+ * The resolved TLS surface a `ClickHouseDatabase` carries after dispatch.
+ * Every field is `undefined` in `mode: "none"`. `certGeneratorFunction`
+ * is `undefined` in `mode: "imported"`. `caCertSha256` is `undefined` in
+ * `mode: "none"` AND in `mode: "imported"` unless the caller supplied it.
+ */
+export interface ClickHouseTlsResolved {
+    readonly caSecret: ISecret | undefined;
+    readonly serverSecret: ISecret | undefined;
+    readonly caCertSha256: string | undefined;
+}

package/dist/lib/patterns/aws/computeEcs.d.ts

@@ -48,7 +48,7 @@ export declare function expandMigrationsSugar(service: EcsServiceConfig, userCon
  *                      themselves and the resolved value differs.
  * @internal Exported for testing only
  */
-export declare function buildContainerConfigs(service: EcsServiceConfig, schemaVersionEnv?: Record<string, string>, annotationsScope?: Construct): EcsClusterProps["services"][number]["containers"];
+export declare function buildContainerConfigs(service: EcsServiceConfig, schemaVersionEnv?: Record<string, string>, annotationsScope?: Construct, chSchemaVersionEnv?: Record<string, string>): EcsClusterProps["services"][number]["containers"];
 /**
  * Resolved scaling configuration for an ECS service.
  * @internal Exported for testing only
@@ -92,6 +92,18 @@ export declare class EcsCompute extends Construct implements IEcsCompute {
      * hardcoding one.
      */
     private resolveSchemaVersionEnv;
+    /**
+     * ClickHouse mirror of `resolveSchemaVersionEnv`. Returns the
+     * `EXPECTED_CH_SCHEMA_VERSION` env entry, or `undefined` when the service is
+     * not gated.
+     *
+     * - `schemaGate: false` → returns `undefined` (auditable opt-out — same flag
+     *   covers BOTH PG and CH gates)
+     * - No migrated CH in connections → returns `undefined`
+     * - Exactly one migrated CH → returns `{ EXPECTED_CH_SCHEMA_VERSION }`
+     * - Two or more migrated CHs → throws via `resolveClickHouseDatabaseForService`
+     */
+    private resolveClickHouseSchemaVersionEnv;
     private materialiseScheduledTasks;
     private buildScheduledTaskDefinition;
     /**

package/dist/lib/patterns/aws/computeEcs.js

@@ -7,7 +7,7 @@ import { Secret } from "aws-cdk-lib/aws-secretsmanager";
 import { StringParameter } from "aws-cdk-lib/aws-ssm";
 import { Construct } from "constructs";
 import { resolveAlertsTopic } from "../../utils/resolveAlertsTopic.js";
-import { EXPECTED_SCHEMA_VERSION_ENV, EXPECTED_SCHEMA_VERSION_TOOL_ENV, isDatabase, isRelationalDatabase } from "./interfaces/database.js";
+import { EXPECTED_SCHEMA_VERSION_ENV, EXPECTED_SCHEMA_VERSION_TOOL_ENV, EXPECTED_CH_SCHEMA_VERSION_ENV, isClickHouseDatabase, isDatabase, isRelationalDatabase } from "./interfaces/database.js";
 import { isConnectionConfig } from "../../utils/connector.js";
 import { isMigrationContributor } from "./interfaces/migrationContributor.js";
 import App from "../../app.js";
@@ -274,6 +274,37 @@ function resolveMigrationDatabaseForService(service) {
     }
     return matches[0];
 }
+/**
+ * ClickHouse mirror of `resolveMigrationDatabaseForService`. Two-CH-per-service
+ * is rejected for the same reason: the gate can only inject one
+ * `EXPECTED_CH_SCHEMA_VERSION`.
+ */
+function resolveClickHouseDatabaseForService(service) {
+    const connections = service.connections;
+    if (connections === undefined || connections.length === 0)
+        return undefined;
+    const matches = [];
+    for (const spec of connections) {
+        const resource = isConnectionConfig(spec) ? spec.resource : spec;
+        if (!isDatabase(resource))
+            continue;
+        if (!isClickHouseDatabase(resource))
+            continue;
+        if (resource.getMigrationsConfig() !== undefined)
+            matches.push(resource);
+    }
+    if (matches.length === 0)
+        return undefined;
+    if (matches.length > 1) {
+        const names = matches.map((d) => d.node.id).join(", ");
+        throw new Error(`Service '${service.name}': connections include two or more ClickHouse ` +
+            `databases declaring \`migrations:\` (${names}). The schema-version ` +
+            `gate cannot inject ${EXPECTED_CH_SCHEMA_VERSION_ENV} unambiguously. ` +
+            `Split the service so each consumes a single migrated database, or ` +
+            `set \`schemaGate: false\` and inject the env manually.`);
+    }
+    return matches[0];
+}
 function getResourceLabel(resource) {
     if (resource !== null &&
         typeof resource === "object" &&
@@ -436,7 +467,7 @@ function mergeContributionsIntoSeparateTaskDef(separateTaskDef, contributions) {
  *                      themselves and the resolved value differs.
  * @internal Exported for testing only
  */
-export function buildContainerConfigs(service, schemaVersionEnv, annotationsScope) {
+export function buildContainerConfigs(service, schemaVersionEnv, annotationsScope, chSchemaVersionEnv) {
     const userContainers = service.containers && service.containers.length > 0
         ? service.containers
         : undefined;
@@ -464,19 +495,43 @@ export function buildContainerConfigs(service, schemaVersionEnv, annotationsScop
             };
         }
         const merged = { ...(authored ?? {}) };
-        for (const [key, value] of Object.entries(schemaVersionEnv)) {
-            if (merged[key] === undefined)
-                merged[key] = value;
+        if (schemaVersionEnv[EXPECTED_SCHEMA_VERSION_ENV] !== undefined) {
+            merged[EXPECTED_SCHEMA_VERSION_ENV] =
+                schemaVersionEnv[EXPECTED_SCHEMA_VERSION_ENV];
+        }
+        if (schemaVersionEnv[EXPECTED_SCHEMA_VERSION_TOOL_ENV] !== undefined) {
+            merged[EXPECTED_SCHEMA_VERSION_TOOL_ENV] =
+                schemaVersionEnv[EXPECTED_SCHEMA_VERSION_TOOL_ENV];
         }
         return merged;
     };
+    const mergeChSchemaEnv = (authored) => {
+        if (chSchemaVersionEnv === undefined)
+            return authored;
+        const authoredValue = authored?.[EXPECTED_CH_SCHEMA_VERSION_ENV];
+        const resolvedValue = chSchemaVersionEnv[EXPECTED_CH_SCHEMA_VERSION_ENV];
+        if (authoredValue !== undefined) {
+            if (authoredValue !== resolvedValue && annotationsScope !== undefined) {
+                Annotations.of(annotationsScope).addWarning(`Service '${service.name}': author-set ${EXPECTED_CH_SCHEMA_VERSION_ENV}` +
+                    `='${authoredValue}' overrides the value resolved from the connected ` +
+                    `ClickHouse database's \`migrations:\` config ('${resolvedValue}'). The ` +
+                    `author value wins; set \`schemaGate: false\` to silence this warning.`);
+            }
+            return authored;
+        }
+        return {
+            ...(authored ?? {}),
+            [EXPECTED_CH_SCHEMA_VERSION_ENV]: resolvedValue
+        };
+    };
+    const mergeAllSchemaEnv = (authored) => mergeChSchemaEnv(mergeSchemaEnv(authored));
     if (expanded) {
         return expanded.map((c, index) => {
             return {
                 name: c.name || `${service.name}Container${index > 0 ? index : ""}`,
                 image: c.image,
                 port: c.port,
-                environment: mergeSchemaEnv(c.environment),
+                environment: mergeAllSchemaEnv(c.environment),
                 secrets: c.secrets,
                 secretsImport: c.secretsImport,
                 command: c.command,
@@ -490,7 +545,7 @@ export function buildContainerConfigs(service, schemaVersionEnv, annotationsScop
             };
         });
     }
-    const fallbackEnv = mergeSchemaEnv(undefined);
+    const fallbackEnv = mergeAllSchemaEnv(undefined);
     return [
         {
             name: `${service.name}Container`,
@@ -562,7 +617,8 @@ export class EcsCompute extends Construct {
         this.appName = props.appName;
         const services = props.services.map((service) => {
             const schemaVersionEnv = this.resolveSchemaVersionEnv(service);
-            const containers = buildContainerConfigs(service, schemaVersionEnv, this);
+            const chSchemaVersionEnv = this.resolveClickHouseSchemaVersionEnv(service);
+            const containers = buildContainerConfigs(service, schemaVersionEnv, this, chSchemaVersionEnv);
             const { scalingType, minCapacity, maxCapacity } = resolveScalingConfig(service.scaling);
             const cloudMapService = service.serviceDiscovery !== undefined
                 ? App.getInstance().registerService({
@@ -670,6 +726,30 @@ export class EcsCompute extends Construct {
             [EXPECTED_SCHEMA_VERSION_TOOL_ENV]: config.tool
         };
     }
+    /**
+     * ClickHouse mirror of `resolveSchemaVersionEnv`. Returns the
+     * `EXPECTED_CH_SCHEMA_VERSION` env entry, or `undefined` when the service is
+     * not gated.
+     *
+     * - `schemaGate: false` → returns `undefined` (auditable opt-out — same flag
+     *   covers BOTH PG and CH gates)
+     * - No migrated CH in connections → returns `undefined`
+     * - Exactly one migrated CH → returns `{ EXPECTED_CH_SCHEMA_VERSION }`
+     * - Two or more migrated CHs → throws via `resolveClickHouseDatabaseForService`
+     */
+    resolveClickHouseSchemaVersionEnv(service) {
+        if (service.schemaGate === false)
+            return undefined;
+        const db = resolveClickHouseDatabaseForService(service);
+        if (db === undefined)
+            return undefined;
+        const version = db.getExpectedSchemaVersion();
+        if (version === undefined)
+            return undefined;
+        return {
+            [EXPECTED_CH_SCHEMA_VERSION_ENV]: version
+        };
+    }
     materialiseScheduledTasks(id, props) {
         const scheduledTasks = props.cluster?.scheduledTasks;
         if (!scheduledTasks || scheduledTasks.length === 0)