Navin Manager documentation
The Navin Manager is the management console of the Navin Enterprise AI platform: it installs, configures, operates and monitors the platform services on your hosts, through the Navin agent installed on each host. This page lists every page of its documentation, in the order of the reader's path.
Overview
| Page | Content |
|---|---|
| Overview | Building blocks, concepts, PostgreSQL policy |
| Architecture | Interactive diagram |
| OS compatibility | Supported distributions, versions, architectures and packages (generated) |
Installation
| Page | Content |
|---|---|
| Install the Navin Manager | Packages for Ubuntu 24.04, RHEL 9 family and Arch Linux, database, first start, initial administrator, TLS, reverse proxy, guided installer |
| Offline installation | Bundle, transfer, mirror, local package repositories, offline archives |
| Sandbox | Everything on one workstation, without root and without Docker |
| Upgrade | Server, migrations and agents |
| Uninstall | Packages, then data |
Configuration
| Page | Content |
|---|---|
| Configuration reference | Every setting with its NM_* variable, type and default (generated) |
Use
| Page | Content |
|---|---|
| Console user guide | One page per console area: buttons, permissions, typical tasks |
| End to end acceptance | From the machine to a verified restore, in one console |
| Operations | Clusters, hosts, services, configurations, operations, upgrades, backups |
| Lifecycle of the services | Profiles, preflight, smoke tests, upgrade and rollback, backups, drift, support bundle, acceptance report |
| Data labeling and model fine-tuning | Label Studio, datasets, LLaMA-Factory on GPUs, export of the fine-tuned model to vLLM and LiteLLM (ADR-0172) |
| WebSSO: Keycloak or LemonLDAP::NG | Choice of the OpenID Connect provider, install or connection of LemonLDAP::NG over the directory of the bank, roles, checks and limits |
| Elasticsearch of the client | Logs of the OpenTelemetry Collector and traces of Jaeger in the Elasticsearch the bank already runs, through a connection (never installed) |
| Backup, restore and disaster recovery | Backup Center, Restore Center, DR plans, exercises, measured RPO and RTO |
| Kubernetes mode | Kubernetes clusters, discovery, Platform Operator, ManagedComponent, RBAC |
| High availability of the services | HA matrix of the catalog |
| Service catalog | One page per service, generated from the catalog |
Navin agent
| Page | Content |
|---|---|
| Navin agent | Architecture, trust and enrollment, mutual TLS |
| Install the Navin agent | Every system, register command, enroll.env, SSH |
| Agent configuration reference | agent.json, nm-agent, enroll.env (generated) |
| Security of the Navin agent | Identity, signatures, path guard, allowed commands |
| Operate the Navin agent | Start, stop, logs, upgrade, decommission |
| Troubleshoot the Navin agent | Symptoms, causes, fixes |
| Host agent | Which agent, supported systems, proxy, facts |
| Kubernetes cluster agent | The agent of a Kubernetes cluster |
Operations and security
| Page | Content |
|---|---|
| Monitoring and alerts | Self monitoring, alert definitions, notifications, Prometheus |
| Security | Sign in, MFA, roles, secrets, audit, agents |
| Hardened installation | Isolated network, Quadlet, security profiles, Trusted Hub, rollback (ADR-0171) |
Reference
| Page | Content |
|---|---|
| Operations reference | Operation types, stages, task types (generated) |
| REST API and agent protocol | Authentication, main routes, errors, agent protocol |
| Troubleshooting | Symptoms, causes, fixes |
Generated pages
configuration.md, agent/configuration.md, os-compatibility.md and operations-reference.md are written by
navin-manager/docs/tools/generate_reference.py from the code (texts in navin-manager/docs/tools/reference_text.yaml):
navin-manager/server/.venv/bin/python navin-manager/docs/tools/generate_reference.py # write
navin-manager/server/.venv/bin/python navin-manager/docs/tools/generate_reference.py --check # exit 1 if stale
The binding developer reference is navin-manager/CONTRACT.md. The French documentation is in
../fr.