From 5a996c5b3961cd3d6a22717ee39897b6d9016c90 Mon Sep 17 00:00:00 2001 From: Shirou-kun Date: Tue, 12 Nov 2024 02:19:36 +0900 Subject: [PATCH] doc: update readmes --- README.md | 4 ++++ frontend/README.md | 2 ++ iac/pulumi-gcp/README.md | 9 ++++++++- 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19f1896e..2d248add 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,7 @@ Supports WebGPU if your browser provides! - GCP Managed Prometheus enabled to store the metrics on the cloud. Saves the hassle of managing on-prem prometheus, plus can setup alerts or create dashboards using the metrics to ensure a reliable monitoring data source. - Gateway API for Ingress enabled, allows using HttpRoute resource to define Ingress routes. It feels more natural and mature than the ever-changing Ingress or Service resources. - Sending Logs to [GCP Logging Stack](https://cloud.google.com/logging/docs/view/logs-explorer-interface) (managed service). +1. Using GCP's Secret Manager for storing Postgres creds. +1. Cluster is using private subnet, all workloads are in private network and the communication between backend and postgres is TLS encrypted using private network. +1. Envoy proxy is used to expose gRPC-Web interface to the backend API, it also forwards the real client IP by detecting the Cloudflare headers. +1. GCP's Ingress ALB is configured to only listen to HTTPS, by using self-signed TLS certifcate, ensuring end-to-end traffic encryption. diff --git a/frontend/README.md b/frontend/README.md index 5002b0df..cf26b5a4 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,5 +1,7 @@ # Whisper Web +Disclaimer: The code is derived from the original [Whisper web project](https://github.com/xenova/whisper-web). Huge shoutout to [@xenova](https://github.com/xenova) for an amazing use-case of Whisper model! + ### Original excerpt > ML-powered speech recognition directly in your browser! Built with [🤗 Transformers.js](https://github.com/xenova/transformers.js). > Check out the demo site [here](https://huggingface.co/spaces/Xenova/whisper-webgpu). diff --git a/iac/pulumi-gcp/README.md b/iac/pulumi-gcp/README.md index 6f2eea56..2ed482a3 100644 --- a/iac/pulumi-gcp/README.md +++ b/iac/pulumi-gcp/README.md @@ -98,4 +98,11 @@ pulumi up -s prod --diff ## Next steps -Once all the provisioning steps are successful, refer to [k8s services](../services/). +Once all the provisioning steps are successful, it's time to configure DNS for public-facing frontend and API gateway. +In your DNS nameserver provider (like Cloudflare), point A record to the IP address of gateway. To get the External address, use: + +```bash +kubectl get gateway +``` + +For runtime configs related to applications, refer to [k8s services](../services/).