REST Resource: projects.locations.azureClusters

‫Resource: AzureCluster

אשכול Anthos שפועל ב-Azure.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "azureRegion": string,
  "resourceGroupId": string,
  "azureClient": string,
  "networking": {
    object (AzureClusterNetworking)
  },
  "controlPlane": {
    object (AzureControlPlane)
  },
  "authorization": {
    object (AzureAuthorization)
  },
  "azureServicesAuthentication": {
    object (AzureServicesAuthentication)
  },
  "state": enum (State),
  "endpoint": string,
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "workloadIdentityConfig": {
    object (WorkloadIdentityConfig)
  },
  "clusterCaCertificate": string,
  "fleet": {
    object (Fleet)
  },
  "managedResources": {
    object (AzureClusterResources)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "errors": [
    {
      object (AzureClusterError)
    }
  ],
  "monitoringConfig": {
    object (MonitoringConfig)
  }
}
שדות
name

string

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

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

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

description

string

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

azureRegion

string

חובה. האזור ב-Azure שבו האשכול פועל.

כל אזור ב-Google Cloud תומך בקבוצת משנה של אזורי Azure סמוכים. אפשר להתקשר אל locations.getAzureServerConfig כדי לראות רשימה של כל האזורים הנתמכים ב-Azure באזור נתון ב-Google Cloud.

resourceGroupId

string

חובה. מזהה ה-ARM של קבוצת המשאבים שבה נפרסים משאבי האשכול. לדוגמה: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>

azureClient

string

זה שינוי אופציונלי. שם ה-AzureClient שמכיל את הגדרות האימות של האופן שבו Anthos Multi-Cloud API מתחבר לממשקי Azure API.

צריך לציין azureClient או azureServicesAuthentication.

המשאב AzureClient חייב להיות באותו פרויקט ובאותו אזור ב-Google Cloud Platform כמו AzureCluster.

השמות של AzureClient מפורמטים כ-projects/<project-number>/locations/<region>/azureClients/<client-id>.

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

networking

object (AzureClusterNetworking)

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

controlPlane

object (AzureControlPlane)

חובה. הגדרה שקשורה למישור הבקרה של האשכול.

authorization

object (AzureAuthorization)

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

azureServicesAuthentication

object (AzureServicesAuthentication)

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

צריך לציין azureClient או azureServicesAuthentication.

state

enum (State)

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

endpoint

string

פלט בלבד. נקודת הקצה של שרת ה-API של האשכול.

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

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

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

annotations

map (key: string, value: string)

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

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

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

workloadIdentityConfig

object (WorkloadIdentityConfig)

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

clusterCaCertificate

string

פלט בלבד. אישור x509 בקידוד PEM של בסיס המהימנות של האשכול.

fleet

object (Fleet)

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

managedResources

object (AzureClusterResources)

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

loggingConfig

object (LoggingConfig)

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

errors[]

object (AzureClusterError)

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

monitoringConfig

object (MonitoringConfig)

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

AzureClusterNetworking

‫ClusterNetworking מכיל את הגדרות הרשת בכל האשכול.

ייצוג ב-JSON
{
  "virtualNetworkId": string,
  "podAddressCidrBlocks": [
    string
  ],
  "serviceAddressCidrBlocks": [
    string
  ],
  "serviceLoadBalancerSubnetId": string
}
שדות
virtualNetworkId

string

חובה. מזהה Azure Resource Manager ‏ (ARM) של רשת VNet שמשויכת לאשכול.

כל הרכיבים באשכול (כלומר, מישור הבקרה ומאגרי הצמתים) פועלים ברשת VNet אחת.

לדוגמה: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>

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

podAddressCidrBlocks[]

string

חובה. טווח כתובות ה-IP של הפודים באשכול הזה, בסימון CIDR (לדוגמה, 10.96.0.0/14).

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

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

serviceAddressCidrBlocks[]

string

חובה. טווח כתובות ה-IP של השירותים באשכול הזה, בסימון CIDR (למשל, 10.96.0.0/14).

לכל השירותים באשכול מוקצית כתובת IPv4 ייחודית מתוך הטווחים האלה. יש תמיכה רק בטווח אחד.

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

serviceLoadBalancerSubnetId

string

זה שינוי אופציונלי. מזהה ה-ARM של רשת המשנה שבה נפרסים מאזני עומסים מסוג שירות פרטי של Kubernetes. אם לא מציינים ערך, ברירת המחדל היא AzureControlPlane.subnet_id.

דוגמה: "/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid456"

AzureControlPlane

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

ייצוג ב-JSON
{
  "version": string,
  "subnetId": string,
  "vmSize": string,
  "sshConfig": {
    object (AzureSshConfig)
  },
  "rootVolume": {
    object (AzureDiskTemplate)
  },
  "mainVolume": {
    object (AzureDiskTemplate)
  },
  "databaseEncryption": {
    object (AzureDatabaseEncryption)
  },
  "proxyConfig": {
    object (AzureProxyConfig)
  },
  "configEncryption": {
    object (AzureConfigEncryption)
  },
  "tags": {
    string: string,
    ...
  },
  "replicaPlacements": [
    {
      object (ReplicaPlacement)
    }
  ],
  "endpointSubnetId": string
}
שדות
version

string

חובה. גרסת Kubernetes להרצה ברפליקות של מישור הבקרה (למשל, 1.19.10-gke.1000).

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

subnetId

string

זה שינוי אופציונלי. מזהה ה-ARM של רשת המשנה שמוגדרת כברירת מחדל למישור הבקרה. מכונות ה-VM של מישור הבקרה נפרסות ברשת המשנה הזו, אלא אם מצוין AzureControlPlane.replica_placements. אם לא מציינים את AzureControlPlane.endpoint_subnet_id, רשת המשנה הזו תשמש גם כברירת מחדל עבור AzureControlPlane.endpoint_subnet_id. באופן דומה, הוא ישמש כברירת מחדל גם עבור AzureClusterNetworking.service_load_balancer_subnet_id.

דוגמה: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default

vmSize

string

זה שינוי אופציונלי. השם של גודל מכונת ה-VM ב-Azure. דוגמה: Standard_DS2_v2

לרשימת הגדלים הזמינים של מכונות וירטואליות, אפשר לעיין בכתובת https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions.

אם לא מציינים ערך, ברירת המחדל היא Standard_DS2_v2.

sshConfig

object (AzureSshConfig)

חובה. הגדרת SSH לגישה למכונות של מישור הבקרה הבסיסי.

rootVolume

object (AzureDiskTemplate)

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

אם לא מציינים ערך, ברירת המחדל היא 32GB של Azure Disk.

mainVolume

object (AzureDiskTemplate)

זה שינוי אופציונלי. ההגדרה שקשורה לנפח הראשי שהוקצה לכל רפליקה של מישור הבקרה. הנפח הראשי אחראי לאחסון כל מצב ה-etcd של האשכול.

אם לא מציינים ערך, ברירת המחדל היא Azure Disk בגודל 8GB.

databaseEncryption

object (AzureDatabaseEncryption)

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

proxyConfig

object (AzureProxyConfig)

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

configEncryption

object (AzureConfigEncryption)

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

tags

map (key: string, value: string)

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

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

replicaPlacements[]

object (ReplicaPlacement)

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

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

endpointSubnetId

string

זה שינוי אופציונלי. מזהה ה-ARM של רשת המשנה שבה נפרס מאזן העומסים של מישור הבקרה. אם לא מציינים ערך, ברירת המחדל היא AzureControlPlane.subnet_id.

דוגמה: "/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid123"

AzureDatabaseEncryption

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

אשכולות Anthos ב-Azure מצפינים את נתוני Kubernetes באחסון ב-etcd באמצעות Azure Key Vault.

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

string

חובה. מזהה ARM של מפתח Azure Key Vault להצפנה או לפענוח של נתונים.

לדוגמה: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.KeyVault/vaults/<key-vault-id>/keys/<key-name> ההצפנה תמיד תשתמש בגרסה העדכנית ביותר של המפתח, ולכן לא נתמכת גרסה ספציפית.

ReplicaPlacement

הגדרת המיקום של רפליקה של מישור הבקרה.

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

string

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

azureAvailabilityZone

string

חובה. עבור עותק משוכפל נתון, אזור הזמינות של Azure שבו יוקצו המכונה הווירטואלית של מישור הבקרה ודיסק ה-ETCD.

AzureAuthorization

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

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

object (AzureClusterUser)

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

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

adminGroups[]

object (AzureClusterGroup)

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

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

AzureClusterUser

זהויות של נושא מסוג משתמש באשכולות Azure.

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

string

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

AzureClusterGroup

זהויות של נושא מסוג קבוצה באשכולות Azure.

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

string

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

AzureServicesAuthentication

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

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

string

חובה. מזהה הדייר ב-Azure Active Directory.

applicationId

string

חובה. מזהה האפליקציה של Azure Active Directory.

מדינה

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

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

AzureClusterResources

משאבי Azure מנוהלים עבור האשכול.

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

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

string

פלט בלבד. מזהה ה-ARM של קבוצת האבטחה של רשת האשכול.

controlPlaneApplicationSecurityGroupId

string

פלט בלבד. מזהה ה-ARM של קבוצת האבטחה של אפליקציית מישור הבקרה.

AzureClusterError

‫AzureClusterError מתאר שגיאות שנמצאו באשכולות Azure.

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

string

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

Methods

create
(deprecated)

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

delete
(deprecated)

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

generateAzureAccessToken
(deprecated)

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

generateAzureClusterAgentToken
(deprecated)

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

get
(deprecated)

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

getJwks
(deprecated)

מקבל את הרכיב הציבורי של מפתחות החתימה של האשכול בפורמט מפתח אינטרנט מבוסס JSON.

list
(deprecated)

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

patch
(deprecated)

מעדכן AzureCluster.