אחסון חבילות Node.js ב-Artifact Registry

אחסון חבילות Node.js ב-Artifact Registry

במדריך למתחילים הזה נסביר איך להגדיר מאגר פרטי של חבילות Node.js ב-Artifact Registry ולהעלות אליו חבילה.

לפני שמתחילים

נכנסים לחשבון Google Cloud . אם אתם משתמשים חדשים ב- Google Cloud, צרו חשבון כדי שתוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

התקינו את ה-CLI של Google Cloud.

הערה: אם התקנתם את ה-CLI של gcloud, השתמשו בפקודה gcloud components update כדי לבדוק אם הגרסה העדכנית מותקנת.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

התקינו את ה-CLI של Google Cloud.

הערה: אם התקנתם את ה-CLI של gcloud, השתמשו בפקודה gcloud components update כדי לבדוק אם הגרסה העדכנית מותקנת.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

1. אם רוצים להתחבר למאגר חבילות של Node.js מ-Windows, צריך להתקין את PowerShell.

התפקידים הנדרשים

כדי לקבל את ההרשאות שדרושות ליצירה ולניהול של מאגרי חבילות Node.js ב-Artifact Registry, צריך לבקש מהאדמין להקצות לכם את תפקיד ה-IAM‏ Artifact Registry Administrator (roles/artifactregistry.admin) בפרויקט. כדי לקרוא הסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.

הפעלת Cloud Shell

במדריך למתחילים הזה תשתמשו ב-Cloud Shell, שהיא סביבת מעטפת לניהול משאבים שמתארחים ב-Google Cloud.

‫Google Cloud CLI מותקן מראש ב-Cloud Shell. ה-CLI של gcloud הוא ממשק שורת הפקודה העיקרי של Google Cloud.

מפעילים את Cloud Shell:

1. עוברים אל Google Cloud המסוף.

   ‫Google Cloud console

2. בסרגל הכלים של המסוף, לוחצים על Activate Cloud Shell (הפעלת Cloud Shell): Google Cloud

בחלק התחתון של המסוף ייפתח סשן של Cloud Shell בתוך מסגרת. משתמשים בשורת הפקודות הזו כדי להריץ פקודות gcloud.

יצירת מאגר חבילות Node.js

יוצרים את המאגר של ארטיפקטים של Node.js.

1. יוצרים את המאגר.

   המסוף

   1. פותחים את הדף Repositories במסוף Google Cloud .

      פתיחת הדף Repositories

   2. לוחצים על Create Repository (יצירת מאגר).

   3. מציינים את quickstart-nodejs-repo כשם המאגר.

   4. בוחרים בפורמט npm ובמצב רגיל.

   5. בקטע Location Type, בוחרים באפשרות Region ואז בוחרים את המיקום us-central1.

   6. לוחצים על יצירה.

   המאגר נוסף לרשימת המאגרים.

   gcloud

   1. מריצים את הפקודה הבאה כדי ליצור מאגר חבילות חדש של Node.js בשם quickstart-nodejs-repo במיקום us-central1 עם התיאור Node.js repository.

      gcloud artifacts repositories create quickstart-nodejs-repo --repository-format=npm \
      --location=us-central1 --description="Node.js package repository"
      

   2. מריצים את הפקודה הבאה כדי לוודא שהמאגר נוצר.

      gcloud artifacts repositories list
      

   כדי לקבל מידע נוסף על פקודות Artifact Registry, מריצים את הפקודה gcloud artifacts.

2. כדי לפשט את הפקודות של gcloud, מגדירים את מאגר ברירת המחדל ל-quickstart-nodejs-repo ואת מיקום ברירת המחדל ל-us-central1. אחרי שמגדירים את הערכים, לא צריך לציין אותם בפקודות gcloud שדורשות מאגר או מיקום.

   כדי להגדיר את המאגר, מריצים את הפקודה:

   gcloud config set artifacts/repository quickstart-nodejs-repo
   

   כדי להגדיר את המיקום, מריצים את הפקודה:

   gcloud config set artifacts/location us-central1
   

   מידע נוסף על הפקודות האלה זמין במאמר בנושא gcloud config set.

הגדרת npm

כדי להעלות ולהוריד חבילות, צריך להגדיר את פרויקטי npm עם הגדרות לאימות מול המאגר שיצרתם. במדריך למתחילים הזה תעלו חבילה ואז תתקינו אותה בחבילה שנייה כתלות.

1. מורידים את חבילת emoji-regex, חבילה שמספקת ביטוי רגולרי להתאמה של כל סמלי האמוג'י והרצפים שלהם.

   npm pack emoji-regex
   

   הפקודה מורידה ארכיון של החבילה.

2. מחולצים את הארכיון לספרייה emoji-regex. הפקודה הבאה מיועדת לארכיון של emoji-regex בגרסה 10.1.0:

   mkdir emoji-regex && tar xvf emoji-regex-10.1.0.tgz -C emoji-regex --strip-components 1
   

3. יוצרים חבילת npm שנייה שתשמש להתקנת החבילה emoji-regex מ-Artifact Registry. כדי ליצור חבילה בסיסית, משתמשים בפקודה npm init.

   mkdir npm-package2
   cd npm-package2
   
   npm init -y
   

   כשמוצגת בקשה, מאשרים את ערכי ברירת המחדל.

4. מגדירים את הפרויקטים emoji-regex ו-npm-package2 כך שיאומתו באמצעות מאגר Artifact Registry שיצרתם.

   1. מריצים את הפקודה הבאה. הפקודה מחזירה הגדרות תצורה שצריך להוסיף לקובץ התצורה של npm.

      gcloud artifacts print-settings npm --scope=@quickstart
      

      quickstart ההיקף משויך למאגר. כשמציינים את ההיקף בפקודות לפרסום או להתקנה של חבילות, npm משתמש במאגר שלכם. כשמפרסמים או מתקינים חבילות בלי להגדיר היקף, נעשה שימוש במאגר ברירת המחדל שהגדרתם. מידע נוסף זמין בסקירה הכללית על Node.js.

      הפלט של הפקודה gcloud אמור להיראות כמו בדוגמה הבאה. ‫PROJECT הוא מזהה הפרויקט. Google Cloud

      @quickstart:registry=https://us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/
      //us-central1-npm.pkg.dev/PROJECT/quickstart-nodejs-repo/:always-auth=true
      

   2. מוסיפים את הגדרות התצורה מהשלב הקודם לקובץ .npmrc של הפרויקט בכל פרויקט npm. הקובץ באותה ספרייה שבה נמצא קובץ package.json.

      מידע נוסף על הקובץ .npmrc זמין בסקירה הכללית של Node.js.

      כל מאגר חבילות Node.js ב-Artifact Registry משויך לנקודת קצה של מאגר npm‏ https://LOCATION-npm.pkg.dev/PROJECT/REPOSITORY. אם יוצרים עוד מאגר חבילות Node.js ב-Artifact Registry, ‏ npm מתקשר איתו כמאגר נפרד עם היקף משלו.

5. עורכים את package.json בפרויקט emoji-regex ובפרויקט npm-package2.

   1. מוודאים שהערך של name כולל את ההיקף quickstart.

      • עבור emoji-regex:

      "name": "@quickstart/emoji-regex"
      

      • עבור npm-package2:

      "name": "@quickstart/npm-package2"
      

   2. בקטע scripts, מוסיפים סקריפט ל-google-artifactregistry-auth, ספריית לקוח שמעדכנת את פרטי הכניסה למאגרי Artifact Registry.

      "scripts": {
        "artifactregistry-login": "npx google-artifactregistry-auth --repo-config=./.npmrc --credential-config=./.npmrc"
      }
      

העלאת חבילה למאגר

1. מרעננים את טוקן הגישה כדי להתחבר למאגר.

   npm run artifactregistry-login
   

2. מוסיפים את החבילה למאגר. אפשר להשתמש בפקודה npm או yarn.

   npm publish
   

   yarn publish
   

הצגת החבילה במאגר

כדי לוודא שהחבילה נוספה למאגר:

המסוף

1. פותחים את הדף Repositories במסוף Google Cloud .

   פתיחת הדף Repositories

2. ברשימת המאגרים, לוחצים על המאגר quickstart-nodejs-repo.

   בדף Packages (חבילות) מופיעה רשימת החבילות במאגר.

3. לוחצים על חבילה כדי לראות את הגרסאות שלה.

gcloud

כדי להציג את רשימת האימג'ים במאגר ברירת המחדל quickstart-nodejs-repo, מריצים את הפקודה הבאה:

 gcloud artifacts packages list

כדי לראות את הגרסאות של חבילה, מריצים את הפקודה הבאה:

gcloud artifacts versions list --package=PACKAGE

כאשר PACKAGE הוא מזהה החבילה.

התקנת חבילות

מתקינים את חבילת emoji-regex ממאגר Artifact Registry ב-npm-package2.

בספרייה npm-package2, מריצים את הפקודה npm install או yarn add:

npm install @quickstart/emoji-regex

yarn add @quickstart/emoji-regex

הפקודה מתקינה את החבילה emoji-regex בפרויקט npm-package2. הוא גם מעדכן את package.json כדי להגדיר את emoji-regex כתלות.

"dependencies": {
  "@quickstart/emoji-regex": "^10.1.0"
}

הסרת המשאבים

כדי לא לצבור חיובים לחשבון Google Cloud על המשאבים שבהם השתמשתם בדף הזה, פועלים לפי השלבים הבאים:

לפני שמסירים מאגר, צריך לוודא שכל החבילות שרוצים לשמור זמינות במיקום אחר.

כדי למחוק את המאגר:

המסוף

1. פותחים את הדף Repositories במסוף Google Cloud .

   פתיחת הדף Repositories

2. ברשימת המאגרים, בוחרים במאגר quickstart-nodejs-repo.

3. לוחצים על Delete.

gcloud

1. כדי למחוק את מאגר quickstart-nodejs-repo, מריצים את הפקודה הבאה:

   gcloud artifacts repositories delete quickstart-nodejs-repo
   

2. אם רוצים להסיר את הגדרות ברירת המחדל של המאגר והמיקום שהגדרתם עבור התצורה הפעילה של gcloud, מריצים את הפקודות הבאות:

   gcloud config unset artifacts/repository
   gcloud config unset artifacts/location
   

המאמרים הבאים

• מידע נוסף על הגדרת אימות
• מידע נוסף על ניהול מאגרי מידע
• מידע על ניהול חבילות
• אפשר גם לקרוא את המשאבים שלנו בנושא DevOps ולעיין בתוכנית המחקר שלנו.