Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: lint template template-local template-minio template-security smoke-local test
.PHONY: lint template template-local template-minio template-security render-examples smoke-local test

lint:
helm lint charts/render-worker
Expand All @@ -15,6 +15,9 @@ template-minio:
template-security:
helm template render-worker charts/render-worker -f examples/values-security-hardening.yaml

render-examples:
scripts/render-examples.sh

smoke-local:
scripts/smoke-local.sh

Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ It is not a full render manager, DCC integration, asset pipeline, AWS provisioni
| Adapter seams | queue, storage, and identity values in examples and helper templates |
| Local smoke path | `workers/mock-render-worker/`, `examples/mock-queue.txt`, and `make smoke-local` |
| Example manifests | `examples/values-local.yaml`, `examples/values-local-minio.yaml`, and `examples/values-aws-gpu-sqs.yaml` |
| Validation | `make test`, `scripts/render-examples.sh`, and GitHub Actions |
| Validation | `make test`, `make render-examples`, and GitHub Actions |
| Evidence map | `docs/evidence-map.md` |

## Quick Start
Expand All @@ -74,6 +74,12 @@ make template-minio
make template
```

Render every built-in example and run kubeconform when it is installed:

```bash
make render-examples
```

Run the public mock worker smoke test without AWS credentials, a real renderer, or a Kubernetes cluster:

```bash
Expand All @@ -89,12 +95,12 @@ Common validation commands:
```bash
make lint
make test
make render-examples
make smoke-local
scripts/render-examples.sh
git diff --check
```

`make test` runs chart contract tests for GPU/KEDA rendering behavior and values schema rejection. `scripts/render-examples.sh` renders the built-in examples and validates manifests with kubeconform when available. CI installs pinned Helm and kubeconform versions before running the same chart validation path.
`make test` runs chart contract tests for GPU/KEDA rendering behavior and values schema rejection. `make render-examples` renders the built-in examples and validates manifests with kubeconform when available. CI installs pinned Helm and kubeconform versions before running the same chart validation path.

See `docs/development.md` for the issue, branch, pull request, and validation workflow.

Expand Down
3 changes: 2 additions & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ make template
make template-local
make template-minio
make template-security
make render-examples
make smoke-local
make test
```

`scripts/render-examples.sh` also validates default, local, local MinIO, AWS GPU/SQS, and security-hardening rendered manifests with kubeconform when it is installed locally. CI installs Helm and kubeconform with pinned versions and SHA256 checksums, then validates built-in Kubernetes resources and KEDA CRDs through a pinned CRD schema catalog.
`make render-examples` validates default, local, local MinIO, AWS GPU/SQS, and security-hardening rendered manifests with kubeconform when it is installed locally. It wraps `scripts/render-examples.sh` so the full example-rendering path is discoverable from the Makefile. CI installs Helm and kubeconform with pinned versions and SHA256 checksums, then validates built-in Kubernetes resources and KEDA CRDs through a pinned CRD schema catalog.

`make smoke-local` runs the public mock worker path from `workers/mock-render-worker/mock-render-worker.sh`. It consumes `examples/mock-queue.txt`, writes placeholder frame output, and creates a postprocess manifest without AWS credentials, a real renderer, or a Kubernetes cluster.

Expand Down
1 change: 1 addition & 0 deletions docs/evidence-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This file maps resume claims to public repository evidence.
| Post-render batch processing | `charts/render-worker/templates/postprocess-job.yaml`, `charts/render-worker/values.yaml`, `scripts/chart-contract-tests.sh` | Render local or AWS examples or run `make test`; inspect Helm hook annotations and the managed-mode opt-out | Implemented | Hook mode avoids normal Helm patching of immutable Job pod templates; live cluster upgrade proof remains environment-specific |
| Public mock worker smoke path | `workers/mock-render-worker/mock-render-worker.sh`, `scripts/smoke-local.sh`, `examples/mock-queue.txt` | Run `make smoke-local` and inspect placeholder frame output plus the postprocess manifest | Implemented | Mock path validates the public worker contract only; it is not a real renderer, queue service, object store, or cluster test |
| Chart contract tests and values schema | `scripts/chart-contract-tests.sh`, `charts/render-worker/values.schema.json` | Run `make test`; CI also runs these tests on PRs and `main` pushes | Implemented | Contract tests inspect rendered manifests and schema failures only; no live Kubernetes, KEDA operator, AWS SQS, MinIO, or GPU node behavior is exercised |
| Rendered example validation | `Makefile`, `scripts/render-examples.sh`, `examples/*.yaml` | Run `make render-examples`; inspect default, local, local MinIO, AWS GPU/SQS, and security-hardening manifests | Implemented | Rendering and kubeconform validation are static checks only; no live cluster, AWS SQS, S3, MinIO, IAM, or GPU node behavior is exercised |
| CI/CD discipline | `.github/workflows/ci.yml` | Review GitHub Actions runs; CI executes Helm lint, template rendering, kubeconform validation, mock smoke, and chart contract tests | Implemented | Static and local validation only; no live cluster, admission webhook, KEDA operator, AWS SQS, MinIO, or GPU node behavior is exercised |
| Tool install integrity | `.github/workflows/ci.yml` | Inspect CI install steps for Helm and kubeconform checksum verification | Implemented | Checksums verify downloaded release assets, not upstream maintainer identity |
| Engineering workflow | `.github/ISSUE_TEMPLATE/*`, `.github/pull_request_template.md`, `docs/roadmap.md` | Review merged PRs and open delivery issues | Active | Solo project, but PR discipline is preserved |
Expand Down