ניהול סודות באמצעות Secret Manager ב-Cloud Code ל-IntelliJ

השילוב של Cloud Code עם Secret Manager מאפשר לכם ליצור סודות, להציג אותם, לעדכן אותם ולהשתמש בהם בסביבת הפיתוח המשולבת (IDE) שלכם, בלי שהם יופיעו בבסיס הקוד.

בדף הזה מוסבר איך לגשת אל Secret Manager בסביבת הפיתוח המשולבת (IDE) ואיך אפשר להתחיל ליצור ולנהל סודות.

הפעלת Secret Manager

כשמנהלים סודות באמצעות Cloud Code, הסודות מאוחסנים בצורה מאובטחת ב-Secret Manager, ואפשר לאחזר אותם באופן פרוגרמטי כשצריך. כל מה שצריך זה להפעיל את Secret Manager API ולוודא שיש לכם את ההרשאות הנכונות לניהול סודות:

  1. כדי להפעיל את Secret Manager, לוחצים על הכרטיסייה Secret Manager בסרגל הצד השמאלי של Cloud Code.

    כרטיסיית Secret Manager ב-Cloud Code מודגשת בסרגל הצד השמאלי, והחלונית Secret Manager פתוחה עם שלושה סודות שמופיעים בה ופרטי הגרסה של הסוד test שמופיעים בחלונית התחתונה

  2. אם לא הפעלתם את Secret Manager API,‏ Cloud Code יציג בקשה להפעלה שלו בחלונית Secret Manager. כדי להפעיל אותו, לוחצים על Enable API (הפעלת ה-API).

    הסוד צריך להיות באותו פרויקט שבו נמצא קוד האפליקציה. צריך לוודא שהפרויקט הנכון נבחר או לעבור לפרויקט אחר באמצעות בורר הפרויקטים בחלונית Secret Manager.

    הפעלת קישור ל-API שזמין בחלונית Secret Manager

יצירה וצפייה של סודות

יצירת סודות

אפשר ליצור סוד באחת מהשיטות הבאות:

שימוש בחלונית Secret Manager

  1. עוברים לחלונית Secret Manager.

  2. לוחצים על סמל ההוספה.

    תיפתח תיבת דו-שיח ליצירת סוד, שבה תוכלו להגדיר את הפרויקט, השם והערך של הסוד, וגם לבחור אזור לאחסון הסוד ותוויות לארגון הסודות.

    תיבת הדו-שיח 'יצירת סוד' פתוחה, השדה 'שם' מלא בערך 'life' והשדה 'ערך הסוד' מלא בערך '42'

שימוש בכלי העריכה

  1. פותחים קובץ שמכיל טקסט שרוצים לאחסן כסוד בעורך.
  2. מדגישים את הטקסט הזה ולוחצים לחיצה ימנית.

    בתפריט, בוחרים באפשרות Create Secret in Secret Manager.... תיפתח תיבת הדו-שיח Create Secret (יצירת סוד) עם ערך הסוד שמולא בטקסט המודגש. כאן אפשר להתאים אישית את הפרויקט, השם, הערך, האזור והתוויות של הסוד.

שימוש בסייר הפרויקטים

  1. בסייר הפרויקטים, בלי להדגיש טקסט, לוחצים לחיצה ימנית.
  2. בתפריט, בוחרים באפשרות Create Secret in Secret Manager.... תיפתח תיבת הדו-שיח 'יצירת סוד'. בוחרים את הפרויקט, השם, הערך, האזור והתוויות של הסוד ולוחצים על OK.

יצירת גרסאות חדשות של סודות

אם יש לכם סוד קיים ואתם רוצים לעדכן אותו, אתם יכולים לעשות זאת על ידי מעבר לכרטיסייה Versions (גרסאות) בחלונית Secret Manager:

  1. לוחצים על סמל ההוספה בכרטיסייה גרסאות.

    ייפתח תיבת דו-שיח להוספת גרסה חדשה, שבה אפשר להגדיר את הערך של הסוד הקיים באמצעות השדה 'ערך הסוד' או באמצעות ייבוא קובץ.

    תיבת דו-שיח של הוספת גרסה חדשה פתוחה עם השדה Secret value (ערך הסוד) עבור הסוד test-secret שמעודכן כ-bar

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

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

הצגת סודות

כדי לראות את הסודות, בחלונית Secret Manager, בוחרים סוד מהרשימה שמוצגת בקטע Secret Name (שם הסוד). הפרטים שלו, כמו השם, מדיניות השכפול, חותמת הזמן של היצירה ומזהה המשאב, מפורטים בכרטיסייה סקירה כללית.

אפשר גם ללחוץ לחיצה ימנית על הסוד ולבחור באפשרות Open in Cloud console כדי לראות ולנהל את הסוד ב מסוף Cloud.

צפייה בגרסאות של סודות

כדי לראות גרסאות של סוד, בוחרים סוד מהרשימה שמוצגת בקטע Secret Name (שם הסוד) ובוחרים בכרטיסייה Versions (גרסאות).

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

הכרטיסייה 'גרסה' נבחרה לסוד 'test' ושתי הגרסאות הזמינות, '2' ו-'3', מוצגות בטבלה יחד עם זמן היצירה שלהן. לוחצים לחיצה ימנית על '3' ובוחרים באפשרות 'הפעלת גרסה סודית'.

גישה לסודות מהאפליקציה

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

הכרטיסייה Code (קוד) בחלונית Secret Manager (ניהול סודות) שבה מפורטות הפעולות שצריך לבצע כדי לגשת לסוד בקוד

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

  1. מתקינים את ספריית הלקוח של Secret Manager.

    עוברים אל Tools (כלים) >‏ Cloud Code >‏ Add Cloud Libraries and Manage Cloud APIs (הוספת ספריות Cloud וניהול ממשקי Cloud API) ובוחרים באפשרות Secret Manager (ניהול סודות) >‏ Secret Manager API (ממשק Secret Manager API) בעץ של Google Cloud APIs Explorer. פועלים לפי ההוראות הספציפיות לשפה שמופיעות בקטע 'התקנה של ספריית הלקוח'.

  2. מתאימים אישית את קטע הקוד הרלוונטי ומוסיפים אותו לקוד של האפליקציה.

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

    • פיתוח מקומי: אם אתם מפתחים באשכול מקומי (כמו minikube, ‏ Docker Desktop) או באמולטור מקומי, אתם צריכים לבצע את השלבים שמפורטים בקטע בנושא פיתוח מקומי שרלוונטיים לתהליך העבודה שלכם.
    • פיתוח מרחוק: אם אתם משתמשים באשכול GKE או בשירות Cloud Run באפליקציה, אתם צריכים לבצע את השלבים שמפורטים בקטע בנושא פיתוח מרחוק שרלוונטיים לתהליך העבודה שלכם, כולל ההוראות הספציפיות ל-Secret Manager להגדרת התפקידים הנדרשים בחשבון השירות.

פנייה לתמיכה

כדי לשלוח משוב או לדווח על בעיה ב-IntelliJ IDE, עוברים אל Tools (כלים) > Cloud Code > Help / About (עזרה / מידע) > Submit feedback or report an issue (שליחת משוב או דיווח על בעיה) כדי לדווח על בעיה ב-GitHub.