הגדרת אימות ל-Go

אימות סביבת הלקוח באמצעות Artifact Registry מאפשר לאחסן מודולים פרטיים של Go ולאחזר אותם כיחסי תלות של גרסאות build.

אפשרויות אימות

הגדרת האימות שונה להעלאה ולהורדה של חבילות.

אימות להעלאות

כשמארזים ומעלים מודול Go ל-Artifact Registry, כלי ה-CLI של gcloud מחפש פרטי כניסה בסביבה שלכם כדי להגדיר אימות בסדר הבא, אלא אם מועבר הדגל --json_key לשימוש במפתח של חשבון שירות.

  1. Application Default Credentials‏ (ADC) – אסטרטגיה שבה מחפשים את פרטי הכניסה בסדר הבא:

    1. פרטי כניסה שמוגדרים במשתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS.

    2. פרטי כניסה שסופקו על ידי חשבון השירות שמוגדר כברירת מחדל ב-Compute Engine, ב-Google Kubernetes Engine, ב-Cloud Run, ב-App Engine או בפונקציות Cloud Run.

  2. פרטי הכניסה שסופקו על ידי Google Cloud CLI, כולל פרטי הכניסה של המשתמשים מהפקודה gcloud auth application-default login.

המשתנה GOOGLE_APPLICATION_CREDENTIALS מגדיר במפורש את החשבון לאימות, וכך קל יותר לפתור בעיות. אם אתם לא משתמשים במשתנה, ודאו שלכל החשבונות שבהם ADC עשוי להשתמש יש את ההרשאות הנדרשות. לדוגמה, לחשבון השירות שמוגדר כברירת מחדל למכונות וירטואליות של Compute Engine, לצמתים של Google Kubernetes Engine ולגרסאות של Cloud Run יש גישת קריאה בלבד למאגרים. אם אתם מתכוונים להעלות מהסביבות האלה באמצעות חשבון השירות שמוגדר כברירת מחדל, אתם צריכים לשנות את ההרשאות.

אימות להורדות

כשמורידים מ-Artifact Registry מודולים ארוזים של Go כדי להשתמש בהם כיחסי תלות, הקובץ הבינארי של Go משתמש בפרטי הכניסה שבקובץ netrc כדי לאמת מול Artifact Registry. כדי לפשט את תהליך האימות, אתם יכולים להשתמש בכלי העזר של Go לאימות פרטי כניסה כדי לרענן את האסימונים בקובץ netrc לאימות ב-Artifact Registry.

אפשר להגדיר את המיקום של קובץ ה-netrc באמצעות משתנה הסביבה netrc. אם המשתנה NETRC לא מוגדר, הפקודה go תקרא את $HOME/.netrc בפלטפורמות דמויות UNIX או את %USERPROFILE%\_netrc ב-Windows.

כשמשתמשים בפרטי כניסה בקובץ netrc, אפשר להשתמש ב-Artifact Registry בשיטות האימות הבאות:

פרטי כניסה לטווח קצר (מומלץ)
משתמשים בכלי העזר של פרטי הכניסה של Go ב-Artifact Registry כדי לעדכן את אסימוני האימות בקובץ netrc באמצעות פרטי הכניסה בסביבה, או מוסיפים ידנית את פרטי הכניסה של Artifact Registry לקובץ netrc.
שימוש במפתח של חשבון שירות
השתמשו באפשרות הזו כשאתם לא יכולים להשתמש בפרטי כניסה בסביבה שלכם לצורך אימות. אתם יכולים להשתמש בכלי העזר של פרטי הכניסה של Go ב-Artifact Registry כדי להוסיף את המפתח הלא מוצפן של חשבון השירות לקובץ netrc, או להוסיף אותו לקובץ באופן ידני.

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

  1. מתקינים את Go בגרסה 1.15 ואילך.
  2. מתקינים את התוסף package-go-module ל-CLI של gcloud:

    gcloud components install package-go-module

הגדרת סביבת Go

  1. מנחים את Go להוריד מודולים מ-Artifact Registry, מהפרוקסי הציבורי של מודול Go ואז מהמקור, בסדר הזה:

      export GOPROXY=https://LOCATION-go.pkg.dev/PROJECT/REPOSITORY,https://proxy.golang.org,direct
    

    מחליפים את מה שכתוב בשדות הבאים:

    • ‫LOCATION הוא המיקום של המאגר, באזור אחד או במספר אזורים.
    • ‫PROJECT הוא מזהה הפרויקט ב- Google Cloud.
    • ‫REPOSITORY הוא שם המאגר שבו החבילה מאוחסנת.
  2. כדי להחריג את המודול מבדיקה באמצעות מסד הנתונים הציבורי של סיכומי ביקורת:

      export GONOSUMDB=MODULE_PATH_REGEX
    

    מחליפים את MODULE_PATH_REGEX בנתיב המודול או בביטוי רגולרי אם רוצים להחריג כמה מודולים.

    לדוגמה, כדי להחריג את המודול example.com/foo מבדיקה באמצעות מסד הנתונים הציבורי של סיכומי ביקורת, מריצים את הפקודה הבאה:

      export GONOSUMDB=example.com/foo
    

    הפקודה הבאה מחריגה את כל המודולים עם נתיבי מודולים שמתחילים ב-example.com מבדיקה באמצעות מסד הנתונים הציבורי של סיכומי ביקורת:

      export GONOSUMDB=example.com/*
    

הוספת פרטי הכניסה של Artifact Registry לקובץ netrc

  1. מריצים את הפקודה הבאה כדי להוסיף את פרטי הכניסה של Artifact Registry לקובץ netrc באמצעות כלי העזר של Go לפרטי כניסה:

      GOPROXY=proxy.golang.org \
          go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.4.0 \
          add-locations --locations=LOCATION \
          --json_key=PATH_TO_JSON_KEY
    

    כאשר:

    • ‫LOCATION הוא המיקום האזורי או במספר אזורים של המאגר. כדי להוסיף כמה מיקומים, מזינים אותם כרשימה מופרדת בפסיקים.
    • PATH_TO_JSON_KEY אופציונלי. הנתיב למפתח של חשבון השירות.

      כלי העזר לאימות של Go מוסיף הגדרות לקובץ netrc כדי לאמת את Artifact Registry. אם מעבירים את הדגל --json_key, המפתח מתווסף לקובץ netrc לאימות באמצעות סיסמה.

  2. אם אתם משתמשים בפרטי כניסה לטווח קצר כדי לאמת את Artifact Registry, תצטרכו לרענן את אסימון ה-OAuth. כדי לעשות את זה, מריצים את הפקודה הבאה לפני שמשתמשים במודול כתלות:

      GOPROXY=proxy.golang.org \
      go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.4.0 refresh
    

אימות באמצעות מפתח לחשבון שירות

השתמשו בגישה הזו כשאתם צריכים אימות באמצעות שם משתמש וסיסמה.

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

  • מומלץ להשתמש בחשבון שירות ייעודי לאינטראקציה עם מאגרים.
  • מקצים לחשבון השירות את התפקיד המינימלי ב-Artifact Registry שנדרש. לדוגמה, הקצו את התפקיד "קריאה ב-Artifact Registry" לחשבון שירות שמוריד פריטי מידע שנוצרו בתהליך הפיתוח (Artifact) בלבד.
  • אם קבוצות בארגון שלכם צריכות רמות שונות של גישה למאגרים ספציפיים, תנו גישה ברמת המאגר ולא ברמת הפרויקט.
  • שיטות מומלצות לניהול פרטי כניסה

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

  1. יוצרים חשבון שירות שיפעל בשם האפליקציה, או בוחרים חשבון שירות קיים שמשמש לאוטומציה.

    כדי להגדיר אימות באמצעות Artifact Registry, תצטרכו את המיקום של קובץ המפתח של חשבון השירות. בחשבונות קיימים, אפשר לראות את המפתחות וליצור מפתחות חדשים בדף Service Accounts.

    מעבר לדף 'חשבונות שירות'

  2. נותנים לחשבון השירות את התפקיד המתאים ב-Artifact Registry כדי לתת גישה למאגר.

  3. מריצים את הפקודה הבאה כדי להוסיף את פרטי הכניסה של חשבון השירות לקובץ netrc באמצעות כלי העזר לפרטי כניסה של Go:

      GOPROXY=proxy.golang.org \
          go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.4.0 \
          add-locations --locations=LOCATION \
          --json_key=PATH_TO_JSON_KEY
    

    כאשר:

    • ‫LOCATION הוא המיקום האזורי או במספר אזורים של המאגר. כדי להוסיף כמה מיקומים, מזינים אותם כרשימה מופרדת בפסיקים.
    • ‫PATH_TO_JSON_KEY הוא הנתיב לקובץ המפתח בפורמט JSON של חשבון השירות.

      כלי העזר לאישורים של Go מוסיף את מפתח חשבון השירות לקובץ netrc לצורך אימות באמצעות סיסמה.

אפשר גם להוסיף באופן ידני את המפתח של חשבון השירות לקובץ netrc בפורמט הבא:

machine LOCATION.pkg.dev
login _json_key_base64
password KEY

מחליפים את מה שכתוב בשדות הבאים:

  • ‫LOCATION במיקום האזורי או במספר האזורים של המאגר.
  • ‫KEY במפתח בקידוד base64 בקובץ המפתח של חשבון השירות.

הוספת כלי העזר של Go לפרטי כניסה אל GONOPROXY

לפני שמשתמשים בכלי העזר לאימות של Go, צריך להוסיף אותו לרשימה GONOPROXY כדי לאלץ את Go להוריד אותו ישירות מ-GitHub. אם יש לכם מודולים אחרים שאתם רוצים להוריד ישירות מהמקור, אתם יכולים להוסיף אותם ברשימה מופרדת בפסיקים, כמו בדוגמה הבאה:

  export GONOPROXY=MODULE_PATH1, MODULE_PATH2

כאשר MODULE_PATH1 ו-MODULE_PATH2 הם נתיבי המודולים שצריך להוריד מהמקור.

כדי להוסיף את כלי העזר של Go לאימות לרשימת GONOPROXY ולהריץ אותו כדי להגדיר את פרטי הכניסה:

  1. מוסיפים את כלי העזר של פרטי הכניסה של Go אל GONOPROXY

      export GONOPROXY=github.com/GoogleCloudPlatform/artifact-registry-go-tools
    
  2. מריצים את הפקודה הבאה כדי להוסיף את פרטי הכניסה של Artifact Registry לקובץ netrc באמצעות כלי החבילה של מודול Go:

      GOPROXY=proxy.golang.org \
          go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.4.0 \
          add-locations --locations=LOCATION \
          [--json_key=path/to/service/account/key.json]
    

    ‫LOCATION הוא המיקום האזורי או במספר אזורים של המאגר. כדי להוסיף כמה מיקומים, מזינים אותם כרשימה מופרדת בפסיקים.

    כלי העזר לאימות של Go מוסיף הגדרות לקובץ netrc כדי לאמת את Artifact Registry. אם מעבירים את הדגל --json_key, המפתח מתווסף לקובץ netrc לאימות באמצעות סיסמה.

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