docs(readme): add Deploy on AWS/GCP with Terraform section - #29873
docs(readme): add Deploy on AWS/GCP with Terraform section#29873yassin-berriai wants to merge 21 commits into
Conversation
[Infra] Promote internal staging to main
[Infra] Promote internal staging to main
chore(ci): promote internal staging to main
chore(ci): promote internal staging to main
chore(ci): promote internal staging to main
chore(ci): promote internal staging to main
chore(ci): promote internal staging to main
chore(ci): promote internal staging to main
chore(ci): promote internal staging to main
Adds a quickstart for the two published Terraform modules on the public registry (BerriAI/litellm/aws and BerriAI/litellm/google). Copy-paste main.tf for each cloud, the one-time GCP Artifact Registry remote-repo command, and pointers to the registry pages for the full input surface. Sits inside the Get Started section, between the gateway/SDK table and Run in Developer Mode -- where someone scanning the README for "how do I deploy this" will land. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
|
Greptile SummaryThis PR adds a new "Deploy on AWS or GCP with Terraform" section to the root
Confidence Score: 3/5The change is README-only and cannot break runtime behaviour, but it adds documentation directly to this repository in a way the team has explicitly decided against. A team rule explicitly requires new documentation to live in the litellm-docs repo rather than here; this PR deposits 124 lines of Terraform quickstart content into the root README instead. Beyond the policy issue, the GCP snippet silently requires users to replace README.md — the only changed file; the GCP section needs the placeholder concern addressed and the content should be evaluated for placement in the litellm-docs repo.
|
| Filename | Overview |
|---|---|
| README.md | Adds a 124-line "Deploy on AWS or GCP with Terraform" section with copy-paste HCL quickstarts; violates the policy requiring new documentation to live in the litellm-docs repo, and the GCP snippet has a repeated placeholder that users may only partially substitute. |
Comments Outside Diff (1)
-
README.md, line 406-529 (link)Documentation added to README violates litellm-docs repo policy
Per the team's custom instruction, documentation additions should live in the
litellm-docsrepository rather than being committed here. This entire "Deploy on AWS or GCP with Terraform" section (124 lines) was added to the rootREADME.md, which will diverge from the canonical docs site and creates a maintenance burden when these snippets need to be updated with new module versions.Rule Used: Prevent documentation from being added - needs to ... (source)
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Reviews (1): Last reviewed commit: "docs(readme): add Deploy on AWS/GCP with..." | Re-trigger Greptile
| source = "BerriAI/litellm/google" | ||
| version = "~> 1.89" | ||
|
|
||
| project_id = "my-gcp-project" | ||
| region = "us-central1" | ||
| tenant = "acme" | ||
| env = "prod" | ||
|
|
||
| image_registry = "us-central1-docker.pkg.dev/my-gcp-project/litellm/berriai" | ||
|
|
||
| # Production: provide DNS already pointing at the LB IP for Google-managed certs. | ||
| # Without one, set allow_plaintext_lb = true (dev/trial only). |
There was a problem hiding this comment.
my-gcp-project placeholder must be updated in three separate locations
The GCP snippet requires users to substitute my-gcp-project in three distinct places: the project_id input, the image_registry path, and the --project flag in the preceding gcloud command. It's easy to update project_id and miss the others — the image_registry value in particular looks like a module default rather than a user-specific placeholder, so users who copy-paste may end up pointing Cloud Run at a non-existent Artifact Registry path and hit a confusing deploy failure. Adding an inline comment like # Replace my-gcp-project with your GCP project ID on the image_registry line would help.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
GCP gets the real 1-click: Open in Cloud Shell badge that clones the repo and walks through `terraform apply` via the existing DeployStack tutorial (already shipped at terraform/litellm/gcp/examples/default/ TUTORIAL.md). User just picks a project. AWS gets a soft 1-click: a Launch in AWS CloudShell badge that opens an in-browser, already-authenticated shell. User runs four commands (clone + cd + cp tfvars + terraform apply) once inside. There's no native AWS deeplink that pre-clones a repo + runs a tutorial -- CFN "Launch Stack" + CodeBuild would be needed for that, and that's a separate piece of work. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…on font GitHub rewrites an image's height attribute to "height: auto; max-height: Npx", which only caps and never stretches, so each image renders at its intrinsic height. The AWS/GCP shields badges are intrinsically 28px while the Render/Railway buttons are 40px, leaving the row uneven regardless of the height="48" we set. Replace the two shields badges with committed 40px PNGs so all four header buttons render at the same 40px. Also swap the Cloud Shell button from open-btn.svg to open-btn.png. The SVG renders its label as live text with font-family "Roboto, Sans" and no generic fallback; since neither font exists in GitHub's render environment, the text fell back to a serif (Times New Roman). The PNG bakes in the correct typeface.
The Railway button wrapped its img across indented lines, so the anchor contained leading and trailing whitespace. GitHub underlines link content, rendering that whitespace as a small blue underline beside the button. Put the anchor on one line like the other three buttons so there is no inner whitespace to underline.
a0dce09 to
7cf1b26
Compare
Pull request was closed
Summary
Adds a quickstart for the two published Terraform modules on the public registry, inside the existing Get Started section.
Where it lands
Inside Get Started, between the gateway-vs-SDK table and "Run in Developer Mode" -- where someone scanning the README for "how do I deploy this" will look.
Test plan
🤖 Generated with Claude Code