Zenko
Copilot instructions672 starsChanged 3 months agoApache-2.0View on GitHub
This is Scality's open-source multi-cloud data controller — a Kubernetes-based deployment of the Zenko stack. The actual service implementations (cloudserver, backbeat, vault2, sorbet, scuba, s3utils, pensieve-api, kafka-cleaner, drctl, zenko-operator) live in separate repos; this repo packages, versions, and tests them together. When reviewing a PR, analyze changes against the following. Post inline comments only for real problems — no praise, no style nits covered by linters.
- Reads credentials
We split this copilot-instructions.md into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 22
When reviewing a PR, analyze changes against the following.
≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Zenko — Copilot / AI Reviewer Instructions
Repo context
This is Scality's open-source multi-cloud data controller — a Kubernetes-based deployment of the Zenko stack. The actual service implementations (cloudserver, backbeat, vault2, sorbet, scuba, s3utils, pensieve-api, kafka-cleaner, drctl, zenko-operator) live in separate repos; this repo packages, versions, and tests them together.
Key paths:
solution/deps.yaml,solution-base/deps.yaml— image/registry/tag manifests for every Zenko componentsolution/zenkoversion.yaml—ZenkoVersionCR template (dashboards, policies, feature flags, capabilities, location types)solution/kafka/Dockerfile,solution/kafka-connect/Dockerfile— Scality Kafka + Kafka Connect imagessolution-base/mongodb/— MongoDB Helm chart, vendored frombitnami/chartsviagit subtreesolution-base/images/— Scality-built MongoDB images (mongodb-sharded,mongodb-exporter,os-shell), vendored frombitnami/containersviagit subtreetests/functional/ctst/— TypeScript Cucumber end-to-end teststests/workflows/— TypeScript Jest tests for CI toolingtests/zenko_tests/— Python + Node.js integration testsmonitoring/— Prometheus rules, Grafana dashboards.github/workflows/— CI pipelines (end2end,release,review,alerts)
PR review criteria
When reviewing a PR, analyze changes against the following. Post inline comments only for real problems — no praise, no style nits covered by linters.
| Area | What to check |
Image tag pinning (solution/deps.yaml, solution-base/deps.yaml) | Every entry must pin to a concrete released tag or content hash — never a branch, latest, or a floating ref. Scality-internal images (cloudserver, backbeat, vault2, ...) must resolve to a tag actually published on ghcr.io/scality. |
| Version coherence | Bumps to VERSION / deps.yaml / solution/zenkoversion.yaml should stay mutually consistent. Feature flags or capabilities added in zenkoversion.yaml must correspond to service versions that actually support them. |
Dockerfiles (solution/kafka/, solution/kafka-connect/...) | Base images pinned by tag or digest, no secrets baked in, no unnecessary COPY . ., reasonable layer count, user is non-root where possible. |
Helm charts & K8s manifests (solution-base/mongodb/charts/, monitoring/) | Resource requests/limits set, label selectors match, no hard-coded namespaces, securityContext present, ServiceAccount scoping minimal. Any breaking chart-value renames documented in an upgrade note. |
Chart upgrade path (solution-base/mongodb/charts/, Makefile, how_to_upgrade.md) | Changes under the vendored chart prefix arrive as a git subtree merge (squashed) plus discrete local-modification commits, not as ad-hoc edits to the tree. |
Image vendoring path (solution-base/images/) | Changes under a vendored image prefix arrive as a make -C solution-base/images vendor-sync subtree merge plus discrete local-modification commits, not as ad-hoc edits. Every BITNAMI_<image>_REF in solution-base/images/Makefile must pin a full upstream commit SHA — never a branch, tag, or main. |
TypeScript tests (tests/functional/ctst/, tests/workflows/) | Proper async/await, no swallowed promise rejections, Cucumber step definitions register correctly, no accidental .only / .skip, correct use of World context in ctst. |
Python tests (tests/zenko_tests/) | No bare except:, specific exception types, consistency with existing style, requirements.txt kept in sync. |
CI workflows (.github/workflows/) | Actions pinned (tag or SHA), secrets not echoed to logs, permissions: block scoped minimally, reusable-workflow inputs/secrets wired correctly, runner labels valid for Scality infra. |
Monitoring changes (monitoring/) | PromQL expressions valid, alert labels/annotations follow existing conventions, dashboard panels reference real metrics, Grafana JSON not corrupted by export tooling. |
| Secrets & config leaks | No credentials, tokens, cloud keys, or internal hostnames in YAML templates, Dockerfiles, .env* files, or test fixtures. |
| Breaking changes | Renamed env vars, removed zenkoversion.yaml capabilities/feature flags, removed location types, or changed ZenkoVersion CR shape must be called out — they break deployed operators. |
| Security | OWASP-relevant issues for web/API code in tests; overly permissive RBAC, hostPath/hostNetwork usage, privileged containers in manifests. |
What NOT to flag
- Markdown formatting preferences
- Refactors unrelated to the PR's purpose
- Style issues already covered by the project's linter (eslint, biome, pylint)
- Anything you can't tie to a concrete problem — if in doubt, stay silent
Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.
Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repositoryOne other file it gives its agents.
- CLAUDE.mdCLAUDE.md
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.