MongoDB Atlas CLI : gérer vos bases de données en ligne de commande
MongoDB Atlas CLI offre une alternative plus rapide à l'interface web. Exécutez et automatisez vos tâches d'administration directement depuis votre terminal.
MongoDB Atlas est un service de base de données cloud qui vous permet de déployer, gérer et faire évoluer des bases MongoDB. Vous pouvez administrer Atlas via l'Atlas UI, une interface web, ou via l'Atlas CLI, un outil en ligne de commande qui permet d'effectuer les mêmes opérations par commandes.
MongoDB Atlas CLI constitue une alternative plus rapide à l'Atlas UI. Vous pouvez exécuter et automatiser des tâches d'administration directement depuis votre terminal.
Dans cet article, je vous guide pas à pas pour gérer vos bases avec l'Atlas CLI.
Prérequis
Avant de commencer, assurez-vous de disposer :
D'un compte MongoDB Atlas.
D'une familiarité de base avec la ligne de commande.
Des prérequis d'installation de l'Atlas CLI pour votre système d'exploitation.
Structure des commandes CLI
MongoDB Atlas CLI suit une structure de commande cohérente :
Manage clusters for your project. The clusters command provides access to your cluster configurations. You can create, edit, and delete clusters.
Usage:
atlas clusters [command]
Aliases:
clusters, cluster
Available Commands:
list Return all clusters for your project.
describe Return the details for the specified cluster for your project.
advancedSettings Manage advanced configuration settings for your cluster.
...
Flags:
-h, --helphelpfor clusters
Global Flags:
-P, --profile string Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
Use "atlas clusters [command] --help"formore information about a command.Propulsé par
Les noms de commandes, d'arguments et d'indicateurs dans l'Atlas CLI sont sensibles à la casse. Respectez exactement la capitalisation indiquée dans les exemples — par exemple, --orgId et non --orgID.
Créer un déploiement MongoDB
Un déploiement est une instance MongoDB en fonctionnement qui stocke et sert vos données. Chaque déploiement inclut les serveurs de base de données, le stockage, le réseau et les sauvegardes automatisées. MongoDB Atlas gère l'infrastructure, afin que vous puissiez vous concentrer sur l'utilisation de la base de données plutôt que sur la maintenance des serveurs.
La commande atlas setup vous guide dans un processus interactif. Elle vous demande des choix de configuration et crée un projet, provisionne un cluster et configure des paramètres de sécurité de base.
S'authentifier avec un déploiement existant
Si vous disposez déjà d'un déploiement MongoDB Atlas et souhaitez le gérer via le CLI, vous devez vous authentifier. Pour vous connecter, exécutez :
Cette commande vous invite à choisir un mode d'authentification, puis fournit un code de vérification à usage unique. Copiez le code et collez-le dans le navigateur lorsqu'il vous est demandé. Par exemple :
atlas auth login
? Select authentication type: UserAccount
To verify your account, copy your one-time verification code:
QPWF-6GT4
Paste the code in the browser when prompted to activate your Atlas CLI. Your code will expire after 3 minutes.
To continue, go to https://account.mongodb.com/account/connect
Press Enter to open the browser and complete authentication...
Successfully logged in as [email protected].Propulsé par
Après authentification, vous choisirez une organisation par défaut et un format de sortie. Le CLI conserve votre session, mais elle expire périodiquement. Si vous voyez une erreur "session expired", exécutez de nouveau atlas auth login.
Gérer des profils pour plusieurs environnements
Les profils vous permettent de gérer plusieurs environnements MongoDB Atlas depuis la même installation du CLI. Chaque profil stocke des paramètres de connexion pour un environnement différent, comme développement, préproduction ou production.
Grâce aux profils, vous pouvez basculer rapidement d'un environnement à l'autre sans vous ré-authentifier ni modifier des fichiers de configuration. C'est utile si vous maintenez des projets ou organisations Atlas séparés selon les étapes de votre cycle de développement.
Une pratique courante consiste à créer des projets Atlas distincts pour chaque environnement et à les gérer via des profils — par exemple :
Profil de développement : pointe vers votre projet de dev avec un petit cluster M0 pour les tests.
Profil de préproduction : pointe vers votre projet de staging qui reflète la configuration de production.
Profil de production : pointe vers votre projet de production avec des clusters calibrés pour la prod.
Créer des profils par environnement
Lors de la première exécution de atlas auth login, le CLI crée un profil par défaut. Pour créer des profils supplémentaires pour d'autres environnements, utilisez l'indicateur --profile :
Dans MongoDB Atlas, les projets organisent vos clusters, utilisateurs et paramètres. Considérez un projet comme un conteneur regroupant des ressources de base de données liées.
Chaque projet peut contenir plusieurs clusters et dispose de ses propres utilisateurs et contrôles d'accès. Cette séparation est utile lorsque vous avez des applications, environnements ou équipes différents nécessitant des ressources isolées.
Créer des projets
Pour créer un nouveau projet, exécutez :
atlas projects create <projectName>[options]Propulsé par
Utilisez un nom explicite qui reflète l'objectif du projet, comme "ecommerce-transactions" ou "mobile-app-staging".
[options] comprend des indicateurs qui modifient le mode et l'emplacement de création du projet. Par exemple, vous pouvez préciser l'organisation dans laquelle créer le projet :
atlas projects create mobile-app-staging --orgId<organizationId>Propulsé par
L'indicateur --orgId spécifie l'organisation où créer le projet. Il est requis sauf si vous avez défini une organisation par défaut. Vous pouvez exécuter la commande atlas organizations list pour obtenir la liste de vos organisations et leur Id.
In all examples, replace placeholders like <projectId>, <clusterName>, and <username> with your actual project, cluster, or user names and identifiers.Propulsé par
Mettre à jour des projets
Pour mettre à jour les paramètres d'un projet, utilisez :
atlas projects update <projectId>[options]Propulsé par
Par exemple, vous pouvez utiliser l'option --name pour changer le nom du projet :
atlas projects update <projectId>--name newProjectNamePropulsé par
Lister les projets
Pour lister tous les projets de votre organisation, utilisez :
Vous pouvez supprimer un projet via une commande Atlas CLI.
atlas projects delete <projectId>--orgId<organizationId>Propulsé par
Vous ne pouvez pas supprimer un projet qui contient encore des clusters actifs. Avant la suppression, supprimez donc tous les clusters qu'il renferme.
Gérer les clusters
Les clusters sont des groupes de serveurs MongoDB qui stockent vos données. Atlas gère pour vous l'infrastructure, la réplication et les sauvegardes.
Créer des clusters
Pour créer un nouveau cluster, exécutez :
atlas clusters create <clusterName>[options]Propulsé par
[options] comprend des indicateurs de configuration du cluster. Par exemple, vous pouvez préciser le fournisseur cloud, la région et le palier tarifaire MongoDB :
Ici, l'indicateur --provider définit le fournisseur cloud, tel qu'AWS, GCP ou Azure. --region spécifie la région de déploiement. --tier définit la taille du cluster.
Si vous n'avez pas défini de projet par défaut, ajoutez l'indicateur --projectId :
atlas clusters describe <clusterName>--projectId<projectId>Propulsé par
Cette commande précise la configuration, la taille, la région et les chaînes de connexion du cluster.
Lister les clusters
Pour lister tous les clusters d'un projet, exécutez :
atlas clusters list --projectId<projectId>Propulsé par
L'indicateur --projectId est requis sauf si vous avez défini un projet par défaut avec :
atlas config set project_id <projectId>Propulsé par
Mettre en pause des clusters
Vous pouvez mettre temporairement en pause un cluster sans le supprimer. Cela arrête ses opérations tout en préservant vos données et sa configuration :
atlas clusters pause <clusterName>--projectId<projectId>Propulsé par
Supprimer des clusters
Pour supprimer définitivement un cluster, exécutez :
atlas clusters delete <clusterName>--projectId<projectId>Propulsé par
Après avoir créé votre cluster, vous devez configurer la sécurité réseau avant de pouvoir vous y connecter.
Gérer la configuration de la liste d'accès IP
Une liste d'accès IP contrôle quelles adresses IP peuvent se connecter à vos clusters MongoDB Atlas. Chaque projet peut contenir jusqu'à 200 entrées. Vous pouvez ajouter des adresses IP individuelles, des plages en notation CIDR ou des IDs de groupes de sécurité AWS. Une plage CIDR définit un bloc d'adresses à partir d'une IP de base et d'un préfixe — par exemple, 192.168.0.0/24. Un ID de groupe de sécurité AWS autorise l'accès pour toutes les ressources de ce groupe.
Pour gérer les listes d'accès IP, vous devez avoir le rôle Project Owner sur le projet.
Ajouter des adresses IP à la liste d'accès
Pour ajouter votre adresse IP actuelle à la liste, exécutez :
atlas accessLists create --currentIp--projectId<projectId>Propulsé par
L'indicateur --currentIp ajoute automatiquement l'adresse IP de la machine qui exécute la commande. Pratique pour un accès rapide depuis votre poste de développement.
Pour ajouter une adresse IP précise, exécutez :
atlas accessLists create <ipAddress>--type ipAddress --projectId<projectId>Propulsé par
<ipAddress> est l'adresse à autoriser. Par exemple :
atlas accessLists create 192.0.2.15 --type ipAddress --comment"Office network"--projectId<projectId>Propulsé par
L'indicateur --comment ajoute une description pour retrouver l'entrée plus facilement.
Pour ajouter une plage d'adresses en notation CIDR, exécutez :
atlas accessLists create <cidrBlock>--type cidrBlock --projectId<projectId>Propulsé par
Par exemple :
atlas accessLists create 73.231.201.0/24 --type cidrBlock --comment"Development servers"--projectId<projectId>Propulsé par
Créer des entrées temporaires
Pour ajouter une adresse IP avec expiration automatique, utilisez l'indicateur --deleteAfter. Vous pouvez définir une date d'expiration jusqu'à sept jours plus tard :
atlas accessLists create <ipAddress>--type ipAddress --deleteAfter<isoDateTime>--projectId<projectId>Propulsé par
L'indicateur --deleteAfter accepte une date au format ISO-8601. Par exemple :
MongoDB Atlas supprime automatiquement l'entrée à la date et l'heure indiquées.
Lister les entrées de la liste d'accès IP
Pour afficher toutes les entrées de liste d'accès IP du projet, exécutez :
atlas accessLists list --projectId<projectId>Propulsé par
Pour consulter le détail d'une entrée spécifique, exécutez :
atlas accessLists describe <entry>--projectId<projectId>Propulsé par
<entry> est l'adresse IP, le bloc CIDR ou l'ID de groupe de sécurité AWS à afficher.
Supprimer des entrées de liste d'accès IP
Pour retirer une adresse IP de la liste, exécutez :
atlas accessLists delete <entry>--projectId<projectId>Propulsé par
Gérer les utilisateurs et les rôles
Un rôle accorde des privilèges pour exécuter un ensemble d'actions sur des ressources spécifiques. Un utilisateur est une entité à laquelle on attribue un ou plusieurs rôles déterminant ses droits dans la base.
Pour configurer les utilisateurs et rôles de base de données, vous devez disposer des accès Organization Owner, Project Owner ou Project Database Access Admin dans MongoDB Atlas.
Gérer les utilisateurs
Pour créer un utilisateur de base de données, exécutez :
atlas dbusers create [builtInRole][options]Propulsé par
[builtInRole] correspond à un ou plusieurs rôles intégrés à attribuer. [options] comprend les indicateurs pour définir ses identifiants et sa configuration. Par exemple :
L'indicateur --username définit le nom d'utilisateur. --password définit le mot de passe. --role précise le rôle à attribuer. Ici, le nom d'utilisateur est myUser et le mot de passe myPassword.
Pour lister tous les utilisateurs de base de données du projet, exécutez :
atlas dbusers list --projectId<projectId>Propulsé par
Pour afficher le détail d'un utilisateur précis, exécutez :
atlas dbusers describe <username>--projectId<projectId>Propulsé par
Vous pouvez aussi mettre à jour l'utilisateur. Par exemple, pour changer son mot de passe :
atlas dbusers update myUser --password newPassword --projectId<projectId>Propulsé par
Pour mettre à jour ses rôles :
atlas dbusers update myUser --role readWriteAnyDatabase --role dbAdmin --projectId<projectId>Propulsé par
Pour supprimer un utilisateur précis :
atlas dbusers delete <username>--projectId<projectId>Propulsé par
Gérer les rôles
Deux catégories de rôles peuvent être attribuées à un utilisateur :
Rôles intégrés
Rôles personnalisés
Rôles intégrés
Les rôles intégrés sont des rôles prédéfinis fournis par MongoDB Atlas. Ils regroupent des permissions usuelles selon les cas d'usage, par exemple :
read : accès en lecture seule à une base spécifique.
readWrite : lecture et modification des données d'une base spécifique.
readAnyDatabase : lecture seule sur toutes les bases sauf local et config.
readWriteAnyDatabase : lecture et écriture sur toutes les bases.
dbAdmin : privilèges d'administration pour une base spécifique (création d'index, consultation de statistiques, etc.).
dbAdminAnyDatabase : privilèges d'administration sur toutes les bases.
clusterAdmin : gestion du cluster dans son ensemble, y compris réplication et sharding.
userAdminAnyDatabase : création et modification des comptes utilisateurs et rôles sur toutes les bases.
Vous ne pouvez pas modifier ni supprimer les rôles intégrés : vous pouvez seulement les attribuer. Pour attribuer des rôles intégrés à la création d'utilisateurs, spécifiez le rôle avec l'indicateur --role :
Pour attribuer ou changer le rôle d'un utilisateur existant, exécutez :
atlas dbusers update app-reader --role readWriteAnyDatabase --projectId<projectId>Propulsé par
Consultez [Built-In Roles and Privileges](https://www.mongodb.com/docs/atlas/mongodb-users-roles-and-privileges/?utm_campaign=devrel&utm_source=third-party-content&utm_medium=cta&utm_content=atlas-cli-datacamp&utm_term=megan.grant) pour d'autres rôles intégrés attribuables.
Rôles personnalisés
Lorsque les rôles intégrés ne suffisent pas, MongoDB Atlas permet de créer des rôles personnalisés. Un rôle personnalisé définit un ensemble d'actions de privilège correspondant à vos besoins applicatifs ou d'équipe.
Lors de la création d'un rôle personnalisé, déterminez les collections auxquelles les utilisateurs doivent accéder et les actions autorisées sur les ressources — par exemple lire, insérer, mettre à jour ou supprimer des données.
Dans les définitions de privilèges MongoDB, vous devez utiliser le nom d'action en MAJUSCULES dans votre commande CLI, par exemple FIND et non find. Voir Privilege Actions pour la liste des actions possibles sur une ressource.
Vous pouvez gérer les rôles personnalisés avec l'Atlas CLI.
Pour créer un rôle personnalisé, exécutez :
atlas customDbRoles create <roleName>[options]Propulsé par
<roleName> est le nom du rôle personnalisé. [options] comprend les indicateurs définissant ses permissions — par exemple :
Cette commande met à jour customAnalyticsRole en lui accordant des privilèges supplémentaires. [email protected] autorise la lecture dans la collection analytics, et [email protected] l'insertion dans la collection logs de myDatabase.
L'indicateur --projectId spécifie le projet Atlas auquel le rôle appartient.
Pour supprimer un rôle personnalisé, exécutez :
atlas customDbRoles delete <roleName>--projectId<projectId>Propulsé par
L'attribution d'un rôle personnalisé à un utilisateur se fait comme pour un rôle intégré. Utilisez l'indicateur --role avec les commandes atlas dbusers create ou atlas dbusers update :
Une fois vos utilisateurs créés et leurs rôles attribués, vous pouvez vous connecter à votre cluster.
Récupérer les chaînes de connexion
Une chaîne de connexion contient les informations nécessaires pour connecter vos applications à votre cluster Atlas : hôte du cluster, base d'authentification et options de connexion.
Avant de l'utiliser, assurez-vous d'avoir configuré votre liste d'accès IP et créé au moins un utilisateur de base.
Obtenir la chaîne de connexion d'un cluster
Pour récupérer la chaîne de connexion d'un cluster, exécutez :
atlas clusters connectionStrings describe <clusterName>--projectId<projectId>Propulsé par
Cette commande renvoie la chaîne de connexion SRV de votre cluster.
Formats de chaîne de connexion
MongoDB Atlas propose deux types de chaînes de connexion :
Chaîne standard (mongodb://) : liste explicitement tous les nœuds du cluster. Utilisez ce format si vous devez spécifier des adresses serveur individuelles.
Chaîne SRV (mongodb+srv://) : utilise le DNS pour récupérer automatiquement les informations du cluster. C'est le format recommandé, car il s'adapte automatiquement en cas de changement de configuration.
Utiliser la chaîne de connexion
Remplacez <username> et <password> dans la chaîne par les identifiants de votre utilisateur de base :
mongodb+srv://<username>:<password>@cluster0.example.mongodb.net/Propulsé par
Par exemple, si votre nom d'utilisateur est appUser et votre mot de passe securePass123 :
Vous pouvez ensuite utiliser cette chaîne avec les MongoDB Drivers, le MongoDB Shell ou d'autres outils MongoDB pour vous connecter à votre cluster.
Gérer les sauvegardes
Les sauvegardes sont des copies de vos données permettant de restaurer un cluster en cas de perte ou de corruption. Atlas crée automatiquement des sauvegardes à intervalles réguliers.
Automated continuous backups are only available for M10+ dedicated clusters. M0 free-tier clusters do not have backup capabilities. M2/M5 shared clusters have basic cloud backups, but not continuous backup. For more information, see [Snapshots for Flex Clusters](https://www.mongodb.com/docs/atlas/backup-restore-cluster/?utm_campaign=devrel&utm_source=third-party-content&utm_medium=cta&utm_content=atlas-cli-datacamp&utm_term=megan.grant#snapshots-for-flex-clusters).Propulsé par
Pour gérer les sauvegardes, vous devez avoir les accès Organization Owner ou Project Owner dans Atlas.
Créer des sauvegardes à la demande
Pour créer immédiatement une sauvegarde, exécutez :
atlas backups snapshots create <clusterName>--desc"Backup description"--projectId<projectId>Propulsé par
Dans cette commande, --desc est un indicateur requis décrivant le snapshot.
Lister les sauvegardes disponibles
Pour lister toutes les sauvegardes d'un cluster, exécutez :
atlas backups snapshots list <clusterName>--projectId<projectId>Propulsé par
Décrire la configuration de sauvegarde
Pour afficher les paramètres de sauvegarde d'un cluster, exécutez :
atlas backups schedule describe <clusterName>--projectId<projectId>Propulsé par
Restaurer depuis une sauvegarde
Pour restaurer des données à partir d'une sauvegarde, exécutez :
atlas backups restores start <clusterName>--snapshotId<snapshotId>--targetClusterName<targetClusterName>--projectId<projectId>Propulsé par
L'indicateur --snapshotId précise la sauvegarde à restaurer. --targetClusterName indique le nom du cluster cible — par exemple :
atlas backups snapshots delete <snapshotId>--projectId<projectId>Propulsé par
Conclusion
Dans cet article, nous avons parcouru la structure des commandes CLI, la création de déploiements, la gestion des projets et des clusters, la configuration des utilisateurs et des rôles, ainsi que la gestion des sauvegardes. Vous pouvez automatiser ces opérations en les combinant dans des scripts pour faciliter la gestion de multiples environnements et intégrer l'administration de la base à votre flux de développement.
FAQs
Dois-je m'authentifier à chaque utilisation de MongoDB Atlas CLI ?⌄
Non. Le CLI conserve votre session après l'exécution de atlas auth login. Toutefois, les sessions expirent périodiquement pour des raisons de sécurité. Vous ne devrez vous réauthentifier que si un message "session expired" s'affiche.
Puis-je utiliser l'Atlas CLI avec des clusters gratuits (M0) ?⌄
Oui, vous pouvez gérer des clusters du niveau gratuit (M0) avec MongoDB Atlas CLI pour la plupart des opérations : création d'utilisateurs, gestion des rôles et configuration du cluster. En revanche, les opérations de sauvegarde ne sont pas disponibles pour les niveaux gratuit ou partagé.
Quelle est la différence entre rôles utilisateur MongoDB Atlas et rôles de base de données ?⌄
Les rôles d'utilisateur Atlas (comme Organization Owner, Project Owner, Project Cluster Manager) contrôlent qui peut administrer la plateforme MongoDB Atlas elle-même via l'UI, le CLI ou l'API. Les rôles de base de données (comme read, readWrite et les rôles personnalisés) déterminent ce que les utilisateurs de base peuvent faire une fois connectés à MongoDB. Vous devez disposer des rôles Atlas appropriés pour créer et attribuer des rôles de base à des utilisateurs.
Puis-je gérer plusieurs projets MongoDB Atlas avec la même installation du CLI ?⌄
Oui, vous pouvez gérer plusieurs projets avec une seule installation du CLI. Vous pouvez définir un projet par défaut lors de l'authentification, ou bien préciser le projet à utiliser en ajoutant l'indicateur --projectId à vos commandes. Pour travailler avec plusieurs organisations, utilisez l'indicateur --orgId. Vous pouvez lister tous vos projets avec atlas projects list et vos organisations avec atlas organizations list.
Comment trouver mon ID d'organisation et mon ID de projet ? ⌄
Exécutez atlas organizations list pour afficher toutes vos organisations et leurs IDs. Exécutez atlas projects list pour lister tous vos projets et leurs IDs.
Apprenez l'essentiel de l'architecture d'un entrepôt de données, des composants clés aux meilleures pratiques, pour construire un système de données évolutif et efficace !
Découvrez le match-case de Python : un guide sur sa syntaxe, ses applications en data science, ML, et une analyse comparative avec le switch-case traditionnel.
Apprenez à utiliser JSON en Python, notamment la sérialisation, la désérialisation, le formatage, l'optimisation des performances, la gestion des API, ainsi que les limites et les alternatives de JSON.
Gagnez en confiance dans la régression par les MCO en maîtrisant ses fondements théoriques. Découvrez comment réaliser des mises en œuvre simples dans Excel, R et Python.
MongoDB Atlas est un service de base de données cloud qui vous permet de déployer, gérer et faire évoluer des bases MongoDB. Vous pouvez administrer Atlas via l'Atlas UI, une interface web, ou via l'Atlas CLI, un outil en ligne de commande qui permet d'effectuer les mêmes opérations par commandes.
MongoDB Atlas CLI constitue une alternative plus rapide à l'Atlas UI. Vous pouvez exécuter et automatiser des tâches d'administration directement depuis votre terminal.
Dans cet article, je vous guide pas à pas pour gérer vos bases avec l'Atlas CLI.
Prérequis
Avant de commencer, assurez-vous de disposer :
Structure des commandes CLI
MongoDB Atlas CLI suit une structure de commande cohérente :
Lorsque vous exécutez une commande sans sous-commandes ni indicateurs, le CLI affiche une aide comprenant :
Par exemple, si vous exécutez :
Vous obtiendrez une réponse similaire :
Les noms de commandes, d'arguments et d'indicateurs dans l'Atlas CLI sont sensibles à la casse. Respectez exactement la capitalisation indiquée dans les exemples — par exemple,
--orgIdet non--orgID.Créer un déploiement MongoDB
Un déploiement est une instance MongoDB en fonctionnement qui stocke et sert vos données. Chaque déploiement inclut les serveurs de base de données, le stockage, le réseau et les sauvegardes automatisées. MongoDB Atlas gère l'infrastructure, afin que vous puissiez vous concentrer sur l'utilisation de la base de données plutôt que sur la maintenance des serveurs.
Pour créer un déploiement MongoDB, installez ou mettez à jour l'Atlas CLI, puis exécutez la commande :
La commande atlas setup vous guide dans un processus interactif. Elle vous demande des choix de configuration et crée un projet, provisionne un cluster et configure des paramètres de sécurité de base.
S'authentifier avec un déploiement existant
Si vous disposez déjà d'un déploiement MongoDB Atlas et souhaitez le gérer via le CLI, vous devez vous authentifier. Pour vous connecter, exécutez :
Cette commande vous invite à choisir un mode d'authentification, puis fournit un code de vérification à usage unique. Copiez le code et collez-le dans le navigateur lorsqu'il vous est demandé. Par exemple :
Après authentification, vous choisirez une organisation par défaut et un format de sortie. Le CLI conserve votre session, mais elle expire périodiquement. Si vous voyez une erreur "session expired", exécutez de nouveau
atlas auth login.Gérer des profils pour plusieurs environnements
Les profils vous permettent de gérer plusieurs environnements MongoDB Atlas depuis la même installation du CLI. Chaque profil stocke des paramètres de connexion pour un environnement différent, comme développement, préproduction ou production.
Grâce aux profils, vous pouvez basculer rapidement d'un environnement à l'autre sans vous ré-authentifier ni modifier des fichiers de configuration. C'est utile si vous maintenez des projets ou organisations Atlas séparés selon les étapes de votre cycle de développement.
Une pratique courante consiste à créer des projets Atlas distincts pour chaque environnement et à les gérer via des profils — par exemple :
Créer des profils par environnement
Lors de la première exécution de
atlas auth login, le CLI crée un profil par défaut. Pour créer des profils supplémentaires pour d'autres environnements, utilisez l'indicateur--profile:Cela crée un profil nommé "dev" et vous guide dans le processus d'authentification. Répétez pour chaque environnement :
Chaque profil conserve ses propres identifiants d'authentification ainsi que les paramètres d'organisation et de projet par défaut.
Lister les profils disponibles
Pour afficher tous les profils configurés, exécutez :
Vous verrez alors tous les noms de profils que vous avez créés.
Afficher le détail d'un profil
Pour consulter la configuration d'un profil spécifique, exécutez :
Par exemple :
Cela affiche les paramètres du profil, y compris les IDs d'organisation et de projet par défaut.
Basculer entre les profils
Pour utiliser un profil spécifique pour une commande, ajoutez l'indicateur
--profile:Cette commande liste les clusters en utilisant les informations d'identification et les paramètres du profil de production.
Vous pouvez aussi définir un profil par défaut pour éviter de le préciser à chaque commande :
Une fois défini, ce profil sera utilisé par défaut, sauf si vous le remplacez avec l'indicateur
--profile.Mettre à jour les paramètres d'un profil
Pour modifier la configuration d'un profil, exécutez :
Par exemple, pour définir un projet par défaut pour le profil dev :
Renommer des profils
Pour renommer un profil, exécutez :
Par exemple :
Gérer les projets
Dans MongoDB Atlas, les projets organisent vos clusters, utilisateurs et paramètres. Considérez un projet comme un conteneur regroupant des ressources de base de données liées.
Chaque projet peut contenir plusieurs clusters et dispose de ses propres utilisateurs et contrôles d'accès. Cette séparation est utile lorsque vous avez des applications, environnements ou équipes différents nécessitant des ressources isolées.
Créer des projets
Pour créer un nouveau projet, exécutez :
Utilisez un nom explicite qui reflète l'objectif du projet, comme "ecommerce-transactions" ou "mobile-app-staging".
[options]comprend des indicateurs qui modifient le mode et l'emplacement de création du projet. Par exemple, vous pouvez préciser l'organisation dans laquelle créer le projet :L'indicateur
--orgIdspécifie l'organisation où créer le projet. Il est requis sauf si vous avez défini une organisation par défaut. Vous pouvez exécuter la commandeatlas organizations listpour obtenir la liste de vos organisations et leurId.Mettre à jour des projets
Pour mettre à jour les paramètres d'un projet, utilisez :
Par exemple, vous pouvez utiliser l'option
--namepour changer le nom du projet :Lister les projets
Pour lister tous les projets de votre organisation, utilisez :
La commande ci-dessus utilise l'option
--orgIdpour préciser l'organisation à lister :Vous pouvez aussi contrôler le format de sortie, par exemple afficher les résultats en JSON :
Supprimer des projets
Vous pouvez supprimer un projet via une commande Atlas CLI.
Vous ne pouvez pas supprimer un projet qui contient encore des clusters actifs. Avant la suppression, supprimez donc tous les clusters qu'il renferme.
Gérer les clusters
Les clusters sont des groupes de serveurs MongoDB qui stockent vos données. Atlas gère pour vous l'infrastructure, la réplication et les sauvegardes.
Créer des clusters
Pour créer un nouveau cluster, exécutez :
[options]comprend des indicateurs de configuration du cluster. Par exemple, vous pouvez préciser le fournisseur cloud, la région et le palier tarifaire MongoDB :Ici, l'indicateur
--providerdéfinit le fournisseur cloud, tel qu'AWS, GCP ou Azure.--regionspécifie la région de déploiement.--tierdéfinit la taille du cluster.Si vous n'avez pas défini de projet par défaut, ajoutez l'indicateur
--projectId:Décrire des clusters
Pour afficher le détail d'un cluster, exécutez :
Cette commande précise la configuration, la taille, la région et les chaînes de connexion du cluster.
Lister les clusters
Pour lister tous les clusters d'un projet, exécutez :
L'indicateur
--projectIdest requis sauf si vous avez défini un projet par défaut avec :Mettre en pause des clusters
Vous pouvez mettre temporairement en pause un cluster sans le supprimer. Cela arrête ses opérations tout en préservant vos données et sa configuration :
Supprimer des clusters
Pour supprimer définitivement un cluster, exécutez :
Après avoir créé votre cluster, vous devez configurer la sécurité réseau avant de pouvoir vous y connecter.
Gérer la configuration de la liste d'accès IP
Une liste d'accès IP contrôle quelles adresses IP peuvent se connecter à vos clusters MongoDB Atlas. Chaque projet peut contenir jusqu'à 200 entrées. Vous pouvez ajouter des adresses IP individuelles, des plages en notation CIDR ou des IDs de groupes de sécurité AWS. Une plage CIDR définit un bloc d'adresses à partir d'une IP de base et d'un préfixe — par exemple,
192.168.0.0/24. Un ID de groupe de sécurité AWS autorise l'accès pour toutes les ressources de ce groupe.Pour gérer les listes d'accès IP, vous devez avoir le rôle Project Owner sur le projet.
Ajouter des adresses IP à la liste d'accès
Pour ajouter votre adresse IP actuelle à la liste, exécutez :
L'indicateur
--currentIpajoute automatiquement l'adresse IP de la machine qui exécute la commande. Pratique pour un accès rapide depuis votre poste de développement.Pour ajouter une adresse IP précise, exécutez :
<ipAddress>est l'adresse à autoriser. Par exemple :L'indicateur
--commentajoute une description pour retrouver l'entrée plus facilement.Pour ajouter une plage d'adresses en notation CIDR, exécutez :
Par exemple :
Créer des entrées temporaires
Pour ajouter une adresse IP avec expiration automatique, utilisez l'indicateur
--deleteAfter. Vous pouvez définir une date d'expiration jusqu'à sept jours plus tard :L'indicateur
--deleteAfteraccepte une date au format ISO-8601. Par exemple :MongoDB Atlas supprime automatiquement l'entrée à la date et l'heure indiquées.
Lister les entrées de la liste d'accès IP
Pour afficher toutes les entrées de liste d'accès IP du projet, exécutez :
Pour consulter le détail d'une entrée spécifique, exécutez :
<entry>est l'adresse IP, le bloc CIDR ou l'ID de groupe de sécurité AWS à afficher.Supprimer des entrées de liste d'accès IP
Pour retirer une adresse IP de la liste, exécutez :
Gérer les utilisateurs et les rôles
Un rôle accorde des privilèges pour exécuter un ensemble d'actions sur des ressources spécifiques. Un utilisateur est une entité à laquelle on attribue un ou plusieurs rôles déterminant ses droits dans la base.
Pour configurer les utilisateurs et rôles de base de données, vous devez disposer des accès Organization Owner, Project Owner ou Project Database Access Admin dans MongoDB Atlas.
Gérer les utilisateurs
Pour créer un utilisateur de base de données, exécutez :
[builtInRole]correspond à un ou plusieurs rôles intégrés à attribuer.[options]comprend les indicateurs pour définir ses identifiants et sa configuration. Par exemple :L'indicateur
--usernamedéfinit le nom d'utilisateur.--passworddéfinit le mot de passe.--roleprécise le rôle à attribuer. Ici, le nom d'utilisateur estmyUseret le mot de passemyPassword.Pour lister tous les utilisateurs de base de données du projet, exécutez :
Pour afficher le détail d'un utilisateur précis, exécutez :
Vous pouvez aussi mettre à jour l'utilisateur. Par exemple, pour changer son mot de passe :
Pour mettre à jour ses rôles :
Pour supprimer un utilisateur précis :
Gérer les rôles
Deux catégories de rôles peuvent être attribuées à un utilisateur :
Rôles intégrés
Les rôles intégrés sont des rôles prédéfinis fournis par MongoDB Atlas. Ils regroupent des permissions usuelles selon les cas d'usage, par exemple :
localetconfig.Vous ne pouvez pas modifier ni supprimer les rôles intégrés : vous pouvez seulement les attribuer. Pour attribuer des rôles intégrés à la création d'utilisateurs, spécifiez le rôle avec l'indicateur
--role:Pour attribuer ou changer le rôle d'un utilisateur existant, exécutez :
Consultez [Built-In Roles and Privileges](https://www.mongodb.com/docs/atlas/mongodb-users-roles-and-privileges/?utm_campaign=devrel&utm_source=third-party-content&utm_medium=cta&utm_content=atlas-cli-datacamp&utm_term=megan.grant) pour d'autres rôles intégrés attribuables.
Rôles personnalisés
Lorsque les rôles intégrés ne suffisent pas, MongoDB Atlas permet de créer des rôles personnalisés. Un rôle personnalisé définit un ensemble d'actions de privilège correspondant à vos besoins applicatifs ou d'équipe.
Lors de la création d'un rôle personnalisé, déterminez les collections auxquelles les utilisateurs doivent accéder et les actions autorisées sur les ressources — par exemple lire, insérer, mettre à jour ou supprimer des données.
Dans les définitions de privilèges MongoDB, vous devez utiliser le nom d'action en MAJUSCULES dans votre commande CLI, par exemple FIND et non find. Voir Privilege Actions pour la liste des actions possibles sur une ressource.
Vous pouvez gérer les rôles personnalisés avec l'Atlas CLI.
Pour créer un rôle personnalisé, exécutez :
<roleName>est le nom du rôle personnalisé.[options]comprend les indicateurs définissant ses permissions — par exemple :Dans la commande ci-dessus :
customAnalyticsRoleest le nom du nouveau rôle personnalisé. Choisissez un nom explicite reflétant son objectif.--privilegeprécise les actions autorisées sur les ressources.[email protected], où@sépare l'action de la ressource.FINDest une action de privilège reconnue par MongoDB.myDatabase.usersest la ressource ciblée — ici, la collection users de la basemyDatabase.Pour afficher les rôles personnalisés, exécutez :
Cette commande liste tous les rôles personnalisés et leurs permissions.
Pour mettre à jour un rôle personnalisé, exécutez :
[options]précise ce qui doit être modifié. Par exemple, pour ajouter de nouveaux privilèges :Cette commande met à jour
customAnalyticsRoleen lui accordant des privilèges supplémentaires.[email protected]autorise la lecture dans la collectionanalytics, et[email protected]l'insertion dans la collectionlogsdemyDatabase.L'indicateur
--projectIdspécifie le projet Atlas auquel le rôle appartient.Pour supprimer un rôle personnalisé, exécutez :
L'attribution d'un rôle personnalisé à un utilisateur se fait comme pour un rôle intégré. Utilisez l'indicateur
--roleavec les commandesatlas dbusers createouatlas dbusers update:Une fois vos utilisateurs créés et leurs rôles attribués, vous pouvez vous connecter à votre cluster.
Récupérer les chaînes de connexion
Une chaîne de connexion contient les informations nécessaires pour connecter vos applications à votre cluster Atlas : hôte du cluster, base d'authentification et options de connexion.
Avant de l'utiliser, assurez-vous d'avoir configuré votre liste d'accès IP et créé au moins un utilisateur de base.
Obtenir la chaîne de connexion d'un cluster
Pour récupérer la chaîne de connexion d'un cluster, exécutez :
Cette commande renvoie la chaîne de connexion SRV de votre cluster.
Formats de chaîne de connexion
MongoDB Atlas propose deux types de chaînes de connexion :
Chaîne standard (
mongodb://) : liste explicitement tous les nœuds du cluster. Utilisez ce format si vous devez spécifier des adresses serveur individuelles.Chaîne SRV (
mongodb+srv://) : utilise le DNS pour récupérer automatiquement les informations du cluster. C'est le format recommandé, car il s'adapte automatiquement en cas de changement de configuration.Utiliser la chaîne de connexion
Remplacez
<username>et<password>dans la chaîne par les identifiants de votre utilisateur de base :Par exemple, si votre nom d'utilisateur est
appUseret votre mot de passesecurePass123:Vous pouvez ensuite utiliser cette chaîne avec les MongoDB Drivers, le MongoDB Shell ou d'autres outils MongoDB pour vous connecter à votre cluster.
Gérer les sauvegardes
Les sauvegardes sont des copies de vos données permettant de restaurer un cluster en cas de perte ou de corruption. Atlas crée automatiquement des sauvegardes à intervalles réguliers.
Pour gérer les sauvegardes, vous devez avoir les accès Organization Owner ou Project Owner dans Atlas.
Créer des sauvegardes à la demande
Pour créer immédiatement une sauvegarde, exécutez :
Dans cette commande,
--descest un indicateur requis décrivant le snapshot.Lister les sauvegardes disponibles
Pour lister toutes les sauvegardes d'un cluster, exécutez :
Décrire la configuration de sauvegarde
Pour afficher les paramètres de sauvegarde d'un cluster, exécutez :
Restaurer depuis une sauvegarde
Pour restaurer des données à partir d'une sauvegarde, exécutez :
L'indicateur
--snapshotIdprécise la sauvegarde à restaurer.--targetClusterNameindique le nom du cluster cible — par exemple :Supprimer des sauvegardes
Pour supprimer une sauvegarde, exécutez :
Conclusion
Dans cet article, nous avons parcouru la structure des commandes CLI, la création de déploiements, la gestion des projets et des clusters, la configuration des utilisateurs et des rôles, ainsi que la gestion des sauvegardes. Vous pouvez automatiser ces opérations en les combinant dans des scripts pour faciliter la gestion de multiples environnements et intégrer l'administration de la base à votre flux de développement.