הכלי Checks CLI מאפשר להשתמש בפונקציונליות של Checks בתהליך העבודה של הפיתוח. אפשר להריץ את ה-CLI באופן מקומי, בצינור עיבוד הנתונים של CI/CD או באמצעות סוגים אחרים של סקריפטים ואוטומציה.
כדי להגדיר את Checks CLI ולהשתמש בו, צריך לבצע את השלבים הבאים:
- התקנת Checks CLI
- אימות המחשב
- כדי לשלב את Checks CLI ולהשתמש בו, מריצים פקודות משורת הפקודה או משלבים את Checks CLI בסביבת ה-CI/CD.
הגדרת Checks CLI
אפשר להתקין או לעדכן את Checks CLI באמצעות קובצי ההפעלה העצמאיים בטבלאות ל-Linux או ל-macOS.
אחרי שמתקינים את Checks CLI, צריך לבצע אימות. אחרי כן תוכלו להתחיל לבדוק את נקודות החולשה ולתקן אותן, ותוכלו להתחיל בבדיקת ההתקנה.
התקנה באמצעות קובצי הפעלה עצמאיים
הכלי Checks מספק קישורים להורדה של קובץ הפעלה עצמאי לגרסה האחרונה ולגרסאות ספציפיות. לדוגמה, הקישורים הבאים הם ל-macOS ול-Linux:
- https://dl.google.com/checks/cli/latest/checks-macos
- https://dl.google.com/checks/cli/v0.2.0/checks-linux
לדוגמה, כדי להוריד ולהריץ את הגרסה האחרונה של Checks CLI ב-macOS, מריצים את הפקודה:
curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
- חשוב לוודא שהתקנתם את מנהל החבילות ואת כל הכלים הנדרשים של צד שלישי.
- מורידים את הקובץ הבינארי של Checks CLI לפלטפורמה שלכם:
Linux
פלטפורמה |
חבילה |
גודל |
סיכום ביקורת (checksum) SHA256 |
Linux |
35.1MB |
cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f |
מריצים את הפקודה chmod +x ./checks
כדי להפוך את הקובץ הבינארי לקובץ הפעלה. (אופציונלי) מעבירים את הקובץ הבינארי למיקום שבו אפשר להריץ אותו באופן גלובלי: mv ./checks
/usr/local/bin/
macOS
פלטפורמה |
חבילה |
גודל |
סיכום ביקורת (checksum) SHA256 |
macOS |
29.4MB |
a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33 |
הופכים את הקובץ הבינארי להפעלה על ידי הרצת chmod +x ./checks
(אופציונלי) מעבירים את הקובץ הבינארי למיקום שבו אפשר להפעיל אותו באופן גלובלי: mv ./checks
/usr/local/bin/
Windows
פלטפורמה |
חבילה |
גודל |
סיכום ביקורת (checksum) SHA256 |
Windows 8.1 ואילך ו-Windows Server 2012 ואילך |
29.5MB |
7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7 |
(אופציונלי) משנים את שם הקובץ ל-checks.exe
כדי להריץ פקודות בדיקה כמו שמתואר במסמכים. לדוגמה, checks help
.
עדכון לגרסה האחרונה של CLI
כדי לוודא שאתם מקבלים את התכונות החדשות ביותר ואת תיקוני הבאגים, מומלץ לבדוק לעיתים קרובות אם יש עדכונים ל-CLI.
אפשר להוריד את הגרסה החדשה מהטבלאות הקודמות, ואז להחליף את הגרסה הקודמת במערכת.
בדיקת ההטמעה
אחרי האימות, אפשר לבדוק את ההתקנה. כדי לבצע בדיקה מהירה, מריצים את הפקודה checks --help
.
מידע נוסף
מריצים את הפקודה checks --help
או מעיינים בסיכום הפקודות והאפשרויות של ה-CLI.
קבלת תמיכה
אם אתם צריכים עזרה בנוגע ל-Checks CLI או ל-Checks באופן כללי, אתם יכולים לשלוח אימייל לכתובת checks-support@google.com.
אימות ה-CLI
אחרי שמתקינים את CLI, צריך להיכנס לחשבון Google. כדי לאשר את הגישה של Checks CLI ל-Checks, אפשר להשתמש בחשבון שירות או בחשבון משתמש.
חשבון שירות הוא חשבון Google Cloud שמשויך לפרויקט ב-Google Cloud ולא למשתמש ספציפי. חשבונות שירות שימושיים להגדרת בדיקות בסביבת CI.
חשבון משתמש הוא חשבון Google שיש לו גישה לחשבון Checks שלכם. זו האפשרות הכי טובה להשתמש ב-CLI של Checks משורת הפקודה.
אימות באמצעות חשבון שירות
- פותחים את מסוף Google Cloud ובוחרים את הפרויקט.
- ב-API Library, מפעילים את Checks API.
- כדי ליצור חשבון שירות לפרויקט, עוברים אל הדף 'חשבונות שירות של IAM' במסוף Google Cloud. לוחצים על Create Service Account ומזינים את פרטי חשבון השירות.
- יוצרים מפתח JSON פרטי לחשבון השירות החדש ומעבירים את המפתח למיקום שאפשר לגשת אליו בסביבת הבנייה. חשוב לשמור את הקובץ הזה במקום בטוח, כי הוא מעניק גישת אדמין לבדיקות.
- כשמשתמשים ב-CLI, מגדירים את משתנה הסביבה
CHECKS_CREDENTIALS
לנתיב של קובץ ה-JSON של המפתח הפרטי. אם משתמשים בפלאגין Checks CI/CD, צריך לעיין בתיעוד של הפלאגין כדי להבין איך מספקים את פרטי הכניסה.
- כדי להעניק לחשבון השירות גישה לחשבון Checks, מוסיפים את כתובת האימייל ומקצים לה את התפקיד בעלים בדף ההגדרות של Checks Console. מידע נוסף על הזמנת משתמשים לחשבון Checks זמין במאמר ניהול הגישה של הצוות.
אימות באמצעות חשבון משתמש
חשוב: אם אתם מתחברים באמצעות SSH, צריך להעביר את יציאה 9005.
נכנסים ל-Checks CLI באמצעות חשבון Google עם הפקודה הבאה:
checks login
הפקודה הזו מחברת את המחשב המקומי שלכם ל-Checks ומעניקה לכם גישה לחשבונות Checks שלכם.
- אם נכנסתם בעבר לחשבון, אבל אתם רוצים לעבור לחשבון Google אחר, אתם יכולים להשתמש ב
checks login --reauth
. - משתמשים ב-
checks logout
כדי לצאת.
- אם נכנסתם בעבר לחשבון, אבל אתם רוצים לעבור לחשבון Google אחר, אתם יכולים להשתמש ב
פותחים בדפדפן את כתובת ה-URL שנוצרה לאימות.
נכנסים לחשבון Google.
מאשרים ל-Checks לגשת לחשבון Checks.