mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 18:41:30 +00:00
shankar0123
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.
98 lines
2.4 KiB
Markdown
98 lines
2.4 KiB
Markdown
# Quick Installation Guide
|
|
|
|
## One-Liner Installation
|
|
|
|
### Development (no auth)
|
|
```bash
|
|
helm install certctl certctl/ \
|
|
--set server.auth.type=none \
|
|
--set postgresql.auth.password=dev
|
|
```
|
|
|
|
### Production (with API key)
|
|
```bash
|
|
API_KEY=$(openssl rand -base64 32)
|
|
DB_PASSWORD=$(openssl rand -base64 32)
|
|
|
|
helm install certctl certctl/ \
|
|
--values examples/values-prod-ha.yaml \
|
|
--set server.auth.apiKey="$API_KEY" \
|
|
--set postgresql.auth.password="$DB_PASSWORD"
|
|
```
|
|
|
|
## Verify Installation
|
|
|
|
```bash
|
|
# Wait for pods to be ready
|
|
kubectl rollout status deployment/certctl-server
|
|
kubectl rollout status statefulset/certctl-postgres
|
|
|
|
# Check all components
|
|
kubectl get pods -l app.kubernetes.io/instance=certctl
|
|
|
|
# View server logs
|
|
kubectl logs -l app.kubernetes.io/component=server -f
|
|
|
|
# Access the API (HTTPS-only as of v2.2; use --cacert or -k depending on your cert provisioning)
|
|
kubectl port-forward svc/certctl-server 8443:8443 &
|
|
# If the chart provisioned a self-signed cert, fetch the CA bundle from the secret first:
|
|
# kubectl get secret certctl-server-tls -o jsonpath='{.data.ca\.crt}' | base64 -d > /tmp/certctl-ca.crt
|
|
curl --cacert /tmp/certctl-ca.crt https://localhost:8443/health
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
1. **Read Documentation**
|
|
- `README.md` - Complete reference
|
|
- `DEPLOYMENT_GUIDE.md` - Step-by-step guide
|
|
- `CHART_SUMMARY.md` - Architecture overview
|
|
|
|
2. **Configure for Your Environment**
|
|
- Review `examples/` for your deployment scenario
|
|
- Customize `values.yaml` as needed
|
|
- Use `helm upgrade` to apply changes
|
|
|
|
3. **Set Up Monitoring**
|
|
- Install Prometheus (optional)
|
|
- Enable Ingress with HTTPS
|
|
- Configure email notifications
|
|
|
|
4. **Deploy Agents**
|
|
- Agents deploy automatically as DaemonSet
|
|
- Verify with: `kubectl get pods -l app.kubernetes.io/component=agent`
|
|
|
|
5. **Create Certificates**
|
|
- Configure issuer connectors (Local CA, ACME, etc.)
|
|
- Access web dashboard at ingress or port-forward
|
|
|
|
## Common Commands
|
|
|
|
```bash
|
|
# List installations
|
|
helm list
|
|
|
|
# View chart values
|
|
helm values certctl
|
|
|
|
# Upgrade chart
|
|
helm upgrade certctl certctl/ -f new-values.yaml
|
|
|
|
# Rollback to previous version
|
|
helm rollback certctl 1
|
|
|
|
# Uninstall chart
|
|
helm uninstall certctl
|
|
|
|
# View deployment history
|
|
helm history certctl
|
|
|
|
# Dry-run installation to see generated YAML
|
|
helm install certctl certctl/ --dry-run --debug
|
|
```
|
|
|
|
## Support
|
|
|
|
- Full documentation in `README.md`
|
|
- Troubleshooting in `DEPLOYMENT_GUIDE.md`
|
|
- Issues: https://github.com/certctl-io/certctl
|