Ce guide de démarrage rapide explique comment configurer un dépôt npm Artifact Registry et y importer un package.
La gestion des packages est disponible en version alpha. Elle n'est disponible que pour les utilisateurs alpha et peut ne pas inclure toutes les fonctionnalités disponibles pour la gestion des conteneurs. Pour demander à participer à la version alpha, remplissez le formulaire d'inscription. Pour en savoir plus, consultez la page Conditions d'accès aux fonctionnalités alpha.
Avant de commencer
- Connectez-vous à votre compte Google.
Si vous n'en possédez pas déjà un, vous devez en créer un.
-
Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.
-
Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.
- Activez l'API Artifact Registry.
- Installez et initialisez le SDK Cloud.
- Installez PowerShell si vous souhaitez vous connecter à un dépôt npm à partir de Windows.
Créer un dépôt npm
Créez le dépôt pour vos artefacts Node.js.
Créez le dépôt.
Console
Ouvrez la page Dépôts dans Cloud Console.
Cliquez sur Créer un dépôt.
Spécifiez
quickstart-npm-repo
comme nom de dépôt.Choisissez npm comme format.
Sous Type d'emplacement, sélectionnez Région, puis l'emplacement
us-central1
.Cliquez sur Create (Créer).
Le dépôt est ajouté à la liste des dépôts.
gcloud
Exécutez la commande suivante pour créer un dépôt npm nommé
quickstart-npm-repo
à l'emplacementus-central1
avec la description "npm repository".gcloud artifacts repositories create quickstart-npm-repo --repository-format=npm \ --location=us-central1 [--description="npm repository"]
Exécutez la commande suivante pour vérifier que votre dépôt a bien été créé.
gcloud artifacts repositories list
Exécutez la commande
gcloud artifacts
pour en savoir plus sur les commandes Artifact Registry.Pour simplifier les commandes
gcloud
, définissez le dépôt par défaut surquickstart-npm-repo
et l'emplacement par défaut surus-central1
. Une fois les valeurs définies, vous n'avez pas besoin de les spécifier dans les commandesgcloud
nécessitant un dépôt ou un emplacement.Pour définir le dépôt, exécutez la commande suivante :
gcloud config set artifacts/repository quickstart-npm-repo
Pour définir l'emplacement, exécutez la commande suivante :
gcloud config set artifacts/location us-central1
Pour plus d'informations sur ces commandes, reportez-vous à la documentation gcloud config set.
Configurer un compte de service pour votre client
Créez ou sélectionnez un compte de service existant pour agir au nom de npm.
Créez un compte de service pour agir au nom de votre application ou sélectionnez un compte de service existant que vous utilisez pour l'automatisation.
Vous aurez besoin de l'emplacement du fichier de clé de compte de service pour configurer l'authentification avec Artifact Registry. Pour les comptes existants, vous pouvez afficher les clés et en créer sur la page "Comptes de service".
Accordez au compte de service un accès en lecture et en écriture sur votre dépôt.
gcloud artifacts repositories add-iam-policy-binding \ quickstart-npm-repo --location=us-central1 --member='serviceAccount:ACCOUNT' --role='roles/artifactregistry.writer'
Où ACCOUNT correspond à l'ID de votre compte de service au format
USERNAME@PROJECT-ID.iam.gserviceaccount.com
.Attribuez l'emplacement du fichier de clé du compte de service à la variable
GOOGLE_APPLICATION_CREDENTIALS
afin que l'assistant d'identification Artifact Registry puisse obtenir votre clé lors de la connexion aux dépôts.export GOOGLE_APPLICATION_CREDENTIALS=KEY-FILE
Où KEY-FILE est le chemin d'accès au fichier de clé du compte de service.
Pour en savoir plus sur la configuration de l'authentification par mot de passe avec le fichier de clé de compte de service, consultez la documentation authentication#auth-password.
Configurer npm
Créez un package npm à importer. Si vous n'avez pas de package disponible à utiliser avec ce guide de démarrage rapide, exécutez la commande suivante pour créer un fichier
package.json
brut :npm init -y
Configurez votre projet npm pour le déployer dans le dépôt Artifact Registry que vous avez créé.
Exécutez la commande suivante. La commande renvoie les paramètres de configuration à ajouter à votre fichier de configuration npm.
gcloud artifacts print-settings npm --scope=@quickstart
Le champ d'application
quickstart
est associé à votre dépôt. Lorsque vous incluez le champ d'application dans les commandes permettant de publier ou d'installer des packages, npm utilise votre dépôt. Lorsque vous publiez ou installez des packages sans champ d'application, le dépôt par défaut configuré est utilisé. Pour en savoir plus, consultez la présentation de Node.js.La sortie de la commande
gcloud
ressemble à ceci :@quickstart:registry=https://us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/ //us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/:_authToken="" //us-central1-npm.pkg.dev/PROJECT/quickstart-npm-repo/:always-auth=true
Ajoutez les paramètres de configuration de l'étape précédente au fichier
.npmrc
de votre projet. Le fichier se trouve généralement dans le même répertoire que le fichierpackage.json
.Remplacez PROJECT par l'ID du projet.
Pour en savoir plus sur le fichier
.npmrc
, consultez la présentation de Node.js.
Chaque dépôt npm d'Artifact Registry est associé à un point de terminaison de registre npm https://LOCATION-npm.pkg.dev/PROJECT/REPOSITORY
. Si vous créez un autre dépôt npm d'Artifact Registry, npm interagit avec celui-ci en tant que registre distinct avec son propre champ d'application.
Importer un package dans le dépôt
Sélectionnez un package à importer. Assurez-vous que le nom du package dans
package.json
inclut le champ d'applicationquickstart
."name": "@quickstart/my-package"
Actualisez le jeton d'accès pour vous connecter au dépôt. google-artifactregistry-auth est une bibliothèque cliente qui met à jour les identifiants pour les dépôts Artifact Registry. Pour actualiser les identifiants, utilisez l'une des options suivantes :
Ajoutez un script au fichier
package.json
dans votre projet."scripts": { "artifactregistry-login": "npx google-artifactregistry-auth" }
Exécutez le script avec la commande suivante :
npm run artifactregistry-login PROJECT-NPMRC
Où PROJECT-NPMRC est le chemin d'accès au fichier
.npmrc
dans le répertoire de votre projet.Pour les versions de npm antérieures à 5.2.0, procédez comme suit :
- Exécutez la commande suivante :
npm install google-artifactregistry-auth --save-dev --registry https://registry.npmjs.org/
- Ajoutez-la à un script d'authentification :
"scripts": { "artifactregistry-login": "./node_modules/.bin/artifactregistry-auth", }
Exécutez le script avec la commande suivante :
npm run artifactregistry-login PROJECT-NPMRC
Où PROJECT-NPMRC est le chemin d'accès au fichier
.npmrc
dans le répertoire de votre projet.
Ajoutez votre package au dépôt. Vous pouvez utiliser une commande
npm
ouyarn
.npm publish
yarn publish
Afficher le package dans le dépôt
Pour vérifier que votre package a bien été ajouté au dépôt :
Console
Ouvrez la page Dépôts dans Cloud Console.
Dans la liste des dépôts, cliquez sur le dépôt
quickstart-npm-repo
.La page Packages répertorie les packages du dépôt.
Cliquez sur un package pour afficher ses versions.
gcloud
Pour répertorier les images dans le dépôt quickstart-npm-repo
par défaut, exécutez la commande suivante :
gcloud artifacts packages list
Pour afficher les versions d'un package, exécutez la commande suivante :
gcloud artifacts versions list --package=PACKAGE
Où PACKAGE correspond à l'ID de package.
Installer des packages
Pour installer un package à partir du dépôt npm, utilisez la commande npm install
ou yarn add
. Remplacez PACKAGE par le nom du package.
npm install @quickstart/PACKAGE
yarn add @quickstart/PACKAGE
Nettoyer
Pour éviter que les ressources utilisées dans ce guide de démarrage rapide soient facturées sur votre compte Google Cloud, procédez comme suit :
Avant de supprimer un dépôt, assurez-vous que tous les packages que vous souhaitez conserver sont disponibles dans un autre emplacement.
Pour supprimer le dépôt :
Console
Ouvrez la page Dépôts dans Cloud Console.
Dans la liste des dépôts, sélectionnez le dépôt
quickstart-npm-repo
.Cliquez sur Supprimer.
gcloud
Pour supprimer le dépôt
quickstart-npm-repo
, exécutez la commande suivante :gcloud artifacts repositories delete quickstart-npm-repo
Si vous souhaitez supprimer le dépôt par défaut et les paramètres d'emplacement que vous avez définis pour la configuration
gcloud
active, exécutez les commandes suivantes :gcloud config unset artifacts/repository gcloud config unset artifacts/location
Étape suivante
- Essayer le guide de démarrage rapide Maven
- En savoir plus sur la configuration de l'authentification
- Découvrez comment gérer les dépôts.
- En savoir plus sur la gestion des packages
- Consultez nos ressources sur DevOps et découvrez notre programme de recherche.