-
Notifications
You must be signed in to change notification settings - Fork 34
[Chore] Add documentation for tests #1266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Holy cow, thats a lot of generated text 😅
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1266 +/- ##
==========================================
+ Coverage 57.64% 57.81% +0.17%
==========================================
Files 121 123 +2
Lines 11277 11491 +214
==========================================
+ Hits 6501 6644 +143
- Misses 4418 4486 +68
- Partials 358 361 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
24k lines 🤯 |
Yeah, If we were to add this manually, it would have taken us forever. Glad that we can just generate the docs with a simple prompt. Claude can process few tests at a time and we have to remind it to continue working on the task. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation for the e2e tests in the Tempo Operator repository. The documentation provides detailed blueprints for various TempoStack and TempoMonolithic deployment configurations, covering everything from basic setups to advanced production scenarios.
Key changes include:
- Comprehensive README files for 25 different test scenarios
- Architecture diagrams and step-by-step deployment guides
- Production considerations and troubleshooting sections
- Configuration examples and operational tooling documentation
Reviewed Changes
Copilot reviewed 48 out of 57 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
tests/e2e/monolithic-memory/README.md | Documentation for basic TempoMonolithic deployment with in-memory storage |
tests/e2e/monolithic-ingestion-mtls/README.md | Guide for mTLS-secured trace ingestion with certificate management |
tests/e2e/monolithic-extraconfig/README.md | Documentation for advanced configuration override capabilities |
tests/e2e/monolithic-custom-storage-class/README.md | Guide for persistent storage with custom Kubernetes storage classes |
tests/e2e/generate/README.md | Documentation for configuration generation and GitOps workflows |
tests/e2e/gateway/README.md | Guide for authentication gateway with OIDC and dynamic Jaeger query control |
tests/e2e/custom-ca/README.md | Documentation for custom Certificate Authority integration |
tests/e2e/compatibility/README.md | Guide for distributed TempoStack with dual query APIs |
tests/e2e-openshift/tls-singletenant/README.md | OpenShift TLS configuration with service CA integration |
tests/e2e-openshift/tls-monolithic-singletenant/README.md | TempoMonolithic TLS setup using OpenShift service CA |
tests/e2e-openshift/tempostack-resources/README.md | Comprehensive resource management and allocation strategies |
tests/e2e-openshift/tempo-single-tenant-auth/README.md | Single tenant authentication with OpenShift OAuth integration |
tests/e2e-openshift/route/README.md | OpenShift Route configuration with must-gather validation |
tests/e2e-openshift/red-metrics/README.md | RED metrics generation with Prometheus alerting |
tests/e2e-openshift/multitenancy/README.md | Multi-tenant deployment with RBAC and monitoring |
tests/e2e-openshift/multitenancy-rbac/README.md | Advanced RBAC patterns for multi-tenant environments |
tests/e2e-openshift/monolithic-single-tenant-auth/README.md | TempoMonolithic authentication for single-tenant environments |
tests/e2e-openshift/monolithic-route/README.md | TempoMonolithic with OpenShift Route and operational tooling |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
I am a bit worried about keeping it up-to-date in the future. |
The PR adds documentation for the e2e tests.