REST Resource: projects.locations.attachedClusters

משאב: AttachedCluster

אשכול Anthos שפועל בתשתית של הלקוח.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "oidcConfig": {
    object (AttachedOidcConfig)
  },
  "platformVersion": string,
  "distribution": string,
  "clusterRegion": string,
  "fleet": {
    object (Fleet)
  },
  "state": enum (State),
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "kubernetesVersion": string,
  "annotations": {
    string: string,
    ...
  },
  "workloadIdentityConfig": {
    object (WorkloadIdentityConfig)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "errors": [
    {
      object (AttachedClusterError)
    }
  ],
  "authorization": {
    object (AttachedClustersAuthorization)
  },
  "monitoringConfig": {
    object (MonitoringConfig)
  },
  "proxyConfig": {
    object (AttachedProxyConfig)
  },
  "binaryAuthorization": {
    object (BinaryAuthorization)
  },
  "securityPostureConfig": {
    object (SecurityPostureConfig)
  },
  "tags": {
    string: string,
    ...
  },
  "systemComponentsConfig": {
    object (SystemComponentsConfig)
  }
}
שדות
name

string

השם של המשאב הזה.

הפורמט של שמות האשכולות הוא projects/<project-number>/locations/<region>/attachedClusters/<cluster-id>.

פרטים נוספים על שמות משאבים ב-Google Cloud Platform מופיעים במאמר שמות משאבים.

description

string

זה שינוי אופציונלי. תיאור קריא (לבני אדם) של האשכול הזה. האורך המקסימלי הוא 255 בייטים בקידוד UTF-8.

oidcConfig

object (AttachedOidcConfig)

חובה. הגדרת OpenID Connect‏ (OIDC) לאשכול.

platformVersion

string

חובה. גרסת הפלטפורמה של האשכול (למשל, 1.19.0-gke.1000).

כדי לראות את כל הגרסאות הנתמכות באזור מסוים ב-Google Cloud, אפשר להפעיל את הפקודה locations.getAttachedServerConfig.

distribution

string

חובה. הפצת Kubernetes של האשכול הבסיסי המצורף.

ערכים נתמכים: [eks, aks, generic].

clusterRegion

string

פלט בלבד. האזור שבו האשכול הזה פועל.

באשכולות EKS, זהו אזור AWS. באשכולות AKS, זהו אזור Azure.

fleet

object (Fleet)

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

state

enum (State)

פלט בלבד. המצב הנוכחי של האשכול.

uid

string

פלט בלבד. מזהה ייחודי גלובלי של האשכול.

reconciling

boolean

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

createTime

string (Timestamp format)

פלט בלבד. השעה שבה האשכול הזה נרשם.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

פלט בלבד. התאריך והשעה שבהם האשכול הזה עודכן בפעם האחרונה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

etag

string

מאפשר ללקוחות לבצע פעולות קריאה-שינוי-כתיבה עקביות באמצעות בקרת בו-זמניות אופטימית.

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

kubernetesVersion

string

פלט בלבד. גרסת Kubernetes של האשכול.

annotations

map (key: string, value: string)

זה שינוי אופציונלי. הערות באשכול.

ההגבלות בשדה הזה זהות להגבלות של הערות ב-Kubernetes. הגודל הכולל של כל המפתחות והערכים יחד מוגבל ל-256k. למפתח יכולים להיות שני מקטעים: קידומת (אופציונלית) ושם (חובה), שמופרדים באמצעות לוכסן (/). הקידומת חייבת להיות תת-דומיין של DNS. השם צריך להיות באורך של עד 63 תווים, להתחיל ולהסתיים בתווים אלפאנומריים, ולהכיל מקפים (-), קווים תחתונים (_), נקודות (.) ותווים אלפאנומריים בין לבין.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

workloadIdentityConfig

object (WorkloadIdentityConfig)

פלט בלבד. הגדרות של Workload Identity.

loggingConfig

object (LoggingConfig)

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

errors[]

object (AttachedClusterError)

פלט בלבד. קבוצת שגיאות שנמצאו באשכול.

authorization

object (AttachedClustersAuthorization)

זה שינוי אופציונלי. הגדרה שקשורה להגדרות RBAC באשכול.

monitoringConfig

object (MonitoringConfig)

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

proxyConfig

object (AttachedProxyConfig)

זה שינוי אופציונלי. הגדרת שרת proxy לתנועת HTTP(S) יוצאת.

binaryAuthorization

object (BinaryAuthorization)

זה שינוי אופציונלי. ההגדרה של Binary Authorization עבור האשכול הזה.

securityPostureConfig

object (SecurityPostureConfig)

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

tags

map (key: string, value: string)

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

צריך לציין את מפתח התג בפורמט <tag namespace>/<tag key name>,, כאשר מרחב השמות של התג הוא המזהה של הארגון או שם הפרויקט שבו מוגדר מפתח התג. האורך המקסימלי של השם המקוצר של מפתח או ערך של תג הוא 256 תווים. מערכת התווים המותרת לשם הקצר כוללת תווים ביוניקוד בקידוד UTF-8, למעט גרש יחיד ('), מירכאות ("), קו נטוי אחורה (\) וקו נטוי לפנים (/).

פרטים נוספים על תגים ב-Google Cloud Platform זמינים במאמר בנושא תגים.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

systemComponentsConfig

object (SystemComponentsConfig)

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

AttachedOidcConfig

מידע על גילוי OIDC של אשכול היעד.

אסימונים של חשבון שירות ב-Kubernetes‏ (KSA) הם אסימוני JWT שנחתמים על ידי שרת ה-API של האשכול. בשדות האלה מצוין איך שירותי Google Cloud Platform מאמתים את אסימוני ה-KSA כדי לאפשר לעומסי עבודה במערכת (כמו GKE Connect וסוכני טלמטריה) לבצע אימות בחזרה ל-Google Cloud Platform.

יש תמיכה בשני סוגי האשכולות: אשכולות עם כתובות URL של מנפיק ציבורי ואשכולות עם כתובות URL של מנפיק פרטי. במקרה של אשכולות עם הנפקות ציבוריות, צריך לציין רק את השדה issuerUrl, ובמקרה של אשכולות עם הנפקות פרטיות, צריך לציין את השדות issuerUrl ו-oidc_jwks.

ייצוג ב-JSON
{
  "issuerUrl": string,
  "jwks": string
}
שדות
issuerUrl

string

מזהה URI של מנפיק אסימון רשת מבוסס JSON‏ (JWT). issuer חייב להתחיל ב-https://.

jwks

string (bytes format)

זה שינוי אופציונלי. מפתחות אימות OIDC בפורמט JWKS‏ (RFC 7517). הוא מכיל רשימה של מפתחות אימות OIDC שאפשר להשתמש בהם כדי לאמת אסימוני JWT של OIDC.

השדה הזה נדרש לאשכול שאין לו נקודת קצה (endpoint) לגילוי שזמינה לכולם. אם מספקים אותו, הוא ישמש ישירות לאימות של אסימון ה-JWT של OIDC שמוצהר על ידי ספק ה-IdP.

מחרוזת בקידוד Base64.

מדינה

מצב מחזור החיים של האשכול.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא מוגדר.
PROVISIONING המצב PROVISIONING מציין שהאשכול נרשם.
RUNNING המצב RUNNING מציין שהאשכול נרשם ומוכן לשימוש.
RECONCILING הסטטוס RECONCILING מציין שמתבצעת פעילות מסוימת באשכול, כמו שדרוג של רכיבי תוכנה.
STOPPING הסטטוס STOPPING מציין שהרישום של האשכול בוטל.
ERROR מצב ERROR מציין שהאשכול נמצא במצב לא תקין שלא ניתן לשחזר.
DEGRADED הסטטוס DEGRADED מציין שהאשכול דורש פעולה של המשתמש כדי לשחזר את הפונקציונליות המלאה.

AttachedClusterError

‫AttachedClusterError מתאר שגיאות שנמצאו באשכולות מצורפים.

ייצוג ב-JSON
{
  "message": string
}
שדות
message

string

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

AttachedClustersAuthorization

הגדרה שקשורה להגדרות RBAC באשכול.

ייצוג ב-JSON
{
  "adminUsers": [
    {
      object (AttachedClusterUser)
    }
  ],
  "adminGroups": [
    {
      object (AttachedClusterGroup)
    }
  ]
}
שדות
adminUsers[]

object (AttachedClusterUser)

זה שינוי אופציונלי. משתמשים שיכולים לבצע פעולות כאדמינים של אשכול. ייווצר ClusterRoleBinding מנוהל כדי להעניק את cluster-admin ClusterRole למשתמשים. אפשר לספק עד עשרה משתמשים עם הרשאת אדמין.

מידע נוסף על RBAC זמין בכתובת https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles

adminGroups[]

object (AttachedClusterGroup)

זה שינוי אופציונלי. קבוצות של משתמשים שיכולים לבצע פעולות כאדמין של אשכול. ייווצר ClusterRoleBinding מנוהל כדי להעניק את cluster-admin ClusterRole לקבוצות. אפשר לספק עד עשר קבוצות של אדמינים.

מידע נוסף על RBAC זמין בכתובת https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles

AttachedClusterUser

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

ייצוג ב-JSON
{
  "username": string
}
שדות
username

string

חובה. שם המשתמש, למשל my-gcp-id@gmail.com.

AttachedClusterGroup

זהויות של נושא מסוג קבוצה עבור Attached clusters.

ייצוג ב-JSON
{
  "group": string
}
שדות
group

string

חובה. שם הקבוצה, למשל my-group@domain.com.

AttachedProxyConfig

פרטים של הגדרת proxy.

ייצוג ב-JSON
{
  "kubernetesSecret": {
    object (KubernetesSecret)
  }
}
שדות
kubernetesSecret

object (KubernetesSecret)

משאב ה-Secret של Kubernetes שמכיל את הגדרות ה-proxy של HTTP(S). הסוד צריך להיות הגדרת proxy מקודדת ב-JSON, כפי שמתואר בכתובות https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/eks/how-to/use-a-proxy#configure-proxy-support לאשכולות EKS ובכתובת https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached/aks/how-to/use-a-proxy#configure-proxy-support לאשכולות AKS.

KubernetesSecret

מידע על סודות (Secrets) ב-Kubernetes

ייצוג ב-JSON
{
  "name": string,
  "namespace": string
}
שדות
name

string

השם של הסוד ב-Kubernetes.

namespace

string

מרחב השמות שבו מאוחסן הסוד של Kubernetes.

SecurityPostureConfig

‫SecurityPostureConfig מגדיר את הדגלים שנדרשים להפעלה או להשבתה של תכונות ב-Security Posture API.

ייצוג ב-JSON
{
  "vulnerabilityMode": enum (VulnerabilityMode)
}
שדות
vulnerabilityMode

enum (VulnerabilityMode)

ההגדרה הזו קובעת באיזה מצב להשתמש לבדיקת נקודות חולשה.

VulnerabilityMode

‫VulnerabilityMode מגדיר את מצב ההפעלה של סריקת נקודות חולשה.

טיפוסים בני מנייה (enum)
VULNERABILITY_MODE_UNSPECIFIED לא צוין ערך ברירת מחדל.
VULNERABILITY_DISABLED השבתה של סריקת נקודות חולשה באשכול.
VULNERABILITY_ENTERPRISE החלת נקודת החולשה של מצב האבטחה על תכונות ברמת הארגון של אשכול.

SystemComponentsConfig

‫SystemComponentsConfig מגדיר את השדות להתאמה אישית של הגדרות לרכיבים שמותקנים אוטומטית.

ייצוג ב-JSON
{
  "tolerations": [
    {
      object (Toleration)
    }
  ],
  "labels": [
    {
      object (Label)
    }
  ]
}
שדות
tolerations[]

object (Toleration)

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

labels[]

object (Label)

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

טולרנטיות

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

ייצוג ב-JSON
{
  "key": string,
  "value": string,
  "keyOperator": enum (KeyOperator),
  "effect": enum (Effect)
}
שדות
key

string

‫Key הוא מפתח ההכתמה שהסבילות חלה עליו.

value

string

הערך הוא ערך הדחייה שהטולרנטיות חלה עליו.

keyOperator

enum (KeyOperator)

‫KeyOperator מייצג את היחס בין מפתח לערך, למשל 'Exist'.

effect

enum (Effect)

האפקט מציין את אפקט ההכתמה שצריך להתאים לו, למשל NoSchedule

KeyOperator

‫KeyOperator מייצג את היחס בין מפתח לערך, למשל 'שווה'.

טיפוסים בני מנייה (enum)
KEY_OPERATOR_UNSPECIFIED לא צוין אופרטור.
KEY_OPERATOR_EQUAL האופרטור ממופה ל-'שווה'.
KEY_OPERATOR_EXISTS האופרטור ממופה אל 'קיים'.

אפקט

האפקט מציין את אפקט ההכתמה להתאמה, למשל 'NoSchedule'.

טיפוסים בני מנייה (enum)
EFFECT_UNSPECIFIED לא צוין אפקט.
EFFECT_NO_SCHEDULE האפקט ממופה ל-'NoSchedule'.
EFFECT_PREFER_NO_SCHEDULE האפקט ממופה ל-PreferNoSchedule.
EFFECT_NO_EXECUTE האפקט ממופה ל-'NoExecute'.

תווית

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

ייצוג ב-JSON
{
  "key": string,
  "value": string
}
שדות
key

string

זה המפתח של התווית.

value

string

זה הערך של התווית.

Methods

create

יוצר משאב AttachedCluster חדש בפרויקט ובאזור נתונים נתונים ב-Google Cloud Platform.

delete

מחיקה של משאב AttachedCluster ספציפי.

generateAttachedClusterAgentToken

יוצר אסימון גישה לסוכן של אשכול.

get

מתאר משאב ספציפי AttachedCluster.

import

הפעולה Imports יוצרת משאב AttachedCluster חדש על ידי ייבוא של משאב Fleet Membership קיים.

list

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

patch

מעדכן AttachedCluster.