KNetraHub Proxy Manager API: endpoints and migrations, no background jobs.
271
Proxy Manager API ā the request half of Proxy Manager.
KNetraHub is a self-hosted IT operations portal: a Docker Swarm console, full-stack monitoring, work management, privileged access management, IP address management and a database workspace, behind one sign-in. It ships two ways ā as a single monolith image, or as the split stack of one image per service that this image belongs to.
š Documentation: https://sengphirum.github.io/KNetraHub/documentationā
The Proxy Manager module's HTTP API and realtime (SSE) endpoints, plus its schema migrations. No background jobs.
It bundles the server code of proxy and nothing else, so the image carries only the module it is named after.
Serves Proxy Manager's HTTP endpoints and its realtime stream, and applies that module's own schema migrations at start-up. It opens two database pools: the portal pool it shares with every service, and Proxy Manager's module pool, which it shares only with that module's worker.
It runs no background job whatsoever. Nothing here polls, sweeps or drains, so restarting it interrupts requests only ā never the work already in flight on the worker.
Runs unprivileged with cap_drop: [ALL] and nothing added back.
| Image | Serves HTTP | Runs background jobs | Scale it with |
|---|---|---|---|
knetrahub-proxy-api (this image) | yes | no | request load |
knetrahub-appā | yes | yes | nothing ā it is one process |
Scale this with request and dashboard load. Scale proxy-worker separately when it is the jobs, not the traffic, that are growing.
Read straight from the stack file that deploys this service, so the list is what the image actually takes. Optional entries ship commented out.
| Variable | Default | |
|---|---|---|
NUXT_PROXY_MASTER_KEY_FILE | /run/secrets/knetrahub_proxy_master_key | optional |
NUXT_PROXY_SHARED_STACK | knetrahub-proxy | optional |
NUXT_PROXY_DEDICATED_STACK_PREFIX | knetrahub-proxy- | optional |
NUXT_PROXY_DEPLOY_TIMEOUT_SECONDS | 180 | optional |
NUXT_PROXY_DRIFT_INTERVAL_SECONDS | 60 | optional |
NUXT_PROXY_STATS_INTERVAL_SECONDS | 60 | optional |
NUXT_PROXY_REQUIRE_APPROVAL_EXTERNAL | true | optional |
NUXT_PROXY_REQUIRE_APPROVAL_RESTRICTED | true | optional |
NUXT_PROXY_RESERVED_PORTS | 3000 | optional |
NUXT_PROXY_NGINX_IMAGE | nginx:1.31.6-alpine | optional |
NUXT_PROXY_CADDY_IMAGE | caddy:2.10.2-alpine | optional |
NUXT_PROXY_TRAEFIK_IMAGE | traefik:v3.5.6 | optional |
NUXT_PROXY_HAPROXY_IMAGE | haproxy:3.2.25-alpine | optional |
NUXT_PROXY_NATIVE_VALIDATION | enforce | optional |
NUXT_PROXY_DIAGNOSTICS_IMAGE | busybox:1.37.0 | optional |
NUXT_PROXY_PRESET_RESERVATION_CPUS | 0.25 | optional |
NUXT_PROXY_PRESET_RESERVATION_MEMORY_MIB | 128 | optional |
NUXT_PROXY_PRESET_LIMIT_CPUS | 1 | optional |
NUXT_PROXY_PRESET_LIMIT_MEMORY_MIB | 512 | optional |
NUXT_APP_REPLICAS | 1 | set |
NUXT_DB_POOL_MAX | 8 | set |
NUXT_MODULE_POOL_REPLICAS | 1 | set |
NUXT_JWT_SECRET | change-me-to-a-long-random-string | set |
NUXT_ENV_MODE | staging | optional |
NUXT_DB_HOST | timescaledb | set |
NUXT_DB_PORT | 5432 | set |
NUXT_DB_NAME | knetrahub | set |
NUXT_DB_USER | knetrahub | set |
NUXT_DB_PASSWORD | change-me-to-a-long-random-string | set |
KNETRA_INTERNAL_TOKEN_FILE | /run/secrets/knetrahub_internal_token | optional |
NUXT_WORK_FILES_DIR | /app/data/work-files | optional |
Anything ending in _FILE reads its value from that path instead, which is how the stack passes Docker secrets.
This is one service of a stack, not a standalone container: it expects the portal database and its siblings on the same overlay network. Deploy it with the stack file that owns it rather than with docker run.
docker stack deploy -c docker/docker-compose.yml knetrahub
Pin a tag or a registry for this one service with KNETRAHUB_PROXY_API_IMAGE, which the stack file reads:
export KNETRAHUB_PROXY_API_IMAGE=phirumseng/knetrahub-proxy-api:0.1.11
latest ā the most recent releasex.y.z (e.g. 0.1.11) ā immutable release versionsPin the version in production. A rollback needs a tag that does not move, and every image in the stack is released under the same version so the whole set can be pinned together.
Each service is its own image, so one can be updated without restarting the others:
phirumseng/knetrahub-appā ā Monolith (app)phirumseng/knetrahub-uiā ā UIphirumseng/knetrahub-core-apiā ā Core APIphirumseng/knetrahub-docker-apiā ā Docker APIphirumseng/knetrahub-docker-workerā ā Docker workerphirumseng/knetrahub-monitoring-apiā ā Monitoring APIphirumseng/knetrahub-monitoring-workerā ā Monitoring workerphirumseng/knetrahub-work-apiā ā Work APIphirumseng/knetrahub-work-workerā ā Work workerphirumseng/knetrahub-pam-apiā ā Privileged Access APIphirumseng/knetrahub-pam-workerā ā Privileged Access workerphirumseng/knetrahub-ipmgt-apiā ā IP Management APIphirumseng/knetrahub-ipmgt-workerā ā IP Management workerphirumseng/knetrahub-dbmanager-apiā ā Database Manager APIphirumseng/knetrahub-cmdb-apiā ā CMDB APIphirumseng/knetrahub-itsm-apiā ā Service Desk APIphirumseng/knetrahub-automation-apiā ā Automation APIphirumseng/knetrahub-netconfig-apiā ā Network Configuration APIphirumseng/knetrahub-pki-apiā ā Certificates APIphirumseng/knetrahub-recovery-apiā ā Backup & DR APIphirumseng/knetrahub-kubernetes-apiā ā Kubernetes APIphirumseng/knetrahub-vulnerability-apiā ā Vulnerabilities APIphirumseng/knetrahub-logs-apiā ā Log Analytics APIphirumseng/knetrahub-logs-workerā ā Log Analytics workerphirumseng/knetrahub-proxy-api ā Proxy Manager API ā this imagephirumseng/knetrahub-agentā ā node agentphirumseng/knetrahub-pam-ssh-gatewayā ā PAM SSH gatewayphirumseng/knetrahub-pam-connector-runnerā ā PAM connector runnerphirumseng/knetrahub-dbmanager-gatewayā ā DB Manager gatewayProprietary ā Ā© Seng Phirum. All rights reserved.
Content type
Image
Digest
sha256:5d935afdbā¦
Size
58.9 MB
Last updated
about 4 hours ago
docker pull phirumseng/knetrahub-proxy-api