Skip to content

Commit 7f2a40e

Browse files
committed
update the README.md to keep up-to-date
1 parent 59f56ba commit 7f2a40e

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

crcr/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ crcr/
2929
├── scripts/
3030
│ └── terrafile_lambdas.py # Downloads Terraform modules and Lambda ZIP assets
3131
├── modules/
32-
│ ├── backend-file/ # S3 backend configuration templates
32+
│ ├── backend-file/ # S3 backend configuration templates for terraform init
3333
│ │ ├── backend-state.tf
3434
│ │ └── backend.tf
3535
│ └── backend-state/ # Symlink to ../../modules/backend-state
@@ -41,11 +41,13 @@ crcr/
4141
├── locals.tf # Computed values (secret ARN, AZs, tags)
4242
├── outputs.tf # Outputs (webhook URL, Redis endpoint)
4343
├── vpc.tf # VPC and subnets
44+
├── security.tf # VPC security groups (Lambda ↔ Redis ↔ internet)
4445
├── iam.tf # Lambda execution role and policies
4546
├── secrets.tf # Secrets Manager secret and version
4647
├── elasticache.tf # Redis replication group
47-
├── callback.tf # Result callback lambda function and public function URL
48-
└── webhook.tf # Webhook lambda function and public function URL
48+
├── callback.tf # Result callback Lambda and public function URL
49+
├── webhook.tf # Webhook receiver Lambda and public function URL
50+
└── sweeper.tf # EventBridge scheduled trigger for zombie-job cleanup
4951
```
5052

5153
## Prerequisites
@@ -90,6 +92,7 @@ aws dynamodb create-table \
9092
| `hud_api_url` | `N/A` | URL for sending callback data to HUD |
9193
| `hud_bot_key` | `N/A` | Key to access to HUD (sensitive) |
9294
| `crcr_status_ttl` | `259200` | CRCR workflow run status TTL in Redis (seconds) |
95+
| `sweeper_interval_minutes` | `10` | How often EventBridge triggers the callback Lambda to reap timed-out zombie jobs (minutes, >= 2) |
9396

9497
**Note:**
9598

@@ -160,6 +163,6 @@ CRCR follows a four-level progression system. Each level adds more integration b
160163
| Level | Name | Status | Description |
161164
|---|---|---|---|
162165
| **L1** | Events Only | running | Webhook events are forwarded to downstream repos. No feedback to upstream PRs. Downstream repos receive `repository_dispatch` and run CI independently. |
163-
| **L2** | HUD Visibility | **Current** | Downstream CI results are written to ClickHouse and displayed on a dedicated HUD page (`hud.pytorch.org/crcr/[org]/[repo]`). Upstream PRs still show no check status. |
164-
| **L3** | Label-Triggered PR Checks | developing | A non-blocking Check Run appears on upstream PRs when a `ciflow/crcr/<name>` label is added. This is the recommended long-term target for most downstream repos. |
166+
| **L2** | HUD Visibility | completed | Downstream CI results are written to ClickHouse and displayed on a dedicated HUD page (`hud.pytorch.org/crcr/[org]/[repo]`). Upstream PRs still show no check status. |
167+
| **L3** | Label-Triggered PR Checks | **Current** | A non-blocking Check Run appears on upstream PRs when a `ciflow/crcr/<name>` label is added. This is the recommended long-term target for most downstream repos. |
165168
| **L4** | Always-On Blocking Checks | developing | Blocking Check Run auto-triggered for every PR. Reserved for critical accelerators only. Merge is blocked on failure. |

0 commit comments

Comments
 (0)