בדף הזה מוסבר איך להתחבר למופע Cloud SQL באמצעות שרת proxy ל-Cloud SQL Auth.
מידע נוסף על האופן שבו שרת ה-Proxy ל-Cloud SQL Auth פועל זמין במאמר מידע על שרת ה-Proxy ל-Cloud SQL Auth.
סקירה כללית
השיטה המומלצת להתחברות למופע Cloud SQL היא באמצעות שרת proxy ל-Cloud SQL Auth. שרת proxy ל-Cloud SQL Auth:
- פועל עם נקודות קצה של כתובות IP ציבוריות ופרטיות
- מאמת חיבורים באמצעות פרטי כניסה של משתמש או חשבון שירות
- עוטף את החיבור בשכבת הצפנה של SSL/TLS שמאושרת למכונה שלכם ב-Cloud SQL.
חלק מהשירותים והאפליקציות משתמשים בשרת proxy ל-Cloud SQL Auth כדי לספק חיבורים לנתיבי כתובות IP ציבוריות עם הצפנה והרשאה, כולל: Cloud de Confiance by S3NS
אפליקציות שפועלות ב- Google Kubernetes Engine יכולות להתחבר באמצעות שרת proxy ל-Cloud SQL Auth.
במדריך למתחילים לשימוש בשרת proxy ל-Cloud SQL Auth יש מבוא בסיסי לשימוש בו.
אפשר גם להתחבר באמצעות לקוח mysql ממחשב מקומי או מ-Compute Engine, עם או בלי שרת proxy ל-Cloud SQL Auth.
לפני שמתחילים
לפני שמתחברים למופע Cloud SQL, צריך לבצע את הפעולות הבאות:
-
- למשתמש או לחשבון שירות, מוודאים שיש לחשבון את התפקיד Cloud SQL Client. התפקיד הזה מכיל את ההרשאה
cloudsql.instances.connect, שמאפשרת לחשבון משתמש להתחבר לכל מכונות Cloud SQL בפרויקט. - אפשר לכלול תנאי IAM בקשירת מדיניות IAM שמעניקה לחשבון הרשאה להתחבר רק למופע ספציפי אחד של Cloud SQL.
- למשתמש או לחשבון שירות, מוודאים שיש לחשבון את התפקיד Cloud SQL Client. התפקיד הזה מכיל את ההרשאה
-
Enable the Cloud SQL Admin API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles. - מתקינים ומפעילים את ה-CLI של gcloud.
- זה שינוי אופציונלי. מתקינים את לקוח Docker של שרת proxy ל-Cloud SQL Auth.
הורדת שרת proxy ל-Cloud SQL Auth
Linux 64 סיביות
- מורידים את שרת ה-proxy ל-Cloud SQL Auth:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.21.1/cloud-sql-proxy.linux.amd64
- הופכים את שרת ה-proxy ל-Cloud SQL Auth לקובץ הפעלה:
chmod +x cloud-sql-proxy
Linux 32 סיביות
- מורידים את שרת ה-proxy ל-Cloud SQL Auth:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.21.1/cloud-sql-proxy.linux.386
- אם הפקודה
curlלא נמצאה, מריצים את הפקודהsudo apt install curlוחוזרים על פקודת ההורדה. - הופכים את שרת ה-proxy ל-Cloud SQL Auth לקובץ הפעלה:
chmod +x cloud-sql-proxy
macOS 64 סיביות
- מורידים את שרת ה-proxy ל-Cloud SQL Auth:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.21.1/cloud-sql-proxy.darwin.amd64
- הופכים את שרת ה-proxy ל-Cloud SQL Auth לקובץ הפעלה:
chmod +x cloud-sql-proxy
Mac M1
- מורידים את שרת ה-proxy ל-Cloud SQL Auth:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.21.1/cloud-sql-proxy.darwin.arm64
- הופכים את שרת ה-proxy ל-Cloud SQL Auth לקובץ הפעלה:
chmod +x cloud-sql-proxy
Windows 64 סיביות
לוחצים לחיצה ימנית על https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.21.1/cloud-sql-proxy.x64.exe ובוחרים באפשרות שמירת קישור בשם כדי להוריד את שרת ה-proxy ל-Cloud SQL Auth. משנים את שם הקובץ ל-cloud-sql-proxy.exe.
Windows 32 סיביות
לוחצים לחיצה ימנית על https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.21.1/cloud-sql-proxy.x86.exe ובוחרים באפשרות שמירת קישור בשם כדי להוריד את שרת ה-proxy ל-Cloud SQL Auth. משנים את שם הקובץ ל-cloud-sql-proxy.exe.
קובץ אימג' של Docker לשרת proxy ל-Cloud SQL Auth
לשרת ה-proxy ל-Cloud SQL Auth יש תמונות קונטיינר שונות, כמו distroless, alpine ו-buster. קובץ האימג' של קונטיינר ברירת המחדל של שרת proxy ל-Cloud SQL Auth משתמש ב-distroless, שלא מכיל מעטפת. אם אתם צריכים מעטפת או כלים קשורים, אתם יכולים להוריד תמונה שמבוססת על alpine או על buster.
מידע נוסף זמין במאמר תמונות קונטיינר של Cloud SQL Auth Proxy.
אפשר לשלוף את התמונה העדכנית ביותר למחשב המקומי באמצעות Docker, באמצעות הפקודה הבאה:
docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.21.1
מערכת הפעלה אחרת
במערכות הפעלה אחרות שלא נכללות כאן, אפשר להדר את שרת ה-proxy ל-Cloud SQL Auth ממקור.הפעלת שרת proxy ל-Cloud SQL Auth
בהתאם לשפה ולסביבה שלכם, אתם יכולים להפעיל את שרת ה-proxy ל-Cloud SQL Auth באמצעות שקעי TCP, שקעי Unix או קובץ אימג' של Docker של שרת ה-proxy ל-Cloud SQL Auth. קובץ הבינארי של שרת ה-proxy ל-Cloud SQL Auth מתחבר למכונה אחת או יותר של Cloud SQL שצוינו בשורת הפקודה, ופותח חיבור מקומי כ-TCP או כ-Unix socket. אפליקציות ושירותים אחרים, כמו קוד האפליקציה או כלי לקוח לניהול מסדי נתונים, יכולים להתחבר למכונות של Cloud SQL דרך חיבורי TCP או Unix socket.
שקעי TCP
בחיבורי TCP, שרת ה-proxy ל-Cloud SQL Auth מאזין ל-localhost(127.0.0.1) כברירת מחדל.
לכן, כשמציינים --port PORT_NUMBER למכונה, החיבור המקומי הוא בכתובת 127.0.0.1:PORT_NUMBER.
אפשר גם לציין כתובת אחרת לחיבור המקומי.
לדוגמה, כך מגדירים את שרת ה-proxy ל-Cloud SQL Auth להאזין בכתובת 0.0.0.0:1234 לחיבור המקומי:
./cloud-sql-proxy --address 0.0.0.0 --port 1234 INSTANCE_CONNECTION_NAME
מעתיקים את INSTANCE_CONNECTION_NAME. אפשר למצוא את כתובת ה-IP בדף Overview של המופע במסוףCloud de Confiance או על ידי הפעלת הפקודה הבאה:
gcloud sql instances describe INSTANCE_NAME --format='value(connectionName)'
לדוגמה: myproject:myregion:myinstance.
- אם למכונה מוגדרות כתובות IP ציבוריות ופרטיות, ואתם רוצים ששרת proxy ל-Cloud SQL Auth ישתמש בכתובת IP פרטית, אתם צריכים לספק את האפשרות הבאה כשמפעילים את שרת proxy ל-Cloud SQL Auth:
--private-ip
- אם אתם משתמשים בחשבון שירות כדי לאמת את שרת ה-proxy ל-Cloud SQL Auth, שימו לב למיקום במכונת הלקוח של קובץ המפתח הפרטי שנוצר כשיצרתם את חשבון השירות.
- מפעילים את שרת ה-proxy ל-Cloud SQL Auth.
מחרוזות אפשריות להפעלת שרת proxy ל-Cloud SQL Auth:
- שימוש באימות Cloud SDK:
היציאה שצוינה לא יכולה להיות בשימוש, למשל על ידי שרת מסד נתונים מקומי../cloud-sql-proxy --port 3306 INSTANCE_CONNECTION_NAME
- שימוש בחשבון שירות וציון מפורש של שם החיבור של המופע (מומלץ לסביבות ייצור):
./cloud-sql-proxy \ --credentials-file PATH_TO_KEY_FILE INSTANCE_CONNECTION_NAME &
מידע נוסף על האפשרויות של Cloud SQL Auth Proxy זמין במאמר אפשרויות לאימות של Cloud SQL Auth Proxy.
- שימוש באימות Cloud SDK:
שקעי Unix
שרת proxy ל-Cloud SQL Auth יכול להאזין לשקע Unix, שהוא מנגנון תקני של Posix לשימוש בתיקייה כדי לנהל תקשורת בין שני תהליכים שפועלים באותו מארח. היתרונות של שימוש בשקעי Unix הם שיפור האבטחה וזמן אחזור נמוך יותר, אבל אי אפשר לגשת לשקע Unix ממכונה חיצונית.
כדי ליצור ולשלוח נתונים דרך שקע Unix, ספריית היעד צריכה להתקיים, ולשרת ה-proxy ל-Cloud SQL Auth ולאפליקציה צריכה להיות גישת קריאה וכתיבה אליה.
מעתיקים את INSTANCE_CONNECTION_NAME. אפשר למצוא את כתובת ה-IP בדף Overview של המופע במסוףCloud de Confiance או על ידי הפעלת הפקודה הבאה:
gcloud sql instances describe INSTANCE_NAME --format='value(connectionName)'
לדוגמה: myproject:myregion:myinstance.
- יוצרים את הספרייה שבה יאוחסנו שקעי ה-Cloud SQL Auth Proxy:
sudo mkdir /cloudsql; sudo chmod 777 /cloudsql
- אם אתם משתמשים בחשבון שירות כדי לאמת את שרת ה-proxy ל-Cloud SQL Auth, שימו לב למיקום במכונת הלקוח של קובץ המפתח הפרטי שנוצר כשיצרתם את חשבון השירות.
- פותחים חלון טרמינל חדש ב-Cloud Shell ומפעילים את שרת ה-proxy לאימות של Cloud SQL.
מחרוזות אפשריות להפעלת שרת proxy ל-Cloud SQL Auth:
- שימוש באימות של Google Cloud SDK:
./cloud-sql-proxy --unix-socket /cloudsql INSTANCE_CONNECTION_NAME &
- שימוש בחשבון שירות:
./cloud-sql-proxy --unix-socket /cloudsql --credentials-file PATH_TO_KEY_FILE INSTANCE_CONNECTION_NAME &
מפעילים את Cloud SQL Auth Proxy במסוף Cloud Shell משלו כדי לעקוב אחרי הפלט שלו בלי שהוא יתערבב עם הפלט מתוכניות אחרות.
מידע נוסף על האפשרויות של Cloud SQL Auth Proxy זמין במאמר אפשרויות לאימות של Cloud SQL Auth Proxy.
- שימוש באימות של Google Cloud SDK:
Docker
כדי להפעיל את שרת ה-proxy ל-Cloud SQL Auth בקונטיינר Docker, משתמשים בקובץ האימג' של Docker של שרת ה-proxy ל-Cloud SQL Auth שזמין ב-Google Container Registry.
אפשר להפעיל את Cloud SQL Auth Proxy באמצעות שקעי TCP או שקעי Unix, עם הפקודות שמוצגות בהמשך. האפשרויות משתמשות ב-INSTANCE_CONNECTION_NAME כמחרוזת החיבור כדי לזהות מכונת Cloud SQL. אפשר למצוא את INSTANCE_CONNECTION_NAME בדף Overview של המופע במסוףCloud de Confiance , או על ידי הפעלת הפקודה הבאה:
gcloud sql instances describe INSTANCE_NAME
לדוגמה: myproject:myregion:myinstance.
בהתאם לשפה ולסביבה שלכם, אתם יכולים להפעיל את שרת ה-proxy ל-Cloud SQL Auth באמצעות שקעי TCP או שקעי Unix. אין תמיכה בשקעי Unix באפליקציות שנכתבו בשפת התכנות Java או בסביבת Windows.
שימוש בשקעי TCP
docker run -d \\ -v PATH_TO_KEY_FILE:/path/to/service-account-key.json \\ -p 127.0.0.1:3306:3306 \\ gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.21.1 \\ --address 0.0.0.0 --port 3306 \\ --credentials-file /path/to/service-account-key.json INSTANCE_CONNECTION_NAME
אם אתם משתמשים בפרטי הכניסה שסופקו על ידי מכונת Compute Engine, אל תכללו את הפרמטר --credentials-file ואת השורה -v PATH_TO_KEY_FILE:/path/to/service-account-key.json.
תמיד מציינים את הקידומת 127.0.0.1 ב--p כדי ששרת ה-proxy ל-Cloud SQL Auth לא ייחשף מחוץ למארח המקומי. הערך '0.0.0.0' בפרמטר instances נדרש כדי שהיציאה תהיה נגישה מחוץ למאגר Docker.
שימוש בשקעי Unix
docker run -d -v /cloudsql:/cloudsql \\ -v PATH_TO_KEY_FILE:/path/to/service-account-key.json \\ gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.21.1 --unix-socket=/cloudsql \\ --credentials-file /path/to/service-account-key.json INSTANCE_CONNECTION_NAME
אם אתם משתמשים בפרטי הכניסה שסופקו על ידי מכונת Compute Engine, אל תכללו את הפרמטר --credentials-file ואת השורה -v PATH_TO_KEY_FILE:/path/to/service-account-key.json.
אם אתם משתמשים בתמונה שעברה אופטימיזציה לקונטיינר, השתמשו בספרייה שאפשר לכתוב בה במקום /cloudsql, לדוגמה:
-v /mnt/stateful_partition/cloudsql:/cloudsql
אפשר לציין יותר ממופע אחד, ולהפריד ביניהם באמצעות פסיקים. אפשר גם להשתמש במטא-נתונים של Compute Engine כדי לקבוע באופן דינמי את המכונות להתחברות. מידע נוסף על הפרמטרים של Cloud SQL Auth Proxy
יצירת חיבור באמצעות לקוח MySQL
- מורידים את MySQL Community Server לפלטפורמה שלכם מדף ההורדה של MySQL Community Server.
שרת הקהילה כולל את לקוח MySQL. - מתקינים את Community Server לפי ההוראות בדף ההורדה.
מידע נוסף על התקנת MySQL זמין במאמר Installing and Upgrading MySQL.
מחרוזת החיבור שבה אתם משתמשים תלויה בדרך שבה הפעלתם את שרת ה-proxy ל-Cloud SQL Auth: באמצעות שקע TCP, שקע UNIX או Docker.
שקעי TCP
- מפעילים את לקוח MySQL:
אם מתחברים למופע MySQL 8.4, משתמשים בפקודה הבאה:mysql -u USERNAME -p --host 127.0.0.1
mysql -u USERNAME -p --host 127.0.0.1 --get-server-public-key
כשמתחברים באמצעות שקעי TCP, מתבצעת גישה לשרת ה-proxy ל-Cloud SQL Auth דרך
127.0.0.1. - אם מופיעה בקשה, מזינים את הסיסמה.
- מופיעה ההנחיה של mysql.
שימוש בשקעי Unix
- מפעילים את לקוח MySQL:
mysql -u USERNAME -p -S /cloudsql/INSTANCE_CONNECTION_NAME
הערה: אי אפשר להשתמש בשרת proxy ל-Cloud SQL Auth באמצעות חיבור לשקע UNIX למכונת MySQL 8.4.
- מזינים את הסיסמה.
- מופיעה ההנחיה של mysql.
דרושה לך עזרה? לקבלת עזרה בפתרון בעיות בשרת ה-proxy, אפשר לעיין במאמר בנושא פתרון בעיות בחיבורים של שרת proxy ל-Cloud SQL Auth או בדף תמיכה ב-Cloud SQL.
חיבור לאפליקציה
אפשר להתחבר לשרת proxy ל-Cloud SQL Auth מכל שפה שמאפשרת להתחבר לשקע Unix או TCP. בהמשך מופיעים קטעי קוד מתוך דוגמאות מלאות ב-GitHub, שיעזרו לכם להבין איך הם פועלים יחד באפליקציה שלכם.
נושאים נוספים
ארגומנטים בשורת הפקודה של שרת proxy ל-Cloud SQL Auth
הדוגמאות שלמעלה מכסות את תרחישי השימוש הנפוצים ביותר, אבל ל-Cloud SQL Auth Proxy יש גם אפשרויות הגדרה אחרות שאפשר להגדיר באמצעות ארגומנטים של שורת פקודה. כדי לקבל עזרה בנושא ארגומנטים בשורת הפקודה, משתמשים בדגל --help כדי לראות את התיעוד העדכני:
./cloud-sql-proxy --helpדוגמאות נוספות לשימוש באפשרויות של שורת הפקודה של שרת proxy ל-Cloud SQL Auth מופיעות בקובץ README במאגר GitHub של שרת proxy ל-Cloud SQL Auth.
אפשרויות לאימות שרת proxy ל-Cloud SQL Auth
בכל האפשרויות האלה נעשה שימוש ב-INSTANCE_CONNECTION_NAME כמחרוזת החיבור כדי לזהות מופע של Cloud SQL. אפשר למצוא את INSTANCE_CONNECTION_NAME בדף Overview של המופע במסוףCloud de Confiance , או על ידי הפעלת הפקודה הבאה:
gcloud sql instances describe --project PROJECT_ID INSTANCE_CONNECTION_NAME.
לדוגמה: gcloud sql instances describe --project myproject myinstance .
חלק מהאפשרויות האלה משתמשות בקובץ פרטי כניסה בפורמט JSON שכולל את המפתח הפרטי של RSA לחשבון. הוראות ליצירת קובץ JSON עם פרטי כניסה לחשבון שירות מופיעות במאמר יצירת חשבון שירות.
שרת ה-proxy ל-Cloud SQL Auth מספק כמה חלופות לאימות, בהתאם לסביבה שלכם. שרת ה-proxy ל-Cloud SQL Auth בודק כל אחד מהפריטים הבאים, לפי הסדר הבא, ומשתמש בראשון שהוא מוצא כדי לנסות לבצע אימות:
פרטי הכניסה שסופקו באמצעות הדגל credentials-file.
משתמשים בחשבון שירות כדי ליצור ולהוריד את קובץ ה-JSON המשויך, ומגדירים את האפשרות--credentials-fileלנתיב של הקובץ כשמפעילים את שרת ה-proxy ל-Cloud SQL Auth. לחשבון השירות צריכות להיות ההרשאות הנדרשות למכונת Cloud SQL.כדי להשתמש באפשרות הזו בשורת הפקודה, מפעילים את הפקודה
cloud-sql-proxyעם הדגל--credentials-fileשמוגדר לנתיב ולשם הקובץ של קובץ פרטי הכניסה בפורמט JSON. הנתיב יכול להיות מוחלט או יחסי לספריית העבודה הנוכחית. לדוגמה:./cloud-sql-proxy --credentials-file PATH_TO_KEY_FILE \ INSTANCE_CONNECTION_NAME
הוראות מפורטות להוספת תפקידי IAM לחשבון שירות זמינות במאמר הענקת תפקידים לחשבונות שירות.
מידע נוסף על התפקידים שנתמכים ב-Cloud SQL זמין במאמר תפקידי IAM ל-Cloud SQL.
פרטי הכניסה שסופקו על ידי אסימון גישה.
יוצרים אסימון גישה ומפעילים את הפקודהcloud-sql-proxyעם הדגל--tokenשמוגדר לאסימון גישה מסוג OAuth 2.0. לדוגמה:./cloud-sql-proxy --token ACCESS_TOKEN \ INSTANCE_CONNECTION_NAME
פרטי הכניסה שסופקו על ידי משתנה סביבה.
האפשרות הזו דומה לשימוש בדגל--credentials-file, אבל במקום להשתמש בארגומנט של שורת הפקודה--credentials-file, מציינים את קובץ פרטי הכניסה בפורמט JSON שהגדרתם במשתנה הסביבהGOOGLE_APPLICATION_CREDENTIALS.פרטי כניסה מלקוח מאומת של ה-CLI של gcloud.
אם התקנתם את ה-CLI של gcloud ואתם מאומתים באמצעות חשבון לשימוש אישי, שרת ה-Proxy ל-Cloud SQL Auth יכול להשתמש באותם פרטי כניסה לחשבון. השיטה הזו שימושית במיוחד להקמה של סביבת פיתוח.
כדי לאפשר ל-Cloud SQL Auth Proxy להשתמש בפרטי הכניסה שלכם ב-CLI של gcloud, משתמשים בפקודה הבאה כדי לאמת את ה-CLI של gcloud:
gcloud auth application-default login
פרטי הכניסה שמשויכים למכונת Compute Engine.
אם מתחברים ל-Cloud SQL ממכונת Compute Engine, שרת ה-proxy ל-Cloud SQL Auth יכול להשתמש בחשבון השירות שמשויך למכונת Compute Engine. אם לחשבון השירות יש את ההרשאות הנדרשות למכונה של Cloud SQL, שרת ה-proxy ל-Cloud SQL Auth מבצע אימות בהצלחה.אם המכונה של Compute Engine נמצאת באותו פרויקט כמו המכונה של Cloud SQL, לחשבון השירות שמוגדר כברירת מחדל למכונה של Compute Engine יש את ההרשאות הנדרשות לאימות שרת ה-proxy ל-Cloud SQL Auth. אם שני המקרים נמצאים בפרויקטים שונים, צריך להוסיף את חשבון השירות של מכונת Compute Engine לפרויקט שמכיל את מכונת Cloud SQL.
חשבון השירות שמוגדר כברירת מחדל בסביבה
אם Cloud SQL Auth Proxy לא מוצא פרטי כניסה באף אחד מהמקומות שצוינו קודם, הוא פועל לפי הלוגיקה שמתועדת במאמרי עזרה הגדרת אימות לאפליקציות ב-Production משרת לשרת. חלק מהסביבות (כמו Compute Engine, App Engine ועוד) מספקות חשבון שירות שמוגדר כברירת מחדל, והאפליקציה יכולה להשתמש בו כדי לבצע אימות כברירת מחדל. אם משתמשים בחשבון שירות שמוגדר כברירת מחדל, צריך לוודא שיש לו את ההרשאות שמפורטות במאמר בנושא תפקידים והרשאות. למידע נוסף על הגישה של Google Cloud לאימות, אפשר לעיין במאמר בנושא סקירה כללית על אימות.
יצירה של חשבון שירות
- נכנסים לדף Service accounts במסוף Cloud de Confiance .
- בוחרים את הפרויקט שמכיל את מופע Cloud SQL.
- לוחצים על יצירת חשבון שירות.
- בשדה Service account name, מזינים שם תיאורי לחשבון השירות.
- משנים את מזהה חשבון השירות לערך ייחודי וקל לזיהוי, ואז לוחצים על יצירה והמשך.
-
לוחצים על השדה בחירת תפקיד ובוחרים באחד מהתפקידים הבאים:
- Cloud SQL > Cloud SQL Client
- Cloud SQL > Cloud SQL Editor
- Cloud SQL > Cloud SQL Admin
- לוחצים על Done כדי לסיים ליצור את חשבון השירות.
- לוחצים על תפריט הפעולות של חשבון השירות החדש ובוחרים באפשרות ניהול מפתחות.
- לוחצים על התפריט הנפתח Add key ואז על Create new key.
-
מוודאים שסוג המפתח הוא JSON ולוחצים על Create.
קובץ המפתח הפרטי יורד למחשב שלכם. אפשר להעביר אותו למיקום אחר. חשוב לשמור על אבטחת קובץ המפתח.
שימוש בשרת proxy ל-Cloud SQL Auth עם כתובת IP פרטית
כדי להתחבר למכונת Cloud SQL באמצעות כתובת IP פרטית, שרת proxy ל-Cloud SQL Auth צריך להיות במשאב עם גישה לאותה רשת VPC כמו המכונה.
שרת ה-proxy ל-Cloud SQL Auth משתמש בכתובת IP כדי ליצור חיבור למכונה שלכם ב-Cloud SQL. כברירת מחדל, שרת proxy ל-Cloud SQL Auth מנסה להתחבר באמצעות כתובת IPv4 ציבורית.
אם למכונת Cloud SQL יש רק כתובת IP פרטית, או אם למכונה יש גם כתובת IP ציבורית וגם כתובת IP פרטית, ואתם רוצים ששרת ה-proxy ל-Cloud SQL Auth ישתמש בכתובת ה-IP הפרטית, אתם צריכים לספק את האפשרות הבאה כשאתם מפעילים את שרת ה-proxy ל-Cloud SQL Auth:
--private-ip
שימוש בשרת proxy ל-Cloud SQL Auth כדי להתחבר לנקודת קצה לכתיבה
אפשר להשתמש בשרת proxy ל-Cloud SQL Auth כדי להתחבר למכונה ראשית של Cloud SQL שהוגדרה עם נקודת קצה לכתיבה. נקודת קצה לכתיבה היא שם שירות DNS גלובלי שבו אפשר להשתמש לחיבורים במקום בכתובת IP לצורך שחזור מתקדם אחרי אסון (DR), כמו ביצוע מעבר לגיבוי או פעולת מעבר. אם מתרחש גיבוי או מעבר לגיבוי (failover או switchover) של העותק המשוכפל של המופע הראשי, Cloud SQL Auth Proxy מזהה את השינויים ברשומת ה-DNS באופן אוטומטי.
למידע נוסף על שימוש בשרת proxy ל-Cloud SQL Auth כדי להתחבר לנקודת קצה לכתיבה, אפשר לעיין במאמר חיבור לקוחות של מסד נתונים למכונות באמצעות שרת proxy ל-Cloud SQL Auth או מחברי שפה של Cloud SQL.
שימוש בשרת proxy ל-Cloud SQL Auth עם מופעים שמופעל בהם Private Service Connect
אפשר להשתמש בשרת proxy ל-Cloud SQL Auth כדי להתחבר למכונה של Cloud SQL עם Private Service Connect מופעל.
שרת ה-proxy ל-Cloud SQL Auth הוא מחבר שמספק גישה מאובטחת למכונה הזו בלי צורך ברשתות מורשות או בהגדרת SSL.
כדי לאפשר חיבורי לקוח של Cloud SQL Auth Proxy, צריך להגדיר רשומת DNS שתתאים לשם ה-DNS המומלץ שמופיע עבור המכונה. רשומת ה-DNS היא מיפוי בין משאב DNS לבין שם דומיין.
מידע נוסף על שימוש בשרת proxy ל-Cloud SQL Auth כדי להתחבר למכונות עם Private Service Connect מופעל זמין במאמר חיבור באמצעות שרת proxy ל-Cloud SQL Auth.
יצירת חשבון משתמש במסד נתונים עבור שרת ה-proxy ל-Cloud SQL Auth
כשמתחברים למכונה באמצעות שרת ה-proxy ל-Cloud SQL Auth, צריך לספק חשבון משתמש כדי להתחבר למכונה. אפשר להשתמש בכל חשבון משתמש במסד הנתונים למטרה הזו. עם זאת, מכיוון ששרת ה-proxy ל-Cloud SQL Auth תמיד מתחבר משם מארח שלא ניתן לגשת אליו אלא דרך שרת ה-proxy ל-Cloud SQL Auth, אפשר ליצור חשבון משתמש שניתן לשימוש רק דרך שרת ה-proxy ל-Cloud SQL Auth. היתרון בשיטה הזו הוא שאפשר לציין את החשבון הזה בלי סיסמה, בלי לפגוע באבטחה של המופע או של הנתונים.
כדי ליצור חשבון משתמש שאפשר להשתמש בו רק עם שרת proxy ל-Cloud SQL Auth, צריך לציין את שם המארח כ-'cloudsqlproxy~[IP_ADDRESS]'. אפשר גם להשתמש בתו כללי של כתובת IP, שיניב 'cloudsqlproxy~%'. השם המלא של חשבון המשתמש יהיה:
'[USER_NAME]'@'cloudsqlproxy~%'
או
'[USER_NAME]'@'cloudsqlproxy~[IP_ADDRESS]'
למידע נוסף על יצירת משתמש, תוכלו לקרוא את המאמר יצירה וניהול של משתמשים. מידע על אופן הפעולה של Cloud SQL עם חשבונות משתמשים זמין במאמר משתמשים.
הפעלת שרת proxy ל-Cloud SQL Auth בתהליך נפרד
הפעלת שרת ה-proxy ל-Cloud SQL Auth בתהליך נפרד של מסוף Cloud Shell יכולה להיות שימושית, כדי למנוע ערבוב של פלט המסוף שלו עם פלט מתוכניות אחרות. כדי להפעיל את שרת ה-proxy ל-Cloud SQL Auth בתהליך נפרד, משתמשים בתחביר שמוצג בהמשך.
Linux
ב-Linux או ב-macOS, משתמשים ב-& בסוף שורת הפקודה כדי להפעיל את Cloud SQL Auth Proxy בתהליך נפרד:
./cloud-sql-proxy INSTANCE_CONNECTION_NAME
--credentials-file PATH_TO_KEY_FILE &
Windows
ב-Windows PowerShell, משתמשים בפקודה Start-Process כדי להפעיל את שרת ה-proxy ל-Cloud SQL Auth בתהליך נפרד:
Start-Process --filepath "cloud-sql-proxy.exe"
--ArgumentList "
--credentials-file PATH_TO_KEY_FILEINSTANCE_CONNECTION_NAME"
הפעלת שרת proxy ל-Cloud SQL Auth בקונטיינר Docker
כדי להפעיל את שרת ה-proxy ל-Cloud SQL Auth בקונטיינר Docker, משתמשים בקובץ האימג' של שרת ה-proxy ל-Cloud SQL Auth Docker שזמין ב-Google Container Registry. כדי להתקין את קובץ האימג' של Docker של Cloud SQL Auth Proxy, משתמשים בפקודה הבאה:
docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.21.1
אפשר להפעיל את Cloud SQL Auth Proxy באמצעות שקעי TCP או שקעי Unix, עם הפקודות שמוצגות בהמשך.
שקעי TCP
docker run -d \ -v PATH_TO_KEY_FILE:/path/to/service-account-key.json \ -p 127.0.0.1:3306:3306 \ gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.21.1 \ --address 0.0.0.0 \ --credentials-file /path/to/service-account-key.json \ INSTANCE_CONNECTION_NAME
שקעי Unix
docker run -d \ -v /PATH_TO_HOST_TARGET:/PATH_TO_GUEST_TARGET \ -v PATH_TO_KEY_FILE:/path/to/service-account-key.json \ gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.21.1 --unix-socket /cloudsql \ --credentials-file /path/to/service-account-key.json/PATH_TO_KEY_FILE \ INSTANCE_CONNECTION_NAME
אם אתם משתמשים בתמונה שעברה אופטימיזציה לקונטיינר, צריך להשתמש בספרייה שאפשר לכתוב בה במקום /cloudsql, למשל:
v /mnt/stateful_partition/cloudsql:/cloudsqlאם אתם משתמשים בפרטי הכניסה שסופקו על ידי מופע Compute Engine, אל תכללו את הפרמטר credential_file ואת השורה -v PATH_TO_KEY_FILE:/path/to/service-account-key.json.
הפעלת שרת proxy ל-Cloud SQL Auth כשירות
אפשר להריץ את שרת ה-proxy ל-Cloud SQL Auth כשירות הפועל ברקע לפיתוח מקומי ולעומסי עבודה בסביבת ייצור. במהלך פיתוח, כשצריך לגשת למכונה של Cloud SQL, אפשר להפעיל את השירות ברקע ולהפסיק אותו כשמסיימים.
לעומסי עבודה בסביבת ייצור, שרת ה-proxy ל-Cloud SQL Auth לא מספק כרגע תמיכה מובנית להפעלה כשירות Windows, אבל אפשר להשתמש במנהלי שירותים של צד שלישי כדי להפעיל אותו כשירות. לדוגמה, אפשר להשתמש ב-NSSM כדי להגדיר את שרת ה-proxy ל-Cloud SQL Auth כשירות Windows, ו-NSSM מנטר את שרת ה-proxy ל-Cloud SQL Auth ומפעיל אותו מחדש באופן אוטומטי אם הוא מפסיק להגיב. מידע נוסף מופיע במסמכי התיעוד של NSSM.
אכיפת השימוש בשרת proxy ל-Cloud SQL Auth
מפעילים את השימוש בשרת proxy ל-Cloud SQL Auth ב-Cloud SQL באמצעות ConnectorEnforcement.
אם אתם משתמשים במכונה עם Private Service Connect, יש מגבלה. אם האכיפה של המחבר מופעלת במופע, אי אפשר ליצור רפליקות לקריאה עבור המופע. באופן דומה, אם למופע יש עותקים לקריאה, אי אפשר להפעיל את האכיפה של המחבר במופע.
gcloud
הפקודה הבאה מחייבת שימוש במחברים של Cloud SQL.
gcloud sql instances patch INSTANCE_NAME \ --connector-enforcement REQUIRED
כדי להשבית את האכיפה, משתמשים בשורת הקוד הבאה:
--connector-enforcement NOT_REQUIRED
העדכון לא מפעיל הפעלה מחדש.
REST v1
הפקודה הבאה מחייבת שימוש במחברים של Cloud SQL
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
- project-id: מזהה הפרויקט.
- instance-id: מזהה המכונה.
ה-method של ה-HTTP וכתובת ה-URL:
PATCH https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id
תוכן בקשת JSON:
{
"settings": {
"connectorEnforcement": "REQUIRED"
}
}
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אתם אמורים לקבל תגובת JSON שדומה לזו:
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id",
"status": "PENDING",
"user": "user@example.com",
"insertTime": "2020-01-16T02:32:12.281Z",
"operationType": "UPDATE",
"name": "operation-id",
"targetId": "instance-id",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/project-id/operations/operation-id",
"targetProject": "project-id"
}
כדי להשבית את האכיפה, משתמשים במדיניות "connectorEnforcement": "NOT_REQUIRED" במקום זאת. העדכון לא מפעיל הפעלה מחדש.
REST v1beta4
הפקודה הבאה מחייבת שימוש במחברים של Cloud SQL.
לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:
- project-id: מזהה הפרויקט.
- instance-id: מזהה המכונה.
ה-method של ה-HTTP וכתובת ה-URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id
תוכן בקשת JSON:
{
"settings": {
"connectorEnforcement": "REQUIRED"
}
}
כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:
אתם אמורים לקבל תגובת JSON שדומה לזו:
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id",
"status": "PENDING",
"user": "user@example.com",
"insertTime": "2020-01-16T02:32:12.281Z",
"operationType": "UPDATE",
"name": "operation-id",
"targetId": "instance-id",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/operations/operation-id",
"targetProject": "project-id"
}
כדי להשבית את האכיפה, משתמשים במדיניות "connectorEnforcement": "NOT_REQUIRED" במקום זאת. העדכון לא מפעיל הפעלה מחדש.
טיפים לעבודה עם שרת proxy ל-Cloud SQL Auth
הפעלת שרת proxy ל-Cloud SQL Auth
כל ההפעלות של ה-Proxy לדוגמה מתחילות את ה-Cloud SQL Auth Proxy ברקע, כך שמוחזרת הנחיה. כדי למנוע ערבוב של הפלט שלו עם הפלט מתוכנות אחרות, כדאי להשתמש בחלון הזה של Cloud Shell לשרת proxy ל-Cloud SQL Auth. בנוסף, הפלט משרת ה-proxy ל-Cloud SQL Auth יכול לעזור לכם לאבחן בעיות בחיבור, ולכן כדאי לתעד אותו בקובץ יומן. אם לא מפעילים את שרת ה-proxy ל-Cloud SQL Auth ברקע, הפלט מועבר ל-stdout אלא אם הוא מנותב מחדש.
לא חייבים להשתמש ב-/cloudsql כספרייה עבור שקעי שרת ה-proxy ל-Cloud SQL Auth. (השם של הספרייה הזו נבחר כדי לצמצם את ההבדלים עם מחרוזות החיבור של App Engine). אם משנים את שם הספרייה, חשוב לשמור על אורך מינימלי כי הוא משולב במחרוזת ארוכה יותר שיש לה מגבלת אורך שמוכתבת על ידי מערכת ההפעלה. זה תלוי במערכת, אבל בדרך כלל זה בין 91 ל-108 תווים. ב-Linux, האורך מוגדר בדרך כלל כ-108, ואפשר להשתמש בפקודה הבאה כדי לבדוק:
cat /usr/include/linux/un.h | grep "define UNIX_PATH_MAX"
שימוש בשרת proxy ל-Cloud SQL Auth כדי להתחבר לכמה מכונות
אפשר להשתמש בלקוח מקומי אחד של שרת proxy ל-Cloud SQL Auth כדי להתחבר לכמה מכונות Cloud SQL. הדרך שבה עושים את זה תלויה בשאלה אם משתמשים ב-Unix sockets או ב-TCP.
שקעי Unix
כדי לחבר את שרת ה-proxy ל-Cloud SQL Auth לכמה מכונות, צריך לספק את שם החיבור של כל מכונה כארגומנט לשרת ה-proxy ל-Cloud SQL Auth, ברשימה מופרדת ברווחים. השרת proxy ל-Cloud SQL Auth מתחבר לכל מופע כשהוא מופעל.
מתחברים לכל מופע באמצעות השקע שלו, בספרייה שצוינה.
לדוגמה:
./cloud-sql-proxy --unix-socket /cloudsql \ myProject:us-central1:myInstance myProject:us-central1:myInstance2 & mysql -u myUser -S /cloudsql/myProject:us-central1:myInstance2
שקעי TCP
כשמתחברים באמצעות TCP, מציינים יציאה במחשב שבה שרת ה-proxy ל-Cloud SQL Auth יאזין לכל מכונה של Cloud SQL. כשמתחברים לכמה מכונות Cloud SQL, כל יציאה שצוינה צריכה להיות ייחודית וזמינה לשימוש במחשב.
לדוגמה:
# Start the Cloud SQL Auth Proxy to connect to two different Cloud SQL instances. # Give the Cloud SQL Auth Proxy a unique port on your machine to use for each Cloud SQL instance. ./cloud-sql-proxy "myProject:us-central1:myInstance?port=3306" \ "myProject:us-central1:myInstance2?port=1234" # Connect to "myInstance" using port 3306 on your machine: mysql -u myInstanceUser --host 127.0.0.1 --port 3306 # Connect to "myInstance2" using port 1234 on your machine: mysql -u myInstance2User --host 127.0.0.1 --port 1234
פתרון בעיות בחיבורים של Cloud SQL Auth Proxy
קובץ האימג' של Docker של שרת proxy ל-Cloud SQL Auth מבוסס על גרסה ספציפית של שרת proxy ל-Cloud SQL Auth. כשגרסה חדשה של שרת ה-proxy ל-Cloud SQL Auth זמינה, צריך למשוך את הגרסה החדשה של קובץ אימג' של Docker של שרת ה-proxy ל-Cloud SQL Auth כדי לשמור על הסביבה מעודכנת. כדי לראות את הגרסה הנוכחית של שרת ה-proxy ל-Cloud SQL Auth, אפשר לעיין ב דף הגרסאות של שרת ה-proxy ל-Cloud SQL Auth ב-GitHub.
אם נתקלתם בבעיות בחיבור למכונת Cloud SQL באמצעות שרת proxy ל-Cloud SQL Auth, כדאי לנסות את הפעולות הבאות כדי לגלות מה גורם לבעיה.
בודקים את הפלט של שרת ה-proxy ל-Cloud SQL Auth.
לרוב, הפלט של Cloud SQL Auth Proxy יכול לעזור לכם לקבוע את מקור הבעיה ואת הדרך לפתור אותה. מעבירים את הפלט לקובץ או צופים בטרמינל Cloud Shell שבו הפעלתם את שרת ה-proxy ל-Cloud SQL Auth.
אם אתם מקבלים שגיאה
403 notAuthorizedואתם משתמשים בחשבון שירות כדי לאמת את שרת ה-proxy ל-Cloud SQL Auth, ודאו שלחשבון השירות יש את ההרשאות הנכונות.אפשר לבדוק את חשבון השירות על ידי חיפוש המזהה שלו בדף IAM. צריכה להיות לו ההרשאה
cloudsql.instances.connect. ההרשאה הזו ניתנת לתפקידים המוגדרים מראשCloud SQL Admin,Clientו-Editor.אם אתם מתחברים מ-App Engine ומוצגת השגיאה
403 notAuthorized, כדאי לבדוק את הערךapp.yamlcloud_sql_instancesכדי לוודא ששם החיבור של המכונה מאוית נכון. שמות החיבור של המכונות מוצגים תמיד בפורמטPROJECT:REGION:INSTANCE.בנוסף, צריך לוודא שלחשבון השירות של App Engine (לדוגמה, $PROJECT_ID@appspot.s3ns-system.iam.gserviceaccount.com) יש את תפקיד הלקוח של Cloud SQL ב-IAM.
אם שירות App Engine נמצא בפרויקט אחד (פרויקט א') ומסד הנתונים נמצא בפרויקט אחר (פרויקט ב'), השגיאה הזו מציינת שלא הוקצה לחשבון השירות של App Engine תפקיד IAM של לקוח Cloud SQL בפרויקט שבו נמצא מסד הנתונים (פרויקט ב').
חשוב להפעיל את Cloud SQL Admin API.
אם לא, תראו פלט כמו
Error 403: Access Not Configuredביומני שרת ה-proxy ל-Cloud SQL Auth.אם אתם כוללים כמה מופעים ברשימת המופעים, הקפידו להשתמש בפסיק כמפריד, ללא רווחים. אם אתם משתמשים ב-TCP, הקפידו לציין יציאות שונות לכל מופע.
אם אתם מתחברים באמצעות שקעי UNIX, צריך לוודא שהשקעים נוצרו על ידי הצגת רשימת הספרייה שציינתם כשהפעלתם את שרת ה-proxy ל-Cloud SQL Auth.
אם יש לכם מדיניות חומת אש ליציאה, ודאו שהיא מאפשרת חיבורים ליציאה 3307 במופע היעד של Cloud SQL.
כדי לוודא ש-Cloud SQL Auth Proxy הופעל בצורה תקינה, אפשר לעיין ביומנים בקטע Operations > Logging > Logs explorer במסוףCloud de Confiance . אם הפעולה בוצעה בהצלחה, התגובה תיראה כך:
2021/06/14 15:47:56 Listening on /cloudsql/$PROJECT_ID:$REGION:$INSTANCE_NAME/3306 for $PROJECT_ID:$REGION:$INSTANCE_NAME 2021/06/14 15:47:56 Ready for new connectionsבעיות במכסה: כשחורגים מהמכסה של Cloud SQL Admin API, שרת ה-proxy ל-Cloud SQL Auth מופעל עם הודעת השגיאה הבאה:
There was a problem when parsing a instance configuration but ignoring due to the configuration. Error: googleapi: Error 429: Quota exceeded for quota metric 'Queries' and limit 'Queries per minute per user' of service 'sqladmin.googleapis.com' for consumer 'project_number:$PROJECT_ID., rateLimitExceededאחרי שאפליקציה מתחברת לשרת ה-proxy, השרת מדווח על השגיאה הבאה:
failed to refresh the ephemeral certificate for $INSTANCE_CONNECTION_NAME: googleapi: Error 429: Quota exceeded for quota metric 'Queries' and limit 'Queries per minute per user' of service 'sqladmin.googleapis.com' for consumer 'project_number:$PROJECT_ID., rateLimitExceededפתרון: אפשר לזהות את מקור הבעיה במכסה, למשל, אפליקציה שמשתמשת במחבר בצורה לא נכונה ויוצרת חיבורים חדשים שלא לצורך, או לפנות לתמיכה כדי לבקש הגדלה של מכסת Cloud SQL Admin API. אם שגיאת המכסה מופיעה בהפעלה, צריך לפרוס מחדש את האפליקציה כדי להפעיל מחדש את ה-proxy. אם שגיאת המכסה מופיעה אחרי ההפעלה, אין צורך בפריסה מחדש.