mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 12:31:29 +00:00
0729ee46e0
Post-transfer cosmetic + release-critical URL refresh after moving the
repo from github.com/shankar0123/certctl to github.com/certctl-io/certctl
(2026-05-03). GitHub HTTP redirects continue to forward old URLs forever,
so existing operators are not broken — but aligns the canonical
references with the new owner so:
- procurement engineers / contributors browsing the docs see the right
URL on first read
- operators copying the agent install one-liner hit the new path
directly without going through a redirect
- the Helm chart's default image repository points at the canonical org
registry path
- the OnboardingWizard rendered to first-run UI users shows the new
URL in the install snippets and doc anchor links
- the GitHub Actions release workflow pushes container images to
ghcr.io/certctl-io/certctl-{server,agent} (was: shankar0123)
- the release-notes Markdown body in release.yml — which gets stamped
into every future release page — references the post-transfer
cert-identity (cosign keyless signing now uses the certctl-io
workflow URL) and the post-transfer SLSA provenance source-uri.
Without this, every cosign verify / slsa-verifier command on a
v2.1.0+ release would fail because the cert-identity-regexp would
not match the signing identity GitHub Actions OIDC issues post-
transfer. Old releases (v2.0.67 and earlier) keep their immutable
release-notes pointing at the shankar0123 path and remain
verifiable via their own published instructions.
Customer impact:
- Operators on ghcr.io/shankar0123/certctl-{server,agent}:latest
silently freeze on whatever tag was current at transfer time. They
get no errors; they just stop receiving updates. The next release
notes need a one-line callout (Phase 3.1 of cowork/transfer-
certctl-to-org.md) telling them to update their image path to
ghcr.io/certctl-io/certctl-{server,agent}.
- All other URLs (git clone, install one-liner, raw.githubusercontent
URLs, browser links, GitHub API) continue to resolve via permanent
HTTP redirects. The sweep is cosmetic for those.
Files swept (30 total):
.github/workflows/release.yml — IMAGE_NAMESPACE, source-uri,
cosign cert-identity-regexp, IMAGE= snippet (5 refs total).
CHANGELOG.md, README.md — anchor links, badges, install one-liner,
cosign verify snippets in operator-facing sections.
api/openapi.yaml — info / externalDocs URLs.
install-agent.sh — GITHUB_REPO const + systemd unit Documentation=
field.
deploy/ENVIRONMENTS.md, deploy/helm/{CHART_SUMMARY,INDEX,
INSTALLATION,README}.md, deploy/helm/certctl/{Chart.yaml,
README.md,values.yaml}, deploy/helm/examples/values-*.yaml —
chart docs + image repository defaults across dev / prod-ha
overrides.
docs/{certctl-for-cert-manager-users,connector-iis,connectors,
migrate-from-acmesh,migrate-from-certbot,quickstart,test-env,
why-certctl}.md — operator-facing doc URLs.
examples/{acme-nginx,acme-wildcard-dns01,multi-issuer,
private-ca-traefik,step-ca-haproxy}/docker-compose.yml +
examples/step-ca-haproxy/step-ca-haproxy.md — example image:
paths and accompanying narrative.
web/src/pages/OnboardingWizard.tsx — first-run-UI URL refs (curl
install one-liners, agent docker image path, doc anchor links).
Files intentionally NOT swept (Choice A from cowork/transfer-certctl-
to-org.md):
go.mod, go.sum — module declaration stays github.com/shankar0123/
certctl. Existing imports compile because Go uses the path
declared in go.mod, not the URL it was fetched from. Internal-
only project; no external Go consumers; rename will land as a
mechanical sed when one materializes.
~250 *.go files — every import remains github.com/shankar0123/
certctl/internal/...
deploy/test/f5-mock-icontrol/go.mod — separate test sub-module;
same Choice A logic; module path stays.
Files intentionally NOT swept (other reasons):
README.md lines 244-245 — Scarf-pixel docker-pull commands.
shankar0123.docker.scarf.sh/... is a Scarf-account hostname
(per-user, not per-repo) and the pixel keeps tracking pulls
against the operator's personal Scarf account. Migrating to a
certctl-io Scarf account is a separate decision (create org
Scarf account → re-create package → update README).
deploy/test/f5-mock-icontrol/f5-mock-icontrol — checked-in
compiled binary with shankar0123/certctl baked into Go build
info via the sub-module path. Out of scope for a URL sweep;
will refresh on the next `make test-integration` rebuild.
Verification:
gofmt: clean (no .go files touched).
go vet ./...: clean (verified at this SHA in 1.3 of the transfer
checklist; no .go changes since).
go build ./...: clean (same).
go test -short on representative packages: green (same).
Diff shape: 30 files, 74 insertions / 74 deletions, net-zero size,
pure URL substitution.
183 lines
5.5 KiB
YAML
183 lines
5.5 KiB
YAML
version: '3.8'
|
|
|
|
services:
|
|
# PostgreSQL database for certctl
|
|
postgres:
|
|
image: postgres:16-alpine
|
|
container_name: certctl-postgres-private-ca
|
|
environment:
|
|
POSTGRES_DB: certctl
|
|
POSTGRES_USER: certctl
|
|
POSTGRES_PASSWORD: ${DB_PASSWORD:-certctl-dev-password}
|
|
volumes:
|
|
- postgres_data:/var/lib/postgresql/data
|
|
healthcheck:
|
|
test: ['CMD-SHELL', 'pg_isready -U certctl -d certctl']
|
|
interval: 5s
|
|
timeout: 5s
|
|
retries: 5
|
|
networks:
|
|
- certctl-network
|
|
restart: unless-stopped
|
|
|
|
# certctl server (control plane) with Local CA in sub-CA mode
|
|
certctl-server:
|
|
image: ghcr.io/certctl-io/certctl-server:latest
|
|
container_name: certctl-server-private-ca
|
|
environment:
|
|
# Database
|
|
CERTCTL_DATABASE_URL: postgres://certctl:${DB_PASSWORD:-certctl-dev-password}@postgres:5432/certctl?sslmode=disable
|
|
|
|
# Server settings
|
|
CERTCTL_SERVER_PORT: 8443
|
|
CERTCTL_SERVER_HOST: 0.0.0.0
|
|
|
|
# Auth (disabled for demo; production should use API keys)
|
|
CERTCTL_AUTH_TYPE: none
|
|
|
|
# CORS (allow agent and Traefik communication)
|
|
CERTCTL_CORS_ORIGINS: '*'
|
|
|
|
# Key generation mode (agent-side in production, server-side for demo)
|
|
CERTCTL_KEYGEN_MODE: server
|
|
|
|
# Local CA configuration
|
|
# For self-signed CA (default, no paths set):
|
|
# - CA generates a self-signed root certificate
|
|
# - All issued certificates chain to this root
|
|
#
|
|
# For sub-CA mode (provide both paths):
|
|
# - Load pre-signed CA certificate and key from these paths
|
|
# - All issued certificates chain to your enterprise root CA
|
|
# - Requires: CA cert must have IsCA=true and KeyUsageCertSign
|
|
# - Supports: RSA, ECDSA, PKCS#8 key formats
|
|
#
|
|
# To use sub-CA mode:
|
|
# 1. Place your enterprise CA cert at ./ca-cert.pem
|
|
# 2. Place your enterprise CA key at ./ca-key.pem
|
|
# 3. Uncomment the two lines below
|
|
# 4. Restart the service
|
|
#
|
|
# CERTCTL_CA_CERT_PATH: /etc/certctl/ca-cert.pem
|
|
# CERTCTL_CA_KEY_PATH: /etc/certctl/ca-key.pem
|
|
|
|
# Logging
|
|
CERTCTL_LOG_LEVEL: info
|
|
ports:
|
|
- '${SERVER_PORT:-8443}:8443'
|
|
volumes:
|
|
# Mount directory for CA cert/key (for sub-CA mode)
|
|
# Copy your enterprise CA cert+key here:
|
|
# cp /path/to/your/ca.pem ./ca-cert.pem
|
|
# cp /path/to/your/ca-key.pem ./ca-key.pem
|
|
- ./ca-certs:/etc/certctl:ro
|
|
depends_on:
|
|
postgres:
|
|
condition: service_healthy
|
|
networks:
|
|
- certctl-network
|
|
healthcheck:
|
|
test: ['CMD-SHELL', 'curl -sfk https://localhost:8443/health || exit 1']
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 3
|
|
restart: unless-stopped
|
|
|
|
# certctl agent (deploys certs to Traefik)
|
|
certctl-agent:
|
|
image: ghcr.io/certctl-io/certctl-agent:latest
|
|
container_name: certctl-agent-private-ca
|
|
environment:
|
|
# Control plane connection
|
|
CERTCTL_SERVER_URL: http://certctl-server:8443
|
|
CERTCTL_API_KEY: ${AGENT_API_KEY:-agent-demo-key}
|
|
|
|
# Key generation (agent-side keys, never sent to server)
|
|
CERTCTL_KEYGEN_MODE: server
|
|
CERTCTL_KEY_DIR: /var/lib/certctl/keys
|
|
|
|
# Discovery (scan for existing certs in Traefik's directory)
|
|
CERTCTL_DISCOVERY_DIRS: /etc/traefik/certs
|
|
|
|
# Heartbeat interval
|
|
CERTCTL_HEARTBEAT_INTERVAL: 30s
|
|
|
|
# Agent metadata (self-reported)
|
|
CERTCTL_AGENT_NAME: traefik-agent-01
|
|
|
|
# Logging
|
|
CERTCTL_LOG_LEVEL: info
|
|
volumes:
|
|
# Mount Traefik cert directory for deployment
|
|
- traefik_certs:/etc/traefik/certs
|
|
# Agent key storage (persisted across restarts)
|
|
- agent_keys:/var/lib/certctl/keys
|
|
depends_on:
|
|
certctl-server:
|
|
condition: service_healthy
|
|
networks:
|
|
- certctl-network
|
|
restart: unless-stopped
|
|
|
|
# Traefik reverse proxy / edge router
|
|
# Certificates deployed by certctl-agent are automatically loaded from the certs directory
|
|
traefik:
|
|
image: traefik:v3.0
|
|
container_name: certctl-traefik-private-ca
|
|
command:
|
|
# Enable dashboard and API
|
|
- '--api.insecure=true'
|
|
- '--api.dashboard=true'
|
|
|
|
# File provider: watch the certs directory for dynamic config updates
|
|
- '--providers.file.directory=/etc/traefik/dynamic'
|
|
- '--providers.file.watch=true'
|
|
|
|
# Entry points (HTTP and HTTPS)
|
|
- '--entrypoints.web.address=:80'
|
|
- '--entrypoints.websecure.address=:443'
|
|
- '--entrypoints.websecure.http.tls=true'
|
|
|
|
# Global TLS settings
|
|
- '--entryPoints.websecure.http.tls.certResolver=internal'
|
|
|
|
# Logging
|
|
- '--log.level=info'
|
|
- '--accesslog=true'
|
|
ports:
|
|
# HTTP
|
|
- '80:80'
|
|
# HTTPS
|
|
- '443:443'
|
|
# Dashboard (http://localhost:8080)
|
|
- '8080:8080'
|
|
volumes:
|
|
# Mount Traefik config directory
|
|
- ./traefik-config:/etc/traefik/dynamic:ro
|
|
# Mount cert directory (where certctl deploys certs)
|
|
- traefik_certs:/etc/traefik/certs:ro
|
|
# Allow Traefik to read Docker socket (optional, for container labeling)
|
|
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
networks:
|
|
- certctl-network
|
|
depends_on:
|
|
- certctl-agent
|
|
healthcheck:
|
|
test: ['CMD-SHELL', 'curl -sf http://localhost:8080/ping || exit 1']
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 3
|
|
restart: unless-stopped
|
|
|
|
networks:
|
|
certctl-network:
|
|
driver: bridge
|
|
|
|
volumes:
|
|
postgres_data:
|
|
driver: local
|
|
traefik_certs:
|
|
driver: local
|
|
agent_keys:
|
|
driver: local
|