שימוש במדיניות ארגונית בהתאמה אישית

בדף הזה מוסבר איך להשתמש באילוצים מותאמים אישית של שירות מדיניות הארגון כדי להגביל פעולות ספציפיות במשאבים הבאים של Google Cloud :

• monitoring.googleapis.com/AlertPolicy
• monitoring.googleapis.com/NotificationChannel
• monitoring.googleapis.com/Snooze

מידע נוסף על מדיניות הארגון זמין במאמר בנושא מדיניות ארגונית בהתאמה אישית.

ב-Cloud Monitoring, אילוצים בהתאמה אישית מאפשרים לאכוף כללי ניהול ברמת הארגון על הגדרות של התראות. לדוגמה, אתם יכולים לדרוש שמדיניות ההתראות תכלול תיעוד או ערוצי התראות לגיבוי, להגביל את ערוצי ההתראות לסוגים מאושרים כמו אימייל, או להגביל את משך ההשהיה המקסימלי.

מידע על מדיניות הארגון ואילוצים

שירות Google Cloud מדיניות הארגון מאפשר לכם לקבל שליטה מרוכזת ופרוגרמטית על המשאבים של הארגון. בתור אדמינים של מדיניות הארגון, אתם יכולים להגדיר מדיניות ארגונית, שהיא קבוצה של הגבלות שנקראות אילוצים שחלות על משאבים ב-Google Cloud ועל משאבים שנגזרים מהם בGoogle Cloud היררכיית המשאבים. אפשר לאכוף את מדיניות הארגון ברמת הארגון, התיקייה או הפרויקט.

ב-Organization Policy יש אילוצים מנוהלים מובנים למגוון שירותים של Google Cloud . עם זאת, אם אתם רוצים שליטה מפורטת יותר ומותאמת אישית בשדות הספציפיים שמוגבלים במדיניות הארגון, אתם יכולים גם ליצור אילוצים מותאמים אישית ולהשתמש בהם במדיניות הארגון.

העברת מדיניות בירושה

כברירת מחדל, מדיניות הארגון עוברת בירושה לצאצאים של המשאבים שבהם אתם אוכפים את המדיניות. לדוגמה, אם אוכפים מדיניות בתיקייה, Google Cloud המדיניות נאכפת בכל הפרויקטים בתיקייה. כאן אפשר לקרוא מידע נוסף על ההתנהגות הזו ועל שינוי שלה.

לפני שמתחילים

נכנסים לחשבון Google Cloud . אנחנו ממליצים למשתמשים חדשים ב- Google Cloud ליצור חשבון כדי שיוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

1. חשוב לוודא שאתם יודעים מהו מזהה הארגון שלכם.

התפקידים הנדרשים

כדי לקבל את ההרשאות שדרושות לניהול מדיניות ארגונית בהתאמה אישית, צריך לבקש מהאדמין להקצות לכם את תפקיד ה-IAM‏ Organization Policy Administrator (אדמין של מדיניות ארגונית) ‏(roles/orgpolicy.policyAdmin) במשאב הארגון. כדי לקרוא הסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

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

משאבים נתמכים ב-Cloud Monitoring

בטבלה הבאה מפורטים המשאבים של Cloud Monitoring שאפשר להפנות אליהם באילוצים בהתאמה אישית.

הגדרת אילוץ בהתאמה אישית

אילוץ בהתאמה אישית מוגדר בקובץ YAML לפי המשאבים, השיטות, התנאים והפעולות שנתמכים על ידי השירות שבו אתם אוכפים את מדיניות הארגון. התנאים להגבלות המותאמות אישית מוגדרים באמצעות Common Expression Language (CEL). מידע נוסף על יצירת תנאים באילוצים מותאמים אישית באמצעות CEL זמין בקטע בנושא CEL במאמר יצירה וניהול של אילוצים מותאמים אישית.

המסוף

כדי ליצור אילוץ בהתאמה אישית:

1. נכנסים לדף Organization policies במסוף Google Cloud .

   אל מדיניות הארגון

2. בתפריט לבחירת פרויקטים, בוחרים את הפרויקט שרוצים להגדיר לו את מדיניות הארגון.
3. לוחצים על add Custom constraint (הגבלה מותאמת אישית).
4. בתיבה שם לתצוגה, מזינים שם שאפשר לקרוא ולהבין את המשמעות שלו. השם הזה מופיע בהודעות שגיאה ויכול לשמש לזיהוי ולניפוי באגים. אל תשתמשו בפרטים אישיים מזהים (PII) או במידע אישי רגיש בשמות לתצוגה, כי השם הזה עלול להיחשף בהודעות שגיאה. השדה הזה יכול להכיל עד 200 תווים.
5. בתיבה Constraint ID (מזהה האילוץ), מזינים את המזהה שרוצים להגדיר לאילוץ המותאם אישית החדש. אילוץ בהתאמה אישית יכול להכיל רק אותיות (כולל אותיות גדולות וקטנות) או מספרים, למשל alertDocHasProject. השדה הזה יכול להכיל עד 70 תווים, לא כולל הקידומת (custom.), לדוגמה, organizations/123456789/customConstraints/custom. אל תכללו פרטים אישיים מזהים (PII) או נתונים רגישים במזהה האילוץ, כי הם עלולים להיחשף בהודעות שגיאה.
6. בתיבה Description, מזינים תיאור של האילוץ שקל לאנשים לקרוא. התיאור הזה משמש כהודעת שגיאה כשמתרחשת הפרה של המדיניות. צריך לכלול פרטים על הסיבה להפרת המדיניות ועל האופן שבו אפשר לפתור את הבעיה. אל תכללו בתיאור פרטים אישיים מזהים (PII) או מידע אישי רגיש, כי הם עלולים להיחשף בהודעות שגיאה. בשדה הזה אפשר להזין עד 2,000 תווים.
7. בתיבה Resource type, בוחרים את השם של Google Cloud משאב REST שמכיל את האובייקט והשדה שרוצים להגביל – לדוגמה, container.googleapis.com/NodePool. רוב סוגי המשאבים תומכים בעד 20 אילוצים מותאמים אישית. אם תנסו ליצור עוד אילוצים בהתאמה אישית, הפעולה תיכשל.
8. בקטע שיטת אכיפה, בוחרים אם לאכוף את האילוץ על שיטת REST‏ CREATE או על שיטות CREATE ו-UPDATE. אם אוכפים את האילוץ באמצעות השיטה UPDATE במשאב שמפר את האילוץ, מדיניות הארגון חוסמת שינויים במשאב הזה, אלא אם השינוי פותר את ההפרה.

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

9. כדי להגדיר תנאי, לוחצים על edit Edit condition.
1. בחלונית Add condition, יוצרים תנאי CEL שמתייחס למשאב שירות נתמך, למשל, resource.management.autoUpgrade == false. השדה הזה יכול לכלול עד 1,000 תווים. פרטים על השימוש ב-CEL זמינים במאמר בנושא Common Expression Language. מידע נוסף על משאבי השירות שאפשר להשתמש בהם באילוצים בהתאמה אישית זמין במאמר שירותים שתומכים באילוצים בהתאמה אישית.
2. לוחצים על Save.
10. בקטע פעולה, בוחרים אם לאשר או לדחות את השיטה שנבדקה אם התנאי מתקיים.

הפעולה deny (דחייה) פירושה שהפעולה ליצירה או לעדכון של המשאב נחסמת אם התנאי מחזיר את הערך true.

הפעולה allow (אישור) פירושה שהפעולה ליצירה או לעדכון של המשאב מותרת רק אם התנאי מחזיר את הערך true. כל מקרה אחר, מלבד אלה שמפורטים במפורש בתנאי, נחסם.

11. לוחצים על יצירת אילוץ.

אחרי שמזינים ערך בכל שדה, מופיעה משמאל הגדרת ה-YAML המקבילה לאילוץ המותאם אישית הזה.

gcloud

1. כדי ליצור אילוץ בהתאמה אישית, יוצרים קובץ YAML בפורמט הבא:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes: RESOURCE_NAME
methodTypes:
  - CREATE
  - UPDATE 
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION

מחליפים את מה שכתוב בשדות הבאים:

• ‫ORGANIZATION_ID: מזהה הארגון, למשל 123456789.
• ‫CONSTRAINT_NAME: השם שרוצים לתת לאילוץ המותאם אישית החדש. אילוץ בהתאמה אישית יכול להכיל רק אותיות (כולל אותיות רישיות וקטנות) או מספרים, למשל, alertDocHasProject. השדה הזה יכול להכיל עד 70 תווים, לא כולל הקידומת (custom.) – לדוגמה, organizations/123456789/customConstraints/custom. אל תכללו פרטים אישיים מזהים (PII) או נתונים רגישים במזהה האילוץ, כי הם עלולים להיחשף בהודעות שגיאה.
• ‫RESOURCE_NAME: השם מוגדר במלואו של המשאב Google Cloudשמכיל את האובייקט והשדה שרוצים להגביל. לדוגמה, monitoring.googleapis.com/AlertPolicy. רוב סוגי המשאבים תומכים בעד 20 אילוצים מותאמים אישית. אם תנסו ליצור עוד אילוצים בהתאמה אישית, הפעולה תיכשל.
• ‫methodTypes: שיטות REST שבהן האילוץ נאכף. יכול להיות CREATE או גם CREATE וגם UPDATE. אם אוכפים את האילוץ באמצעות השיטה UPDATE על משאב שמפר את האילוץ, שינויים במשאב הזה נחסמים על ידי מדיניות הארגון, אלא אם השינוי פותר את ההפרה.

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

• ‫CONDITION: תנאי CEL שנכתב על סמך ייצוג של משאב שירות נתמך. בשדה הזה אפשר להזין עד 1,000 תווים. לדוגמה, resource.documentation.content.contains('${resource.project}').

מידע נוסף על המשאבים שאפשר לכתוב תנאים לגביהם זמין במאמר משאבים נתמכים.

• ‫ACTION: הפעולה שתתבצע אם התנאי condition יתקיים. הערכים האפשריים הם ALLOW ו-DENY.

הפעולה allow (אישור) אומרת שאם התנאי מקבל את הערך true, הפעולה ליצירה או לעדכון של המשאב מותרת. המשמעות היא שכל מקרה אחר, מלבד המקרה שמופיע במפורש בתנאי, ייחסם.

הפעולה deny (דחייה) פירושה שאם התנאי מחזיר את הערך true, הפעולה ליצירה או לעדכון של המשאב נחסמת.

• DISPLAY_NAME: שם קריא לאנשים של האילוץ. השם הזה מופיע בהודעות שגיאה ויכול לשמש לזיהוי ולניפוי באגים. אל תשתמשו בפרטים אישיים מזהים (PII) או במידע אישי רגיש בשמות המוצגים, כי השם הזה עלול להיחשף בהודעות שגיאה. השדה הזה יכול להכיל עד 200 תווים.
• ‫DESCRIPTION: תיאור ידידותי למשתמש של האילוץ שיוצג כהודעת שגיאה אם המדיניות תופר. בשדה הזה אפשר להזין עד 2,000 תווים.
2. אחרי שיוצרים את קובץ ה-YAML לאילוץ חדש בהתאמה אישית, צריך להגדיר אותו כדי שיהיה זמין למדיניות הארגון בארגון. כדי להגדיר אילוץ בהתאמה אישית, משתמשים בפקודה gcloud org-policies set-custom-constraint:

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

מחליפים את CONSTRAINT_PATH בנתיב המלא לקובץ האילוצים המותאמים אישית. לדוגמה, /home/user/customconstraint.yaml.

אחרי שהפעולה הזו תושלם, האילוצים המותאמים אישית יהיו זמינים כמדיניות ארגונית ברשימת Google Cloud מדיניות הארגון.

3. כדי לוודא שהאילוץ המותאם אישית קיים, משתמשים בפקודה gcloud org-policies list-custom-constraints:

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

מחליפים את ORGANIZATION_ID במזהה של משאב הארגון.

למידע נוסף על מדיניות הארגון

אכיפה של מדיניות ארגון בהתאמה אישית

כדי לאכוף אילוץ, יוצרים מדיניות ארגון שמפנה אליו, ואז מחילים את מדיניות הארגון הזו על משאב Google Cloud .

המסוף

1. נכנסים לדף Organization policies במסוף Google Cloud .

   אל מדיניות הארגון

2. בתפריט לבחירת פרויקט, בוחרים את הפרויקט שרוצים להגדיר לו את מדיניות הארגון.
3. מהרשימה בדף מדיניות הארגון, בוחרים את האילוץ כדי לראות את הדף פרטי המדיניות של האילוץ הזה.
4. כדי להגדיר את מדיניות הארגון עבור המשאב הזה, לוחצים על ניהול מדיניות.
5. בדף עריכת מדיניות, בוחרים באפשרות במקום המדיניות של המשאב הראשי.
6. לוחצים על Add a rule.
7. בקטע Enforcement (אכיפה), בוחרים אם מדיניות הארגון הזו נאכפת או לא.
8. אופציונלי: כדי להגדיר את מדיניות הארגון כתלויה בתג, לוחצים על הוספת תנאי. הערה: אם מוסיפים כלל מותנה למדיניות ארגון, צריך להוסיף לפחות כלל לא מותנה אחד, אחרת אי אפשר לשמור את המדיניות. מידע נוסף זמין במאמר בנושא הגדרת היקף של מדיניות הארגון באמצעות תגים.
9. כדי לסיים ולהחיל את מדיניות הארגון, לוחצים על הגדרת מדיניות. המדיניות תיכנס לתוקף תוך 15 דקות לכל היותר.

gcloud

1. כדי ליצור מדיניות ארגונית עם כללים בוליאניים, יוצרים קובץ YAML של מדיניות שמפנה לאילוץ:

name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
spec:
  rules:
  - enforce: true

מחליפים את מה שכתוב בשדות הבאים:

• ‫PROJECT_ID: הפרויקט שבו רוצים לאכוף את האילוץ.
• ‫CONSTRAINT_NAME: שם האילוץ שרוצים לאכוף. לדוגמה, alertDocHasProject.
2. כדי לאכוף את מדיניות הארגון שמכילה את האילוץ, מריצים את הפקודה הבאה:

gcloud org-policies set-policy POLICY_PATH

מחליפים את POLICY_PATH בנתיב המלא לקובץ ה-YAML של מדיניות הארגון. המדיניות תיכנס לתוקף תוך 15 דקות לכל היותר.

בדיקה של מדיניות הארגון המותאמת אישית

בדוגמה הבאה נוצרת אילוץ ומדיניות בהתאמה אישית שבודקים אם בתיעוד של מדיניות התראות מוזכר שם הפרויקט.

לפני שמתחילים, מחליפים את הערכים הבאים:

• ‫ORGANIZATION_ID: המזהה המספרי הייחודי של הארגון. מידע על קבלת המזהה הזה זמין במאמר איך מוצאים את מזהה הארגון.
• ‫PROJECT_ID: מזהה הפרויקט.

יצירת האילוץ

1. שומרים את הקובץ הבא בשם constraint-alert-doc-has-project.yaml:

   actionType: DENY
   condition: resource.documentation.content.contains('${resource.project}')
   description: Requires documentation to include the project name.
   displayName: Alerting policy documentation must include the project name.
   methodTypes:
     - CREATE
     - UPDATE
   name: organizations/ORGANIZATION_ID/customConstraints/custom.alertDocHasProject
   resourceTypes:
     - monitoring.googleapis.com/AlertPolicy
   

   מחליפים את ORGANIZATION_ID במזהה הארגון.

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

2. מחילים את האילוץ:

   gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml
   

3. מוודאים שהאילוץ קיים:

   gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
   

   הפלט אמור להיראות כך:

   CUSTOM_CONSTRAINT: custom.alertDocHasProject
   ACTION_TYPE: DENY
   METHOD_TYPES: CREATE,UPDATE
   RESOURCE_TYPES: monitoring.googleapis.com/AlertPolicy
   DISPLAY_NAME: Alerting policy documentation must include the project name.
   

יצירת המדיניות

1. שומרים את הקובץ הבא בשם policy-alert-doc-has-project.yaml:

   name: projects/PROJECT_ID/policies/custom.alertDocHasProject
   spec:
     rules:
     - enforce: true
   

   מחליפים את PROJECT_ID במזהה הפרויקט.

2. החלת המדיניות:

   gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml
   

3. מוודאים שהמדיניות קיימת:

   gcloud org-policies list --project=PROJECT_ID
   

   הפלט אמור להיראות כך:

   CONSTRAINT: custom.alertDocHasProject
   LIST_POLICY: -
   BOOLEAN_POLICY: SET
   ETAG: CKSx5LwGEPjBuKwD-
   

אחרי שמחילים את המדיניות, מחכים כשתי דקות עד ש- Google Cloud יתחיל לאכוף את המדיניות.

בדיקת המדיניות

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

gcloud monitoring policies create \
  --display-name="CPU Utilization - 5% Threshold" \
  --project=PROJECT_ID \
  --condition-display-name="Condition 1" \
  --condition-filter='resource.type="gce_instance" AND metric.type="compute.googleapis.com/instance/cpu/utilization"' \
  --duration='60s' \
  --if='>5' \
  --combiner='AND' \
  --documentation='The ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} has exceeded 5% for over 60 seconds.'

מחליפים את PROJECT_ID במזהה הפרויקט.

הפלט שיתקבל:

Operation denied by custom org policies: ["customConstraints/alertDocHasProject": "Alerting policy documentation must include the project name."]

דוגמאות למדיניות ארגונית מותאמת אישית לתרחישים נפוצים

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

תיאור	תחביר של מגבלות
למדיניות התראות יכול להיות רק תנאי אחד	actionType: DENY condition: "resource.conditions.size() > 1" description: Requires alerting policies to have only one condition. displayName: Alerting policies must have only one condition methodTypes: - CREATE - UPDATE name: organizations/ORGANIZATION_ID/customConstraints/custom.oneCondition resourceTypes: - monitoring.googleapis.com/AlertPolicy
בכללי מדיניות להתראות צריך להשתמש לפחות בשני ערוצי התראות	actionType: DENY condition: "resource.notificationChannels.size() < 2" description: Alerting policies must use at least two notification channels. displayName: Policies must have a backup notification channel methodTypes: - CREATE - UPDATE name: organizations/ORGANIZATION_ID/customConstraints/custom.alertOnTwoChannels resourceTypes: - monitoring.googleapis.com/AlertPolicy
אפשר להשתמש רק בערוצי התראות באימייל	actionType: DENY condition: "resource.type != 'email'" description: Requires notification channels to use only the email channel type. displayName: Always use email for notification channels methodTypes: - CREATE - UPDATE name: organizations/ORGANIZATION_ID/customConstraints/custom.emailChannelsOnly resourceTypes: - monitoring.googleapis.com/NotificationChannel
התזכורת צריכה להיות לזמן של פחות משעה	actionType: DENY condition: "int(resource.interval.endTime) > int(resource.interval.startTime) + 3600" description: Requires snoozes to be under 1 hour. displayName: Snoozes must be less than 1 hour methodTypes: - CREATE - UPDATE name: organizations/ORGANIZATION_ID/customConstraints/custom.setMaxSnooze resourceTypes: - monitoring.googleapis.com/Snooze

המאמרים הבאים

• מידע נוסף על שירות מדיניות הארגון
• מידע נוסף על יצירה וניהול של מדיניות הארגון
• רשימה מלאה של אילוצים של מדיניות הארגון