enterprise_ai.manager
Source : sdks/python/src/enterprise_ai/manager/__init__.py. Retour à l'index de la référence du SDK Python.
remarque
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Modèle ManagerConfig
Paramètres de connexion du manager. :meth:from_env lit les variables NM_MANAGER_*.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
base_url | str | non | Adresse de l'API du manager (obligatoire). Variable : NM_MANAGER_URL. |
token | str | None | non | Jeton d'accès au Hub. En écriture seule, scellé ; nul conserve le jeton enregistré. |
token_file | str | None | non | Chemin d'un fichier (mode 0600) contenant le jeton, lu au moment de la connexion. Variable : NM_MANAGER_TOKEN_FILE. |
ca_bundle | str | None | non | Fichier PEM d'autorités de certification supplémentaires de confiance pour le manager. Variable : NM_MANAGER_CA_BUNDLE. |
on_behalf_of | str | None | non | Utilisateur envoyé dans l'en-tête X-NM-On-Behalf-Of ; accepté uniquement d'un jeton de service avec auth:delegate. Variable : NM_MANAGER_ON_BEHALF_OF. |
locale | str | None | non | Langue des messages, par exemple fr. Variable : NM_MANAGER_LOCALE. |
timeout | float | non | Délai d'expiration de chaque requête HTTP, en secondes. Par défaut 30.0. |
retries | int | non | Nombre de nouvelles tentatives après le premier essai en cas d'échec passager. Par défaut 2. |
headers | dict[str, str] | non | En-têtes de l'événement, valeurs textuelles. Le contexte de trace y est ajouté. |
ManagerConfig.client_config
client_config() -> ClientConfig
La configuration de transport partagée, sans aucun identifiant du Control Plane (EAI_*).
Cet élément ne prend aucun paramètre.
Retour : ClientConfig. Un ClientConfig : paramètres de connexion. Les valeurs non fournies reprennent les variables d'environnement EAI_*.
Erreurs levées : ValueError.
ManagerConfig.from_env
from_env(env: dict[str, str] | None = None, **overrides: Any) -> ManagerConfig
Construit les paramètres à partir des variables NM_MANAGER_*, puis applique les surcharges qui ne valent pas None.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
env | dict[str, str] | None | None | non | Variables à lire à la place de os.environ. |
**overrides | Any | non | Champs de ManagerConfig prioritaires sur les variables ; les valeurs None sont ignorées. |
Retour : ManagerConfig. Un ManagerConfig : paramètres de connexion du manager. :meth:from_env lit les variables NM_MANAGER_*.
ManagerConfig.resolved_token
resolved_token() -> str | None
Le jeton du manager : token s'il est défini, sinon le contenu de token_file sans espaces aux extrémités.
Cet élément ne prend aucun paramètre.
Retour : str \| None. La chaîne du jeton, ou None si ni token ni token_file n'est défini.
Classe ManagerClient
Client synchrone du manager. Les paramètres non fournis viennent des variables NM_MANAGER_*.
_ManagerBase
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
agent_templates | AgentTemplatesApi | oui | Gabarits d'agents. Le registre des gabarits d'agents (Service Templates des produits Navin, par exemple l'Agent RAG Navin Enterprise) : chaque gabarit avec son nom, son éditeur, sa version, son statut et le service du catalogue qui l'installe. Un gabarit n'est published que si ce service existe dans le catalogue et que le gabarit a été publié, par la version livrée (statut published) ou sur ce Manager par un administrateur (POST .../publish, la validation du client : la définition de service rejoint le catalogue de ce Manager) ; sinon reason indique pourquoi il ne peut pas être déployé et publishable s'il peut être publié ici. La lecture est ouverte à tout utilisateur connecté, comme le catalogue de la pile ; publier et retirer demandent agent_templates:publish. Opérations de ce groupe de l'API du Navin Manager. |
alerts | AlertsApi | oui | Alertes et notifications. Alertes levées par le Manager à partir de ses définitions d'alertes (machine hors ligne, disque plein, service en mauvaise santé, certificat proche de l'expiration...), et cibles de notification qui les reçoivent. Opérations de ce groupe de l'API du Navin Manager. |
audit | AuditApi | oui | Audit. Le journal d'audit du Manager : chaque changement, connexion, refus et lecture sensible, avec l'acteur (utilisateur, jeton d'API, agent ou système), l'action (par exemple service.install), la cible, le cluster, le résultat (success, failure, denied), l'adresse du client et des détails. Les événements sont chaînés : chacun porte l'empreinte du précédent, si bien qu'un événement modifié ou supprimé rompt la chaîne. Opérations de ce groupe de l'API du Navin Manager. |
auth | AuthApi | oui | Authentification. Connexion à la console et déconnexion : fournisseurs d'identité, configuration initiale, connexion locale et LDAP, second facteur (TOTP), changement de mot de passe, session et connexion OIDC. Opérations de ce groupe de l'API du Navin Manager. |
auth_config | AuthConfigApi | oui | Fournisseurs d'identité et politique de sécurité. Configuration de la connexion des utilisateurs : l'annuaire LDAP, les fournisseurs OIDC et la politique de sécurité (mots de passe, verrouillage, délais de session, rôles qui exigent la MFA). Opérations de ce groupe de l'API du Navin Manager. |
availability | AvailabilityApi | oui | Groupes de haute disponibilité. Un groupe de haute disponibilité décrit comment un composant d'un cluster reste disponible : son mode de HA (single, active_passive, active_active, quorum), son profil (standalone, ha avec au moins 2 réplicas dans 2 domaines de panne, critical-ha avec au moins 3 dans 3), ses membres et leurs domaines de panne, sa politique de bascule et ses objectifs de reprise (RTO, RPO). Le groupe indique son état de HA à partir des battements de cœur de ses membres. Opérations de ce groupe de l'API du Navin Manager. |
backup | BackupApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
backups | BackupsApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
blueprint | BlueprintApi | oui | Blueprints. Un blueprint décrit les services d'un cluster sous une forme portable, pour reconstruire la même plateforme sur un autre cluster : les services avec leur mode, leur méthode, leur configuration non secrète et leurs liaisons, et des groupes de machines (ensembles de composants qui tournent ensemble, avec leur nombre de machines). Sa forme : Opérations de ce groupe de l'API du Navin Manager. |
clusters | ClustersApi | oui | Opérations clusters du Platform Manager. |
config | oui | Paramètres du manager (ManagerConfig) utilisés par ce client. | |
configs | ConfigsApi | oui | Configurations. La configuration d'un service géré : ses paramètres (déclarés par le catalogue avec leurs types, leurs valeurs par défaut et leurs sections), enregistrés en versions numérotées, avec des groupes de configuration qui surchargent des valeurs sur certaines machines. Opérations de ce groupe de l'API du Navin Manager. |
connections | ConnectionsApi | oui | Connexions externes. Connexions vers des systèmes extérieurs aux clusters que les services peuvent utiliser : bases de données (PostgreSQL, MySQL, ClickHouse), moteurs de recherche (Elasticsearch, OpenSearch, Qdrant), messagerie (Kafka, NATS, Redis), stockage objet S3, annuaires LDAP et OIDC, SMTP, syslog et simples points d'accès HTTP. Un service se lie à une connexion par ses liaisons bindings (type connection). Opérations de ce groupe de l'API du Navin Manager. |
consoles | ConsolesApi | oui | Consoles des services. Les interfaces web locales des services installés (par exemple la console d'administration de Keycloak ou d'un courtier de messages), ouvertes depuis le Manager. Opérations de ce groupe de l'API du Navin Manager. |
dr | DRApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
ha | HAApi | oui | Groupes de haute disponibilité. Un groupe de haute disponibilité décrit comment un composant d'un cluster reste disponible : son mode de HA (single, active_passive, active_active, quorum), son profil (standalone, ha avec au moins 2 réplicas dans 2 domaines de panne, critical-ha avec au moins 3 dans 3), ses membres et leurs domaines de panne, sa politique de bascule et ses objectifs de reprise (RTO, RPO). Le groupe indique son état de HA à partir des battements de cœur de ses membres. Opérations de ce groupe de l'API du Navin Manager. |
hosts | HostsApi | oui | Opérations hosts du Platform Manager. |
hub | HubApi | oui | Navin Trusted Hub. Client du Navin Trusted Hub : le Manager récupère (en ligne) ou importe (hors ligne) le document de distribution signé du client, le vérifie, conserve ses cibles (paquets et images approuvés avec leurs empreintes) et alimente le miroir avec les images approuvées. Opérations de ce groupe de l'API du Navin Manager. |
kubernetes | KubernetesApi | oui | Clusters Kubernetes. Un cluster du Manager peut être un cluster Kubernetes plutôt qu'un ensemble de machines. Le Manager lui parle uniquement par son serveur d'API (jamais en SSH) avec un kubeconfig scellé, et y exécute les services du catalogue sous forme de ressources ManagedComponent du groupe platform.navin.ai : il écrit l'état souhaité (application côté serveur, gestionnaire de champs navin-manager), le Navin Platform Operator applique les charts, et toute réponse sur un composant est lue dans le statut de sa ressource. Le Navin Cluster Agent, déployé dans le cluster, reçoit des commandes signées et rend compte. Opérations de ce groupe de l'API du Navin Manager. |
lifecycle | LifecycleApi | oui | Cycle de vie. Le cycle de vie d'un cluster et de ses services après l'installation : profil d'installation et approbations, contrôles préalables, contrôles de vivacité, de disponibilité et de fonctionnement, mises à niveau avec retour arrière et restauration, sauvegardes et restaurations coordonnées, détection des dérives, archives de support expurgées, rapports de recette signés et fiche uniforme de composant. Opérations de ce groupe de l'API du Navin Manager. |
mcp | McpApi | oui | Serveurs MCP. Les serveurs MCP (Model Context Protocol) d'un projet de locataire : créés à partir d'un modèle de la bibliothèque Navin ou saisis par un administrateur, testés, et éventuellement hébergés sur le service mcp-host d'un cluster. Opérations de ce groupe de l'API du Navin Manager. |
mcp_runtime | McpRuntimeApi | oui | Environnement d'exécution MCP. L'environnement d'exécution MCP d'un cluster Kubernetes : le ToolHive Kubernetes Operator, installé à partir de charts épinglés, et les instances éphémères de serveurs MCP qu'y crée le contrôleur de cycle de vie du Control Plane. Opérations de ce groupe de l'API du Navin Manager. |
me | MeApi | oui | Mon profil. Le profil de l'utilisateur connecté et ses jetons d'API personnels. Opérations de ce groupe de l'API du Navin Manager. |
meta | MetaApi | oui | Version. Métadonnées publiques du Manager. Aucune authentification n'est nécessaire. Opérations de ce groupe de l'API du Navin Manager. |
mirror | MirrorApi | oui | Miroir local. Le miroir local contient les paquets, les images de conteneurs et les paquets Python que les agents installent, afin qu'un site sans accès Internet (ou sous les profils banking-secure et air-gapped) ne télécharge jamais rien de l'extérieur. Il est alimenté par un lot hors ligne décrit par un manifeste. Opérations de ce groupe de l'API du Navin Manager. |
navin_sm | NavinSmApi | oui | Navin SM. Navin SM est la version de Navin (poste de travail et CLI) qu'une organisation remet à son personnel, avec un fichier qui dirige Navin vers le proxy LiteLLM de l'organisation et ses modèles (Azure, Bedrock, vLLM... derrière LiteLLM), éventuellement de façon exclusive (aucun autre fournisseur permis). Un profil est ce fichier : l'organisation, la passerelle (adresse, authentification, en-têtes, autorité de certification, modèles, modèle par défaut, routes, mode exclusif) et la politique gérée que Navin applique (permissions, liste des serveurs MCP permis, plugins, hooks, contournement des demandes de permission, environnement imposé). Opérations de ce groupe de l'API du Navin Manager. |
network | NetworkApi | oui | Flux réseau. Les flux réseau d'un cluster, calculés à partir de ce que connaît le Manager, pour l'équipe réseau qui les ouvre dans ses groupes de sécurité ou ses pare-feu de machines. Chaque flux appartient à une portée : Opérations de ce groupe de l'API du Navin Manager. |
node_security | NodeSecurityApi | oui | Sécurité des nœuds. La sécurité des machines gérées et de leurs agents de nœud : inventaire, politique SSH, contrôles préalables et amorçage SSH de l'agent, jetons d'enrôlement liés à la clé de l'agent, état de confiance (quarantaine, révocation, rétablissement), mode de gestion, commandes d'agent signées et leurs reçus, mise à jour de l'agent et accès d'urgence SSH (break glass). Opérations de ce groupe de l'API du Navin Manager. |
operations | OperationsApi | oui | Opérations. Une opération est l'unité de tout changement fait par le Manager : une installation, un redémarrage, une mise à niveau, une sauvegarde, l'amorçage d'une machine... Elle se compose d'étapes ordonnées ; chaque étape contient des tâches, en général une par machine, exécutées par les agents Navin. Statut d'une opération : pending, running, succeeded, failed ou aborted ; progress va de 0 à 100. Opérations de ce groupe de l'API du Navin Manager. |
pki | PKIApi | oui | PKI et certificats. L'autorité de certification du Manager et les certificats qu'elle émet : certificats clients des agents et certificats TLS des composants des services. Opérations de ce groupe de l'API du Navin Manager. |
restores | RestoresApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
services | ServicesApi | oui | Opérations services du Platform Manager. |
settings | SettingsApi | oui | Réglages. Réglages généraux du Manager : nom du site, langue par défaut, valeurs par défaut d'installation (méthode préférée, registre, miroir), SMTP et syslog distant pour les notifications d'alertes (syslog sert aussi à la règle d'audit distant de banking-secure), conservation des données et proxy d'entreprise des machines gérées. Tout utilisateur connecté lit les valeurs non secrètes ; settings:manage (globale) les modifie. Le mot de passe SMTP est relu sous la forme {"secret": true, "set": true|false}. Les changements sont audités (settings.update). Opérations de ce groupe de l'API du Navin Manager. |
stack | StackApi | oui | Catalogue de la pile. Le catalogue des services que le Manager peut installer (la pile) : chaque service avec ses versions, ses composants, ses méthodes d'installation, ses paramètres, ses dépendances et ses règles de haute disponibilité. Tout utilisateur connecté peut le lire ; aucune permission n'est nécessaire. Opérations de ce groupe de l'API du Navin Manager. |
system | SystemApi | oui | Système. Supervision du Manager par lui-même : santé de la base de données, du moteur, des agents et des tâches planifiées, liste des systèmes d'exploitation pris en charge et découverte de services Prometheus d'un cluster. Permissions : system:read pour la santé, cluster:read pour la découverte de services ; les systèmes pris en charge sont ouverts à tout utilisateur connecté. Opérations de ce groupe de l'API du Navin Manager. |
telemetry | TelemetryApi | oui | Télémétrie. État de l'export en temps réel des métriques et événements du Manager vers ClickHouse. La plateforme ne livre pas de serveur de tableaux de bord (ADR-0169) : les machines et les services se suivent dans le Manager lui-même et les tables exportées se lisent en SQL. L'export est désactivé tant qu'aucune URL ClickHouse n'est configurée. Tout principal qui lit au moins un cluster (cluster:read, globale ou sur un cluster). Opérations de ce groupe de l'API du Navin Manager. |
users | UsersApi | oui | Utilisateurs et rôles. Administration des comptes de la console et de leurs attributions de rôle. Opérations de ce groupe de l'API du Navin Manager. |
vault | VaultApi | oui | Coffre-fort. Le coffre-fort des administrateurs de la plateforme : les identifiants des services de la plateforme. Une entrée est un nom de service, son URL, un identifiant de connexion, un mot de passe et une clé d'API ou clé secrète. Seul le nom est conservé en clair ; URL, identifiant, mot de passe et clé forment un document scellé en AES-256-GCM avec la clé maîtresse. Les listes et les fiches ne portent jamais le mot de passe ni la clé (has_password, has_api_key) ; POST .../reveal les renvoie et est audité, l'audit ne gardant que le nom du service, jamais une valeur. Opérations de ce groupe de l'API du Navin Manager. |
Constructeur ManagerClient
ManagerClient(base_url: str | None = None, config: ManagerConfig | None = None, http_client: httpx.Client | None = None, **settings: Any) -> None
Construit les paramètres du manager (ou reprend config) et branche chaque groupe d'opérations sur un SyncTransport.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
base_url | str | None | None | non | Adresse de l'API du manager ; None reprend NM_MANAGER_URL, et une adresse vide lève ValueError. |
config | ManagerConfig | None | None | non | ManagerConfig complet à utiliser ; ne peut pas être combiné avec base_url ni d'autres paramètres (ValueError). |
http_client | httpx.Client | None | None | non | httpx.Client existant pour envoyer les requêtes ; par défaut, un client est créé à partir des paramètres. |
**settings | Any | non | Champs de ManagerConfig (token, token_file, ca_bundle, on_behalf_of, locale, timeout, retries, headers) ; ceux non fournis viennent de NM_MANAGER_*. |
ManagerClient.close
close() -> None
Ferme le transport et ses connexions HTTP ; également appelée à la fin d'un bloc with.
Cet élément ne prend aucun paramètre.
Retour : None.
ManagerClient.on_behalf_of
on_behalf_of(user: str, http_client: httpx.Client | None = None) -> ManagerClient
Un client partageant ces paramètres qui agit pour user (jeton de service avec auth:delegate).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
user | str | oui | Utilisateur pour lequel les requêtes sont faites, envoyé dans l'en-tête X-NM-On-Behalf-Of. | |
http_client | httpx.Client | None | None | non | Client HTTP du nouveau client ; par défaut, celui de ce client est réutilisé. |
Retour : ManagerClient. Un ManagerClient : client synchrone du manager. Les paramètres non fournis viennent des variables NM_MANAGER_*.
Classe AsyncManagerClient
Client asynchrone du manager : chaque méthode renvoie un attendable.
_ManagerBase
Attributs :
| Nom | Type | Requis | Description |
|---|---|---|---|
agent_templates | AgentTemplatesApi | oui | Gabarits d'agents. Le registre des gabarits d'agents (Service Templates des produits Navin, par exemple l'Agent RAG Navin Enterprise) : chaque gabarit avec son nom, son éditeur, sa version, son statut et le service du catalogue qui l'installe. Un gabarit n'est published que si ce service existe dans le catalogue et que le gabarit a été publié, par la version livrée (statut published) ou sur ce Manager par un administrateur (POST .../publish, la validation du client : la définition de service rejoint le catalogue de ce Manager) ; sinon reason indique pourquoi il ne peut pas être déployé et publishable s'il peut être publié ici. La lecture est ouverte à tout utilisateur connecté, comme le catalogue de la pile ; publier et retirer demandent agent_templates:publish. Opérations de ce groupe de l'API du Navin Manager. |
alerts | AlertsApi | oui | Alertes et notifications. Alertes levées par le Manager à partir de ses définitions d'alertes (machine hors ligne, disque plein, service en mauvaise santé, certificat proche de l'expiration...), et cibles de notification qui les reçoivent. Opérations de ce groupe de l'API du Navin Manager. |
audit | AuditApi | oui | Audit. Le journal d'audit du Manager : chaque changement, connexion, refus et lecture sensible, avec l'acteur (utilisateur, jeton d'API, agent ou système), l'action (par exemple service.install), la cible, le cluster, le résultat (success, failure, denied), l'adresse du client et des détails. Les événements sont chaînés : chacun porte l'empreinte du précédent, si bien qu'un événement modifié ou supprimé rompt la chaîne. Opérations de ce groupe de l'API du Navin Manager. |
auth | AuthApi | oui | Authentification. Connexion à la console et déconnexion : fournisseurs d'identité, configuration initiale, connexion locale et LDAP, second facteur (TOTP), changement de mot de passe, session et connexion OIDC. Opérations de ce groupe de l'API du Navin Manager. |
auth_config | AuthConfigApi | oui | Fournisseurs d'identité et politique de sécurité. Configuration de la connexion des utilisateurs : l'annuaire LDAP, les fournisseurs OIDC et la politique de sécurité (mots de passe, verrouillage, délais de session, rôles qui exigent la MFA). Opérations de ce groupe de l'API du Navin Manager. |
availability | AvailabilityApi | oui | Groupes de haute disponibilité. Un groupe de haute disponibilité décrit comment un composant d'un cluster reste disponible : son mode de HA (single, active_passive, active_active, quorum), son profil (standalone, ha avec au moins 2 réplicas dans 2 domaines de panne, critical-ha avec au moins 3 dans 3), ses membres et leurs domaines de panne, sa politique de bascule et ses objectifs de reprise (RTO, RPO). Le groupe indique son état de HA à partir des battements de cœur de ses membres. Opérations de ce groupe de l'API du Navin Manager. |
backup | BackupApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
backups | BackupsApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
blueprint | BlueprintApi | oui | Blueprints. Un blueprint décrit les services d'un cluster sous une forme portable, pour reconstruire la même plateforme sur un autre cluster : les services avec leur mode, leur méthode, leur configuration non secrète et leurs liaisons, et des groupes de machines (ensembles de composants qui tournent ensemble, avec leur nombre de machines). Sa forme : Opérations de ce groupe de l'API du Navin Manager. |
clusters | ClustersApi | oui | Opérations clusters du Platform Manager. |
config | oui | Paramètres du manager (ManagerConfig) utilisés par ce client. | |
configs | ConfigsApi | oui | Configurations. La configuration d'un service géré : ses paramètres (déclarés par le catalogue avec leurs types, leurs valeurs par défaut et leurs sections), enregistrés en versions numérotées, avec des groupes de configuration qui surchargent des valeurs sur certaines machines. Opérations de ce groupe de l'API du Navin Manager. |
connections | ConnectionsApi | oui | Connexions externes. Connexions vers des systèmes extérieurs aux clusters que les services peuvent utiliser : bases de données (PostgreSQL, MySQL, ClickHouse), moteurs de recherche (Elasticsearch, OpenSearch, Qdrant), messagerie (Kafka, NATS, Redis), stockage objet S3, annuaires LDAP et OIDC, SMTP, syslog et simples points d'accès HTTP. Un service se lie à une connexion par ses liaisons bindings (type connection). Opérations de ce groupe de l'API du Navin Manager. |
consoles | ConsolesApi | oui | Consoles des services. Les interfaces web locales des services installés (par exemple la console d'administration de Keycloak ou d'un courtier de messages), ouvertes depuis le Manager. Opérations de ce groupe de l'API du Navin Manager. |
dr | DRApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
ha | HAApi | oui | Groupes de haute disponibilité. Un groupe de haute disponibilité décrit comment un composant d'un cluster reste disponible : son mode de HA (single, active_passive, active_active, quorum), son profil (standalone, ha avec au moins 2 réplicas dans 2 domaines de panne, critical-ha avec au moins 3 dans 3), ses membres et leurs domaines de panne, sa politique de bascule et ses objectifs de reprise (RTO, RPO). Le groupe indique son état de HA à partir des battements de cœur de ses membres. Opérations de ce groupe de l'API du Navin Manager. |
hosts | HostsApi | oui | Opérations hosts du Platform Manager. |
hub | HubApi | oui | Navin Trusted Hub. Client du Navin Trusted Hub : le Manager récupère (en ligne) ou importe (hors ligne) le document de distribution signé du client, le vérifie, conserve ses cibles (paquets et images approuvés avec leurs empreintes) et alimente le miroir avec les images approuvées. Opérations de ce groupe de l'API du Navin Manager. |
kubernetes | KubernetesApi | oui | Clusters Kubernetes. Un cluster du Manager peut être un cluster Kubernetes plutôt qu'un ensemble de machines. Le Manager lui parle uniquement par son serveur d'API (jamais en SSH) avec un kubeconfig scellé, et y exécute les services du catalogue sous forme de ressources ManagedComponent du groupe platform.navin.ai : il écrit l'état souhaité (application côté serveur, gestionnaire de champs navin-manager), le Navin Platform Operator applique les charts, et toute réponse sur un composant est lue dans le statut de sa ressource. Le Navin Cluster Agent, déployé dans le cluster, reçoit des commandes signées et rend compte. Opérations de ce groupe de l'API du Navin Manager. |
lifecycle | LifecycleApi | oui | Cycle de vie. Le cycle de vie d'un cluster et de ses services après l'installation : profil d'installation et approbations, contrôles préalables, contrôles de vivacité, de disponibilité et de fonctionnement, mises à niveau avec retour arrière et restauration, sauvegardes et restaurations coordonnées, détection des dérives, archives de support expurgées, rapports de recette signés et fiche uniforme de composant. Opérations de ce groupe de l'API du Navin Manager. |
mcp | McpApi | oui | Serveurs MCP. Les serveurs MCP (Model Context Protocol) d'un projet de locataire : créés à partir d'un modèle de la bibliothèque Navin ou saisis par un administrateur, testés, et éventuellement hébergés sur le service mcp-host d'un cluster. Opérations de ce groupe de l'API du Navin Manager. |
mcp_runtime | McpRuntimeApi | oui | Environnement d'exécution MCP. L'environnement d'exécution MCP d'un cluster Kubernetes : le ToolHive Kubernetes Operator, installé à partir de charts épinglés, et les instances éphémères de serveurs MCP qu'y crée le contrôleur de cycle de vie du Control Plane. Opérations de ce groupe de l'API du Navin Manager. |
me | MeApi | oui | Mon profil. Le profil de l'utilisateur connecté et ses jetons d'API personnels. Opérations de ce groupe de l'API du Navin Manager. |
meta | MetaApi | oui | Version. Métadonnées publiques du Manager. Aucune authentification n'est nécessaire. Opérations de ce groupe de l'API du Navin Manager. |
mirror | MirrorApi | oui | Miroir local. Le miroir local contient les paquets, les images de conteneurs et les paquets Python que les agents installent, afin qu'un site sans accès Internet (ou sous les profils banking-secure et air-gapped) ne télécharge jamais rien de l'extérieur. Il est alimenté par un lot hors ligne décrit par un manifeste. Opérations de ce groupe de l'API du Navin Manager. |
navin_sm | NavinSmApi | oui | Navin SM. Navin SM est la version de Navin (poste de travail et CLI) qu'une organisation remet à son personnel, avec un fichier qui dirige Navin vers le proxy LiteLLM de l'organisation et ses modèles (Azure, Bedrock, vLLM... derrière LiteLLM), éventuellement de façon exclusive (aucun autre fournisseur permis). Un profil est ce fichier : l'organisation, la passerelle (adresse, authentification, en-têtes, autorité de certification, modèles, modèle par défaut, routes, mode exclusif) et la politique gérée que Navin applique (permissions, liste des serveurs MCP permis, plugins, hooks, contournement des demandes de permission, environnement imposé). Opérations de ce groupe de l'API du Navin Manager. |
network | NetworkApi | oui | Flux réseau. Les flux réseau d'un cluster, calculés à partir de ce que connaît le Manager, pour l'équipe réseau qui les ouvre dans ses groupes de sécurité ou ses pare-feu de machines. Chaque flux appartient à une portée : Opérations de ce groupe de l'API du Navin Manager. |
node_security | NodeSecurityApi | oui | Sécurité des nœuds. La sécurité des machines gérées et de leurs agents de nœud : inventaire, politique SSH, contrôles préalables et amorçage SSH de l'agent, jetons d'enrôlement liés à la clé de l'agent, état de confiance (quarantaine, révocation, rétablissement), mode de gestion, commandes d'agent signées et leurs reçus, mise à jour de l'agent et accès d'urgence SSH (break glass). Opérations de ce groupe de l'API du Navin Manager. |
operations | OperationsApi | oui | Opérations. Une opération est l'unité de tout changement fait par le Manager : une installation, un redémarrage, une mise à niveau, une sauvegarde, l'amorçage d'une machine... Elle se compose d'étapes ordonnées ; chaque étape contient des tâches, en général une par machine, exécutées par les agents Navin. Statut d'une opération : pending, running, succeeded, failed ou aborted ; progress va de 0 à 100. Opérations de ce groupe de l'API du Navin Manager. |
pki | PKIApi | oui | PKI et certificats. L'autorité de certification du Manager et les certificats qu'elle émet : certificats clients des agents et certificats TLS des composants des services. Opérations de ce groupe de l'API du Navin Manager. |
restores | RestoresApi | oui | Sauvegarde, restauration et reprise après sinistre. Le gestionnaire de sauvegarde et de reprise : cibles et plans de sauvegarde, artefacts de sauvegarde avec leurs vérifications, conservation, tests de restauration, restaurations et reprise après sinistre (sites, plans, exercices, bascules, changements DNS et d'équilibreur de charge). Opérations de ce groupe de l'API du Navin Manager. |
services | ServicesApi | oui | Opérations services du Platform Manager. |
settings | SettingsApi | oui | Réglages. Réglages généraux du Manager : nom du site, langue par défaut, valeurs par défaut d'installation (méthode préférée, registre, miroir), SMTP et syslog distant pour les notifications d'alertes (syslog sert aussi à la règle d'audit distant de banking-secure), conservation des données et proxy d'entreprise des machines gérées. Tout utilisateur connecté lit les valeurs non secrètes ; settings:manage (globale) les modifie. Le mot de passe SMTP est relu sous la forme {"secret": true, "set": true|false}. Les changements sont audités (settings.update). Opérations de ce groupe de l'API du Navin Manager. |
stack | StackApi | oui | Catalogue de la pile. Le catalogue des services que le Manager peut installer (la pile) : chaque service avec ses versions, ses composants, ses méthodes d'installation, ses paramètres, ses dépendances et ses règles de haute disponibilité. Tout utilisateur connecté peut le lire ; aucune permission n'est nécessaire. Opérations de ce groupe de l'API du Navin Manager. |
system | SystemApi | oui | Système. Supervision du Manager par lui-même : santé de la base de données, du moteur, des agents et des tâches planifiées, liste des systèmes d'exploitation pris en charge et découverte de services Prometheus d'un cluster. Permissions : system:read pour la santé, cluster:read pour la découverte de services ; les systèmes pris en charge sont ouverts à tout utilisateur connecté. Opérations de ce groupe de l'API du Navin Manager. |
telemetry | TelemetryApi | oui | Télémétrie. État de l'export en temps réel des métriques et événements du Manager vers ClickHouse. La plateforme ne livre pas de serveur de tableaux de bord (ADR-0169) : les machines et les services se suivent dans le Manager lui-même et les tables exportées se lisent en SQL. L'export est désactivé tant qu'aucune URL ClickHouse n'est configurée. Tout principal qui lit au moins un cluster (cluster:read, globale ou sur un cluster). Opérations de ce groupe de l'API du Navin Manager. |
users | UsersApi | oui | Utilisateurs et rôles. Administration des comptes de la console et de leurs attributions de rôle. Opérations de ce groupe de l'API du Navin Manager. |
vault | VaultApi | oui | Coffre-fort. Le coffre-fort des administrateurs de la plateforme : les identifiants des services de la plateforme. Une entrée est un nom de service, son URL, un identifiant de connexion, un mot de passe et une clé d'API ou clé secrète. Seul le nom est conservé en clair ; URL, identifiant, mot de passe et clé forment un document scellé en AES-256-GCM avec la clé maîtresse. Les listes et les fiches ne portent jamais le mot de passe ni la clé (has_password, has_api_key) ; POST .../reveal les renvoie et est audité, l'audit ne gardant que le nom du service, jamais une valeur. Opérations de ce groupe de l'API du Navin Manager. |
Constructeur AsyncManagerClient
AsyncManagerClient(base_url: str | None = None, config: ManagerConfig | None = None, http_client: httpx.AsyncClient | None = None, **settings: Any) -> None
Construit les paramètres du manager (ou reprend config) et branche chaque groupe d'opérations sur un AsyncTransport.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
base_url | str | None | None | non | Adresse de l'API du manager ; None reprend NM_MANAGER_URL, et une adresse vide lève ValueError. |
config | ManagerConfig | None | None | non | ManagerConfig complet à utiliser ; ne peut pas être combiné avec base_url ni d'autres paramètres (ValueError). |
http_client | httpx.AsyncClient | None | None | non | httpx.AsyncClient existant pour envoyer les requêtes ; par défaut, un client est créé à partir des paramètres. |
**settings | Any | non | Champs de ManagerConfig (token, token_file, ca_bundle, on_behalf_of, locale, timeout, retries, headers) ; ceux non fournis viennent de NM_MANAGER_*. |
AsyncManagerClient.close
async close() -> None
Ferme le transport et ses connexions HTTP (une coroutine) ; également appelée par async with.
Cet élément ne prend aucun paramètre.
Retour : None.
AsyncManagerClient.on_behalf_of
on_behalf_of(user: str, http_client: httpx.AsyncClient | None = None) -> AsyncManagerClient
Un client partageant ces paramètres qui agit pour user (jeton de service avec auth:delegate).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
user | str | oui | Utilisateur pour lequel les requêtes sont faites, envoyé dans l'en-tête X-NM-On-Behalf-Of. | |
http_client | httpx.AsyncClient | None | None | non | Client HTTP du nouveau client ; par défaut, celui de ce client est réutilisé. |
Retour : AsyncManagerClient. Un AsyncManagerClient : client asynchrone du manager, chaque méthode renvoie un attendable.