Use this manual to prepare the CLI, edge-protected API access, repository events, inherited policy, Kubernetes runtime, hardware-isolated analysis workers, and customer-controlled keys.
RELEASE CONTRACT PREVIEWExamples define the intended operator interface—not proof that an endpoint or artifact is currently issued.
Obtain signed package URLs, checksums, chart versions, webhook endpoints, and environment-specific values from the controlled Trust Center release record before execution.
Every installation begins with a signed artifact, a least-privilege API key, an explicit egress route, and a repository webhook whose signature is verified before its payload is accepted.
01.1
CLI installation
Download only the platform-specific package referenced by your Trust Center release record. Verify its checksum and release signature before placing the binary on a managed workstation or runner.
Artifact gate
The public preview does not publish a CLI archive or checksum. Replace every bracketed value with the immutable artifact data from your approved release record.
shell / controlled workstation
# Download from the signed URI in the Trust Center
curl --proto '=https' --tlsv1.2 --fail --location \
'<approved-package-uri>' \
--output codecr-cli.tar.gz
# Verify before extraction
sha256sum -c SHA256SUMS
cosign verify-blob codecr-cli.tar.gz \
--signature codecr-cli.sig \
--certificate codecr-cli.pem
tar -xzf codecr-cli.tar.gz
install -m 0755 codecr "$HOME/.local/bin/codecr"
codecr version
01.2
Cloudflare-proxied API key scoping
Cloudflare protects the network edge; codecr authorizes the application action. Issue separate, short-lived keys for human CLI use, CI review, and telemetry ingestion—never one key with combined read, write, and administrative authority.
Send the key only in Authorization: Bearer … over HTTPS. Never place it in a URL, query string, cookie, WAF expression, analytics field, or support ticket.
01.3
GitHub Enterprise and GitLab webhook setup
Create one webhook per enterprise organization or self-managed GitLab group. Restrict events to the pilot scope, retain delivery IDs for replay defense, and reject a payload before parsing when its signature or token is invalid.
Provider
Events
Verification
GitHub Enterprise
Pull request, push, check suite
X-Hub-Signature-256
GitLab Self-Managed
Merge request, push, pipeline
X-Gitlab-Token + source allowlist
expected endpoint contract
GitHub Enterprise
POST https://api.codecr.org/v1/webhooks/github
Content-Type: application/json
X-Hub-Signature-256: sha256=<signature>
GitLab Self-Managed
POST https://api.codecr.org/v1/webhooks/gitlab
Content-Type: application/json
X-Gitlab-Token: <rotated-secret>
# Activate only the endpoint issued for your pilot.
# Never use placeholder values in production.
02 / CONFIGURATION REFERENCE
Policy is source-controlled architecture.
.codecr.yaml resolves organizational controls into a deterministic repository gate. Parent policies are pinned by digest, repository authors may tighten controls, and only a centrally signed exception may relax them.
02.1
Author a high-assurance policy file
This example blocks high-blast-radius changes in payment services until the Security owner signs off, requires P0 remediation, and prevents a repository-local file from weakening the inherited control.
Pin every parent policy by immutable digest.
Use stable rule IDs that appear in audit evidence.
Bind approval to an identity group, not a display name.
Validate the resolved policy before enabling merge enforcement.
Resolution flows from organization to portfolio, repository, and path. codecr records each source and digest in the decision evidence so reviewers can reproduce the effective rule set without relying on mutable defaults.
01Organization baselineMandatory identity, retention, and P0 controls
02Portfolio overlayPayments, healthcare, defense, or regional controls
03Repository policyService ownership and local test requirements
04Path ruleSchema, migration, secret, or privileged-code guardrail
DETERMINISTIC RESOLUTION
Conflict
The most restrictive enforceable rule wins.
Relaxation
Rejected unless a signed, unexpired exception authorizes the exact rule and scope.
Missing parent
Fail closed; do not evaluate against an unpinned substitute.
Evidence
Record source URI, digest, resolution order, decision, and approver identity.
03 / SELF-HOSTED + VPC
Bring the execution plane to the code.
The self-hosted data plane runs inside the customer network. Kubernetes schedules the services, a hardware-isolated runtime executes untrusted review workloads, and customer KMS policy controls envelope encryption and key rotation.
03.1
Kubernetes and Helm parameters
Use a dedicated namespace, restricted service account, private image mirror, NetworkPolicy default-deny, and an admission policy that rejects privileged pods. Pin the chart version and image digests from the signed release manifest.
Reserved registry contract
The registry path below describes the intended release channel. It becomes executable only when your Trust Center record grants access and supplies an approved version.
Route every untrusted checkout and model-assisted remediation task into a runtime class backed by a hardware-isolated virtual machine. Destroy the root disk, memory, network namespace, and derived workspace on completion, cancellation, timeout, or failure.
RUNTIMEKata Containers or approved microVM classNo fallback to the default container runtime.
NETWORKDefault deny + explicit destinationsBlock metadata endpoints and arbitrary Internet egress.
TEARDOWNTerminate on every exit pathEmit hashes and decision state—never source payloads.
03.3
Local KMS key management
Customer Security owns key creation, policy, rotation, disablement, and audit review. codecr receives only the runtime permission required to generate or decrypt a data key for the authorized environment.
Separate keys by environment and data classification.
Bind use to workload identity and encryption context.
Deny direct key export and broad wildcard principals.
Alert on policy change, disabled rotation, or decrypt outside the expected runtime identity.
KEY AUTHORITYCUSTOMER
Material
Never exported
Rotation
Customer schedule
Revocation
Immediate customer action
Audit
Customer security log
Acceptance evidence: key ARN or resource ID, policy digest, workload identity, rotation state, last rotation timestamp, and a denied unauthorized decrypt test.
04 / PRODUCTION OPERATIONS
Publish once. Verify from every boundary.
The production record is incomplete until DNS, edge TLS, cache state, WAF behavior, security headers, accessibility checks, and regional performance measurements are attached to the deployed version.
04.1
Activate docs.codecr.org without ambiguous DNS.
Publish the two verification TXT records first, prove them through independent resolvers, then replace only the conflicting docs address record with the exact Sites CNAME. TTL remains Auto; unrelated apex, mail, and verification records are outside this change.
Strict change boundary
Start the CNAME as DNS-only during hostname validation. Enable Cloudflare proxying only if the approved architecture and the upstream custom-hostname service explicitly support the proxied path; never assume an orange-to-orange route is valid.
Exact owners: _openai-site-verification.docs.codecr.org, _cf-custom-hostname.docs.codecr.org, and docs.codecr.org.
01
Open the change record. Capture the current zone export, any existing docs A/AAAA/CNAME values, their proxy state, and the rollback owner.
02
Publish verification first. Create both TXT records with TTL Auto. Wait until Cloudflare authoritative DNS plus 1.1.1.1 and 8.8.8.8 return the exact values.
03
Clear only the collision. A CNAME cannot coexist with another A, AAAA, or CNAME at docs. Remove the recorded conflicting docs value; preserve every unrelated record.
Wait for both planes. Require the Sites hostname state and certificate state to be active before application acceptance testing.
06
Prove TLS and content. Confirm the SAN contains docs.codecr.org, the chain verifies, HTTPS returns the approved documentation release, and no fallback hostname appears.
Invalidate only the documentation URLs changed by the release unless the release invalidates the entire asset map. A cache status is transport evidence; the SHA-256 digest is the artifact-integrity check.
FIRST REQUESTMISS, EXPIRED, or REVALIDATED may be valid after purge.
SECOND REQUESTExpect HIT or UPDATING when the active cache policy makes the asset eligible.
INVESTIGATEBYPASS, DYNAMIC, or NONE/UNKNOWN requires policy/header review when caching is expected.
ACCEPTANCEHTTP 200, expected SHA-256, expected release path, and no superseded bytes.
04.3
Cloudflare edge protocol
Proxy only validated hostnames, enforce Full (strict) where the approved origin architecture supports it, purge changed URLs after publication, and protect the telemetry API with narrow custom controls plus mandatory origin authorization. Never cache authenticated API responses.
Inventory before mutationExport the zone and query apex plus docs A, AAAA, CNAME, TXT, CAA, and MX records through authoritative DNS.
02
Resolve the exact owner collisionAt docs, retain verification TXT records and replace only a conflicting address/CNAME record. Never delete apex A records required by codecr.org.
03
Observe—not churnWith TTL Auto, wait for authoritative and recursive answers to converge. Do not alternate record values during propagation.
04
Roll back from the recordIf validation or TLS fails after the change window, restore the captured docs value and proxy state; attach the failure evidence.
04.4
Post-publication acceptance record
Execute the checks after the custom domain is active. A single local request cannot prove a global SLA; capture repeated cold and warm measurements from every contracted region and attach the raw results.
01HostnameExact CNAME and both verification TXT records resolve; certificate and Sites state are active.DNS + CONTROL PLANE