Skip to content

Commit

Permalink
doc: update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
shivanshs9 committed Nov 11, 2024
1 parent ab76cfc commit 5a996c5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 2 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
9 changes: 8 additions & 1 deletion iac/pulumi-gcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

0 comments on commit 5a996c5

Please sign in to comment.