@spine-event-engine/deployment-gke 2.0.0-snapshot.11

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,404 @@
+# Deploy a Spine TS application on GKE
+
+`@spine-event-engine/deployment-gke` helps one standalone Gateway find ready
+Spine TS application nodes through a Kubernetes headless Service. This guide
+adds an editable Terraform starting point for a private, one-Gateway GKE
+deployment. It is deliberately storage-neutral: your application chooses the
+storage and supplies its configuration.
+
+This is a guide for people deploying an application. For exact discovery API
+and lifecycle behavior, see the [deployment reference](REFERENCE.md).
+
+This experimental snapshot package is for operators who already own
+an application, images, and a GKE cluster. Install its library API when writing
+the Gateway or application entrypoint:
+
+```bash
+pnpm add @spine-event-engine/deployment-gke@snapshot
+```
+
+Copy the packaged Terraform directory into an operator deployment repository
+only when you want its private reference topology. Installing this library, or
+copying Terraform, does not create the cluster, public Gateway policy,
+authentication/session implementation, application secrets, or storage.
+
+## Before you begin
+
+You need an existing GKE cluster, `gcloud`, `kubectl`, Terraform 1.6 or newer,
+an existing Kubernetes ServiceAccount with the image-pull and configuration
+access required by your workload, and images for three processes:
+
+- your Spine TS application-node image;
+- your standalone Gateway image; and
+- an image running the simple delivery server.
+
+Publish immutable image references before deployment. The template does not
+create a GKE cluster, an image registry, an identity provider, or application
+secrets. Authenticate `gcloud` and select the cluster first:
+
+```bash
+gcloud container clusters get-credentials CLUSTER --location REGION --project PROJECT
+kubectl create namespace spine-app
+```
+
+Create the two Secrets through your normal secret-management process before
+running Terraform. Terraform receives only their names; it never receives or
+creates their values. The application Secret holds application-selected
+settings, including storage settings when the application needs them. The
+Gateway Secret holds separate identity and session settings.
+
+## First Terraform plan
+
+Copy the packaged template into an operator-owned deployment repository. The
+following commands assume its Terraform directory is your current directory;
+fill in its existing cluster, Secret names, and immutable image references,
+then validate the private topology before configuring entrypoint details:
+
+```bash
+cp terraform.tfvars.example terraform.tfvars
+terraform init
+terraform fmt -check
+terraform validate
+terraform plan -var-file=terraform.tfvars
+```
+
+A plan showing only the Gateway, application, delivery, and private Services
+is the first success. Review it before `terraform apply`.
+
+## What this deployment creates
+
+The Terraform module creates three private Kubernetes Deployments and three
+ClusterIP Services. One Service is headless: Kubernetes publishes the ready
+Node Coordinator endpoint of each application Pod in DNS. The Gateway uses that
+DNS name with `GkeNodeDiscovery`; it does not call the Kubernetes API or
+maintain a separate node registry. Managed application children remain
+loopback-only and are not Service endpoints.
+
+```mermaid
+flowchart LR
+  Edge["Operator-managed TLS and authentication edge"] --> Gateway["One standalone Gateway"]
+  Gateway --> DNS["Headless application Service DNS"]
+  DNS --> App1["Application node"]
+  DNS --> App2["Application node"]
+  App1 --> Delivery["One simple delivery server"]
+  App2 --> Delivery
+```
+
+The template intentionally keeps Gateway, application, and delivery traffic
+private. It does not create a public load balancer, TLS certificate, or
+authentication policy. Connect the `gateway` ClusterIP Service to the public
+TLS/authentication edge your operators choose. That edge is responsible for
+admitting browser traffic; the Gateway then forwards authorized requests to
+the application nodes.
+
+The simple delivery server is useful for this supported topology, but it is
+in-memory, single-replica, and not highly available. It loses its state when
+it restarts. Choose an operationally suitable delivery design before depending
+on it for a critical production workload.
+
+This template has one Gateway and a fixed deployment shape. Multiple-Gateway
+behavior and Cloud Run are outside the supported offering.
+
+## Configure the template
+
+Edit the existing `terraform.tfvars` copied for the first plan and replace every placeholder with values for
+your cluster and delivery pipeline:
+
+`terraform.tfvars` asks for the existing Secret names, immutable images, and
+the kubeconfig context selected by `gcloud`. It defaults to two application
+nodes, one Gateway, and one delivery server. The Gateway and delivery-server
+replica counts are intentionally fixed at one in this topology.
+
+Your application and Gateway entrypoints remain application code. The template
+uses `HOST=0.0.0.0` and the matching `PORT` value for every container so its
+private Kubernetes Service can reach the process. Keep that listener convention
+in your image entrypoints. Put one small configuration owner beside the two
+entrypoints, then have each entrypoint read its injected settings rather than
+hard-coding the Terraform defaults:
+
+Both supplied entrypoints bind `host: "0.0.0.0"` so the Kubernetes Service can
+reach their listeners.
+
+<!-- docs-snippet-path: packages/deployment-gke/examples/deployment-settings.ts -->
+
+```ts
+export type DeploymentEnvironment = Readonly<Record<string, string | undefined>>;
+
+export const DeploymentSettings = Object.freeze({
+  port(environment: DeploymentEnvironment, name: "PORT" | "BACKEND_DISCOVERY_PORT"): number {
+    const value = environment[name];
+    const port = Number(value);
+    if (typeof value !== "string" || !Number.isInteger(port) || port < 1 || port > 65_535)
+      throw new Error(`${name} must be an integer from 1 through 65535.`);
+    return port;
+  },
+
+  serviceName(environment: DeploymentEnvironment): string {
+    const value = environment.BACKEND_DISCOVERY_SERVICE?.trim();
+    if (value === undefined || value.length === 0)
+      throw new Error("BACKEND_DISCOVERY_SERVICE must not be blank.");
+    return value;
+  },
+});
+```
+
+The [complete shared settings owner](examples/deployment-settings.ts) is a
+small source file. Each Node.js entrypoint supplies `process.env` to it.
+The Gateway reads `"BACKEND_DISCOVERY_PORT"` and
+`BACKEND_DISCOVERY_SERVICE` from the same source.
+
+The standalone Gateway uses the headless Service name and application port from
+the module. Choose one admission mode for it: authenticated mode supplies
+sessions and may supply named durable subscription bindings; public mode
+supplies `publicAccess: true`, and the framework owns process-local bindings.
+Both modes supply authorization, trusted actor-context resolution, allowed
+origins, a clock, and a type registry. The complete
+[server browser guide](https://github.com/SpineEventEngine/spine-ts/blob/master/packages/server/README.md#browser-gateway-migration) and
+[browser authentication guide](https://github.com/SpineEventEngine/spine-ts/blob/master/docs/BROWSER_CLIENT_AUTH_EXTENSION_GUIDE.md)
+explain those application integration points.
+
+<!-- docs-snippet-path: packages/deployment-gke/examples/gateway.ts -->
+
+```ts
+import { GkeNodeDiscovery } from "@spine-event-engine/deployment-gke";
+import { BrowserServer, type BrowserServerOptions } from "@spine-event-engine/server/browser";
+
+type GatewayBrowserOptions = BrowserServerOptions extends infer Options
+  ? Options extends BrowserServerOptions
+    ? Omit<Options, "host" | "port" | "discovery">
+    : never
+  : never;
+
+import { DeploymentSettings, type DeploymentEnvironment } from "./deployment-settings.js";
+
+export interface GatewayOptions {
+  readonly browser: GatewayBrowserOptions;
+}
+
+export const GatewayEntrypoint = Object.freeze({
+  async run(
+    options: GatewayOptions,
+    environment: DeploymentEnvironment = process.env,
+  ): Promise<void> {
+    const discovery = new GkeNodeDiscovery({
+      serviceName: DeploymentSettings.serviceName(environment),
+      port: DeploymentSettings.port(environment, "BACKEND_DISCOVERY_PORT"),
+    });
+    await BrowserServer.run({
+      host: "0.0.0.0",
+      port: DeploymentSettings.port(environment, "PORT"),
+      ...options.browser,
+      discovery,
+    });
+  },
+});
+```
+
+The [complete Gateway entrypoint](examples/gateway.ts) receives your typed
+browser collaborators as `GatewayOptions`. In authenticated mode, supply
+sessions, authorization, trusted actor-context resolution, allowed origins, a
+clock, type registry, and optionally named durable subscription bindings. In
+public mode, supply `publicAccess: true` with the shared collaborators; it
+cannot accept bindings because the framework owns process-local ones.
+
+The application entrypoint uses the same configuration source for its managed
+Coordinator. Set `application_process_count` and `delivery_shard_count`
+explicitly in Terraform. The former starts complete local replicas; the latter
+is passed to your context assembly and is not inferred from hardware:
+
+<!-- docs-snippet-path: packages/deployment-gke/examples/application.ts -->
+
+```ts
+import {
+  ManagedServerApplication,
+  type ManagedServerApplicationHandle,
+  type ManagedServerApplicationOptions,
+  type RunningServer,
+} from "@spine-event-engine/server";
+
+import { DeploymentSettings, type DeploymentEnvironment } from "./deployment-settings.js";
+
+export interface ApplicationOptions {
+  readonly moduleUrl: string;
+  readonly createServer: (options: {
+    readonly host: string;
+    readonly port: number;
+    readonly deliveryShardCount: number;
+  }) => Promise<RunningServer>;
+  readonly synchronize?: ManagedServerApplicationOptions["synchronize"];
+  readonly restart?: ManagedServerApplicationOptions["restart"];
+}
+
+export const ApplicationEntrypoint = Object.freeze({
+  async run(
+    options: ApplicationOptions,
+    environment: DeploymentEnvironment = process.env,
+  ): Promise<ManagedServerApplicationHandle> {
+    const deliveryShardCount = DeploymentSettings.deliveryShardCount(environment);
+    return await ManagedServerApplication.run({
+      processCount: DeploymentSettings.processCount(environment),
+      host: "0.0.0.0",
+      port: DeploymentSettings.port(environment, "PORT"),
+      moduleUrl: options.moduleUrl,
+      createServer: async ({ host, port }) =>
+        await options.createServer({ host, port, deliveryShardCount }),
+      ...(options.synchronize === undefined ? {} : { synchronize: options.synchronize }),
+      ...(options.restart === undefined ? {} : { restart: options.restart }),
+    });
+  },
+});
+```
+
+The [complete application entrypoint](examples/application.ts) receives its
+typed bounded-context, service, and resource configuration as
+`ApplicationOptions`.
+
+The ConfigMap in the template exposes matching service and port values as a
+simple convention. Adapt the names or use another configuration loader; Spine
+TS does not require a particular environment-variable format. Authenticated
+production startup rejects missing or volatile bindings before opening its
+browser listener. `DurableSubscriptionBindings` is the supplied durable option;
+give it a stable namespace and storage factory configured by the Gateway
+process. Use shared persistent storage across Gateway replacements; an
+in-memory store does not preserve bindings when a Gateway is replaced. Public
+mode has no supplied bindings: its framework-owned process-local definitions
+end when the Gateway is replaced.
+
+## Deploy
+
+Terraform applies Kubernetes resources to the cluster selected by your
+kubeconfig. Keep cluster creation separate from this module, then run:
+
+```bash
+terraform init
+terraform fmt -check
+terraform validate
+terraform plan -var-file=terraform.tfvars
+terraform apply -var-file=terraform.tfvars
+```
+
+`plan` should show one Gateway Deployment, one delivery Deployment, one
+application Deployment, and only private Services. Review it before `apply`.
+
+## Verify the deployment
+
+Wait for the Deployments, then inspect the headless Service endpoints:
+
+```bash
+kubectl get deployment,pod,service --namespace spine-app
+kubectl rollout status deployment/application --namespace spine-app
+kubectl rollout status deployment/gateway --namespace spine-app
+kubectl rollout status deployment/delivery --namespace spine-app
+kubectl get endpointslice --namespace spine-app \
+  --selector kubernetes.io/service-name=application
+kubectl logs --namespace spine-app deployment/gateway
+```
+
+A ready application Pod appears in the EndpointSlice and therefore becomes an
+available Gateway backend. An unready Pod is not published because the Service
+sets `publishNotReadyAddresses` to `false`. The Gateway refreshes the DNS
+answer and reconciles its backend connections. A Gateway log or an application
+metrics should show the expected ready backend count.
+
+## Scale application nodes
+
+Spine TS never changes replica counts. When autoscaling is disabled, operators
+scale the identical application Deployment by changing the Terraform input:
+
+```bash
+terraform apply -var-file=terraform.tfvars -var=application_replicas=4
+terraform apply -var-file=terraform.tfvars -var=application_replicas=1
+```
+
+Scaling to zero is also explicit. The Gateway remains available but reports no
+backend until a ready application node returns:
+
+```bash
+terraform apply -var-file=terraform.tfvars -var=application_replicas=0
+terraform apply -var-file=terraform.tfvars -var=application_replicas=2
+```
+
+The optional HPA is disabled by default. Its minimum is one application node.
+When your platform team already operates an external-metrics adapter, set
+`autoscaling_enabled = true` and choose its metric name, target, minimum, and
+maximum in `terraform.tfvars`.
+When it is enabled, Terraform deliberately omits the Deployment replica value
+so routine applies do not reset changes made by the HPA. To return to manual
+capacity, disable autoscaling and set `application_replicas` in the same apply.
+CPU alone cannot wake an application Deployment from zero because no Pod is
+running to report CPU. On Standard GKE, Google documents KEDA as the scale from
+zero path. For that policy, set `autoscaling_enabled = false` and let
+operator-managed KEDA be the sole autoscaler for the Deployment. HPA and KEDA
+are mutually exclusive: never run the module HPA and a KEDA-managed HPA
+together. Add the KEDA configuration
+separately; this editable template does not install CRDs or assume a metric
+provider.
+
+## Replace an application version
+
+Use immutable image digests and keep the previous digest in your deployment
+record. A compatible replacement can use Kubernetes' normal rolling update:
+
+```bash
+terraform apply -var-file=terraform.tfvars \
+  -var='application_image=REGION-docker.pkg.dev/PROJECT/spine/application@sha256:NEW'
+```
+
+During overlap, old and new nodes can process work. Pending Inbox work may run
+under the new business logic, so operators—not Spine TS—must decide whether the
+two versions are compatible. For an incompatible replacement, first disable
+the module HPA if it controls capacity, stop every application node, apply the new
+image, then restore one chosen capacity policy:
+
+```bash
+terraform apply -var-file=terraform.tfvars \
+  -var=autoscaling_enabled=false -var=application_replicas=0
+terraform apply -var-file=terraform.tfvars \
+  -var='application_image=REGION-docker.pkg.dev/PROJECT/spine/application@sha256:NEW' \
+  -var=application_replicas=2
+```
+
+Keep manual capacity by leaving `autoscaling_enabled = false`. Restore the
+module HPA by applying `autoscaling_enabled = true` only when KEDA is absent.
+For KEDA, leave the module HPA disabled and restore the operator-managed KEDA
+policy only after the new application version is ready. Before the stop-all
+step, suspend or remove the KEDA policy so it cannot create a node while the
+replacement is intentionally at zero.
+
+Replacing the single Gateway interrupts connected clients. The
+Gateway-configured durable subscription registry preserves definitions across
+the replacement; clients reconnect and re-query authoritative state after the
+Gateway is ready again.
+
+## Roll back
+
+Roll back by applying a known compatible image digest and the prior replica
+count. For an incompatible rollback, first disable the module HPA, use the
+same stop-all, apply-old-image, start sequence, then restore exactly one of
+manual replicas, the module HPA, or the operator-managed KEDA policy. Confirm
+ready application endpoints and a successful Gateway connection before
+declaring the rollback complete. Suspend or remove the KEDA policy before the
+stop-all step, then restore it only after the old version is ready.
+
+## Troubleshooting
+
+| Symptom                    | Check                                                                              | Likely next step                                                                                  |
+| -------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| Gateway has no backend     | `kubectl get endpointslice -n spine-app -l kubernetes.io/service-name=application` | Check application logs and readiness; only ready Pods enter headless DNS.                         |
+| Pods do not start          | `kubectl describe pod -n spine-app POD`                                            | Verify image access, ServiceAccount permissions, and that both existing Secret names are correct. |
+| Terraform cannot connect   | `kubectl config current-context`                                                   | Re-run `gcloud container clusters get-credentials` and match `kubeconfig_context`.                |
+| HPA shows no data          | `kubectl describe hpa -n spine-app application`                                    | Confirm the external-metrics adapter and metric name; the template does not install either.       |
+| Browser clients disconnect | Gateway logs and the public edge                                                   | Expect interruption during Gateway replacement; reconnect and re-query.                           |
+
+## Remove the deployment
+
+Remove only the Terraform-managed resources when the application is no longer
+needed:
+
+```bash
+terraform destroy -var-file=terraform.tfvars
+```
+
+The existing namespace, image registry, public edge, and Secrets are
+managed by the operator and remain. Delete them separately only after verifying that no
+other workload needs them.

package/REFERENCE.md

@@ -0,0 +1,56 @@
+# GKE deployment reference
+
+The [deployment guide](README.md) is for people deploying an application. This
+reference records the exact package and Terraform-template contract.
+
+## Discovery package
+
+`GkeNodeDiscovery` implements `NodeDiscovery`. It reads A and AAAA answers for
+a headless-Service DNS name and publishes each successful answer as a complete
+ready-Coordinator snapshot. Each answer reaches one node-local Coordinator,
+not a managed child listener. Its default refresh interval is 10 seconds. A
+positive DNS TTL can schedule an earlier refresh; zero, missing, and unusable
+TTLs use the configured interval. Empty and name-not-found answers publish an
+empty snapshot immediately and retry at the configured interval.
+
+HTTPS connects to Pod IP addresses while retaining the configured Service name
+for TLS server-name verification. Resolver failures retain the last valid
+membership until its deadline, then publish one empty snapshot while retries
+continue. `close()` cancels timers and resolver work, waits for admitted work,
+and prevents later snapshots.
+
+Supplying discovery to `BrowserServer.run(...)` from
+`@spine-event-engine/server/browser` selects standalone Gateway hosting. It
+does not build or attach local contexts, and closing the Gateway stops
+discovery. When an application supplies both fixed
+`backend` URLs and discovery, discovery is the active membership source; fixed
+URLs are not reconciled.
+
+## Terraform template
+
+`terraform/` targets an existing Kubernetes context. It does not provision a
+GKE cluster. The module uses versioned Kubernetes-provider resources and keeps
+the three process Services private. `application` is headless with
+`publish_not_ready_addresses = false`; its ready Coordinator endpoint addresses
+are the Gateway discovery source. `gateway` and `delivery` each have exactly one
+replica. The delivery server is in-memory and not highly available.
+
+The module creates no Kubernetes Secret and accepts only the names of
+operator-created application and Gateway Secrets. It selects no storage engine,
+identity provider, public load balancer, TLS certificate, Cloud Run service, or
+application command. The topology has exactly one Gateway; Multiple-Gateway
+behavior is outside its contract. Application code configures
+`GkeNodeDiscovery`, storage, identity, public-edge integration, and any session
+or secret resolution.
+
+`autoscaling_enabled` defaults to `false`. When true, the module creates one
+external-metric HPA with a minimum of one and the operator's metric, target,
+and maximum
+and omits the Deployment replica value, leaving capacity control with the
+HPA. When false, Terraform manages `application_replicas`. The HPA is not a
+scale-to-zero mechanism; external request or queue activation such as
+operator-managed KEDA is required for that behavior on Standard GKE. KEDA is
+the sole autoscaler for its target Deployment: set `autoscaling_enabled` to
+`false` before applying a KEDA policy. Suspend or remove KEDA before an
+incompatible stop-all replacement or rollback, and restore it only after the
+selected version is ready.

package/dist/discovery/gke-log.d.ts

@@ -0,0 +1,11 @@
+import type { ILogLayer } from "loglayer";
+/**
+ * Records a contained GKE discovery warning without changing discovery outcomes.
+ *
+ * @param logger Receives the contained record when supplied.
+ */
+export declare const gkeDiscoveryLog: Readonly<{
+    warn(logger: ILogLayer | undefined): void;
+    isPromiseLike(value: unknown): value is PromiseLike<unknown>;
+}>;
+//# sourceMappingURL=gke-log.d.ts.map

package/dist/discovery/gke-log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gke-log.d.ts","sourceRoot":"","sources":["../../src/discovery/gke-log.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC;IACrC,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;IAC1C,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;CAC9D,CAyBC,CAAC"}