README
¶
Unkey
The Developer Platform for Modern APIs
What is Unkey?
Unkey is the developer platform for modern APIs. We unify your infrastructure so you can ship faster: deploy APIs instantly, route traffic through global gateways, and understand usage — all in one place.
- Deploy — push an API to production in seconds, with zero infrastructure to manage
- Gateway — route, authenticate, and shape traffic through globally distributed gateways
- API Keys — issue, verify, and revoke keys with fast global verification
- Ratelimiting — globally consistent, durable ratelimiting for any identifier
- Permissions & RBAC — per-key permissions, roles, and fine-grained access control
- Analytics — usage, latency, and per-key insights across every request
- Audit logs — immutable history of every action across your workspace
License
Please find the license under the LICENSE file.
Pull requests
Unkey is not accepting external pull requests at this time.
Unkey has paused external code contributions while the team focuses on platform direction and stability. Pull requests opened by people outside the Unkey team will not be reviewed or merged.
Issues remain open for bug reports, feature requests, and documentation feedback. This repository remains public and source-available so you can read the code, fork it under the terms of the AGPL, and self-host. Unkey may revisit this policy in the future, and any change will be announced here.
If you've found a security issue, please email security@unkey.com instead of opening a public issue.
Let's Talk
Authors
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apps
|
|
|
agent
module
|
|
|
api
module
|
|
|
chproxy
module
|
|
|
event-router
module
|
|
|
tinybird-proxy
module
|
|
|
vault
module
|
|
|
build
|
|
|
api
command
|
|
|
control-api
command
|
|
|
control-worker
command
|
|
|
frontline
command
|
|
|
heimdall
command
|
|
|
krane
command
|
|
|
util
Package util contains shared command wiring for release service binaries.
|
Package util contains shared command wiring for release service binaries. |
|
vault
command
|
|
|
cmd
|
|
|
dev/seed/checkpoints
Package checkpoints seeds heimdall instance_checkpoints data so the full Deploy billing pipeline (ClickHouse aggregation -> Stripe meter push, and the dashboard usage charts) can be tested without running real workloads.
|
Package checkpoints seeds heimdall instance_checkpoints data so the full Deploy billing pipeline (ClickHouse aggregation -> Stripe meter push, and the dashboard usage charts) can be tested without running real workloads. |
|
dev/stripe
Package stripe groups Stripe development tools: test-clock time travel for billing tests, invoice inspection, and whatever billing tooling comes next.
|
Package stripe groups Stripe development tools: test-clock time travel for billing tests, invoice inspection, and whatever billing tooling comes next. |
|
demo_api
module
|
|
|
gen
|
|
|
proto/ctrl/v1/ctrlv1connect
Package ctrl.v1 provides the Cluster service for multi-cluster deployment orchestration.
|
Package ctrl.v1 provides the Cluster service for multi-cluster deployment orchestration. |
|
go
module
|
|
|
deploy/assetmanagerd
module
|
|
|
deploy/billaged
module
|
|
|
deploy/builderd
module
|
|
|
deploy/metald
module
|
|
|
deploy/metald/client
module
|
|
|
deploy/pkg/health
module
|
|
|
deploy/pkg/spiffe
module
|
|
|
deploy/pkg/tls
module
|
|
|
deploy/pkg/tracing
module
|
|
|
internal
|
|
|
services/auditlogs
Package auditlogs provides audit logging services for tracking user actions and system events across the Unkey platform.
|
Package auditlogs provides audit logging services for tracking user actions and system events across the Unkey platform. |
|
services/caches
Package caches provides a centralized caching service for commonly accessed database entities.
|
Package caches provides a centralized caching service for commonly accessed database entities. |
|
services/keys
Package keys implements a comprehensive key management and verification system for API keys with support for rate limiting, usage tracking, permissions, and workspace isolation.
|
Package keys implements a comprehensive key management and verification system for API keys with support for rate limiting, usage tracking, permissions, and workspace isolation. |
|
services/keys/db
Package db provides database access for the keys service.
|
Package db provides database access for the keys service. |
|
services/keys/metrics
Package metrics provides Prometheus metric collectors for monitoring application performance.
|
Package metrics provides Prometheus metric collectors for monitoring application performance. |
|
services/portal
Package portal provides session validation for the customer portal.
|
Package portal provides session validation for the customer portal. |
|
services/ratelimit
Package ratelimit implements lockless distributed rate limiting using a sliding window algorithm with atomic counters.
|
Package ratelimit implements lockless distributed rate limiting using a sliding window algorithm with atomic counters. |
|
services/ratelimit/db
Package db provides MySQL access for the ratelimit service's cross-region count propagation.
|
Package db provides MySQL access for the ratelimit service's cross-region count propagation. |
|
services/ratelimit/metrics
Package metrics provides Prometheus collectors for the rate limit service.
|
Package metrics provides Prometheus collectors for the rate limit service. |
|
services/usagelimiter/metrics
Package metrics provides Prometheus metric collectors for monitoring application performance.
|
Package metrics provides Prometheus metric collectors for monitoring application performance. |
|
pkg
|
|
|
array
Package array provides generic utility functions for slice generation and manipulation.
|
Package array provides generic utility functions for slice generation and manipulation. |
|
assert
Package assert provides simple assertion utilities for validating conditions and inputs throughout the application.
|
Package assert provides simple assertion utilities for validating conditions and inputs throughout the application. |
|
auditlog
Package auditlog defines types and constants for the audit logging system.
|
Package auditlog defines types and constants for the audit logging system. |
|
auth
Package auth normalizes API credentials into principals.
|
Package auth normalizes API credentials into principals. |
|
auth/jwt
Package jwt scaffolds short-lived bearer JWT authentication for API handlers.
|
Package jwt scaffolds short-lived bearer JWT authentication for API handlers. |
|
auth/portal_session
Package portalsession authenticates customer portal browser sessions.
|
Package portalsession authenticates customer portal browser sessions. |
|
auth/portalrbac
Package portalrbac is the single translation seam between the portal's simplified, public-facing permission model and the RBAC mechanism that actually enforces access.
|
Package portalrbac is the single translation seam between the portal's simplified, public-facing permission model and the RBAC mechanism that actually enforces access. |
|
auth/principal
Package principal defines the normalized authenticated subject shared by API authentication, request sessions, and audit logging.
|
Package principal defines the normalized authenticated subject shared by API authentication, request sessions, and audit logging. |
|
auth/workos
Package workos adapts WorkOS access tokens into Unkey auth principals.
|
Package workos adapts WorkOS access tokens into Unkey auth principals. |
|
base58
Package base58 implements Base58 encoding for binary data.
|
Package base58 implements Base58 encoding for binary data. |
|
batch
Package batch provides utilities for efficiently processing items in batches.
|
Package batch provides utilities for efficiently processing items in batches. |
|
batch/metrics
Package metrics provides Prometheus metric collectors for monitoring application performance.
|
Package metrics provides Prometheus metric collectors for monitoring application performance. |
|
billingperiod
Package billingperiod parses and works with the "YYYY-MM" billing period keys used to key the monthly cron handlers (quota check, deploy billing push, ...).
|
Package billingperiod parses and works with the "YYYY-MM" billing period keys used to key the monthly cron handlers (quota check, deploy billing push, ...). |
|
buffer
Package buffer provides a generic buffered channel implementation with configurable capacity and drop behavior.
|
Package buffer provides a generic buffered channel implementation with configurable capacity and drop behavior. |
|
buffer/metrics
Package metrics provides Prometheus metric collectors for monitoring application performance.
|
Package metrics provides Prometheus metric collectors for monitoring application performance. |
|
buildinfo
Package buildinfo exposes build metadata that is injected at link time via -ldflags -X. Values are populated by the release pipeline (goreleaser).
|
Package buildinfo exposes build metadata that is injected at link time via -ldflags -X. Values are populated by the release pipeline (goreleaser). |
|
cache
Package cache provides a generic, thread-safe caching system with support for time-based expiration, custom eviction policies, and observability.
|
Package cache provides a generic, thread-safe caching system with support for time-based expiration, custom eviction policies, and observability. |
|
circuitbreaker
Package circuitbreaker implements the Circuit Breaker pattern to prevent cascading failures when dependent services are unavailable or experiencing high latency.
|
Package circuitbreaker implements the Circuit Breaker pattern to prevent cascading failures when dependent services are unavailable or experiencing high latency. |
|
cli
Package cli provides a command-line interface framework for building CLI applications.
|
Package cli provides a command-line interface framework for building CLI applications. |
|
clickhouse
Package clickhouse provides a client for interacting with ClickHouse databases, optimized for high-volume event data storage and analytics.
|
Package clickhouse provides a client for interacting with ClickHouse databases, optimized for high-volume event data storage and analytics. |
|
clickhouse/schema/gen
command
Command gen writes columns_generated.go: the Row implementation (Table and InsertColumns methods) for every schema struct carrying an //unkey:table directive in its doc comment, so INSERT statements can name their target table and columns statically (see the Row interface).
|
Command gen writes columns_generated.go: the Row implementation (Table and InsertColumns methods) for every schema struct carrying an //unkey:table directive in its doc comment, so INSERT statements can name their target table and columns statically (see the Row interface). |
|
clock
Package clock provides a flexible interface for time-related operations, allowing for consistent time handling in both production and test environments.
|
Package clock provides a flexible interface for time-related operations, allowing for consistent time handling in both production and test environments. |
|
codes
Code generated by generate.go; DO NOT EDIT.
|
Code generated by generate.go; DO NOT EDIT. |
|
conc
Package conc provides bounded-concurrency helpers.
|
Package conc provides bounded-concurrency helpers. |
|
config
Package config loads and validates TOML configuration into Go structs using struct tags for defaults and constraints.
|
Package config loads and validates TOML configuration into Go structs using struct tags for defaults and constraints. |
|
counter
Package counter provides abstractions and implementations for distributed counters.
|
Package counter provides abstractions and implementations for distributed counters. |
|
ctxutil
Package ctxutil provides utilities for working with context.Context, specifically focused on storing and retrieving request-scoped values.
|
Package ctxutil provides utilities for working with context.Context, specifically focused on storing and retrieving request-scoped values. |
|
db
Package db provides a database access layer for MySQL with support for read/write splitting, connection management, and type-safe SQL operations.
|
Package db provides a database access layer for MySQL with support for read/write splitting, connection management, and type-safe SQL operations. |
|
db/plugins/bulk-insert
command
Package main provides a sqlc plugin that generates bulk insert functions.
|
Package main provides a sqlc plugin that generates bulk insert functions. |
|
dns
Package dns provides DNS lookup utilities using Cloudflare's 1.1.1.1 resolver.
|
Package dns provides DNS lookup utilities using Cloudflare's 1.1.1.1 resolver. |
|
dns/domainconnect
Package domainconnect implements the Domain Connect protocol (v2) for one-click DNS configuration of custom domains.
|
Package domainconnect implements the Domain Connect protocol (v2) for one-click DNS configuration of custom domains. |
|
fault
Package fault provides a clean, concise error handling system designed for building robust applications with rich error context and secure user messaging.
|
Package fault provides a clean, concise error handling system designed for building robust applications with rich error context and secure user messaging. |
|
fuzz
Package fuzz provides utilities for consuming fuzzer-generated byte slices and converting them into typed Go values.
|
Package fuzz provides utilities for consuming fuzzer-generated byte slices and converting them into typed Go values. |
|
hash
Package hash provides cryptographic hashing utilities for various security-related operations such as API key validation, data integrity checks, and signatures.
|
Package hash provides cryptographic hashing utilities for various security-related operations such as API key validation, data integrity checks, and signatures. |
|
healthcheck
Package healthcheck provides push-based health monitoring for scheduled tasks.
|
Package healthcheck provides push-based health monitoring for scheduled tasks. |
|
jwt
Package jwt provides JSON Web Token signing and verification with algorithm-pinned security to prevent algorithm confusion attacks.
|
Package jwt provides JSON Web Token signing and verification with algorithm-pinned security to prevent algorithm confusion attacks. |
|
logger
Package logger provides wide-event logging with tail sampling support.
|
Package logger provides wide-event logging with tail sampling support. |
|
logger/loggertest
Package loggertest provides shared testing utilities for the global logger package: a slog handler that records every emitted record and helpers for inspecting them.
|
Package loggertest provides shared testing utilities for the global logger package: a slog handler that records every emitted record and helpers for inspecting them. |
|
match
Package match provides pattern matching utilities.
|
Package match provides pattern matching utilities. |
|
mysql
Package mysql provides a minimal shared MySQL abstraction for backend services.
|
Package mysql provides a minimal shared MySQL abstraction for backend services. |
|
mysql/metrics
Package metrics defines Prometheus metrics used by pkg/mysql wrappers.
|
Package metrics defines Prometheus metrics used by pkg/mysql wrappers. |
|
mysql/plugins/bulk-insert
command
Package main provides a sqlc plugin that generates bulk insert functions.
|
Package main provides a sqlc plugin that generates bulk insert functions. |
|
mysql/sqlcomment
Package sqlcomment appends SQLCommenter-compatible metadata to SQL statements so PlanetScale Query Insights can attribute query load to services, operations, and deploys.
|
Package sqlcomment appends SQLCommenter-compatible metadata to SQL statements so PlanetScale Query Insights can attribute query load to services, operations, and deploys. |
|
prefixedapikey/cmd
command
|
|
|
prometheus
Package prometheus provides HTTP server infrastructure for exposing Prometheus metrics.
|
Package prometheus provides HTTP server infrastructure for exposing Prometheus metrics. |
|
prometheus/lazy
Package lazy provides lazy-registering Prometheus metric wrappers.
|
Package lazy provides lazy-registering Prometheus metric wrappers. |
|
prometheus/metrics
Package metrics provides Prometheus metric collectors for monitoring Unkey services.
|
Package metrics provides Prometheus metric collectors for monitoring Unkey services. |
|
prompt
Package prompt provides interactive terminal prompts for CLI applications.
|
Package prompt provides interactive terminal prompts for CLI applications. |
|
prompt/example
command
|
|
|
prompt/example/date
command
|
|
|
prompt/example/datetime
command
|
|
|
prompt/example/multiselect
command
|
|
|
prompt/example/select
command
|
|
|
prompt/example/time
command
|
|
|
prompt/example/wizard
command
|
|
|
rbac
Package rbac implements a flexible Role-Based Access Control system for managing permissions and authorization checks.
|
Package rbac implements a flexible Role-Based Access Control system for managing permissions and authorization checks. |
|
rbac/permissions
Package permissions defines typed actions for Unkey resource permissions.
|
Package permissions defines typed actions for Unkey resource permissions. |
|
restate/admin
Package admin provides a client for the Restate admin API.
|
Package admin provides a client for the Restate admin API. |
|
restate/compensation
Package compensation provides a rollback mechanism for multi-step Restate workflows.
|
Package compensation provides a rollback mechanism for multi-step Restate workflows. |
|
restate/restateutil
Package restateutil holds small helpers shared by Restate handlers.
|
Package restateutil holds small helpers shared by Restate handlers. |
|
retry
Package retry provides functionality to retry operations with configurable attempts and backoff.
|
Package retry provides functionality to retry operations with configurable attempts and backoff. |
|
testutil/containers
Package containers provides lightweight Docker container management for integration tests.
|
Package containers provides lightweight Docker container management for integration tests. |
|
timing
Package timing defines a small, strict header format for server-side timing data and provides helpers to record it through zen sessions.
|
Package timing defines a small, strict header format for server-side timing data and provides helpers to record it through zen sessions. |
|
tls
Package tls provides utilities for configuring TLS (Transport Layer Security) in HTTP servers.
|
Package tls provides utilities for configuring TLS (Transport Layer Security) in HTTP servers. |
|
tui
Package tui renders styled, aligned terminal output for CLI commands.
|
Package tui renders styled, aligned terminal output for CLI commands. |
|
uid
Package uid generates prefixed random identifiers for Unkey resources.
|
Package uid generates prefixed random identifiers for Unkey resources. |
|
urn
Package urn constructs and parses Unkey resource names.
|
Package urn constructs and parses Unkey resource names. |
|
validation
Package validation provides reusable input validation functions for the Unkey platform.
|
Package validation provides reusable input validation functions for the Unkey platform. |
|
webhook
Package webhook receives provider webhooks over HTTP.
|
Package webhook receives provider webhooks over HTTP. |
|
webhook/verifiers/github
Package github verifies GitHub App webhook signatures for pkg/webhook receivers.
|
Package github verifies GitHub App webhook signatures for pkg/webhook receivers. |
|
webhook/verifiers/stripe
Package stripe verifies Stripe webhook signatures for pkg/webhook receivers.
|
Package stripe verifies Stripe webhook signatures for pkg/webhook receivers. |
|
zen
Package zen provides a lightweight HTTP framework built on top of the standard library.
|
Package zen provides a lightweight HTTP framework built on top of the standard library. |
|
zen/metrics
Package metrics provides Prometheus metric collectors for monitoring application performance.
|
Package metrics provides Prometheus metric collectors for monitoring application performance. |
|
sdks
|
|
|
golang
module
|
|
|
svc
|
|
|
api/internal/auditactor
Package auditactor maps an authenticated principal to the actor recorded on audit logs.
|
Package auditactor maps an authenticated principal to the actor recorded on audit logs. |
|
api/internal/deployment
Package deployment maps a stored deployment row onto the openapi.Deployment wire type shared by the deployment read endpoints (getDeployment, listDeployments).
|
Package deployment maps a stored deployment row onto the openapi.Deployment wire type shared by the deployment read endpoints (getDeployment, listDeployments). |
|
api/internal/environment
Package environment maps stored app settings onto the openapi.Environment wire type shared by the environment read endpoints.
|
Package environment maps stored app settings onto the openapi.Environment wire type shared by the environment read endpoints. |
|
api/internal/pagination
Package pagination implements the cursor pagination idiom shared by the v2 list endpoints:
|
Package pagination implements the cursor pagination idiom shared by the v2 list endpoints: |
|
api/internal/portalscope
Package portalscope resolves the external identity a portal route must scope to.
|
Package portalscope resolves the external identity a portal route must scope to. |
|
api/internal/testutil
Package testutil provides integration test infrastructure for the API service.
|
Package testutil provides integration test infrastructure for the API service. |
|
api/internal/testutil/seed
Package seed provides database seeding utilities for integration tests.
|
Package seed provides database seeding utilities for integration tests. |
|
api/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
|
Package openapi provides primitives to interact with the openapi HTTP API. |
|
ctrl
Package ctrl is the root package for the Unkey control plane service.
|
Package ctrl is the root package for the Unkey control plane service. |
|
ctrl/api
Package api provides the control plane HTTP/2 server for Unkey's distributed infrastructure.
|
Package api provides the control plane HTTP/2 server for Unkey's distributed infrastructure. |
|
ctrl/api/webhooks/github
Package github registers and routes inbound GitHub App webhook events for ctrl-api.
|
Package github registers and routes inbound GitHub App webhook events for ctrl-api. |
|
ctrl/api/webhooks/stripe
Package stripe routes Stripe webhooks for ctrl-api.
|
Package stripe routes Stripe webhooks for ctrl-api. |
|
ctrl/dedup
Package dedup centralises the "cancel in-progress siblings" logic used when a new deployment is created for a branch that already has an active build.
|
Package dedup centralises the "cancel in-progress siblings" logic used when a new deployment is created for a branch that already has an active build. |
|
ctrl/integration/harness
Package harness provides a unified test harness for ctrl worker integration tests.
|
Package harness provides a unified test harness for ctrl worker integration tests. |
|
ctrl/internal/actor
Package actor maps the shared ctrl.v1.ActorInfo wire type onto audit log fields, so every ctrl RPC that writes audit logs converts actors the same way.
|
Package actor maps the shared ctrl.v1.ActorInfo wire type onto audit log fields, so every ctrl RPC that writes audit logs converts actors the same way. |
|
ctrl/internal/audit
Package audit writes audit logs from inside Restate deletion workflows.
|
Package audit writes audit logs from inside Restate deletion workflows. |
|
ctrl/internal/auditlogs
Package auditlogs provides the control plane audit log outbox writer.
|
Package auditlogs provides the control plane audit log outbox writer. |
|
ctrl/internal/auth
Package auth provides shared bearer token authentication for ctrl ConnectRPC services.
|
Package auth provides shared bearer token authentication for ctrl ConnectRPC services. |
|
ctrl/internal/billingmeter
Package billingmeter reports workspace usage to a billing provider's metering API.
|
Package billingmeter reports workspace usage to a billing provider's metering API. |
|
ctrl/internal/db
Package db provides the control plane database access layer.
|
Package db provides the control plane database access layer. |
|
ctrl/internal/invoicecloser
Package invoicecloser lists and finalizes Stripe draft invoices for month-end close.
|
Package invoicecloser lists and finalizes Stripe draft invoices for month-end close. |
|
ctrl/services
Package services provides Connect service implementations for the control plane.
|
Package services provides Connect service implementations for the control plane. |
|
ctrl/services/acme
Package acme provides ACME certificate challenge management.
|
Package acme provides ACME certificate challenge management. |
|
ctrl/services/cluster
Package cluster implements the Connect ClusterService for synchronizing desired state between the control plane and krane agents running in regional Kubernetes clusters.
|
Package cluster implements the Connect ClusterService for synchronizing desired state between the control plane and krane agents running in regional Kubernetes clusters. |
|
ctrl/services/ctrl
Package ctrl provides administrative and health check services.
|
Package ctrl provides administrative and health check services. |
|
ctrl/services/openapi
Package openapi provides OpenAPI specification and schema documentation.
|
Package openapi provides OpenAPI specification and schema documentation. |
|
ctrl/services/ops
Package ops hosts internal operator RPCs that aren't part of the normal customer-facing deploy flow.
|
Package ops hosts internal operator RPCs that aren't part of the normal customer-facing deploy flow. |
|
ctrl/worker
Package worker implements the Restate workflow worker for Unkey's control plane.
|
Package worker implements the Restate workflow worker for Unkey's control plane. |
|
ctrl/worker/buildslot
Package buildslot implements the BuildSlotService Restate virtual object, which caps how many deployments in a workspace can be actively building at the same time.
|
Package buildslot implements the BuildSlotService Restate virtual object, which caps how many deployments in a workspace can be actively building at the same time. |
|
ctrl/worker/certificate
Package certificate implements ACME certificate workflows for SSL/TLS provisioning.
|
Package certificate implements ACME certificate workflows for SSL/TLS provisioning. |
|
ctrl/worker/clickhouseuser
Package clickhouseuser implements ClickHouse user provisioning workflows.
|
Package clickhouseuser implements ClickHouse user provisioning workflows. |
|
ctrl/worker/cron
Package cron wires hydra.v1.CronService to per-task handlers in subpackages.
|
Package cron wires hydra.v1.CronService to per-task handlers in subpackages. |
|
ctrl/worker/cron/auditlogcleanup
Package auditlogcleanup implements the CronService.RunAuditLogOutboxCleanup handler.
|
Package auditlogcleanup implements the CronService.RunAuditLogOutboxCleanup handler. |
|
ctrl/worker/cron/auditlogexport
Package auditlogexport implements the CronService.RunAuditLogExport handler.
|
Package auditlogexport implements the CronService.RunAuditLogExport handler. |
|
ctrl/worker/cron/deploybilling
Package deploybilling runs the hourly Deploy usage push and month-end close.
|
Package deploybilling runs the hourly Deploy usage push and month-end close. |
|
ctrl/worker/cron/idlepreview
Package idlepreview implements the CronService.RunScaleDownIdlePreviewDeployments handler.
|
Package idlepreview implements the CronService.RunScaleDownIdlePreviewDeployments handler. |
|
ctrl/worker/cron/keylastusedsync
Package keylastusedsync implements the CronService.RunKeyLastUsedSync orchestrator handler.
|
Package keylastusedsync implements the CronService.RunKeyLastUsedSync orchestrator handler. |
|
ctrl/worker/cron/keyrefill
Package keyrefill implements the CronService.RunKeyRefill handler.
|
Package keyrefill implements the CronService.RunKeyRefill handler. |
|
ctrl/worker/cron/quotacheck
Package quotacheck implements the CronService.RunQuotaCheck handler.
|
Package quotacheck implements the CronService.RunQuotaCheck handler. |
|
ctrl/worker/cron/ratelimitcleanup
Package ratelimitcleanup implements the CronService.RunRatelimitGlobalCountersCleanup handler.
|
Package ratelimitcleanup implements the CronService.RunRatelimitGlobalCountersCleanup handler. |
|
ctrl/worker/customdomain
Package customdomain implements domain verification workflows.
|
Package customdomain implements domain verification workflows. |
|
ctrl/worker/deploy
Package deploy orchestrates the deployment lifecycle for user applications.
|
Package deploy orchestrates the deployment lifecycle for user applications. |
|
ctrl/worker/deployment
Package deployment provides a Restate virtual object that serialises all mutations targeting a single deployment.
|
Package deployment provides a Restate virtual object that serialises all mutations targeting a single deployment. |
|
ctrl/worker/github
Package github provides a GitHub App client for repository access.
|
Package github provides a GitHub App client for repository access. |
|
ctrl/worker/openapi
Package openapi provides a Restate virtual object that scrapes OpenAPI specifications from running user deployments.
|
Package openapi provides a Restate virtual object that scrapes OpenAPI specifications from running user deployments. |
|
ctrl/worker/routing
Package routing manages frontline route assignment for deployments.
|
Package routing manages frontline route assignment for deployments. |
|
demo
command
|
|
|
frontline/internal/certmanager
Package certmanager provides dynamic TLS certificate management for the frontline.
|
Package certmanager provides dynamic TLS certificate management for the frontline. |
|
frontline/internal/db
Package db provides read-only database access for the frontline reverse proxy.
|
Package db provides read-only database access for the frontline reverse proxy. |
|
frontline/internal/errorpage
Package errorpage renders HTML error pages for frontline.
|
Package errorpage renders HTML error pages for frontline. |
|
frontline/internal/metrics
Package metrics holds the cross-cutting per-request metrics frontline emits from its observability middleware: a unified outcome counter labelled by URN, and a saturation gauge.
|
Package metrics holds the cross-cutting per-request metrics frontline emits from its observability middleware: a unified outcome counter labelled by URN, and a saturation gauge. |
|
frontline/internal/proxy
Package proxy provides HTTP/HTTPS proxying for the frontline.
|
Package proxy provides HTTP/HTTPS proxying for the frontline. |
|
frontline/internal/router
Package router resolves a hostname to a deployment, parses the deployment's policies, and decides whether the request runs locally (engine + proxy to a running instance in this region) or hops to a peer frontline in another region.
|
Package router resolves a hostname to a deployment, parses the deployment's policies, and decides whether the request runs locally (engine + proxy to a running instance in this region) or hops to a peer frontline in another region. |
|
heimdall
Package heimdall is the per-node resource metering agent for Unkey's deployment platform.
|
Package heimdall is the per-node resource metering agent for Unkey's deployment platform. |
|
heimdall/internal/checkpoint
Package checkpoint defines the unit heimdall writes to ClickHouse.
|
Package checkpoint defines the unit heimdall writes to ClickHouse. |
|
heimdall/internal/collector
Package collector reads cgroup v2 counters for each krane-managed pod on the node and emits one checkpoint per container per tick.
|
Package collector reads cgroup v2 counters for each krane-managed pod on the node and emits one checkpoint per container per tick. |
|
heimdall/internal/network
Package network owns heimdall's per-pod egress/ingress byte accounting.
|
Package network owns heimdall's per-pod egress/ingress byte accounting. |
|
kitchensink
command
Command kitchensink runs a stdlib-only HTTP server that exposes every probe subpackage as a real HTTP endpoint.
|
Command kitchensink runs a stdlib-only HTTP server that exposes every probe subpackage as a real HTTP endpoint. |
|
kitchensink/buildinfo
Package buildinfo exposes a string injected at link time.
|
Package buildinfo exposes a string injected at link time. |
|
kitchensink/echo
Package echo returns the request body verbatim and preserves Content-Type.
|
Package echo returns the request body verbatim and preserves Content-Type. |
|
kitchensink/env
Package env exposes process environment variables over HTTP.
|
Package env exposes process environment variables over HTTP. |
|
kitchensink/headers
Package headers echoes the incoming request headers as JSON.
|
Package headers echoes the incoming request headers as JSON. |
|
kitchensink/hello
Package hello is the simplest kitchensink probe: it returns a constant 200 OK response.
|
Package hello is the simplest kitchensink probe: it returns a constant 200 OK response. |
|
kitchensink/index
Package index serves the route listing at GET /.
|
Package index serves the route listing at GET /. |
|
kitchensink/internal/httpx
Package httpx provides the small response helpers shared across kitchensink probes.
|
Package httpx provides the small response helpers shared across kitchensink probes. |
|
kitchensink/logs
Package logs reads the request body and writes it to stdout at INFO.
|
Package logs reads the request body and writes it to stdout at INFO. |
|
kitchensink/principal
Package principal decodes the X-Unkey-Principal header that frontline sets after a successful auth policy and echoes the decoded principal as JSON.
|
Package principal decodes the X-Unkey-Principal header that frontline sets after a successful auth policy and echoes the decoded principal as JSON. |
|
kitchensink/sleep
Package sleep blocks for a caller-specified duration before returning 200.
|
Package sleep blocks for a caller-specified duration before returning 200. |
|
kitchensink/status
Package status returns whatever HTTP status the caller asks for via the URL path.
|
Package status returns whatever HTTP status the caller asks for via the URL path. |
|
krane
Package krane provides a distributed container orchestration agent for managing deployments across Kubernetes clusters via gRPC APIs.
|
Package krane provides a distributed container orchestration agent for managing deployments across Kubernetes clusters via gRPC APIs. |
|
krane/internal/deployment
Package deployment manages user workload ReplicaSets in Kubernetes as part of krane's split control loop architecture.
|
Package deployment manages user workload ReplicaSets in Kubernetes as part of krane's split control loop architecture. |
|
krane/internal/keymutex
Package keymutex provides a keyed mutex used to serialize work per key.
|
Package keymutex provides a keyed mutex used to serialize work per key. |
|
krane/internal/podstatus
Package podstatus provides small helpers for inspecting a pod's ContainersReady condition from krane's watch loops.
|
Package podstatus provides small helpers for inspecting a pod's ContainersReady condition from krane's watch loops. |
|
krane/internal/testutil
Package testutil provides test utilities shared across krane controller tests.
|
Package testutil provides test utilities shared across krane controller tests. |
|
krane/pkg/labels
Package labels provides standardized label management for krane Kubernetes resources.
|
Package labels provides standardized label management for krane Kubernetes resources. |
|
vault/testutil
Package testutil provides test utilities for creating a real vault service.
|
Package testutil provides test utilities for creating a real vault service. |
|
tools
|
|
|
exportoneof
command
Command exportoneof scans protobuf-generated Go files for unexported oneof interfaces (e.g.
|
Command exportoneof scans protobuf-generated Go files for unexported oneof interfaces (e.g. |
|
generate-rpc-clients
command
generate-rpc-clients generates simplified client wrappers for Connect RPC service interfaces.
|
generate-rpc-clients generates simplified client wrappers for Connect RPC service interfaces. |
|
release
command
Command release tags one or more Unkey services and pushes the tags to origin.
|
Command release tags one or more Unkey services and pushes the tags to origin. |
|
upsert-workos-permissions
command
Command upsert-workos-permissions syncs Unkey's WorkOS permission slugs into a WorkOS environment.
|
Command upsert-workos-permissions syncs Unkey's WorkOS permission slugs into a WorkOS environment. |
|
gha-fetch-digest
module
|
Click to show internal directories.
Click to hide internal directories.