התכונה Open in Cloud Shell מאפשרת לפרסם קישור שפותח את מסוף Google Cloud עם מאגר Git ששוכפל ל-Cloud Shell, או מפעיל את Cloud Shell עם קובץ אימג' בהתאמה אישית. אפשר גם להדפיס הוראות לטרמינל כדי לעזור למשתמשים להבין איך להשתמש בתוכן.
קישורים לפתיחה ב-Cloud Shell עוזרים למפתחים להתנסות בדוגמאות הקוד ובממשקי ה-API שלכם בלי להוריד את Google Cloud CLI, להתקין את יחסי התלות הנדרשים או לחפש קובצי מקור רלוונטיים. בדף הזה מוסבר איך להוסיף למאגר Git קישור לפתיחה ב-Cloud Shell.
פרמטרים של כתובות URL
אפשר להוסיף קישור לפתיחה ב-Cloud Shell, שמוטמע באופן אופציונלי בתמונה של לחצן, לקובץ README.md של כל ספרייה במאגר Git. המיקום המומלץ לקישור הזה הוא קובץ README.md ברמה הבסיסית (root) של מאגר Git.
פרמטר חובה של כתובת URL
כדי ליצור את הקישור, משתמשים בכתובת ה-URL הבסיסית shell.cloud.google.com (או בכל דף במסוף Google Cloud שמתחיל ב-console.cloud.google.com) עם הפרמטר הנדרש הבא של כתובת ה-URL:
| פרמטר של כתובת URL | תיאור | ערכים נתמכים |
|---|---|---|
cloudshell_git_repo |
כתובת ה-URL של מאגר Git שרוצים לשכפל. אחרי שהמאגר משוכפל, תיקיית השורש של הפרויקט נפתחת והתוכן שלה מוצג בחלונית הניווט הימנית. |
כתובת URL תקינה של מאגר Git. כתובת ה-URL הזו מורכבת מדומיין מותר (GitHub או Bitbucket) ומנתיב. אפשר להשתמש בתווים הבאים: אותיות רישיות וקטנות, ספרות, קווים תחתונים (_), מקפים (-), נקודות (.) ולוכסנים (/). רק מאגרים מורשים בבעלות Google ייפתחו בסביבת ברירת המחדל של Cloud Shell ותהיה להם גישה לפרטי הכניסה של המשתמש. בכל שאר המאגרים תהיה סביבה זמנית של Cloud Shell, בלי גישה לפרטי הכניסה של המשתמש. |
פרמטרים אופציונליים של כתובות URL
אפשר גם לציין את הפרמטרים האופציונליים הבאים:
| פרמטר של כתובת URL | תיאור | ערכים נתמכים |
|---|---|---|
cloudshell_git_branch
|
הסתעפות ממאגר Git לשכפול. רלוונטי רק כשמציינים את cloudshell_git_repo. ההסתעפות שמוגדרת כברירת מחדל היא master. | כל ענף תקין במאגר. אפשר להשתמש בתווים הבאים: אותיות רישיות וקטנות, ספרות, טילדות (~), קווים תחתונים (_), מקפים (-), נקודות (.), לוכסנים (/) ונקודתיים (:). |
cloudshell_image
|
קובץ אימג' של Docker בהתאמה אישית שמריץ סביבה מותאמת אישית במהלך הסשן. כך תוכלו לספק כלים בהתאמה אישית ב-Cloud Shell, שבהם המשתמשים יוכלו להשתמש כדי לעבוד עם המאגר שלכם. כשפותחים מאגר ב-Cloud Shell עם הפרמטר הזה, נוצרת סביבה זמנית עם ספריית בית זמנית שנמחקת בסיום הסשן. |
כתובת ה-URL של קובץ אימג' של Docker שמתארח ב- Artifact Registry. קובץ האימג' של Docker צריך להיות מבוסס על קובץ האימג' הבסיסי של Cloud Shell, וצריכה להיות לו גישה ציבורית. שימו לב: לוקח קצת זמן להוריד תמונות גדולות למכונה הווירטואלית של Cloud Shell כשפותחים את כתובת ה-URL. |
cloudshell_open_in_editor
|
הקבצים שייפתחו ב-Cloud Shell Editor. אפשר לחזור על הפעולה כדי לציין כמה קבצים לפתיחה. אם מציינים כמה כתובות URL, הן נפתחות בסדר שבו הן צוינו. הקבצים שצוינו נפתחים בכרטיסיות של כלי העריכה בצד שמאל, כרטיסייה אחת לכל קובץ, בפרויקט הפתוח. נתיבי הקבצים הם יחסיים לספרייה הנוכחית. אם הפרמטר working_dir צוין, הנתיב לקבצים האלה נחשב יחסי ל-working_dir. |
כל נתיב קובץ חוקי שמורכב מהתווים המותרים הבאים: אותיות רישיות וקטנות, ספרות, טילדות (~), קווים תחתונים (_), מקפים (-), נקודות (.), קווים נטויים (/) ונקודתיים (:). |
cloudshell_print
|
קובץ במאגר Git, שבדרך כלל מכיל הוראות שמוצגות במסוף כדי להנחות את המשתמש לגבי השלבים הבאים. נתיב הקובץ הוא יחסי לספרייה הנוכחית. אם הפרמטר working_dir צוין, הנתיב לקובץ הזה נחשב כנתיב יחסי ל-working_dir. |
כל נתיב קובץ חוקי שמורכב מהתווים המותרים הבאים: אותיות רישיות וקטנות, ספרות, טילדות (~), קווים תחתונים (_), מקפים (-), נקודות (.), קווים נטויים (/) ונקודתיים (:). |
cloudshell_tutorial
|
קובץ Tutorial Markdown במאגר Git, שמכיל הוראות להפעלה כמדריך למשתמשים בפרויקט. נתיב הקובץ הוא יחסי לספרייה הנוכחית. |
כל קובץ Markdown תקין של מדריך עם שם קובץ חוקי. |
cloudshell_working_dir (הוצא משימוש)
|
הפרמטר הזה הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב- |
כל נתיב קובץ חוקי שמורכב מהתווים המותרים הבאים: אותיות רישיות וקטנות, ספרות, טילדות (~), קווים תחתונים (_), מקפים (-), נקודות (.), קווים נטויים (/) ונקודתיים (:). |
cloudshell_workspace
|
ספריית העבודה של Cloud Shell. הטרמינל נפתח בספרייה שצוינה. הספרייה נפתחת ב-Cloud Shell Editor כסביבת עבודה. | כל נתיב קובץ חוקי שקשור למאגר המשוכפל. אפשר להשאיר את ערך הפרמטר ריק או להשתמש ב-. כדי לציין את הבסיס של המאגר המשוכפל. אם לא מציינים מאגר, הנתיב הוא יחסי לספריית הבית של Cloud Shell. אפשר להשתמש בתווים הבאים: אותיות רישיות וקטנות, ספרות, טילדות (~), קווים תחתונים (_), מקפים (-), נקודות (.), קווים נטויים (/) ונקודתיים (:).
|
ephemeral |
כשפותחים מאגר ב-Cloud Shell עם הפרמטר הזה, נוצרת סביבה זמנית עם ספריית בית זמנית שנמחקת בסיום הסשן. מידע נוסף זמין במאמר בחירת מצב זמני. | true, false |
show
|
אפשר לפתוח רק את הטרמינל, רק את Cloud Shell Editor או את שניהם. |
ide, terminal, ide%2Cterminal |
דוגמאות
כדי להטמיע כפתור לפתיחת מאגר Git לדוגמה ב-Cloud Shell, צריך לכלול את ה-Markdown הבא בקובץ README.md של המאגר:
[](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)
כדי להטמיע את אותה פונקציונליות באתר, משתמשים בקטע הקוד המקביל ב-HTML:
<a href="https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git">
<img alt="Open in Cloud Shell" src ="https://gstatic.com/cloudssh/images/open-btn.svg">
</a>
הכלי ליצירת קישורים לפתיחה ב-Cloud Shell
כדי להגדיר את ההתנהגות של הקישור Open in Cloud Shell באופן ספציפי יותר, אתם יכולים להשתמש בטופס הבא כדי להתנסות בפרמטרים שנדרשים לפתיחת המאגר ב-Cloud Shell.