בדף הזה מוסבר איך ליצור חיבורים ל-GitHub וקישורים למאגרים ב-GitHub. אתם יכולים לבצע את המשימות האלה באמצעות מסוף Google Cloud או Google Cloud CLI.
ההוראות האלה מיועדות למפתחי אפליקציות, לאדמינים של פלטפורמות ולמנהלי אבטחה שרוצים להשתמש במאגרי קוד המקור של GitHub עם Google.
לדוגמה, אתם יכולים לקבל הצעות לכתיבת קוד מ-Gemini Code Assist, שמותאמות לבסיס הקוד שלכם, או להשתמש במאגרי GitHub המקושרים כדי לפתח אפליקציות אינטרנט באמצעות Firebase App Hosting.
סקירה כללית על Developer Connect
לפני שמתחילים
-
נכנסים לחשבון Google.
אם עדיין אין חשבון, יוצרים חשבון חדש.
-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
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.enablepermission. 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.-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
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.enablepermission. 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.-
מוודאים שיש לכם גישה לחשבון ב-GitHub.
כדי לשמור על אבטחת העבודה של הצוות, מומלץ להשלים את המשימות במדריך הזה באמצעות חשבון בוט או חשבון שמשותף לצוות, ולא באמצעות חשבון אישי.
- מוודאים שיש לכם מאגר ב-GitHub או הרשאות ברמת אדמין במאגר משותף.
- אופציונלי: יוצרים מפתח הצפנה בניהול הלקוח (CMEK) כדי להצפין את סודות האימות שנוצרים על ידי Developer Connect.
- אופציונלי: כדי להשתמש בהוראות של שורת הפקודה במדריך הזה, מבצעים את השלבים הבאים:
- מתקינים את Google Cloud CLI. אם כבר התקנתם את ה-CLI של gcloud, צריך לוודא שפועלת אצלכם הגרסה העדכנית ביותר של
gcloud components update. - יוצרים חשבון שירות של Developer Connect באמצעות הפקודה הבאה, כאשר PROJECT_ID הוא Google Cloud מזהה הפרויקט:
gcloud beta services identity create \ --service=developerconnect.googleapis.com \ --project=PROJECT_ID
- מתקינים את Google Cloud CLI. אם כבר התקנתם את ה-CLI של gcloud, צריך לוודא שפועלת אצלכם הגרסה העדכנית ביותר של
התפקידים הנדרשים
כדי לקבל את ההרשאות שדרושות ליצירת חיבורים וקישורים, בקשו מהאדמין להקצות לכם את התפקידים הבאים ב-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) בחשבון המשתמש שלכם.
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
יצירת חיבור
בקטע הזה מוסבר איך ליצור חיבור בין Developer Connect ל-GitHub. אם אתם משתמשים במסוף Google Cloud , תוכלו גם להתחיל להוסיף קישורים למאגרים כשתסיימו להגדיר את החיבור.
כדי ליצור חיבור חדש ל-GitHub, בוחרים באחת מהאפשרויות הבאות:
המסוף
כדי ליצור חיבור:
במסוף Google Cloud , פותחים את Developer Connect.
בדף Git repositories ב-Developer Connect,
- אם מוצגת רשימה של ספקי ניהול של קוד מקור: בוחרים ספק ניהול של קוד מקור ומתחילים להגדיר את החיבור הראשון. לוחצים על Connect (קישור) בכרטיס של GitHub.
אם מופיעה טבלה עם רשימה של חיבורים קיימים: מגדירים את הספק לניהול קוד המקור בלחיצה על Create connection ואז על GitHub.
הדף Create Connection נפתח.
בשדה Region, בוחרים אזור למשאבי החיבור.
- בשדה Name, נותנים שם לחיבור החדש.
מסמנים את התיבה Enable a data residency compliant connection כדי שהחיבור יעמוד בדרישות של מיקום אחסון הנתונים.
קישורים ל-GitHub שנוצרו באמצעות מסוף Google Cloud תואמים למיקום אחסון הנתונים אם מסמנים את התיבה הזו כשיוצרים את הקישור. כשעושים את זה, Developer Connect יוצר אפליקציית GitHub
כשיוצרים חיבורים ל-GitHub באמצעות Google Cloud CLI, החיבורים האלה לא תואמים למיקום אחסון הנתונים. כל סוגי החיבורים האחרים תואמים לדרישות של מיקום אחסון הנתונים.
לוחצים על הצגת הגדרות נוספות כדי לראות הגדרות אישיות אופציונליות.
אופציונלי: בקטע Encryption, בוחרים מפתח CMEK כדי להצפין את הסודות ב-Secret Manager שנוצרו על ידי Developer Connect.
אופציונלי: כברירת מחדל, Developer Connect יכול לשמש כשרת proxy לקריאות Git ל-GitHub. כדי להשבית את האפשרות הזו, מבטלים את הסימון בתיבה Enable Developer Connect proxy.
לוחצים על Continue.
לוחצים על I understand and continue כדי לאשר את השיתוף של טוקן ה-OAuth של GitHub עם Developer Connect ואת האחסון שלו ב-Secret Manager.
אם מוצגת בקשה להיכנס לחשבון ב-GitHub, עושים את זה.
לוחצים על Authorize Developer Connect כדי לאפשר לאפליקציית Google Developer Connect לגשת לחשבון ב-GitHub.
אם ההודעה הזו לא מופיעה, סימן שכבר ניתנה הרשאה בחשבון הזה.
אם בחרתם באפשרות Enable a data residency compliant connection, תתבקשו ליצור אפליקציית GitHub.
נותנים שם לאפליקציית GitHub.
לוחצים על Create GitHub app.
בוחרים את היעד שבו רוצים להתקין את האפליקציה (חשבון GitHub או ארגון).
בוחרים את המאגרים שבהם רוצים להתקין את אפליקציית GitHub, או את האפשרות All repositories, ולוחצים על Install.
בוחרים את המאגרים שרוצים לקשר לחיבור הזה ולוחצים על Ok.
לוחצים על קישור.
GitHub יוצר אסימון ו-Developer Connect מאחסן אותו בפרויקט ב-Google Cloud כסוד ב-Secret Manager. למידע נוסף על ניהול סודות, קראו את המאמר הצגת פרטי הסוד.
אם הפעלתם את מיקום אחסון הנתונים, עכשיו יש לכם אפליקציית GitHub. אתם יכולים לנהל אותה בלחיצה על Manage installation בדף Connection details.
הגדרת החיבור
אם לא הפעלתם את תיבת הסימון Enable data residency-compliant connection, אתם צריכים לבצע את השלבים הבאים.
כדי לתת הרשאות בחשבון GitHub ולקשר למאגרים, פועלים לפי ההוראות הבאות. ההנחיות שמופיעות בדפדפן האינטרנט תלויות בשאלה אם אפליקציית Developer Connect GitHub כבר מותקנת בחשבון GitHub.
בתיבת הדו-שיח של Developer Connect, מבצעים את הפעולות הבאות:
אם מופיעה רשימה של חשבונות GitHub, מתקינים את האפליקציה ומקשרים את המאגרים לפי השלבים הבאים:
בוחרים את החשבון ב-GitHub שבו רוצים להשתמש.
בוחרים מאגר אחד או יותר שרוצים לתת לו גישה.
אם מופיעה בקשה להשתמש מחדש בהתקנה קיימת של האפליקציה, בוחרים איפה להגדיר את האפליקציה לפי השלבים הבאים:
לוחצים על GitHub Account כדי לראות את החשבונות שבהם מותקנת אפליקציית Google Developer Connect. אם החשבון שבו רוצים להשתמש מופיע, לוחצים על אישור כדי לבחור אותו.
אם החשבון שבו אתם רוצים להשתמש לא מופיע, בצעו את הפעולות הבאות:
בוחרים באפשרות Install the GitHub App on another GitHub account ולוחצים על Confirm.
פועלים לפי השלבים ב-GitHub כדי לאשר את התקנת האפליקציה.
בוחרים מאגר אחד או יותר שרוצים לתת לו גישה.
כשתיבת הדו-שיח נסגרת, התקנת האפליקציה הושלמה.
אחרי שיוצרים את החיבור, מופיע הדף Link repositories.
כדי לקשר מאגרים לחיבור:
ברשימת המאגרים הזמינים, בוחרים את המאגרים שבהם רוצים להשתמש.
לוחצים על OK.
לוחצים על קישור.
החיבור נוסף לדף Connections והקישורים למאגרים נוספים לדף Repositories במסוף Google Cloud . תמיד אפשר להוסיף עוד קישורים לחיבורים קיימים.
אם אתם מגדירים את Gemini Code Assist, המשיכו בתהליך לפי השלבים שמפורטים במאמר הגדרה ושימוש בעיגון בקוד של הארגון ב-Gemini Code Assist.
gcloud
כדי לבצע את המשימות הבאות, צריך לבצע כמה פעולות בדפדפן האינטרנט.
כדי ליצור חיבור:
מריצים את הפקודה
gcloud developer-connect connections createכדי ליצור חיבור ל-GitHub:gcloud developer-connect connections create CONNECTION_NAME \ --location=REGION \ --github-config-app=APP_TYPE \ --git-proxy-config-enabledמחליפים את מה שכתוב בשדות הבאים:
- CONNECTION_NAME: השם של החיבור.
- REGION: האזור של החיבור.
APP_TYPE: סוג האפליקציה שצריך להתקין ב-GitHub. אחת מהאפשרויות הבאות:
FIREBASEלשימוש עם Firebase App Hosting
DATAFORMלשימוש עם Dataform
GEMINI_CODE_ASSISTלשימוש עם Gemini Code Assist
DEVELOPER_CONNECTלכל השאר
--git-proxy-config-enabled: דגל אופציונלי שמאפשר ל-Developer Connect לפעול כשרת proxy לקריאות Git ל-GitHub.
נוצר שם לחיבור.
כדי לסיים את יצירת החיבור, מתקינים את אפליקציית Developer Connect ב-GitHub. מריצים את הפקודה הבאה כדי לקבל את ה-URI להתקנת האפליקציה:
gcloud developer-connect connections describe CONNECTION_NAME \ --location=REGIONמחליפים את מה שכתוב בשדות הבאים:
- CONNECTION_NAME: השם של החיבור.
- REGION: האזור של החיבור.
ב-Developer Connect מופיע קישור להשלמת השלבים הבאים בחלון דפדפן. מעתיקים את הקישור הזה.
פותחים את הקישור בדפדפן אינטרנט.
לוחצים על I understand and continue כדי לאשר את השיתוף של טוקן ה-OAuth של GitHub עם Developer Connect ואת האחסון שלו ב-Secret Manager.
אם מוצגת בקשה להיכנס לחשבון ב-GitHub, עושים את זה.
לוחצים על Authorize Developer Connect כדי לאפשר לאפליקציית Google Developer Connect לגשת לחשבון ב-GitHub.
אם ההודעה הזו לא מופיעה, סימן שכבר ניתנה הרשאה בחשבון הזה.
GitHub יוצר אסימון ו-Developer Connect מאחסן אותו בפרויקט ב-Google Cloud כסוד ב-Secret Manager. למידע נוסף על ניהול סודות, קראו את המאמר הצגת פרטי הסוד.
אם הפעלתם חיבור שתואם למיקום אחסון הנתונים, עכשיו יש לכם אפליקציית GitHub. אתם יכולים לנהל אותה בלחיצה על Manage installation בדף Connection details.
הגדרת החיבור
כדי לתת הרשאות בחשבון GitHub ולקשר למאגרים, פועלים לפי ההוראות הבאות. ההנחיות שמופיעות בדפדפן האינטרנט תלויות בשאלה אם אפליקציית Developer Connect GitHub כבר מותקנת בחשבון GitHub.
בתיבת הדו-שיח של Developer Connect, מבצעים את הפעולות הבאות:
אם מופיעה רשימה של חשבונות GitHub, מתקינים את האפליקציה ומקשרים את המאגרים לפי השלבים הבאים:
בוחרים את החשבון ב-GitHub שבו רוצים להשתמש.
בוחרים מאגר אחד או יותר שרוצים לתת לו גישה.
אם מופיעה בקשה להשתמש מחדש בהתקנה קיימת של האפליקציה, בוחרים איפה להגדיר את האפליקציה לפי השלבים הבאים:
לוחצים על GitHub Account כדי לראות את החשבונות שבהם מותקנת אפליקציית Google Developer Connect. אם החשבון שבו רוצים להשתמש מופיע, לוחצים על אישור כדי לבחור אותו.
אם החשבון שבו אתם רוצים להשתמש לא מופיע, בצעו את הפעולות הבאות:
בוחרים באפשרות Install the GitHub App on another GitHub account ולוחצים על Confirm.
פועלים לפי השלבים ב-GitHub כדי לאשר את התקנת האפליקציה.
בוחרים מאגר אחד או יותר שרוצים לתת לו גישה.
כשתיבת הדו-שיח נסגרת, התקנת האפליקציה הושלמה.
אימות החיבור
כדי לוודא שהחיבור ל-GitHub נוצר, מריצים את הפקודה הבאה:
gcloud developer-connect connections describe CONNECTION_NAME \
--location=REGION
מחליפים את מה שכתוב בשדות הבאים:
- CONNECTION_NAME: שם החיבור.
- REGION: האזור של החיבור.
Developer Connect מחזיר סטטוס בשדה installationState. אם הערך של השדה הזה הוא COMPLETE, התקנת האפליקציה הסתיימה.
אחרת, Developer Connect מחזיר URI כדי להחזיר אתכם להגדרה בדפדפן.
אחרי שהחיבור הושלם, בוחרים אילו מאגרים לקשר לפי ההוראות שמפורטות בקטע הוספת קישורים למאגרים בחיבורים קיימים.
הוספת קישורים למאגרים לחיבורים קיימים
אחרי שיוצרים חיבור ל-GitHub, אפשר לקשר למאגרים. אפשר לחזור על השלבים האלה בהמשך כדי לקשר מאגרים נוספים לפי הצורך.
כדי ליצור קישורים למאגרים בחיבור קיים ל-GitHub, בוחרים אחת מהאפשרויות הבאות:
המסוף
פותחים את הדף Repositories במסוף Google Cloud .
לוחצים על Link repository.
החלונית Link Git repositories נפתחת.
ברשימת החיבורים, בוחרים חיבור.
לוחצים על Continue.
ברשימת המאגרים, בוחרים את המאגרים שרוצים לקשר.
לוחצים על יצירה.
הקישורים למאגרים נוצרים ב-Developer Connect ומוצגים במסוף Google Cloud .
gcloud
מריצים את הפקודה הבאה:
gcloud developer-connect connections git-repository-links create REPO_NAME \
--clone-uri=REPO_URI \
--connection=CONNECTION_NAME \
--location=REGION
מחליפים את מה שכתוב בשדות הבאים:
- REPO_NAME: שם המאגר.
- REPO_URI: הקישור למאגר שלכם ב-GitHub.
לדוגמה,
https://github.com/cloud-build/test-repo.git. - CONNECTION_NAME: שם החיבור.
- REGION: האזור של החיבור.
Developer Connect יוצר את הקישורים למאגרים.
כדי להציג רשימה של מאגרים מקושרים, מריצים את הפקודה developer-connect connections git-repository-links list.
אם אתם מגדירים את Gemini Code Assist, המשיכו בתהליך לפי השלבים שמפורטים במאמר הגדרה ושימוש בעיגון בקוד של הארגון ב-Gemini Code Assist.
שיתוף נתונים
יכול להיות שתוכן ממשאבי Google Cloud שמקושרים לחיבור הזה יועבר ל-GitHub. ההצהרה הזו חלה על כל המשאבים הקיימים והעתידיים שמשתמשים בחיבור הזה. כדי להפסיק את שיתוף המידע עם GitHub, צריך למחוק את החיבורים של Developer Connect במסוף Google Cloud או ב-CLI של gcloud, ולבטל את הגישה ב-GitHub.
המאמרים הבאים
- מסיימים להגדיר את עיגון הקוד של הארגון ב-Gemini Code Assist.
- איך Gemini Code Assist עוזר לכם לזרז את פיתוח התוכנה
- שילובים נוספים שזמינים דרך Developer Connect