התחברות ל-GitLab

בדף הזה מוסבר איך ליצור חיבורים ל-GitLab וקישורים למאגרים ב-GitLab. אתם יכולים לבצע את המשימות האלה באמצעות מסוף Google Cloud או Google Cloud CLI.

ההוראות האלה מיועדות למפתחי אפליקציות, לאדמינים של פלטפורמות ולמנהלי אבטחה שרוצים להשתמש במאגרי קוד המקור של GitLab עם Google. באופן ספציפי, אתם יכולים להשתמש במאגרים של GitLab עם Gemini Code Assist.

סקירה כללית על Developer Connect

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

  1. 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.

    Go to project selector

  2. Verify that billing is enabled for your Google Cloud project.

  3. Enable the Developer Connect, Secret Manager APIs, if any are not already enabled.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

  4. מוודאים שיש לכם גישה לחשבון ב-GitLab.

    כדי לשמור על אבטחת העבודה של הצוות, מומלץ להשלים את המשימות במדריך הזה באמצעות חשבון שירות או חשבון שמשותף עם הצוות, ולא באמצעות חשבון אישי.

  5. מוודאים שיש לכם מאגר ב-GitLab או הרשאות ברמת אדמין במאגר משותף.
  6. אופציונלי: יוצרים מפתח הצפנה בניהול הלקוח (CMEK) כדי להצפין את סודות האימות שנוצרים על ידי Developer Connect.
  7. אופציונלי: כדי להשתמש בהוראות של שורת הפקודה במדריך הזה, מבצעים את השלבים הבאים:
    1. מתקינים את Google Cloud CLI. אם כבר התקנתם את ה-CLI של gcloud, צריך לוודא שפועלת אצלכם הגרסה העדכנית ביותר של gcloud components update.
    2. יוצרים חשבון שירות של Developer Connect באמצעות הפקודה הבאה, כאשר PROJECT_ID הוא Google Cloud מזהה הפרויקט:
              gcloud beta services identity create \
                  --service=developerconnect.googleapis.com \
                  --project=PROJECT_ID
              

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

כדי לקבל את ההרשאות שדרושות ליצירת חיבורים וקישורים, בקשו מהאדמין להקצות לכם את התפקידים הבאים ב-IAM:

  • אם אתם לא הבעלים של הפרויקט: התפקיד אדמין ב-Developer Connect (roles/developerconnect.admin) בחשבון המשתמש שלכם.
  • אם אתם מתכננים להשתמש ב-CMEK כדי להצפין את הסודות שנוצרו על ידי Developer Connect: Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter) בחשבון השירות של Secret Manager.
  • אם אתם מתכננים להשתמש ב-CLI של gcloud כדי לבצע את השלבים במדריך הזה: תפקיד אדמין של Secret Manager (roles/secretmanager.admin) בחשבון השירות של Developer Connect.
  • אם אתם מתכננים להשתמש במסוף Google Cloud כדי לבצע את השלבים שבמדריך הזה: אדמין IAM של פרויקט (roles/resourcemanager.projectIamAdmin) בחשבון המשתמש שלכם.

להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

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

יצירת טוקני גישה

כדי ליצור טוקני גישה ב-GitLab:

  1. נכנסים ל-GitLab.

  2. פועלים לפי ההוראות במסמכי התיעוד של GitLab כדי ליצור טוקני גישה אישיים, טוקני גישה לקבוצות או טוקני גישה לפרויקטים עם ההרשאות הבאות:

    • טוקן אחד עם היקף api לחיבור ולניתוק של מאגרים.
    • טוקן אחד עם היקף הרשאות של read_api כדי לאפשר ל-Developer Connect לקרוא את קוד המקור במאגרים.
    • לטוקני גישה לקבוצות ולטוקני גישה לפרויקטים, הטוקנים צריכים להיות עם תפקיד Maintainer או תפקיד גבוה יותר.

יצירת חיבור

בקטע הזה מוסבר איך ליצור חיבור בין Developer Connect ל-GitLab. אם אתם משתמשים במסוף Google Cloud , תוכלו גם להתחיל להוסיף קישורים למאגרים כשתסיימו להגדיר את החיבור.

כדי ליצור חיבור חדש ל-GitLab, בוחרים באחת מהאפשרויות הבאות:

המסוף

כדי ליצור חיבור:

  1. במסוף Google Cloud , פותחים את Developer Connect.

    כניסה ל-Developer Connect

    בדף Git repositories ב-Developer Connect,

    • אם מוצגת רשימה של ספקי ניהול של קוד מקור: בוחרים ספק ניהול של קוד מקור ומתחילים להגדיר את החיבור הראשון. לוחצים על Connect בכרטיס GitLab.
    • אם מופיעה טבלה עם רשימה של חיבורים קיימים: מגדירים את הספק של ניהול קוד המקור בלחיצה על Create connection > GitLab.

      הדף Create Connection נפתח.

  2. בשדה Region, בוחרים אזור למשאבי החיבור.

    1. בשדה Name, נותנים שם לחיבור החדש.
  3. בקטע Access Tokens, מזינים את טוקני הגישה של החשבון:

    • טוקן גישה ל-API: מזינים את טוקן הגישה עם היקף ההרשאות של api.
    • טוקן גישה לקריאת API: מזינים את טוקן הגישה עם ההיקף read_api.

    אתם אחראים לוודא שהאסימונים של GitLab נשארים בתוקף. משך החיים המקסימלי של אסימוני GitLab הוא 365 ימים, אלא אם יוצר האסימון או אדמין ציינו אחרת. כדי ללמוד איך לנהל את ההגדרות של תפוגת התוקף של הטוקנים ואת ההתראות, קראו את המאמרים הבאים בתיעוד של GitLab: טוקני גישה אישיים, טוקני גישה קבוצתיים, וטוקני גישה לפרויקטים.

  4. לוחצים על הצגת הגדרות נוספות כדי לראות הגדרות אישיות אופציונליות.

    1. אופציונלי: בקטע Encryption, בוחרים מפתח CMEK כדי להצפין את הסודות ב-Secret Manager שנוצרו על ידי Developer Connect.

    2. אופציונלי: כברירת מחדל, Developer Connect יכול לשמש כשרת proxy לקריאות Git ל-GitLab. כדי להשבית את האפשרות הזו, מבטלים את הסימון בתיבה Enable Developer Connect proxy.

  5. לוחצים על Continue.

אחרי שיוצרים את החיבור, מופיע הדף Link repositories.

כדי לקשר מאגרים לחיבור:

  1. ברשימת המאגרים הזמינים, בוחרים את המאגרים שבהם רוצים להשתמש.

  2. לוחצים על OK.

  3. לוחצים על קישור.

החיבור נוסף לדף Connections והקישורים למאגרים נוספים לדף Repositories במסוף Google Cloud . תמיד אפשר להוסיף עוד קישורים לחיבורים קיימים.

אם אתם מגדירים את Gemini Code Assist, המשיכו בתהליך לפי השלבים שמפורטים במאמר הגדרה ושימוש בעיגון בקוד של הארגון ב-Gemini Code Assist.

gcloud

  1. כדי ליצור סוד של לפעולת Webhook ב-Secret Manager, מריצים את הפקודה הבאה, כאשר WEBHOOK_SECRET_NAME הוא השם של הסוד לפעולת ה-Webhook:

         cat /proc/sys/kernel/random/uuid | tr -d '\n' | gcloud secrets create WEBHOOK_SECRET_NAME
    
  2. כדי לאחסן את טוקני הגישה ב-Secret Manager, מריצים את הפקודות הבאות:

    gcloud secrets create API_SECRET_NAME
    
    echo -n API_SECRET_DATA | gcloud secrets versions add API_SECRET_NAME --data-file=-
    
    gcloud secrets create READ_SECRET_NAME
    
    echo -n READ_SECRET_DATA | gcloud secrets versions add READ_SECRET_NAME --data-file=-
    

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

    • ‫API_SECRET_NAME: שם לסוד שבו מאוחסן האסימון עם ההיקף api.
    • ‫API_SECRET_DATA: האסימון עם ההיקף api, בדומה ל-glpat-XXXXXXXXXXXXXXXX.
    • ‫READ_SECRET_NAME: שם לסוד שבו מאוחסן האסימון עם ההיקף read_api.
    • ‫READ_SECRET_DATA: האסימון עם ההיקף read_api, בדומה ל-glpat-XXXXXXXXXXXXXXXX.
  3. מפעילים את הפקודה developer-connect connections create כדי להתחבר לחשבון GitLab:

    gcloud developer-connect connections create CONNECTION_NAME \
        --location=REGION \
        --gitlab-config-authorizer-credential-user-token-secret-version=projects/PROJECT_ID/secrets/API_SECRET_NAME/versions/VERSION \
        --gitlab-config-read-authorizer-credential-user-token-secret-version=projects/PROJECT_ID/secrets/READ_SECRET_NAME/versions/VERSION \
        --gitlab-config-webhook-secret-version=projects/PROJECT_ID/secrets/WEBHOOK_SECRET_NAME/versions/VERSION \
        --git-proxy-config-enabled
    

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

    • ‫CONNECTION_NAME: שם לחיבור.
    • ‫REGION: האזור של החיבור.
    • ‫PROJECT_NAME: מזהה הפרויקט ב- Google Cloud.
    • ‫API_SECRET_NAME: השם של הסוד ב-Secret Manager שמכיל את הטוקן עם ההיקף api.
    • ‫READ_SECRET_NAME: השם של הסוד ב-Secret Manager שמכיל את הטוקן עם ההיקף read_api.
    • ‫WEBHOOK_SECRET_NAME: השם של הסוד ב-Secret Manager שמכיל את הסוד של ה-webhook.
    • ‫VERSION: מספר הגרסה של כל סוד. אפשר להשתמש ב-latest כדי להשתמש במספר הגרסה העדכני ביותר.
    • ‫--git-proxy-config-enabled: דגל אופציונלי שמאפשר ל-Developer Connect לפעול כשרת proxy לקריאות Git ל-GitLab.

    ‫Developer Connect משלים את החיבור ל-GitLab. בשלב הבא, מקשרים למאגרים.

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

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

המסוף

כדי ליצור קישורים למאגרים:

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

    פותחים את הדף Repositories.

  2. לוחצים על Link repository.

    החלונית Link Git repositories נפתחת.

  3. ברשימת החיבורים, בוחרים חיבור.

  4. לוחצים על Continue.

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

    ב-Developer Connect מוצגים שמות מוצעים למשאבי המאגר.

  6. בוחרים אפשרות למתן שמות למשאבים במאגר:

    • ‫Generated: שימוש בשמות המשאבים שנוצרו במאגר.
    • ידנית: מזינים שמות משלכם.
  7. לוחצים על יצירה.

הקישורים למאגרים נוצרים ב-Developer Connect ומוצגים במסוף Google Cloud .

gcloud

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

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

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

  • ‫REPO_NAME: השם של הקישור למאגר.
  • ‫REPO_URI: הקישור למאגר, בדומה ל-https://gitlab.com/my-project/test-repo.git.
  • ‫CONNECTION_NAME: שם החיבור.
  • ‫REGION: האזור של החיבור.

‫Developer Connect יוצר את הקישורים למאגרים.

כדי להציג רשימה של מאגרים מקושרים, מריצים את הפקודה developer-connect connections git-repository-links list.

אם אתם מגדירים את Gemini Code Assist, המשיכו בתהליך לפי השלבים שמפורטים במאמר הגדרה ושימוש בעיגון בקוד של הארגון ב-Gemini Code Assist.

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