You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: position Cloud Run deployment as demo API server example
Update all documentation to clarify that the Cloud Run deployment
is a demonstration for testing and development purposes only.
Users should self-host eidosd for production use.
Changes:
- RELEASING.md: Rename "Cloud Run Deployment" to "Demo Cloud Run Deployment"
- api-server.md: Rename "Production Deployment" to "Demo API Server Deployment"
- README.md (architecture): Update pipeline diagram and deployment description
- README.md (actions): Clarify deploy job is for demo purposes
- copilot-instructions.md: Update cloud-run-deploy action description
- CLAUDE.md: Update reference to demo deployment procedures
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
-**Pre-releases**: `v1.2.3-rc1`, `v1.2.3-beta1` (automatically marked in GitHub)
162
162
-**Breaking changes**: Increment MAJOR version
163
163
164
-
## Cloud Run Deployment
164
+
## Demo Cloud Run Deployment
165
165
166
-
The `eidosd` API server is automatically deployed to Google Cloud Run on successful release:
166
+
> **Note**: This is a **demonstration deployment** for testing and development purposes only. It is not a production service. Users should self-host the `eidosd` API server in their own infrastructure for production use. See [API Server Documentation](docs/architecture/api-server.md) for deployment guidance.
167
+
168
+
The `eidosd` API server demo is automatically deployed to Google Cloud Run on successful release:
> **Note**: This section describes the **demonstration deployment** of the `eidosd` API server for testing and development purposes only. It is not a production service. Users should self-host the `eidosd` API server in their own infrastructure for production use. See the [Kubernetes Deployment](#kubernetes-deployment) section below for deployment guidance.
529
529
530
-
The API server is deployed to Google Cloud Run with the following configuration:
530
+
### Example: Google Cloud Run
531
531
532
-
**Live Service:**
533
-
-**URL**: http://localhost:8080
532
+
The demo API server is deployed to Google Cloud Run as an example of how to deploy `eidosd`:
533
+
534
+
**Demo Configuration:**
534
535
-**Platform**: Google Cloud Run (fully managed serverless)
535
-
-**Authentication**: Public access
536
+
-**Authentication**: Public access (for demo purposes)
536
537
-**Auto-scaling**: 0-100 instances based on load
537
-
-**Region**: Multi-region for high availability
538
+
-**Region**: `us-west1`
538
539
539
540
**CI/CD Pipeline** (`on-tag.yaml`):
540
541
```mermaid
541
542
flowchart LR
542
543
A["Git Tag<br/>v0.8.12"] --> B["GitHub Actions"]
543
544
B --> C["Go CI<br/>(Test + Lint)"]
544
545
C --> D["Build Image<br/>(ko + goreleaser)"]
545
-
D --> E["Generate SBOM<br/>(Syft)"]
546
+
D --> E["Generate SBOM<br/>(Syft)"]
546
547
E --> F["Sign Attestations<br/>(Cosign keyless)"]
547
548
F --> G["Push to GHCR<br/>ghcr.io/nvidia/eidosd"]
548
-
G --> H["Deploy to Cloud Run<br/>(WIF auth)"]
549
+
G --> H["Demo Deploy<br/>(example)"]
549
550
H --> I["Health Check<br/>Verification"]
550
551
```
551
552
552
553
**Supply Chain Security:**
553
554
-**SLSA Build Level 3** compliance
554
555
-**Signed SBOMs** in SPDX format
555
-
-**Attestations** logged in Rekor transparency log
556
+
-**Attestations** logged in Rekor transparency log
0 commit comments