enterprise_ai.manager
Source: sdks/python/src/enterprise_ai/manager/__init__.py. Back to the Python SDK reference index.
note
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Model ManagerConfig
Connection settings of the manager. :meth:from_env reads the NM_MANAGER_* variables.
Fields:
| Name | Type | Required | Description |
|---|---|---|---|
base_url | str | no | Address of the manager API (required). Env: NM_MANAGER_URL. |
token | str | None | no | Access token of the Hub. Write only, sealed; null keeps the stored token. |
token_file | str | None | no | Path of a file (mode 0600) holding the token, read at connection time. Env: NM_MANAGER_TOKEN_FILE. |
ca_bundle | str | None | no | PEM bundle of extra trusted certificate authorities for the manager. Env: NM_MANAGER_CA_BUNDLE. |
on_behalf_of | str | None | no | User sent in the X-NM-On-Behalf-Of header; accepted only from a service token with auth:delegate. Env: NM_MANAGER_ON_BEHALF_OF. |
locale | str | None | no | Language of the messages, for example fr. Env: NM_MANAGER_LOCALE. |
timeout | float | no | Timeout of each HTTP request, in seconds. Default 30.0. |
retries | int | no | Number of retries after the first attempt on a transient failure. Default 2. |
headers | dict[str, str] | no | Headers of the event, string values. The trace context is added. |
ManagerConfig.client_config
client_config() -> ClientConfig
The shared transport configuration, without any Control Plane (EAI_*) credential.
This element takes no parameter.
Returns: ClientConfig. A ClientConfig: Connection settings. Values not given fall back to EAI_* environment variables.
Raises: ValueError.
ManagerConfig.from_env
from_env(env: dict[str, str] | None = None, **overrides: Any) -> ManagerConfig
Build the settings from the NM_MANAGER_* variables, then apply the overrides that are not None.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
env | dict[str, str] | None | None | no | Variables to read instead of os.environ. |
**overrides | Any | no | Fields of ManagerConfig that win over the variables; None values are ignored. |
Returns: ManagerConfig. A ManagerConfig: Connection settings of the manager. :meth:from_env reads the NM_MANAGER_* variables.
ManagerConfig.resolved_token
resolved_token() -> str | None
The manager token: token when set, otherwise the stripped content of token_file.
This element takes no parameter.
Returns: str \| None. The token string, or None when neither token nor token_file is set.
Class ManagerClient
Synchronous manager client. Settings not given come from NM_MANAGER_* variables.
_ManagerBase
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
agent_templates | AgentTemplatesApi | yes | Agent templates. The registry of the agent templates (Service Templates of the Navin products such as the Navin Enterprise RAG Agent): each template with its name, publisher, version, status and the catalog service that installs it. A template is published only when that service exists in the catalog and the template was published, by the release (status published) or on this Manager by an administrator (POST .../publish, the validation of the customer: the service definition joins the catalog of this Manager); otherwise reason says why it cannot be deployed and publishable whether it can be published here. Reading is open to any signed in user, like the stack catalog; publishing and withdrawing need agent_templates:publish. Operations of this group of the Navin Manager API. |
alerts | AlertsApi | yes | Alerts and notifications. Alerts raised by the Manager from its alert definitions (host down, disk full, service unhealthy, certificate about to expire...), and the notification targets that receive them. Operations of this group of the Navin Manager API. |
audit | AuditApi | yes | Audit. The audit trail of the Manager: every change, sign in, refusal and sensitive read, with the actor (user, API token, agent or system), the action (for example service.install), the target, the cluster, the outcome (success, failure, denied), the client address and details. Events are chained: each one carries the hash of the previous one, so a modified or deleted event breaks the chain. Operations of this group of the Navin Manager API. |
auth | AuthApi | yes | Authentication. Sign in and sign out of the console: identity providers, first run setup, local and LDAP login, second factor (TOTP), password change, session and OIDC login. Operations of this group of the Navin Manager API. |
auth_config | AuthConfigApi | yes | Identity providers and security policy. Configuration of how users sign in: the LDAP directory, the OIDC providers and the security policy (passwords, lockout, session timeouts, roles that require MFA). Operations of this group of the Navin Manager API. |
availability | AvailabilityApi | yes | High availability groups. A high availability group describes how one component of a cluster stays available: its HA mode (single, active_passive, active_active, quorum), its profile (standalone, ha with at least 2 replicas in 2 fault domains, critical-ha with at least 3 in 3), its members and their fault domains, its failover policy and its recovery objectives (RTO, RPO). The group reports its HA status from the heartbeats of its members. Operations of this group of the Navin Manager API. |
backup | BackupApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
backups | BackupsApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
blueprint | BlueprintApi | yes | Blueprints. A blueprint describes the services of a cluster in a portable form, to rebuild the same platform on another cluster: the services with their mode, method, non secret configuration and bindings, and host groups (sets of components that run together, with their number of hosts). Its shape: Operations of this group of the Navin Manager API. |
clusters | ClustersApi | yes | Platform Manager clusters operations. |
config | yes | Manager settings (ManagerConfig) used by this client. | |
configs | ConfigsApi | yes | Configurations. The configuration of a managed service: its parameters (declared by the catalog with their types, defaults and sections), saved as numbered versions, with config groups that override values on some hosts. Operations of this group of the Navin Manager API. |
connections | ConnectionsApi | yes | External connections. Connections to systems outside the clusters that services can use: databases (PostgreSQL, MySQL, ClickHouse), search engines (Elasticsearch, OpenSearch, Qdrant), messaging (Kafka, NATS, Redis), S3 object storage, LDAP and OIDC directories, SMTP, syslog and plain HTTP endpoints. A service binds to a connection through its bindings (kind connection). Operations of this group of the Navin Manager API. |
consoles | ConsolesApi | yes | Service consoles. The local web interfaces of the installed services (for example the administration console of Keycloak or of a message broker), opened from the Manager. Operations of this group of the Navin Manager API. |
dr | DRApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
ha | HAApi | yes | High availability groups. A high availability group describes how one component of a cluster stays available: its HA mode (single, active_passive, active_active, quorum), its profile (standalone, ha with at least 2 replicas in 2 fault domains, critical-ha with at least 3 in 3), its members and their fault domains, its failover policy and its recovery objectives (RTO, RPO). The group reports its HA status from the heartbeats of its members. Operations of this group of the Navin Manager API. |
hosts | HostsApi | yes | Platform Manager hosts operations. |
hub | HubApi | yes | Navin Trusted Hub. Client of the Navin Trusted Hub: the Manager fetches (online) or imports (offline) the signed distribution document of the customer, verifies it, keeps its targets (approved packages and images with their digests) and feeds the mirror with the approved images. Operations of this group of the Navin Manager API. |
kubernetes | KubernetesApi | yes | Kubernetes clusters. A cluster of the Manager can be a Kubernetes cluster instead of a set of hosts. The Manager talks to it through its API server only (never over SSH) with a sealed kubeconfig, and runs catalog services there as ManagedComponent resources of the group platform.navin.ai: it writes the desired state (server side apply, field manager navin-manager), the Navin Platform Operator applies the charts, and every answer about a component is read from the status of its resource. The Navin Cluster Agent, deployed in the cluster, receives signed commands and reports back. Operations of this group of the Navin Manager API. |
lifecycle | LifecycleApi | yes | Lifecycle. The lifecycle of a cluster and of its services after the install: installation profile and approvals, preflight, liveness, readiness and smoke checks, upgrades with rollback and restore, coordinated backups and restores, drift detection, sanitized support bundles, signed acceptance reports and the uniform component sheet. Operations of this group of the Navin Manager API. |
mcp | McpApi | yes | MCP servers. The MCP (Model Context Protocol) servers of a tenant project: created from a preset of the Navin library or typed by an administrator, tested, and optionally hosted on the mcp-host service of a cluster. Operations of this group of the Navin Manager API. |
mcp_runtime | McpRuntimeApi | yes | MCP runtime. The MCP runtime of a Kubernetes cluster: the ToolHive Kubernetes Operator, installed from pinned charts, and the ephemeral MCP server instances the lifecycle controller of the Control Plane creates in it. Operations of this group of the Navin Manager API. |
me | MeApi | yes | My profile. The profile of the signed in user and its personal API tokens. Operations of this group of the Navin Manager API. |
meta | MetaApi | yes | Version. Public metadata of the Manager. No authentication is needed. Operations of this group of the Navin Manager API. |
mirror | MirrorApi | yes | Local mirror. The local mirror holds the packages, container images and Python wheels the agents install from, so that a site without Internet access (or under the banking-secure and air-gapped profiles) never downloads from outside. It is filled from an offline bundle described by a manifest. Operations of this group of the Navin Manager API. |
navin_sm | NavinSmApi | yes | Navin SM. Navin SM is the Navin desktop and CLI build an organization gives to its staff, with a file that points Navin at the organization's own LiteLLM proxy and models (Azure, Bedrock, vLLM... behind LiteLLM), optionally exclusive (no other provider allowed). A profile is that file: the organization, the gateway (base URL, authentication, headers, CA bundle, models, default model, routes, exclusive flag) and the managed policy Navin enforces (permissions, MCP allowlist, plugins, hooks, bypass, pinned environment). Operations of this group of the Navin Manager API. |
network | NetworkApi | yes | Network flows. The network flows of a cluster, computed from what the Manager knows, for the network team that opens them in its security groups or host firewalls. Each flow belongs to a scope: Operations of this group of the Navin Manager API. |
node_security | NodeSecurityApi | yes | Node security. The security of the managed hosts and of their node agents: inventory, SSH policy, preflight and SSH bootstrap of the agent, enrollment tokens bound to the agent key, trust state (quarantine, revocation, recovery), management mode, signed agent commands and their receipts, agent update and SSH break glass. Operations of this group of the Navin Manager API. |
operations | OperationsApi | yes | Operations. An operation is the unit of every change the Manager makes: an install, a restart, an upgrade, a backup, a host bootstrap... It is made of ordered stages; each stage holds tasks, usually one per host, run by the Navin agents. Status of an operation: pending, running, succeeded, failed or aborted; progress goes from 0 to 100. Operations of this group of the Navin Manager API. |
pki | PKIApi | yes | PKI and certificates. The certificate authority of the Manager and the certificates it issues: client certificates of the agents and TLS certificates of the service components. Operations of this group of the Navin Manager API. |
restores | RestoresApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
services | ServicesApi | yes | Platform Manager services operations. |
settings | SettingsApi | yes | Settings. General settings of the Manager: site name, default language, install defaults (preferred method, registry, mirror), SMTP and remote syslog for the alert notifications (syslog also serves the remote audit rule of banking-secure), data retention and the corporate proxy of the managed hosts. Every signed in user reads the non secret values; settings:manage (global) writes them. The SMTP password is read back as {"secret": true, "set": true|false}. Changes are audited (settings.update). Operations of this group of the Navin Manager API. |
stack | StackApi | yes | Stack catalog. The catalog of services the Manager can install (the stack): every service with its versions, components, install methods, parameters, dependencies and high availability rules. Any signed in user can read it; no permission is needed. Operations of this group of the Navin Manager API. |
system | SystemApi | yes | System. Self monitoring of the Manager: health of the database, the engine, the agents and the scheduled jobs, the list of supported operating systems and the Prometheus service discovery of a cluster. Permissions: system:read for the health, cluster:read for the service discovery; the supported systems are open to every signed in user. Operations of this group of the Navin Manager API. |
telemetry | TelemetryApi | yes | Telemetry. State of the real time export of the metrics and events of the Manager to ClickHouse. The platform ships no dashboard server (ADR-0169): machines and services are followed in the Manager itself and the exported tables are read with SQL. The export is off while no ClickHouse URL is configured. Any principal that reads at least one cluster (cluster:read, global or on a cluster). Operations of this group of the Navin Manager API. |
users | UsersApi | yes | Users and roles. Administration of the console accounts and of their role bindings. Operations of this group of the Navin Manager API. |
vault | VaultApi | yes | Vault. The vault of the platform administrators: the credentials of the platform services. An entry is a service name, its URL, a login, a password and an API key or secret key. Only the name is stored in clear; URL, login, password and key are one document sealed with AES-256-GCM and the master key. Lists and sheets never carry the password nor the key (has_password, has_api_key); POST .../reveal returns them and is audited, the audit keeping the service name only, never a value. Operations of this group of the Navin Manager API. |
Constructor ManagerClient
ManagerClient(base_url: str | None = None, config: ManagerConfig | None = None, http_client: httpx.Client | None = None, **settings: Any) -> None
Build the manager settings (or take config) and wire every operation group on a SyncTransport.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
base_url | str | None | None | no | Address of the manager API; None falls back to NM_MANAGER_URL, and an empty address raises ValueError. |
config | ManagerConfig | None | None | no | Complete ManagerConfig to use; cannot be combined with base_url or other settings (ValueError). |
http_client | httpx.Client | None | None | no | Existing httpx.Client to send the requests; by default one is created from the settings. |
**settings | Any | no | Fields of ManagerConfig (token, token_file, ca_bundle, on_behalf_of, locale, timeout, retries, headers); unset ones come from NM_MANAGER_*. |
ManagerClient.close
close() -> None
Close the transport and its HTTP connections; also called at the end of a with block.
This element takes no parameter.
Returns: None.
ManagerClient.on_behalf_of
on_behalf_of(user: str, http_client: httpx.Client | None = None) -> ManagerClient
A client sharing these settings that acts for user (service token with auth:delegate).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
user | str | yes | User the requests are made for, sent in the X-NM-On-Behalf-Of header. | |
http_client | httpx.Client | None | None | no | HTTP client of the new client; by default the one of this client is reused. |
Returns: ManagerClient. A ManagerClient: Synchronous manager client. Settings not given come from NM_MANAGER_* variables.
Class AsyncManagerClient
Asynchronous manager client: every method returns an awaitable.
_ManagerBase
Attributes:
| Name | Type | Required | Description |
|---|---|---|---|
agent_templates | AgentTemplatesApi | yes | Agent templates. The registry of the agent templates (Service Templates of the Navin products such as the Navin Enterprise RAG Agent): each template with its name, publisher, version, status and the catalog service that installs it. A template is published only when that service exists in the catalog and the template was published, by the release (status published) or on this Manager by an administrator (POST .../publish, the validation of the customer: the service definition joins the catalog of this Manager); otherwise reason says why it cannot be deployed and publishable whether it can be published here. Reading is open to any signed in user, like the stack catalog; publishing and withdrawing need agent_templates:publish. Operations of this group of the Navin Manager API. |
alerts | AlertsApi | yes | Alerts and notifications. Alerts raised by the Manager from its alert definitions (host down, disk full, service unhealthy, certificate about to expire...), and the notification targets that receive them. Operations of this group of the Navin Manager API. |
audit | AuditApi | yes | Audit. The audit trail of the Manager: every change, sign in, refusal and sensitive read, with the actor (user, API token, agent or system), the action (for example service.install), the target, the cluster, the outcome (success, failure, denied), the client address and details. Events are chained: each one carries the hash of the previous one, so a modified or deleted event breaks the chain. Operations of this group of the Navin Manager API. |
auth | AuthApi | yes | Authentication. Sign in and sign out of the console: identity providers, first run setup, local and LDAP login, second factor (TOTP), password change, session and OIDC login. Operations of this group of the Navin Manager API. |
auth_config | AuthConfigApi | yes | Identity providers and security policy. Configuration of how users sign in: the LDAP directory, the OIDC providers and the security policy (passwords, lockout, session timeouts, roles that require MFA). Operations of this group of the Navin Manager API. |
availability | AvailabilityApi | yes | High availability groups. A high availability group describes how one component of a cluster stays available: its HA mode (single, active_passive, active_active, quorum), its profile (standalone, ha with at least 2 replicas in 2 fault domains, critical-ha with at least 3 in 3), its members and their fault domains, its failover policy and its recovery objectives (RTO, RPO). The group reports its HA status from the heartbeats of its members. Operations of this group of the Navin Manager API. |
backup | BackupApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
backups | BackupsApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
blueprint | BlueprintApi | yes | Blueprints. A blueprint describes the services of a cluster in a portable form, to rebuild the same platform on another cluster: the services with their mode, method, non secret configuration and bindings, and host groups (sets of components that run together, with their number of hosts). Its shape: Operations of this group of the Navin Manager API. |
clusters | ClustersApi | yes | Platform Manager clusters operations. |
config | yes | Manager settings (ManagerConfig) used by this client. | |
configs | ConfigsApi | yes | Configurations. The configuration of a managed service: its parameters (declared by the catalog with their types, defaults and sections), saved as numbered versions, with config groups that override values on some hosts. Operations of this group of the Navin Manager API. |
connections | ConnectionsApi | yes | External connections. Connections to systems outside the clusters that services can use: databases (PostgreSQL, MySQL, ClickHouse), search engines (Elasticsearch, OpenSearch, Qdrant), messaging (Kafka, NATS, Redis), S3 object storage, LDAP and OIDC directories, SMTP, syslog and plain HTTP endpoints. A service binds to a connection through its bindings (kind connection). Operations of this group of the Navin Manager API. |
consoles | ConsolesApi | yes | Service consoles. The local web interfaces of the installed services (for example the administration console of Keycloak or of a message broker), opened from the Manager. Operations of this group of the Navin Manager API. |
dr | DRApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
ha | HAApi | yes | High availability groups. A high availability group describes how one component of a cluster stays available: its HA mode (single, active_passive, active_active, quorum), its profile (standalone, ha with at least 2 replicas in 2 fault domains, critical-ha with at least 3 in 3), its members and their fault domains, its failover policy and its recovery objectives (RTO, RPO). The group reports its HA status from the heartbeats of its members. Operations of this group of the Navin Manager API. |
hosts | HostsApi | yes | Platform Manager hosts operations. |
hub | HubApi | yes | Navin Trusted Hub. Client of the Navin Trusted Hub: the Manager fetches (online) or imports (offline) the signed distribution document of the customer, verifies it, keeps its targets (approved packages and images with their digests) and feeds the mirror with the approved images. Operations of this group of the Navin Manager API. |
kubernetes | KubernetesApi | yes | Kubernetes clusters. A cluster of the Manager can be a Kubernetes cluster instead of a set of hosts. The Manager talks to it through its API server only (never over SSH) with a sealed kubeconfig, and runs catalog services there as ManagedComponent resources of the group platform.navin.ai: it writes the desired state (server side apply, field manager navin-manager), the Navin Platform Operator applies the charts, and every answer about a component is read from the status of its resource. The Navin Cluster Agent, deployed in the cluster, receives signed commands and reports back. Operations of this group of the Navin Manager API. |
lifecycle | LifecycleApi | yes | Lifecycle. The lifecycle of a cluster and of its services after the install: installation profile and approvals, preflight, liveness, readiness and smoke checks, upgrades with rollback and restore, coordinated backups and restores, drift detection, sanitized support bundles, signed acceptance reports and the uniform component sheet. Operations of this group of the Navin Manager API. |
mcp | McpApi | yes | MCP servers. The MCP (Model Context Protocol) servers of a tenant project: created from a preset of the Navin library or typed by an administrator, tested, and optionally hosted on the mcp-host service of a cluster. Operations of this group of the Navin Manager API. |
mcp_runtime | McpRuntimeApi | yes | MCP runtime. The MCP runtime of a Kubernetes cluster: the ToolHive Kubernetes Operator, installed from pinned charts, and the ephemeral MCP server instances the lifecycle controller of the Control Plane creates in it. Operations of this group of the Navin Manager API. |
me | MeApi | yes | My profile. The profile of the signed in user and its personal API tokens. Operations of this group of the Navin Manager API. |
meta | MetaApi | yes | Version. Public metadata of the Manager. No authentication is needed. Operations of this group of the Navin Manager API. |
mirror | MirrorApi | yes | Local mirror. The local mirror holds the packages, container images and Python wheels the agents install from, so that a site without Internet access (or under the banking-secure and air-gapped profiles) never downloads from outside. It is filled from an offline bundle described by a manifest. Operations of this group of the Navin Manager API. |
navin_sm | NavinSmApi | yes | Navin SM. Navin SM is the Navin desktop and CLI build an organization gives to its staff, with a file that points Navin at the organization's own LiteLLM proxy and models (Azure, Bedrock, vLLM... behind LiteLLM), optionally exclusive (no other provider allowed). A profile is that file: the organization, the gateway (base URL, authentication, headers, CA bundle, models, default model, routes, exclusive flag) and the managed policy Navin enforces (permissions, MCP allowlist, plugins, hooks, bypass, pinned environment). Operations of this group of the Navin Manager API. |
network | NetworkApi | yes | Network flows. The network flows of a cluster, computed from what the Manager knows, for the network team that opens them in its security groups or host firewalls. Each flow belongs to a scope: Operations of this group of the Navin Manager API. |
node_security | NodeSecurityApi | yes | Node security. The security of the managed hosts and of their node agents: inventory, SSH policy, preflight and SSH bootstrap of the agent, enrollment tokens bound to the agent key, trust state (quarantine, revocation, recovery), management mode, signed agent commands and their receipts, agent update and SSH break glass. Operations of this group of the Navin Manager API. |
operations | OperationsApi | yes | Operations. An operation is the unit of every change the Manager makes: an install, a restart, an upgrade, a backup, a host bootstrap... It is made of ordered stages; each stage holds tasks, usually one per host, run by the Navin agents. Status of an operation: pending, running, succeeded, failed or aborted; progress goes from 0 to 100. Operations of this group of the Navin Manager API. |
pki | PKIApi | yes | PKI and certificates. The certificate authority of the Manager and the certificates it issues: client certificates of the agents and TLS certificates of the service components. Operations of this group of the Navin Manager API. |
restores | RestoresApi | yes | Backup, restore and disaster recovery. The Backup & Recovery Manager: backup targets and plans, backup artefacts with their verifications, retention, restore tests, restores and disaster recovery (sites, plans, exercises, failovers, DNS and load balancer switches). Operations of this group of the Navin Manager API. |
services | ServicesApi | yes | Platform Manager services operations. |
settings | SettingsApi | yes | Settings. General settings of the Manager: site name, default language, install defaults (preferred method, registry, mirror), SMTP and remote syslog for the alert notifications (syslog also serves the remote audit rule of banking-secure), data retention and the corporate proxy of the managed hosts. Every signed in user reads the non secret values; settings:manage (global) writes them. The SMTP password is read back as {"secret": true, "set": true|false}. Changes are audited (settings.update). Operations of this group of the Navin Manager API. |
stack | StackApi | yes | Stack catalog. The catalog of services the Manager can install (the stack): every service with its versions, components, install methods, parameters, dependencies and high availability rules. Any signed in user can read it; no permission is needed. Operations of this group of the Navin Manager API. |
system | SystemApi | yes | System. Self monitoring of the Manager: health of the database, the engine, the agents and the scheduled jobs, the list of supported operating systems and the Prometheus service discovery of a cluster. Permissions: system:read for the health, cluster:read for the service discovery; the supported systems are open to every signed in user. Operations of this group of the Navin Manager API. |
telemetry | TelemetryApi | yes | Telemetry. State of the real time export of the metrics and events of the Manager to ClickHouse. The platform ships no dashboard server (ADR-0169): machines and services are followed in the Manager itself and the exported tables are read with SQL. The export is off while no ClickHouse URL is configured. Any principal that reads at least one cluster (cluster:read, global or on a cluster). Operations of this group of the Navin Manager API. |
users | UsersApi | yes | Users and roles. Administration of the console accounts and of their role bindings. Operations of this group of the Navin Manager API. |
vault | VaultApi | yes | Vault. The vault of the platform administrators: the credentials of the platform services. An entry is a service name, its URL, a login, a password and an API key or secret key. Only the name is stored in clear; URL, login, password and key are one document sealed with AES-256-GCM and the master key. Lists and sheets never carry the password nor the key (has_password, has_api_key); POST .../reveal returns them and is audited, the audit keeping the service name only, never a value. Operations of this group of the Navin Manager API. |
Constructor AsyncManagerClient
AsyncManagerClient(base_url: str | None = None, config: ManagerConfig | None = None, http_client: httpx.AsyncClient | None = None, **settings: Any) -> None
Build the manager settings (or take config) and wire every operation group on an AsyncTransport.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
base_url | str | None | None | no | Address of the manager API; None falls back to NM_MANAGER_URL, and an empty address raises ValueError. |
config | ManagerConfig | None | None | no | Complete ManagerConfig to use; cannot be combined with base_url or other settings (ValueError). |
http_client | httpx.AsyncClient | None | None | no | Existing httpx.AsyncClient to send the requests; by default one is created from the settings. |
**settings | Any | no | Fields of ManagerConfig (token, token_file, ca_bundle, on_behalf_of, locale, timeout, retries, headers); unset ones come from NM_MANAGER_*. |
AsyncManagerClient.close
async close() -> None
Close the transport and its HTTP connections (a coroutine); also called by async with.
This element takes no parameter.
Returns: None.
AsyncManagerClient.on_behalf_of
on_behalf_of(user: str, http_client: httpx.AsyncClient | None = None) -> AsyncManagerClient
A client sharing these settings that acts for user (service token with auth:delegate).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
user | str | yes | User the requests are made for, sent in the X-NM-On-Behalf-Of header. | |
http_client | httpx.AsyncClient | None | None | no | HTTP client of the new client; by default the one of this client is reused. |
Returns: AsyncManagerClient. A AsyncManagerClient: Asynchronous manager client: every method returns an awaitable.