ציון הגדרות אישיות שיחליפו את הגדרות ברירת המחדל
בתוכנת ההתקנה של Apigee Hybrid יש הרבה הגדרות שמוגדרות כברירת מחדל. עם זאת, יש כמה הגדרות שאין להן ערכי ברירת מחדל. צריך להזין ערכים בהגדרות האלה, כמו שמוסבר בהמשך.
לפני שמתחילים
מומלץ לבדוק את התרחישים הבאים כדי להחליט אם אתם רוצים להגדיר את האשכול בהתאם. ההגדרות האלה הן אופציונליות.
- אם אתם מתכננים להתקין את Apigee Hybrid בכמה אזורים, קראו את המאמר פריסה בכמה אזורים לפני שתמשיכו.
- ב-Apigee Hybrid יש סיסמאות שמוגדרות כברירת מחדל למשתמשי Cassandra. Apigee ממליצה לשנות את סיסמאות ברירת המחדל של המשתמשים. למידע נוסף, ראו הגדרת TLS ל-Cassandra.
- כדי לקבוע את הגדרות האחסון וה-heap של Cassandra, קראו את המאמר קביעת הגדרות האחסון וה-heap.
- כפי שמתואר בחלק 1: הגדרת פרויקט וארגון – שלב 1: הפעלת ממשקי API, בתרחישים של התקנה בסביבת ייצור, צריך להגדיר אחסון בכונן SSD קבוע בשביל Cassandra. ב-Apigee אין תמיכה בשימוש בכונני SSD מקומיים ל-Apigee Hybrid. לפרטים נוספים, קראו את המאמר הוספת אחסון SSD לפריסות בסביבת ייצור.
הגדרת האשכול
מקובל לכתוב את ההגדרות האישיות שמחליפות את ברירת המחדל בקובץ בשם overrides.yaml, שבדרך כלל מאוחסן בספרייה $APIGEE_HELM_CHARTS_HOME.
- יוצרים קובץ חדש בשם
overrides.yamlבספרייה$APIGEE_HELM_CHARTS_HOME.overrides.yamlמספק את ההגדרות להתקנה הייחודית של Apigee Hybrid. קובץ ההגדרות החלופיות בשלב הזה מספק הגדרה בסיסית להתקנה של סביבת זמן ריצה היברידית עם טביעת רגל קטנה, שמתאימה להתקנה הראשונה. - ב-
overrides.yaml, מוסיפים את ערכי המאפיינים הנדרשים שמוצגים בהמשך. בהמשך מופיע תיאור מפורט של כל מאפיין.חשוב לוודא שהמבנה והתחביר של הקובץ
overrides.yamlתואמים לדוגמה הבאה.בוחרים את הכרטיסייה של סוג האימות של חשבון השירות שבו אתם משתמשים בהתקנה: שלב 4: יצירת חשבונות שירות.
- מפתחות של חשבונות שירות בסודות של Kubernetes: סודות של Kubernetes
- קובצי מפתחות JSON של חשבונות שירות: קובצי JSON
- מפתחות של חשבונות שירות ב-Vault: Vault
- איחוד זהויות של עומסי עבודה ל-GKE: WIF ל-GKE
- איחוד שירותי אימות הזהות של עומסי עבודה: WIF בפלטפורמות אחרות
לסקירה כללית של אפשרויות האימות השונות, ראו שיטות אימות של חשבון שירות ב-Apigee hybrid.
בוחרים את הכרטיסייה של ההתקנה, הייצור, Production או לא-ייצור (התקנות של הדגמה, הערכה או הוכחת היתכנות), Non-prod בהתאם לבחירה שלכם בשלב 4: יצירת חשבונות שירות.
להתקנות בסביבות ייצור, עיינו בדרישות האחסון של מסד הנתונים של Cassandra במאמר הגדרת Cassandra לייצור.
סודות של Kubernetes
ייצור
תבנית
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_SECRET # For example: "apigee-synchronizer-svc-account" runtime: RUNTIME_SERVICE_ACCOUNT_SECRET # For example: "apigee-runtime-svc-account" udca: UDCA_SERVICE_ACCOUNT_SECRET # For example: "apigee-udca-svc-account" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET # For example: "apigee-mart-svc-account" connectAgent: serviceAccountRef: MART_SERVICE_ACCOUNT_SECRET # Use the same secret for mart and connectAgent # For example: "apigee-mart-svc-account" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountRef: LOGGER_SERVICE_ACCOUNT_SECRET # For example: "apigee-logger-svc-account" metrics: serviceAccountRef: METRICS_SERVICE_ACCOUNT_SECRET # For example: "apigee-metrics-svc-account" udca: serviceAccountRef: UDCA_SERVICE_ACCOUNT_SECRET # For example: "apigee-udca-svc-account" watcher: serviceAccountRef: WATCHER_SERVICE_ACCOUNT_SECRET # For example: "apigee-watcher-svc-account" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_SECRET # For example: "apigee-mint-task-scheduler-svc-account" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
SECRETהשם של הסוד ב-Kubernetes שיצרתם למפתח של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
apigee-cassandra-svc-accountapigee-logger-svc-accountapigee-mart-svc-accountapigee-metrics-svc-accountapigee-mint-task-scheduler-svc-accountapigee-runtime-svc-accountapigee-synchronizer-svc-accountapigee-udca-svc-accountapigee-watcher-svc-account
לא בסביבת ייצור
apigee-non-prod-svc-account
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretRefs: synchronizer: "apigee-synchronizer-svc-account" runtime: "apigee-runtime-svc-account" udca: "apigee-udca-svc-account" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "apigee-mart-svc-account" connectAgent: serviceAccountRef: "apigee-mart-svc-account" logger: enabled: true serviceAccountRef: "apigee-logger-svc-account" metrics: serviceAccountRef: "apigee-metrics-svc-account" udca: serviceAccountRef: "apigee-udca-svc-account" watcher: serviceAccountRef: "apigee-watcher-svc-account" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountRef: apigee-mint-task-scheduler-svc-account # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
SECRETהשם של הסוד ב-Kubernetes שיצרתם למפתח של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
apigee-cassandra-svc-accountapigee-logger-svc-accountapigee-mart-svc-accountapigee-metrics-svc-accountapigee-mint-task-scheduler-svc-accountapigee-runtime-svc-accountapigee-synchronizer-svc-accountapigee-udca-svc-accountapigee-watcher-svc-account
לא בסביבת ייצור
apigee-non-prod-svc-account
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
לא בסביבת ייצור
תבנית
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" runtime: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" udca: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" connectAgent: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # Use the same secret for mart and connectAgent # For example: "apigee-non-prod-svc-account" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" metrics: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" udca: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" watcher: serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: NON_PROD_SERVICE_ACCOUNT_SECRET # For example: "apigee-non-prod-svc-account" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
SECRETהשם של הסוד ב-Kubernetes שיצרתם למפתח של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
apigee-cassandra-svc-accountapigee-logger-svc-accountapigee-mart-svc-accountapigee-metrics-svc-accountapigee-mint-task-scheduler-svc-accountapigee-runtime-svc-accountapigee-synchronizer-svc-accountapigee-udca-svc-accountapigee-watcher-svc-account
לא בסביבת ייצור
apigee-non-prod-svc-account
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretRefs: synchronizer: "apigee-non-prod-svc-account" runtime: "apigee-non-prod-svc-account" udca: "apigee-non-prod-svc-account" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "apigee-non-prod-svc-account" connectAgent: serviceAccountRef: "apigee-non-prod-svc-account" logger: enabled: true serviceAccountRef: "apigee-non-prod-svc-account" metrics: serviceAccountRef: "apigee-non-prod-svc-account" udca: serviceAccountRef: "apigee-non-prod-svc-account" watcher: serviceAccountRef: "apigee-non-prod-svc-account" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountRef: apigee-non-prod-svc-account # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
SECRETהשם של הסוד ב-Kubernetes שיצרתם למפתח של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
apigee-cassandra-svc-accountapigee-logger-svc-accountapigee-mart-svc-accountapigee-metrics-svc-accountapigee-mint-task-scheduler-svc-accountapigee-runtime-svc-accountapigee-synchronizer-svc-accountapigee-udca-svc-accountapigee-watcher-svc-account
לא בסביבת ייצור
apigee-non-prod-svc-account
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
קובצי JSON
ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-synchronizer.json" runtime: RUNTIME_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-runtime.json" udca: UDCA_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-udca.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountPath: LOGGER_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-F chart directory. # For example: "PROJECT_ID-apigee-logger.json" mart: serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-mart.json" connectAgent: serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-mart.json" metrics: serviceAccountPath: METRICS_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-metrics.json" udca: serviceAccountPath: UDCA_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-udca.json" watcher: serviceAccountPath: WATCHER_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-watcher.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-mint-task-scheduler.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
FILEPATHהנתיב ושם הקובץ של קובצי ה-JSON של חשבון השירות בספריית התרשים התואמת. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה: - אם הקובץ
my-project-apigee-synchronizer.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
בסביבות שהן לא סביבות ייצור, השם של חשבון השירות היחיד הוא
PROJECT_ID-non-prod.jsonכברירת מחדל.בסביבות ייצור, השם של קובץ המפתח של חשבון השירות שיצרתם באמצעות הכלי
create-service-accountבשלב 4: יצירת חשבונות שירות.אפשר לראות את קובצי חשבון השירות בכל ספריית תרשים תואמת.
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-apigee-cassandra.jsonapigee-datastore/PROJECT_ID-apigee-mart.jsonapigee-org/PROJECT_ID-apigee-metrics.jsonapigee-telemetry/PROJECT_ID-apigee-mint-task-scheduler.jsonapigee-org/PROJECT_ID-apigee-runtime.jsonapigee-env/PROJECT_ID-apigee-synchronizer.jsonapigee-env/PROJECT_ID-apigee-udca.jsonapigee-org/PROJECT_ID-apigee-watcher.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-non-prod.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountPaths: synchronizer: "my-project-apigee-synchronizer.json" runtime: "my-project-apigee-runtime.json" udca: "my-project-apigee-udca.json" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true serviceAccountPath: "my-project-apigee-logger.json" mart: serviceAccountPath: "my-project-apigee-mart.json" connectAgent: serviceAccountPath: "my-project-apigee-mart.json" metrics: serviceAccountPath: "my-project-apigee-metrics.json" udca: serviceAccountPath: "my-project-apigee-udca.json" watcher: serviceAccountPath: "my-project-apigee-watcher.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountPath: my-project-apigee-mint-task-scheduler.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
FILEPATHהנתיב ושם הקובץ של קובצי ה-JSON של חשבון השירות בספריית התרשים התואמת. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה: - אם הקובץ
my-project-apigee-synchronizer.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
בסביבות שהן לא סביבות ייצור, השם של חשבון השירות היחיד הוא
PROJECT_ID-non-prod.jsonכברירת מחדל.בסביבות ייצור, השם של קובץ המפתח של חשבון השירות שיצרתם באמצעות הכלי
create-service-accountבשלב 4: יצירת חשבונות שירות.אפשר לראות את קובצי חשבון השירות בכל ספריית תרשימים תואמת.
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-apigee-cassandra.jsonapigee-datastore/PROJECT_ID-apigee-mart.jsonapigee-org/PROJECT_ID-apigee-metrics.jsonapigee-telemetry/PROJECT_ID-apigee-mint-task-scheduler.jsonapigee-org/PROJECT_ID-apigee-runtime.jsonapigee-env/PROJECT_ID-apigee-synchronizer.jsonapigee-env/PROJECT_ID-apigee-udca.jsonapigee-org/PROJECT_ID-apigee-watcher.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-non-prod.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
לא בסביבת ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: NON_PROD_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-non-prod.json" runtime: NON_PROD_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-non-prod.json" udca: NON_PROD_SERVICE_ACCOUNT_FILEPATH # For example: "PROJECT_ID-apigee-non-prod.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" connectAgent: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-F chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" metrics: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" udca: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" watcher: serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "PROJECT_ID-apigee-non-prod.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
FILEPATHהנתיב ושם הקובץ של קובצי ה-JSON של חשבון השירות בספריית התרשים התואמת. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה: - אם הקובץ
my-project-apigee-synchronizer.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
בסביבות שהן לא סביבות ייצור, השם של חשבון השירות היחיד הוא
PROJECT_ID-non-prod.jsonכברירת מחדל.בסביבות ייצור, השם של קובץ המפתח של חשבון השירות שיצרתם באמצעות הכלי
create-service-accountבשלב 4: יצירת חשבונות שירות.אפשר לראות את קובצי חשבון השירות בכל ספריית תרשים תואמת.
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-apigee-cassandra.jsonapigee-datastore/PROJECT_ID-apigee-mart.jsonapigee-org/PROJECT_ID-apigee-metrics.jsonapigee-telemetry/PROJECT_ID-apigee-mint-task-scheduler.jsonapigee-org/PROJECT_ID-apigee-runtime.jsonapigee-env/PROJECT_ID-apigee-synchronizer.jsonapigee-env/PROJECT_ID-apigee-udca.jsonapigee-org/PROJECT_ID-apigee-watcher.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-non-prod.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountPaths: synchronizer: "hybrid-example-apigee-non-prod.json" runtime: "hybrid-example-apigee-non-prod.json" udca: "hybrid-example-apigee-non-prod.json" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountPath: "my-project-apigee-non-prod.json" connectAgent: serviceAccountPath: "my-project-apigee-non-prod.json" logger: enabled: true serviceAccountPath: "my-project-apigee-non-prod.json" metrics: serviceAccountPath: "my-project-apigee-non-prod.json" udca: serviceAccountPath: "my-project-apigee-non-prod.json" watcher: serviceAccountPath: "my-project-apigee-non-prod.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountPath: my-project-apigee-non-prod.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
FILEPATHהנתיב ושם הקובץ של קובצי ה-JSON של חשבון השירות בספריית התרשים התואמת. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה: - אם הקובץ
my-project-apigee-synchronizer.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
בסביבות שהן לא סביבות ייצור, השם של חשבון השירות היחיד הוא
PROJECT_ID-non-prod.jsonכברירת מחדל.בסביבות ייצור, השם של קובץ המפתח של חשבון השירות שיצרתם באמצעות הכלי
create-service-accountבשלב 4: יצירת חשבונות שירות.אפשר לראות את קובצי חשבון השירות בכל ספריית תרשים תואמת.
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-apigee-cassandra.jsonapigee-datastore/PROJECT_ID-apigee-mart.jsonapigee-org/PROJECT_ID-apigee-metrics.jsonapigee-telemetry/PROJECT_ID-apigee-mint-task-scheduler.jsonapigee-org/PROJECT_ID-apigee-runtime.jsonapigee-env/PROJECT_ID-apigee-synchronizer.jsonapigee-env/PROJECT_ID-apigee-udca.jsonapigee-org/PROJECT_ID-apigee-watcher.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים PROJECT_ID-non-prod.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
Vault
ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:
3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
לא בסביבת ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi
בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # for message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
WIF ל-GKE
ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: true k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME gsa: synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-synchronizer@PROJECT_ID.iam.gserviceaccount.com" runtime: RUNTIME_SERVICE_ACCOUNT_EMAIL # For example: "apigee-runtime@PROJECT_ID.iam.gserviceaccount.com" udca: UDCA_SERVICE_ACCOUNT_EMAIL # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. backup: enabled: true # Required to create the Cassandra Kubernetes service accounts # for Workload Identity Federation for GKE # See Cassandra backup overview. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: gsa: MART_SERVICE_ACCOUNT_EMAIL # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com" connectAgent: gsa: MART_SERVICE_ACCOUNT_EMAIL # Use the same service account email for mart and connectAgent # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com" logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. gsa: LOGGER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-logger@PROJECT_ID.iam.gserviceaccount.com" metrics: gsa: METRICS_SERVICE_ACCOUNT_EMAIL # For example: "apigee-metrics@PROJECT_ID.iam.gserviceaccount.com" udca: gsa: UDCA_SERVICE_ACCOUNT_EMAIL # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com" watcher: gsa: WATCHER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-watcher@PROJECT_ID.iam.gserviceaccount.com" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid gsa: MINT_TASK_SCHEDULER_SERVICE_ACCOUNT_EMAIL # For example: "apigee-mint-task-scheduler@PROJECT_ID.iam.gserviceaccount.com" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
EMAILכתובות האימייל של חשבונות השירות של Google (GSA) שצריך לספק אם משתמשים באיחוד זהויות של עומסי עבודה ל-GKE. אלה חשבונות השירות שיצרתם בשלב 4: יצירת חשבונות שירות. כדי למצוא את כתובות האימייל של חשבונות השירות, אפשר להשתמש בפקודה הבאה: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"למידע נוסף:
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: true k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env gsa: synchronizer: "apigee-synchronizer@my-project.iam.gserviceaccount.com" runtime: "apigee-runtime@my-project.iam.gserviceaccount.com" udca: "apigee-udca@my-project.iam.gserviceaccount.com" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: gsa: "apigee-mart@my-project.iam.gserviceaccount.com" connectAgent: gsa: "apigee-mart@my-project.iam.gserviceaccount.com" logger: enabled: true gsa: "apigee-logger@my-project.iam.gserviceaccount.com" metrics: gsa: "apigee-metrics@my-project.iam.gserviceaccount.com" udca: gsa: "apigee-udca@my-project.iam.gserviceaccount.com" watcher: gsa: "apigee-watcher@my-project.iam.gserviceaccount.com" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountPath: my-project-apigee-mint-task-scheduler.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
SERVICE_ACCOUNT_
EMAILכתובות האימייל של חשבונות השירות של Google (GSA) שצריך לספק אם משתמשים באיחוד זהויות של עומסי עבודה ל-GKE. אלה חשבונות השירות שיצרתם בשלב 4: יצירת חשבונות שירות. כדי למצוא את כתובות האימייל של חשבונות השירות, אפשר להשתמש בפקודה הבאה: gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"למידע נוסף:
לא בסביבת ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: true gsa: "NON_PROD_SERVICE_ACCOUNT_EMAIL" # For example: "apigee-non-prod@PROJECT_ID.iam.gserviceaccount.com" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: true # enabled by default # See apigee-logger in Service accounts and roles used by hybrid components. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.NON_PROD_
SERVICE_ACCOUNT_
EMAILכתובות האימייל של חשבון השירות של Google (GSA) שלא מיועד לסביבת ייצור. זהו חשבון השירות של apigee-non-prodשיצרתם בשלב 4: יצירת חשבונות שירות.אם אתם משתמשים באיחוד זהויות של עומסי עבודה ל-GKE בהתקנה שהיא לא בסביבת ייצור, ציינו את כתובת האימייל של חשבון השירות במאפיין
gcp.workloadIdentity.gsa. לא תצטרכו להוסיף את המאפייןgsaלרכיבים נפרדים.כדי למצוא את כתובות האימייל של חשבונות השירות, אפשר להשתמש בפקודה הבאה:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: true gsa: "apigee-non-prod@my-project.iam.gserviceaccount.com" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: true # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.NON_PROD_
SERVICE_ACCOUNT_
EMAILכתובות האימייל של חשבון השירות של Google (GSA) שלא מיועד לסביבת ייצור. זהו חשבון השירות של apigee-non-prodשיצרתם בשלב 4: יצירת חשבונות שירות.אם אתם משתמשים באיחוד זהויות של עומסי עבודה ל-GKE בהתקנה שהיא לא בסביבת ייצור, ציינו את כתובת האימייל של חשבון השירות במאפיין
gcp.workloadIdentity.gsa. לא תצטרכו להוסיף את המאפייןgsaלרכיבים נפרדים.כדי למצוא את כתובות האימייל של חשבונות השירות, אפשר להשתמש בפקודה הבאה:
gcloud iam service-accounts list \ --project ${PROJECT_ID} \ --filter "apigee"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
WIF בפלטפורמות אחרות
WIF: סודות
ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: SYNCHRONIZER_WORKLOAD_IDENTITY_SECRET # For example: "synchronizer-workload-identity-secret" runtime: RUNTIME_WORKLOAD_IDENTITY_SECRET # For example: "runtime-workload-identity-secret" udca: UDCA_WORKLOAD_IDENTITY_SECRET # For example: "udca-workload-identity-secret" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountRef: MART_WORKLOAD_IDENTITY_SECRET # For example: "mart-workload-identity-secret" connectAgent: serviceAccountRef: MART_WORKLOAD_IDENTITY_SECRET # Use the same secret for mart and connectAgent # For example: "mart-workload-identity-secret" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, create a # Kubernetes secret for apigee-logger by following the steps # under Kubernetes secrets in # Step 5: Set up service account authentication. # Provide a reference to the secret with the # logger.serviceAccountRef property. metrics: serviceAccountRef: METRICS_WORKLOAD_IDENTITY_SECRET # For example: "metrics-workload-identity-secret" udca: serviceAccountRef: UDCA_WORKLOAD_IDENTITY_SECRET # For example: "udca-workload-identity-secret" watcher: serviceAccountRef: WATCHER_WORKLOAD_IDENTITY_SECRET # For example: "watcher-workload-identity-secret" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: MINT_TASK_SCHEDULER_WORKLOAD_IDENTITY_SECRET # For example: "apigee-mint-task-scheduler-workload-identity-secret" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
WORKLOAD_IDENTITY_
SECRETהשם של הסוד ב-Kubernetes שנוצר בשביל הגדרת פרטי כניסה לחשבון של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
cassandra-workload-identity-secretlogger-workload-identity-secretmart-workload-identity-secretmetrics-workload-identity-secretmint-task-scheduler-workload-identity-secretruntime-workload-identity-secretsynchronizer-workload-identity-secretudca-workload-identity-secretwatcher-workload-identity-secret
לא בסביבת ייצור
non-prod-workload-identity-secret
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretRefs: synchronizer: "synchronizer-workload-identity-secret" runtime: "runtime-workload-identity-secret" udca: "udca-workload-identity-secret" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "mart-workload-identity-secret" connectAgent: serviceAccountRef: "mart-workload-identity-secret" logger: enabled: false metrics: serviceAccountRef: "metrics-workload-identity-secret" udca: serviceAccountRef: "udca-workload-identity-secret" watcher: serviceAccountRef: "watcher-workload-identity-secret" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountRef: "apigee-mint-task-scheduler-workload-identity-secret" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
WORKLOAD_IDENTITY_
SECRETהשם של הסוד ב-Kubernetes שנוצר בשביל הגדרת פרטי כניסה לחשבון של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
cassandra-workload-identity-secretlogger-workload-identity-secretmart-workload-identity-secretmetrics-workload-identity-secretmint-task-scheduler-workload-identity-secretruntime-workload-identity-secretsynchronizer-workload-identity-secretudca-workload-identity-secretwatcher-workload-identity-secret
לא בסביבת ייצור
non-prod-workload-identity-secret
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
לא בסביבת ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretRefs: synchronizer: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" runtime: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" udca: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" connectAgent: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # Use the same secret for mart and connectAgent # For example: "non-prod-workload-identity-secret" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, create a # Kubernetes secret for apigee-logger by following the steps # under Kubernetes secrets in # Step 5: Set up service account authentication. # Provide a reference to the secret with the # logger.serviceAccountRef property. metrics: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" udca: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" watcher: serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountRef: NON_PROD_WORKLOAD_IDENTITY_SECRET # For example: "non-prod-workload-identity-secret" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
WORKLOAD_IDENTITY_
SECRETהשם של הסוד ב-Kubernetes שנוצר בשביל הגדרת פרטי כניסה לחשבון של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
cassandra-workload-identity-secretlogger-workload-identity-secretmart-workload-identity-secretmetrics-workload-identity-secretmint-task-scheduler-workload-identity-secretruntime-workload-identity-secretsynchronizer-workload-identity-secretudca-workload-identity-secretwatcher-workload-identity-secret
לא בסביבת ייצור
non-prod-workload-identity-secret
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretRefs: synchronizer: "non-prod-workload-identity-secret" runtime: "non-prod-workload-identity-secret" udca: "non-prod-workload-identity-secret" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountRef: "non-prod-workload-identity-secret" connectAgent: serviceAccountRef: "non-prod-workload-identity-secret" logger: enabled: false metrics: serviceAccountRef: "non-prod-workload-identity-secret" udca: serviceAccountRef: "non-prod-workload-identity-secret" watcher: serviceAccountRef: "non-prod-workload-identity-secret" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountRef: "non-prod-workload-identity-secret" # for message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
WORKLOAD_IDENTITY_
SECRETהשם של הסוד ב-Kubernetes שנוצר בשביל הגדרת פרטי כניסה לחשבון של חשבון השירות בשלב 5: הגדרת אימות של חשבון שירות. שמות ברירת המחדל של הסודות שמוצעים במדריך הזה הם:
ייצור
cassandra-workload-identity-secretlogger-workload-identity-secretmart-workload-identity-secretmetrics-workload-identity-secretmint-task-scheduler-workload-identity-secretruntime-workload-identity-secretsynchronizer-workload-identity-secretudca-workload-identity-secretwatcher-workload-identity-secret
לא בסביבת ייצור
non-prod-workload-identity-secret
למידע נוסף:
-
envs[].serviceAccountSecretRefs.synchronizer. -
envs[].serviceAccountSecretRefs.runtime. -
envs[].serviceAccountSecretRefs.udca. -
logger.serviceAccountRef. -
connectAgent.serviceAccountRef. -
mart.serviceAccountRef. -
metrics.serviceAccountRef. -
mintTaskScheduler.serviceAccountRef. -
udca.serviceAccountRef. -
watcher.serviceAccountRef.
WIF: קבצים
ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: SYNCHRONIZER_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-synchronizer-credential-configuration.json" runtime: RUNTIME_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-runtime-credential-configuration.json" udca: UDCA_SERVICE_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-udca-credential-configuration.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE installations. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift # installations. See Multi-region deployment: Prerequisites replicaCount:3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-mart-credential-configuration.json" connectAgent: serviceAccountPath: MART_CREDENTIAL_CONFIGURATION_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "apigee-mart-credential-configuration.json" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, provide # the path to the apigee-logger service account key file with # the logger.serviceAccountPath property. metrics: serviceAccountPath: METRICS_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-metrics-credential-configuration.json" udca: serviceAccountPath: UDCA_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-udca-credential-configuration.json" watcher: serviceAccountPath: WATCHER_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-watcher-credential-configuration.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: MINT_TASK_SCHEDULER_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-mint-task-scheduler-credential-configuration.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHהנתיב ושם הקובץ של קובצי התצורה של פרטי הכניסה שיצרתם בשלב 5: הגדרת אימות של חשבון שירות. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה:
- אם הקובץ
apigee-synchronizer-credential-configuration.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-cassandra-credential-configuration.jsonapigee-datastore/apigee-logger-credential-configuration.jsonapigee-telemetry/apigee-mart-credential-configuration.jsonapigee-org/apigee-metrics-credential-configuration.jsonapigee-telemetry/apigee-mint-task-scheduler-credential-configuration.jsonapigee-org/apigee-runtime-credential-configuration.jsonapigee-env/apigee-synchronizer-credential-configuration.jsonapigee-env/apigee-udca-credential-configuration.jsonapigee-org/apigee-watcher-credential-configuration.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-non-prod-credential-configuration.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountPaths: synchronizer: "apigee-synchronizer-credential-configuration.json" runtime: "apigee-runtime-credential-configuration.json" udca: "apigee-udca-credential-configuration.json" cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountPath: "apigee-mart-credential-configuration.json" connectAgent: serviceAccountPath: "apigee-mart-credential-configuration.json" logger: enabled: false metrics: serviceAccountPath: "apigee-metrics-credential-configuration.json" udca: serviceAccountPath: "apigee-udca-credential-configuration.json" watcher: serviceAccountPath: "apigee-watcher-credential-configuration.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountPath: apigee-mint-task-scheduler-credential-configuration.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHהנתיב ושם הקובץ של קובצי התצורה של פרטי הכניסה שיצרתם בשלב 5: הגדרת אימות של חשבון שירות. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה:
- אם הקובץ
apigee-synchronizer-credential-configuration.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-cassandra-credential-configuration.jsonapigee-datastore/apigee-logger-credential-configuration.jsonapigee-telemetry/apigee-mart-credential-configuration.jsonapigee-org/apigee-metrics-credential-configuration.jsonapigee-telemetry/apigee-mint-task-scheduler-credential-configuration.jsonapigee-org/apigee-runtime-credential-configuration.jsonapigee-env/apigee-synchronizer-credential-configuration.jsonapigee-env/apigee-udca-credential-configuration.jsonapigee-org/apigee-watcher-credential-configuration.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-non-prod-credential-configuration.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
לא בסביבת ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountPaths: # Provide the path relative to the apigee-env chart directory. synchronizer: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-non-prod-credential-configuration.json" runtime: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-non-prod-credential-configuration.json" udca: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # For example: "apigee-non-prod-credential-configuration.json" cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE mart: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-non-prod-credential-configuration.json" connectAgent: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Use the same service account for mart and connectAgent # Provide the path relative to the apigee-org chart directory. # For example: "apigee-non-prod-credential-configuration.json" logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, provide # the path to the apigee-non-prod service account key file with # the logger.serviceAccountPath property. metrics: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-non-prod-credential-configuration.json" udca: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-non-prod-credential-configuration.json" watcher: serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-telemetry chart directory. # For example: "apigee-non-prod-credential-configuration.json" # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. mintTaskScheduler: # Required for Monetization for Apigee hybrid serviceAccountPath: NON_PROD_CREDENTIAL_CONFIGURATION_FILEPATH # Provide the path relative to the apigee-org chart directory. # For example: "apigee-non-prod-credential-configuration.json" # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHהנתיב ושם הקובץ של קובצי התצורה של פרטי הכניסה שיצרתם בשלב 5: הגדרת אימות של חשבון שירות. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה:
- אם הקובץ
apigee-synchronizer-credential-configuration.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-cassandra-credential-configuration.jsonapigee-datastore/apigee-logger-credential-configuration.jsonapigee-telemetry/apigee-mart-credential-configuration.jsonapigee-org/apigee-metrics-credential-configuration.jsonapigee-telemetry/apigee-mint-task-scheduler-credential-configuration.jsonapigee-org/apigee-runtime-credential-configuration.jsonapigee-env/apigee-synchronizer-credential-configuration.jsonapigee-env/apigee-udca-credential-configuration.jsonapigee-org/apigee-watcher-credential-configuration.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-non-prod-credential-configuration.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountPaths: synchronizer: "apigee-non-prod-credential-configuration.json" runtime: "apigee-non-prod-credential-configuration.json<" udca: "apigee-non-prod-credential-configuration.json" cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key mart: serviceAccountPath: "apigee-non-prod-credential-configuration.json" connectAgent: serviceAccountPath: "apigee-non-prod-credential-configuration.json" logger: enabled: false metrics: serviceAccountPath: "apigee-non-prod-credential-configuration.json" udca: serviceAccountPath: "apigee-non-prod-credential-configuration.json" watcher: serviceAccountPath: "apigee-non-prod-credential-configuration.json" # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" mintTaskScheduler: serviceAccountPath: apigee-non-prod-credential-configuration.json" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
<component>_
CREDENTIAL_
CONFIGURATION_
FILEPATHהנתיב ושם הקובץ של קובצי התצורה של פרטי הכניסה שיצרתם בשלב 5: הגדרת אימות של חשבון שירות. צריך לציין את השמות עם הנתיב ביחס לספריית התרשים. לדוגמה:
- אם הקובץ
apigee-synchronizer-credential-configuration.jsonנמצא בספריית התרשיםapigee-env/, צריך לציין רק את שם הקובץ, למשל:synchronizer: "FILE_NAME.json"
- אם הקובץ נמצא בספרייה
apigee-env/service-accounts/, צריך לציין נתיב יחסי:synchronizer: "service-accounts/FILE_NAME.json"
אלה השמות שמוגדרים כברירת מחדל לספריות של התרשימים התואמים של חשבונות השירות:
ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-cassandra-credential-configuration.jsonapigee-datastore/apigee-logger-credential-configuration.jsonapigee-telemetry/apigee-mart-credential-configuration.jsonapigee-org/apigee-metrics-credential-configuration.jsonapigee-telemetry/apigee-mint-task-scheduler-credential-configuration.jsonapigee-org/apigee-runtime-credential-configuration.jsonapigee-env/apigee-synchronizer-credential-configuration.jsonapigee-env/apigee-udca-credential-configuration.jsonapigee-org/apigee-watcher-credential-configuration.jsonapigee-org/לא בסביבת ייצור
שם הקובץ של חשבון השירות מדריך תרשימים apigee-non-prod-credential-configuration.jsonapigee-datastore/
apigee-org/
apigee-telemetry/למידע נוסף:
-
envs[].serviceAccountPaths.synchronizer. -
envs[].serviceAccountPaths.runtime. -
envs[].serviceAccountPaths.udca. -
logger.serviceAccountPath. -
connectAgent.serviceAccountPath. -
mart.serviceAccountPath. -
metrics.serviceAccountPath. -
mintTaskScheduler.serviceAccountPath. -
udca.serviceAccountPath. -
watcher.serviceAccountPath.
WIF: Vault
ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount:3 # Use multiples of 3 for production. # See Configure Cassandra for production for guidelines. storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M # Minimum storage requirements for a production environment. # See Configure Cassandra for production. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, add # a "logger" : "value" entry in the orgsakeys vault secret # using the contents of the apigee-logger key file for the # value. See Step 5: Set up service account authentication. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Gi בטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: prod-env serviceAccountSecretProviderClass: apigee-envsakeys-prod-env-spc cassandra: hostNetwork: false replicaCount: 3 storage: storageSize: 500Gi resources: requests: cpu: 7 memory: 15Gi maxHeapSize: 8192M heapNewSize: 1200M ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: false # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # For message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
לא בסביבת ייצור
תבנית
הערכים ב-red, bold italics הם ערכי מאפיינים שאתם צריכים לספק. אפשר לערוך את הערכים שלהם בדף הזה. הם מתוארים בטבלה שבהמשך.
instanceID: UNIQUE_INSTANCE_IDENTIFIER namespace: APIGEE_NAMESPACE # Usually "apigee" gcp: projectID: PROJECT_ID region: ANALYTICS_REGION workloadIdentity: enabled: false # Must be set to false to use # Workload Identity Federation on other platforms. federatedWorkloadIdentity: enabled: true audience: "AUDIENCE" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: CLUSTER_NAME region: CLUSTER_LOCATION # Closest Google Cloud region to your cluster. org: ORG_NAME serviceAccountSecretProviderClass: apigee-orgsakeys-spc # Required for Enhanced per-environment proxy limits: enhanceProxyLimits: true # Required if using data residency with hybrid: contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com envs: - name: ENVIRONMENT_NAME serviceAccountSecretProviderClass: apigee-envsakeys-ENVIRONMENT_NAME-spc cassandra: hostNetwork: false # Set to false for single region installations and for multi-region # installations with connectivity between pods in different clusters, # like GKE. # Set to true for multi-region installations with no communication # between pods in different clusters, for example Google Distributed # Cloud on VMware or bare metal, AKS, EKS, and OpenShift. # See Multi-region deployment: Prerequisites replicaCount: 1 # Use 1 for non-prod installations and multiples of 3 for production. # See Configure Cassandra for production for guidelines. ingressGateways: - name: INGRESS_NAME # maximum 17 characters. replicaCountMin: 2 replicaCountMax: 10 svcAnnotations: # optional. If you are on AKS, see Known issue #260772383 SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE virtualhosts: - name: ENVIRONMENT_GROUP_NAME selector: app: apigee-ingressgateway ingress_name: INGRESS_NAME sslCertPath: PATH_TO_CERT_FILE sslKeyPath: PATH_TO_KEY_FILE logger: enabled: false # apigee-logger does not support Workload Identity Federation. # See Known issue #341099433. # If you want to enable the apigee-logger component, add # a "logger" : "value" entry in the orgsakeys vault secret # using the contents of the apigee-non-prod key file for the # value. See Step 5: Set up service account authentication. # Required if using Monetization for Apigee hybrid (v1.15.1 and later) runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # Must be 1.15.1 or higher. # If using message payloads larger than 10MB. # See configure large message payload support: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
דוגמה
instanceID: "my_hybrid_example" namespace: "apigee" gcp: projectID: my-project region: us-central1 workloadIdentity: enabled: false federatedWorkloadIdentity: enabled: true audience: "//iam.googleapis.com/projects/123123123123/locations/global/workloadIdentityPools/my-wi-pool/providers/my-wi-provider" credentialSourceFile: "/var/run/service-account/token" k8sCluster: name: hybrid-env region: us-central1 org: my-project serviceAccountSecretProviderClass: apigee-orgsakeys-spc enhanceProxyLimits: true contractProvider: https://us-apigee.googleapis.com envs: - name: test serviceAccountSecretProviderClass: apigee-envsakeys-test-env-spc cassandra: hostNetwork: false replicaCount: 1 ingressGateways: - name: my-ingress-1 replicaCountMin: 2 replicaCountMax: 10 virtualhosts: - name: example-env-group selector: app: apigee-ingressgateway ingress_name: my-ingress-1 sslCertPath: certs/keystore.pem sslKeyPath: certs/keystore.key logger: enabled: false # Monetization for Apigee hybrid runtime: image: url: "gcr.io/apigee-release/hybrid/apigee-runtime" tag: "1.15.9" # for message payloads larger than 10MB: runtime: cwcAppend: bin_setenv_max_mem: 4096m # Increase max heap size to 4 gigs resources: requests: memory: 4Gi limits: memory: 6Giבטבלה הבאה מתוארים ערכי המאפיינים שצריך לספק בקובץ השינויים. מידע נוסף זמין במאמר חומר עזר בנושא מאפייני הגדרה.
משתנה תיאור UNIQUE_INSTANCE_
IDENTIFIERמחרוזת ייחודית לזיהוי המופע הזה. השם יכול להיות כל שילוב של אותיות ומספרים, באורך של עד 63 תווים.
אפשר ליצור כמה ארגונים באותו אשכול, אבל הערך של
instanceIDחייב להיות זהה בכל הארגונים באותו אשכול Kubernetes.APIGEE_NAMESPACE מרחב השמות של Kubernetes לרכיבי Apigee Hybrid.
ערך ברירת המחדל הוא
apigee.PROJECT_ID מזהה את הפרויקט ב-Google Cloud שאליו נדחפים הנתונים של apigee-loggerושלapigee-metrics. זה הערך שהוקצה למשתנה הסביבהPROJECT_ID.ANALYTICS_REGION ב-GKE, צריך להגדיר את הערך הזה לאותו אזור שבו פועל האשכול. בכל שאר הפלטפורמות, בוחרים את אזור הניתוח הקרוב ביותר לאשכול שיש לו תמיכה ב-Analytics (ראו את הטבלה בחלק 1, שלב 2: יצירת ארגון). זה הערך שהקציתם למשתנה הסביבה
ANALYTICS_REGIONקודם לכן.AUDIENCE הקהל המורשה של ספק מאגרי הזהויות של עומסי העבודה. כדי למצוא את הערך, מחפשים את המונח audience:בכל אחד מקובצי התצורה של פרטי הכניסה. ערך הקהל זהה בכל קובץ תצורה של פרטי כניסה.לדוגמה, בקובץ
apigee-udca-credential-configuration.jsonהבא:{ "universe_domain": "googleapis.com", "type": "external_account:," "audience": "AUDIENCE", "subject_token_type": "TOKEN_TYPE", "token_url": "TOKEN_URL", "service "impersonation_url": "IMPERSONATION_URL", "credential_source": { "file": "FILE_PATH", "format": { "type": "text" } } }ערך הקהל ייראה בערך כך (בלי מעברי שורה):
"//iam.googleapis.com/projects/123456789012/ locations/global/workloadIdentityPools/ POOL_ID/providers/WORKLOAD_PROVIDER_ID"CLUSTER_NAME שם אשכול Kubernetes. זה הערך שהוקצה למשתנה הסביבה CLUSTER_NAME.CLUSTER_LOCATION האזור שבו האשכול פועל. זה האזור שבו יצרתם את האשכול ב שלב 1: יצירת אשכול. זה הערך שהקציתם למשתנה הסביבה
CLUSTER_LOCATIONקודם לכן.ORG_NAME המזהה של הארגון ב-Apigee Hybrid. זה הערך שמוקצה למשתנה הסביבה ORG_NAME.CONTROL_PLANE_
LOCATIONחובה אם אתם משתמשים במיקום אחסון הנתונים בהתקנה של Apigee Hybrid. זה המיקום שבו מאוחסן תוכן הליבה של הלקוח, כמו חבילות שרת proxy. רשימת האזורים הזמינים של מישור הבקרה של Apigee API זה הערך שהוקצה למשתנה הסביבה CONTROL_PLANE_LOCATIONבשלב 2: יצירת ארגון.ENVIRONMENT_NAME משתמשים באותו שם שבו השתמשתם כשיצרתם סביבה בממשק המשתמש, כפי שמוסבר במאמר הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. ENVIRONMENT_GROUP_
NAMEהשם של קבוצת הסביבות שאליה הסביבות שלכם מוקצות. זו הקבוצה שיצרתם ב הגדרת פרויקט וארגון – שלב 3: יצירת קבוצת סביבות. זה הערך שהוקצה למשתנה הסביבה ENV_GROUP.INGRESS_NAME השם של שער הכניסה של Apigee לפריסה. אפשר לבחור כל שם שעומד בדרישות הבאות: - להיות באורך של עד 17 תווים
- להכיל רק תווים אלפאנומריים באותיות קטנות, "-" או "."
- להתחיל בתו אלפאנומרי
- להסתיים בתו אלפאנומרי
למידע נוסף:
PATH_TO_CERT_FILE
PATH_TO_KEY_FILEמזינים את הנתיב ואת שם הקובץ של קובצי המפתח והאישור של TLS בחתימה עצמית שיצרתם קודם ב שלב 6: יצירת אישורי TLS. הקבצים האלה חייבים להיות בספרייה APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs. לדוגמה:sslCertPath: certs/keystore.crt sslKeyPath: certs/keystore.key
למידע נוסף:
SVC_ANNOTATIONS_
KEY: SVC_ANNOTATIONS_
VALUE(אופציונלי). זהו צמד מפתח/ערך שמספק הערות לשירות ברירת המחדל של Ingress. פלטפורמת הענן משתמשת בהערות כדי להגדיר את ההתקנה ההיברידית, למשל הגדרת סוג מאזן העומסים כפנימי או חיצוני. ההערות משתנות מפלטפורמה לפלטפורמה. כדאי לעיין במאמרי העזרה של הפלטפורמה כדי לראות אילו הערות נדרשות ומומלצות.
אם אתם לא משתמשים בקטע הזה, סמנו אותו כהערה או מחקו אותו.
סיכום
קובץ התצורה מורה ל-Kubernetes איך לפרוס את הרכיבים ההיברידיים באשכול. בשלב הבא תפעילו את הגישה לסנכרון כדי שסביבת זמן הריצה ומישורי הניהול של Apigee יוכלו לתקשר.
השלב הבא
1 2 3 4 5 6 7 (השלב הבא) שלב 8: הפעלת הגישה למישור הבקרה 9 10 11