הגדרת האופרטור Cluster Services for OpenShift Telemetry

במאמר הזה מוסבר איך להתקין את האופרטור Cluster Services for OpenShift Telemetry ולהגדיר אותו כך שיתחבר לאשכול OpenShift שפועל במכונה של Compute Engine.

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

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

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

הפעלת הגישה ל-Cloud APIs

ב-Compute Engine מומלץ להגדיר את המכונות כך שיאפשרו את כל היקפי הגישה לכל ממשקי ה-Cloud API, ולהשתמש רק בהרשאות ה-IAM של חשבון השירות של המכונה כדי לשלוט בגישה למשאביGoogle Cloud . מידע נוסף מופיע במאמר יצירת מכונה וירטואלית שמשתמשת בחשבון שירות שמנוהל על ידי משתמש.

אם אתם מגבילים את הגישה ל-Cloud APIs, האופרטור Cluster Services for OpenShift Telemetry דורש לפחות את היקפי הגישה הבאים ל-Cloud APIs במכונה המארחת:

https://www.googleapis.com/auth/cloud-platform

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

אם אתם מריצים אשכול OpenShift במכונה שאין לה כתובת IP חיצונית, אתם צריכים להפעיל את התכונה גישה פרטית ל-Google ברשת המשנה של המכונה כדי שהאופרטור Cluster Services for OpenShift Telemetry יוכל לגשת ל-Google APIs ולשירותים של Google. במאמר הגדרת גישה פרטית ל-Google מוסבר איך מפעילים את הגישה הפרטית ל-Google.

אימות משתמשים באשכול OpenShift

כדי לבצע פעולות ניהול, אתם או המשתמשים שלכם צריכים לאמת את אשכול OpenShift באמצעות ה-CLI של OpenShift. כדי לאמת משתמשים באשכול OpenShift, אתם יכולים לבחור מבין האפשרויות הבאות:

  • מריצים את הפקודה הבאה ופועלים לפי ההנחיות:

    oc login "https://api.CLUSTER_DOMAIN:6443" -u kubeadmin
    
  • אפשר גם לקבל אסימון אימות של סשן לשימוש עם הקובץ הבינארי oc. כדי לקבל את האסימון הזה, פותחים את כתובת ה-URL הבאה בדפדפן אינטרנט:

    https://oauth-openshift.apps.CLUSTER_DOMAIN/oauth/token/request
    

מחליפים את CLUSTER_DOMAIN בדומיין של אשכול OpenShift. לדוגמה: mycluster.google.com.

אימות המפעיל ב- Google Cloud

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

כדי לאמת את מפעיל הטלמטריה כחשבון השירות, אתם יכולים להשתמש באפשרויות הבאות:

אימות המפעיל באמצעות איחוד שירותי אימות הזהות של עומסי עבודה

כדי לאמת את מפעיל הטלמטריה כחשבון השירות באמצעות איחוד שירותי אימות הזהות של עומסי עבודה, מבצעים את השלבים הבאים:

  1. בטרמינל, מחלצים את המניפסט CredentialsRequest מחבילת המפעיל של הטלמטריה לספרייה מקומית:

    mkdir -p credrequests
    oc image extract us-docker.pkg.dev/workload-agent-products/cluster-services-for-openshift-telemetry/bundle:VERSION --path /manifests/:./credrequests --confirm
    

    מחליפים את VERSION במספר הגרסה של המפעיל הטלמטרי שנרשמתם אליה ב-OperatorHub. אתם יכולים לראות את רשימת מספרי הגרסאות המאושרות של מפעיל הטלמטריה בקטלוג Red Hat Ecosystem.

  2. באמצעות הכלי ccoctl, מעבדים את המניפסט של CredentialsRequest שחולץ ומקצים את פרטי הכניסה והקישורים של Google Cloud ניהול הזהויות והרשאות הגישה (IAM):

    • (מומלץ) ל-OpenShift בגרסה 4.22 ואילך:

      מומלץ מאוד להשתמש ב-OpenShift בגרסה 4.22 ואילך עם הדגל --key-storage-method=pool-jwk-file כדי לאחסן את קבוצת מפתחות האינטרנט של JSON‏ (JWKS) של האשכול ישירות בספק של מאגר הזהויות של עומסי העבודה, וכך להימנע מיצירת קטגוריה של Cloud Storage:

      ccoctl gcp create-all \
        --name=NAME \
        --region=REGION \
        --project=PROJECT_ID \
        --credentials-requests-dir=./credrequests \
        --output-dir=./ccoctl-out \
        --key-storage-method=pool-jwk-file
      
    • בגרסאות OpenShift‏ 4.18 עד 4.21:

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

      ccoctl gcp create-all \
        --name=NAME \
        --region=REGION \
        --project=PROJECT_ID \
        --credentials-requests-dir=./credrequests \
        --output-dir=./ccoctl-out
      

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

    • ‫NAME: שם לפרטי הכניסה ולמשאבים שנוצרו על ידי הכלי ccoctl. מומלץ מאוד לציין שם ייחודי ואקראי מאוד (למשל, לכלול סיומת אלפאנומרית אקראית) לאשכול או לארגון.
    • ‫REGION: האזור ב-Compute Engine שבו פועל אשכול OpenShift
    • ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud שבו פועל אשכול OpenShift
  3. מחילים על האשכול את ספק OpenID Connect (OIDC), את תפקידי ה-IAM ואת המניפסטים של הסודות שנוצרו:

    oc apply -f ./ccoctl-out/manifests/
    

בשלבים הקודמים נוצר חשבון שירות בפרויקט ב- Google Cloud , והוקצו לו תפקידי ה-IAM הבאים:

אימות של מפעיל באמצעות מפתח של חשבון שירות

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

כדי לאמת את מפעיל הטלמטריה כחשבון השירות באמצעות מפתח של חשבון שירות, מבצעים את השלבים הבאים:

  1. בטרמינל, מחלצים את המניפסט CredentialsRequest מחבילת המפעיל של הטלמטריה לספרייה מקומית:

    mkdir -p credrequests
    oc image extract us-docker.pkg.dev/workload-agent-products/cluster-services-for-openshift-telemetry/bundle:VERSION --path /manifests/:./credrequests --confirm
    
  2. בפרויקט ב- Google Cloud , יוצרים חשבון שירות למפעיל הטלמטריה:

    gcloud iam service-accounts create cso-telemetry-agent \
      --description="Service account for OpenShift Telemetry Operator" \
      --display-name="CSO Telemetry Agent" \
      --project=PROJECT_ID
    

    מחליפים את PROJECT_ID במזהה הפרויקט ב-Google Cloud שבו פועל אשכול OpenShift.

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

    מריצים את הפקודה הבאה לכל תפקיד ב-IAM שמוגדר במניפסט:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member="serviceAccount:cso-telemetry-agent@PROJECT_ID." \
      --role="IAM_ROLE"
    

    מחליפים את IAM_ROLE בתפקיד ב-IAM שרוצים להקצות לחשבון השירות.

  4. יוצרים ומורידים מפתח פרטי לחשבון השירות:

    gcloud iam service-accounts keys create ./sa_key.json \
      --iam-account=cso-telemetry-agent@PROJECT_ID. \
      --project=PROJECT_ID
    
  5. במרחב השמות openshift-operators, יוצרים סוד בשם telemetry-agent-sa למפתח של חשבון השירות שיצרתם:

    oc create secret generic telemetry-agent-sa \
      --from-file=workload_agent_sa_key.json=./sa_key.json \
      -n openshift-operators
    

התקנת האופרטור Cluster Services for OpenShift Telemetry

אתם יכולים להתקין את האופרטור Cluster Services for OpenShift Telemetry באמצעות מסוף האינטרנט של Red Hat OpenShift Container Platform או באמצעות מניפסטים של YAML למינויים הצהרתיים. למידע נוסף על האפשרויות האלה, קראו את המאמר הוספת אופרטורים לאשכול של Red Hat.

מסוף האינטרנט של OpenShift

כדי להתקין את אופרטור הטלמטריה באשכול OpenShift באמצעות מסוף האינטרנט של OpenShift Container Platform, מבצעים את השלבים הבאים:

  1. נכנסים למסוף האינטרנט של Red Hat OpenShift.
  2. מוודאים שנמצאים בתצוגת Administrator.
  3. בחלונית הניווט הימנית, מרחיבים את הקטע Operators ולוחצים על OperatorHub.
  4. בשורת החיפוש, בקטע All items, מקלידים Cluster Services for OpenShift Telemetry.

    אפשר גם לחפש את Google. כך מסננים את האופרטורים ש-Google מספקת, כולל האופרטור Cluster Services for OpenShift Telemetry.

  5. לוחצים על הכרטיס Cluster Services for OpenShift Telemetry.

  6. בחלונית Cluster Services for OpenShift Telemetry, לוחצים על Install.

  7. בדף Install Operator, מבצעים את הפעולות הבאות:

    1. בשדה Update channel, בוחרים באפשרות stable.
    2. בשדה Installation mode, בוחרים באפשרות A specific namespace on the cluster.
    3. בשדה Installed Namespace, בוחרים את הפרויקט openshift-operators או יוצרים מרחב שמות מותאם אישית למעקב.
    4. בשדה שיטת אישור, בוחרים באפשרות אוטומטית או ידנית.
    5. לוחצים על התקנה.
  8. כדי לוודא שהאופרטור הותקן בהצלחה, מבצעים את השלבים הבאים:

    1. עוברים אל Operators > Installed Operators.
    2. ברשימת האופרטורים, מחפשים את האופרטור Cluster Services for OpenShift Telemetry ומוודאים שהוא מופיע.
    3. מוודאים שבעמודה Status מופיע הערך Succeeded או Up to date.
    4. אם רוצים, לוחצים על המפעיל כדי לראות את הפרטים שלו.

OpenShift CLI

כדי להתקין את מפעיל הטלמטריה באשכול OpenShift באמצעות OpenShift CLI ומניפסט Subscription YAML הצהרתי, מבצעים את השלבים הבאים:

  1. יוצרים מניפסט של משאב מותאם אישית של Subscription בשם subscription.yaml עם ההגדרות הבאות:

    apiVersion: operators.coreos.com/v1alpha1
    kind: Subscription
    metadata:
      name: google-cloud-cluster-services-for-openshift-telemetry
      namespace: openshift-operators
    spec:
      channel: stable
      installPlanApproval: Automatic
      name: google-cloud-cluster-services-for-openshift-telemetry
      source: certified-operators
      sourceNamespace: openshift-marketplace
    
  2. מחילים את המינוי על האשכול:

    oc apply -f subscription.yaml
    
  3. כדי לוודא שהמפעיל של הטלמטריה הותקן בהצלחה, בודקים את הסטטוס של ClusterServiceVersion:

    oc get csv -n openshift-operators
    

    בפלט, מוודאים שהערך בעמודה PHASE של cluster-services-for-openshift-telemetry הוא Succeeded.

הגבלת הספק של איחוד שירותי אימות הזהות של עומסי עבודה

אם הגדרתם את איחוד שירותי אימות הזהות של עומסי עבודה ב-OpenShift בגרסאות 4.18 עד 4.21 בלי הדגל --key-storage-method=pool-jwk-file, האשכול שלכם משתמש בקטגוריה של Cloud Storage כדי לארח את הגדרת ה-OIDC שלו. אחרי שמתקינים את האופרטור Cluster Services for OpenShift Telemetry, צריך לבצע את השלבים הבאים כדי להגביל את ספק מאגר הזהויות של עומסי העבודה למזהה הייחודי של חשבון השירות הספציפי של האשכול:

  1. מאחזרים את המזהה הייחודי (uid) של חשבון השירות של מפעיל הטלמטריה ב-Kubernetes במרחב השמות openshift-operators:

    KSA_UID=$(oc get serviceaccount google-cloud-cluster-services-telemetry-agent-workloadagent-service-account \
      -n openshift-operators \
      -o jsonpath='{.metadata.uid}')
    
  2. מעדכנים את הספק של מאגר הזהויות של עומסי העבודה עם תנאי מאפיין שמצמיד את החלפת האסימון למזהה הייחודי של חשבון השירות שאוחזר:

    gcloud iam workload-identity-pools providers update-oidc PROVIDER_ID \
      --location="global" \
      --workload-identity-pool="POOL_ID" \
      --project="PROJECT_ID" \
      --attribute-condition="assertion['kubernetes.io']['serviceaccount']['uid']=='${KSA_UID}'"
    

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

    • ‫PROVIDER_ID: מזהה הספק של מאגר הזהויות של עומסי העבודה שנוצר על ידי הכלי ccoctl (תואם ל-NAME מהפקודה ccoctl gcp create-all)
    • ‫POOL_ID: המזהה של מאגר הזהויות של עומסי העבודה שנוצר על ידי הכלי ccoctl (תואם ל-NAME מהפקודה ccoctl gcp create-all)
    • ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud שבו פועל אשכול OpenShift

אם חשבון השירות או המפעיל של google-cloud-cluster-services-telemetry-agent-workloadagent-service-account נמחקים ונוצרים מחדש באשכול, נוצר מזהה UID חדש וצריך להריץ מחדש את הפקודה update-oidc עם מזהה ה-UID החדש.

הפעלת איסוף המדדים

כדי לאפשר לאופרטור לאסוף מדדים מאשכול OpenShift, צריך להחיל משאב מותאם אישית של TelemetryConfig. המשאב הזה פורס פודים של דימון (daemon) בצומתי האשכול של Agent for Compute Workloads.

כדי לאפשר לאופרטור לאסוף מדדים מאשכול OpenShift, מבצעים את הפעולות הבאות:

  1. יוצרים מניפסט של משאב בהתאמה אישית של TelemetryConfig בשם telemetryconfig.yaml:

    • אם הגדרתם אימות למפעיל הטלמטריה באמצעות איחוד שירותי אימות הזהות של עומסי עבודה, השתמשו במשאב המינימלי הבא בהתאמה אישית. המשאב המותאם אישית הזה מאחזר באופן אוטומטי את פרטי הכניסה שמאוחסנים בסוד google-cloud-cluster-services-telemetry-agent-wif-secret.

      apiVersion: cluster-services-openshift.cloud.google.com/v1alpha1
      kind: TelemetryConfig
      metadata:
        name: telemetryconfig
        namespace: openshift-operators
      spec:
        enabled: true
      
    • אם הגדרתם אימות למפעיל הטלמטריה באמצעות מפתח של חשבון שירות, השתמשו במשאב הבא בהתאמה אישית:

      apiVersion: cluster-services-openshift.cloud.google.com/v1alpha1
      kind: TelemetryConfig
      metadata:
        name: telemetryconfig
        namespace: openshift-operators
      spec:
        enabled: true
        serviceAccountCredentialsSecretName: telemetry-agent-sa
        serviceAccountCredentialsPath: SERVICE_ACCOUNT_KEY_PATH
      

      מחליפים את SERVICE_ACCOUNT_KEY_PATH בנתיב שבו טענתם את המפתח של חשבון השירות. שם נקודת הטעינה צריך להיות זהה לשם של קובץ ה-JSON של מפתח חשבון השירות. לדוגמה: /var/run/secrets/google/workload_agent_sa_key.json.

  2. מחילים את המשאב בהתאמה אישית על האשכול:

    oc apply -f telemetryconfig.yaml
    
  3. מוודאים שהסטטוס של pod סוכן הטלמטריה הוא Running:

    oc get pods -n openshift-operators -l app.kubernetes.io/name=workloadagent-operator
    

    אפשר גם לבדוק את איסוף המדדים באמצעות בדיקת היומנים של ה-pod:

    "openshiftmetrics/openshiftmetrics.go:126","msg":"Metric payload after collection","pid":5,"context":"OpenShiftMetricCollection","payload":"version:\"v0.1.0-pre\" agent_version:\"1.3\"

הצגת יומני המפעילים ב-Cloud Logging

כברירת מחדל, היומנים מהאופרטור Cluster Services for OpenShift Telemetry נשלחים ל-Cloud Logging. אתם יכולים לצפות ביומנים האלה ב-Logging. כדי לראות את יומני המפעיל ב-Logging, מבצעים את הפעולות הבאות:

  1. נכנסים לדף Logs Explorer במסוף Google Cloud .

    כניסה לדף Logs Explorer

  2. בחלונית השאילתה, מזינים שאילתה:

    • כדי לסנן את היומנים של פרויקט Google Cloud , משתמשים בשאילתה הבאה:

      logName="projects/PROJECT_ID/logs/google-cloud-workload-agent"

      מחליפים את PROJECT_ID במזהה הפרויקט של הפרויקט ב-Google Cloud שבו פועל אשכול OpenShift.

    • אם אתם מריצים כמה אשכולות בפרויקט ב- Google Cloud ורוצים לסנן את היומנים מאשכול ספציפי, אתם יכולים להשתמש בשאילתה הבאה:

      resource.labels.instance_id=("COMPUTE_INSTANCE_ID_1" OR "COMPUTE_INSTANCE_ID_2" OR "COMPUTE_INSTANCE_ID_3")

      מחליפים את COMPUTE_INSTANCE_ID ב-Instance ID של המכונות ב-Compute Engine שמריצות את אשכול OpenShift. במאמר הצגת הפרטים של מכונה וירטואלית מוסבר איך למצוא את מזהה המכונה.

  3. לוחצים על Run query.

הגדרת מדיניות התראות שמבוססות על יומנים

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

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

  1. מוודאים שעמדתם בדרישות המוקדמות שמפורטות בקטע "לפני שמתחילים" במאמר הגדרת מדיניות התראות מבוססות-יומנים.

  2. נכנסים לדף Logs Explorer במסוף Google Cloud .

    כניסה לדף Logs Explorer

  3. בחלונית השאילתה, מזינים את השאילתה הנדרשת:

    logName="projects/PROJECT_ID/logs/google-cloud-workload-agent"
    severity=SEVERITY_LEVEL

    מחליפים את SEVERITY_LEVEL בערך נתמך של רמת חומרה, כולל: DEBUG,‏ INFO,‏ WARNING ו-ERROR. מומלץ להשתמש בערך ERROR או בערך גבוה יותר של רמת היומן.

  4. לוחצים על Run query כדי לאמת את השאילתה.

  5. ליצור התראה ביומן.

    כדי ללמוד איך ליצור את ההתראה הזו, קראו את שלב 3 בתהליך שמתואר במאמר יצירת מדיניות התראות מבוססת-יומנים באמצעות Logs Explorer.

אופציונלי: הפעלת הערכות ספציפיות לסביבת הייצור

חלק מהשיטות המומלצות שהכלי לניהול עומס העבודה תומך בהן לאשכולות OpenShift חלות רק על סביבות ייצור. כדי להבחין בין הסביבות, הכלי לניהול עומס העבודה בודק אם באשכול, בפריסה או ב-pod יש את התווית environment. אם הערך שמשויך לתווית הזו הוא production, הכלי לניהול עומס העבודה מתייחס למשאב הזה כמשאב ייצור.

כדי להודיע לכלי לניהול עומסי העבודה שאשכול שייך לסביבת ייצור, מבצעים את השלבים הבאים:

  1. יוצרים מרחב שמות של workloadmanager:

    oc create namespace workloadmanager
    
  2. יוצרים ConfigMap במרחב השמות workloadmanager באמצעות ההגדרות הבאות:

    apiVersion: v1
    kind: ConfigMap
    metadata:
      name: wlm-cluster-environment
      namespace: workloadmanager
    data:
      # Options: "production" or "non-production"
      environment: "production"
    

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

  • מגדירים ידנית את ההגדרות הבאות:

    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: my-app
      labels:
        # Options: "production" or "non-production"
        environment: "production"
    spec:
    ...
    
  • מריצים את הפקודה הבאה:

    oc label --overwrite deployments DEPLOYMENT_NAME environment=production
    

    מחליפים את DEPLOYMENT_NAME בשם של הפריסה.

אם מוסיפים את התווית environment לאשכול OpenShift וגם לפריסה או לפוד שפועלים באשכול, הכלי לניהול עומס העבודה נותן עדיפות לערך התווית שמוגדר לפריסה או לפוד על פני ערך התווית שמוגדר לאשכול.

אופציונלי: הפעלת איסוף מדדים

אחרי שמגדירים את האופרטור Cluster Services for OpenShift Telemetry באשכול OpenShift, האופרטור אוסף מדדים מהאשכול ושולח אותם לכלי לניהול עומס העבודה כל 30 דקות.

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

כדי להפעיל באופן ידני את האופרטור לאיסוף מדדים:

  1. פותחים את הטרמינל.

  2. מוצאים את השם של ה-pod שפועל:

    POD_NAME=$(oc get pods -l app.kubernetes.io/name=workloadagent-operator --field-selector=status.phase=Running -o=name)
    
  3. מפעילים את האופרטור כדי לאסוף ולשלוח מדדים:

    oc debug -t $POD_NAME -- /openshift-docker-entrypoint.sh
    

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