בדף המדריך הזה של Cloud Search מוסבר איך להגדיר מקור נתונים ומחבר תוכן לצורך הוספה לאינדקס. כדי להתחיל את מדריך ההתחלה, כדאי לעיין במדריך לתחילת העבודה ב-Cloud Search.
יצירת המחבר
משנים את ספריית העבודה לספרייה cloud-search-samples/end-to-end/connector
ומריצים את הפקודה הבאה:
mvn package -DskipTests
הפקודה מורידה את יחסי התלות הנדרשים לבניית מחבר התוכן ויוצרת את הקוד בעצמכם.
יצירת פרטי כניסה לחשבון שירות
המחבר דורש פרטי כניסה של חשבון שירות כדי להפעיל את ממשקי Cloud Search API. כדי ליצור את פרטי הכניסה:
- חוזרים למסוף Google Cloud.
- בחלונית הניווט השמאלית, לוחצים על Credentials (פרטי כניסה). יופיע הדף 'פרטי כניסה'.
- לוחצים על הרשימה הנפתחת + CREATE CREDENTIALS ובוחרים באפשרות Service account. יופיע הדף 'יצירת חשבון שירות'.
- בשדה Service account name, מזינים "tutorial".
- שימו לב לערך של מזהה חשבון השירות (מיד אחרי השם של חשבון השירות). ייעשה שימוש בערך הזה מאוחר יותר.
- לוחצים על יצירה. תיבת הדו-שיח 'הרשאות חשבון שירות (אופציונלי)' מופיעה.
- לוחצים על המשך. מופיעה תיבת הדו-שיח 'Grant users access to this service account (optional)'.
- לוחצים על סיום. המסך 'פרטי כניסה' יופיע.
- בקטע 'חשבונות שירות', לוחצים על כתובת האימייל של חשבון השירות. הקישורים הדף 'פרטי חשבון שירות'
- בקטע Keys (מפתחות), לוחצים על הרשימה הנפתחת ADD KEY ובוחרים באפשרות Create new key. מופיעה תיבת הדו-שיח 'יצירת מפתח פרטי'.
- לוחצים על יצירה.
- (אופציונלי) אם מופיעה תיבת הדו-שיח 'Do you want toAllow Download on console.cloud.google.com? ", לוחצים על Allow.
- קובץ מפתח פרטי נשמר במחשב שלכם. שימו לב למיקום של הקובץ שהורדתם. הקובץ הזה משמש להגדרה של מחבר התוכן כך שיוכל לאמת את עצמו במהלך קריאה לממשקי ה-API של Google Cloud Search.
הפעלת תמיכה של צד שלישי
לפני שתוכלו לקרוא לממשקי API אחרים של Cloud Search, תצטרכו להפעיל תמיכה של צד שלישי ב-Google Cloud Search.
כדי להפעיל תמיכה של צד שלישי ב-Cloud Search:
הפרויקט בפלטפורמת Cloud Search מכיל פרטי כניסה של חשבון שירות. עם זאת, לצורך אתחול התמיכה של צד שלישי, צריך ליצור פרטי כניסה לאפליקציית אינטרנט. במאמר יצירת פרטי כניסה מוסבר איך יוצרים פרטי כניסה לאפליקציית אינטרנט. כשתסיימו את השלב הזה, תצטרכו לספק מזהה לקוח וקובץ סוד לקוח.
משתמשים בפלטפורמת OAuth 2 של Google כדי לקבל אסימון גישה:
- לוחצים על 'הגדרות' ומסמנים את האפשרות שימוש בפרטי הכניסה שלך לאימות.
- מזינים את מזהה הלקוח ואת סוד הלקוח משלב 1.
- לוחצים על Close.
- בשדה Scopes, מקלידים
https://www.googleapis.com/auth/cloud_search.settings
ולוחצים על Authorize. ה-Playground של OAuth 2 מחזיר קוד הרשאה. - לוחצים על החלפת קוד הרשאה לאסימונים. מוחזר אסימון.
כדי להפעיל תמיכה של צד שלישי ב-Cloud Search, משתמשים בפקודת ה-curl הבאה. חשוב להחליף את
[YOUR_ACCESS_TOKEN]
באסימון שקיבלתם בשלב 2.curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressed
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של
operation
. לדוגמה:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
אם הפעולה נכשלה, צריך לפנות לתמיכה של Cloud Search.
משתמשים ב-operations.get כדי לוודא שהתמיכה של הצד השלישי הופעלה:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
כשהאתחול של הצד השלישי יושלם, הוא יכיל את השדה
done
שמוגדר ל-true
. למשל:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
יצירת מקור הנתונים
בשלב הבא צריך ליצור מקור נתונים במסוף Admin. מקור הנתונים מספק מרחב שמות להוספת תוכן לאינדקס באמצעות המחבר.
- פותחים את מסוף Google Admin.
- לוחצים על סמל האפליקציות. הדף 'ניהול אפליקציות' יופיע.
- לוחצים על Google Workspace. הדף 'ניהול אפליקציות ב-Google Workspace' יופיע.
- גוללים למטה ולוחצים על Cloud Search. הדף Settings for Google Workspace יופיע.
- לוחצים על מקורות נתונים של צד שלישי. הדף 'מקורות נתונים' יופיע.
- לוחצים על העיגול הצהוב +. מופיעה תיבת הדו-שיח 'הוספת מקור נתונים חדש'.
- בשדה Display name, מקלידים 'tutorial'.
- בשדה Service account email addresses, מזינים את כתובת האימייל של חשבון השירות שיצרתם בקטע הקודם. אם לא יודעים מה כתובת האימייל של חשבון השירות, אפשר לחפש אותו בדף service accounts.
- לוחצים על ADD. תופיע תיבת הדו-שיח 'מקור הנתונים נוצר בהצלחה'.
- לוחצים על *אישור. שימו לב למזהה המקור של מקור הנתונים החדש שנוצר. מזהה המקור משמש להגדרה של מחבר התוכן.
יצירת אסימון גישה אישי ל-GitHub API
למחבר נדרשת גישה מאומתת ל-GitHub API כדי שהמכסה תהיה מספיקה. כדי לשמור על פשטות, המחבר משתמש באסימוני גישה אישיים במקום ב-OAuth. אסימונים אישיים מאפשרים לבצע אימות כמשתמשים עם קבוצה מוגבלת של הרשאות, שדומות ל-OAuth.
- מתחברים ל-GitHub.
- בפינה הימנית העליונה, לוחצים על תמונת הפרופיל. יופיע תפריט נפתח.
- לוחצים על הגדרות.
- לוחצים על הגדרות למפתחים.
- לוחצים על אסימוני גישה אישיים.
- לוחצים על יצירת אסימון גישה אישי.
- בשדה הערה, מזינים "Cloud Search training" (מדריך ל-Cloud Search).
- בודקים את ההיקף של public_repo.
- לוחצים על יצירת אסימון.
- רושמים או זוכרים את האסימון שנוצר. המחבר משמש את המחבר כדי לקרוא ל-API של GitHub, ומספק מכסת API לביצוע ההוספה לאינדקס.
הגדרת המחבר
אחרי שיוצרים את פרטי הכניסה ואת מקור הנתונים, צריך לעדכן את הגדרות המחבר כך שיכללו את הערכים הבאים:
- משורת הפקודה, משנים את הספרייה ל-
cloud-search-samples/end-to-end/connector/
. - פותחים את הקובץ
sample-config.properties
באמצעות כלי לעריכת טקסט. - מגדירים את הפרמטר
api.serviceAccountPrivateKeyFile
לנתיב הקובץ של פרטי הכניסה לשירות שהורדתם בעבר. - מגדירים את הפרמטר
api.sourceId
כמזהה של מקור הנתונים שיצרתם בעבר. - מגדירים את הפרמטר
github.user
לשם המשתמש שלכם ב-GitHub. - מגדירים את הפרמטר
github.token
לאסימון הגישה שיצרתם בעבר. - שומרים את הקובץ.
עדכון הסכימה
המחבר מוסיף לאינדקס גם תוכן מובנה וגם תוכן לא מובנה. לפני שמוסיפים נתונים לאינדקס, צריך לעדכן את הסכימה של מקור הנתונים. מריצים את הפקודה הבאה כדי לעדכן את הסכימה:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
הפעלת המחבר
כדי להריץ את המחבר ולהתחיל בהוספה לאינדקס, מריצים את הפקודה:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
הגדרות ברירת המחדל של המחבר הן ליצור אינדקס של מאגר יחיד בארגון googleworkspace
. ההוספה של המאגר לאינדקס נמשכת בערך דקה.
אחרי ההוספה הראשונית לאינדקס, המחבר ממשיך לבדוק אם יש שינויים במאגר שצריכים להשתקף באינדקס של Cloud Search.
בדיקת הקוד
הקטעים הנותרים יבחנו כיצד המחבר נבנה.
הפעלת האפליקציה
נקודת הכניסה למחבר היא המחלקה GithubConnector
. ה-method main
יוצרת את ה-IndexingApplication
של ה-SDK ומפעילה אותו.
ב-ListingConnector
שסופק על ידי ה-SDK מוטמעת אסטרטגיית מעבר שמשתמשת בתורים של Cloud Search למעקב אחרי מצב הפריטים באינדקס. הוא מעניק גישה ל-GithubRepository
, שמוטמע על ידי המחבר לדוגמה, כדי לגשת לתוכן מ-GitHub.
מעבר למאגרים של GitHub
במהלך מעברים מלאים, השיטה getIds()
נקראת כדי לדחוף פריטים שצריך להוסיף לאינדקס לתור.
המחבר יכול להוסיף מספר מאגרים או ארגונים לאינדקס. כדי לצמצם למינימום את ההשפעה של כשל, עוברים במאגר אחד של GitHub בכל פעם. נקודת הביקורת מוחזרת עם תוצאות המעבר עם רשימת המאגרים שצריך להוסיף לאינדקס בקריאות הבאות ל-getIds()
. אם מתרחשת שגיאה, ההוספה לאינדקס תמשיך להתבצע במאגר הנוכחי במקום להתחיל מההתחלה.
ה-method collectRepositoryItems()
מטפלת במעבר של מאגר GitHub אחד. השיטה הזו מחזירה אוסף של ApiOperations
שמייצג את הפריטים שיש להעביר אותם לתור. הפריטים נדחפים כשם משאב וערך גיבוב (hash) שמייצג את המצב הנוכחי של הפריט.
ערך הגיבוב משמש במעברים הבאים במאגרים של GitHub. הערך הזה מספק בדיקה פשוטה כדי לקבוע אם התוכן השתנה בלי להעלות תוכן נוסף. המחבר מוסיף את כל הפריטים בתור. אם הפריט חדש או אם ערך הגיבוב השתנה, הוא יהיה זמין לתשאול בתור. אחרת, הפריט נחשב ללא שינוי.
מתבצע עיבוד של התור
לאחר השלמת המעבר המלא, המחבר מתחיל לדגום את התור לפריטים שצריך להוסיף לאינדקס. מתבצעת קריאה ל-method getDoc()
לכל פריט שנשלף מהתור. ה-method קוראת את הפריט מ-GitHub וממירה אותו לייצוג המתאים להוספה לאינדקס.
מכיוון שהמחבר פועל מול נתונים פעילים שעשויים להשתנות בכל שלב, getDoc()
גם מאמת שהפריט בתור עדיין בתוקף ומוחק את כל הפריטים מהאינדקס שלא קיימים יותר.
לכל אובייקט של GitHub שהמחבר מוסיף לאינדקס, השיטה המתאימה ב-indexItem()
מטפלת בבניית ייצוג הפריט עבור Cloud Search. לדוגמה, כדי ליצור ייצוג של פריטי תוכן:
לאחר מכן, פורסים את ממשק החיפוש.