REST Resource: projects.locations.azureClusters

Resource: AzureCluster

Cluster Anthos yang berjalan di Azure.

Representasi 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)
  }
}
Kolom
name

string

Nama resource ini.

Nama cluster diformat sebagai projects/<project-number>/locations/<region>/azureClusters/<cluster-id>.

Lihat Nama Resource untuk mengetahui detail selengkapnya tentang nama resource Google Cloud Platform.

description

string

Opsional. Deskripsi cluster ini yang dapat dibaca manusia. Tidak boleh lebih dari 255 byte berenkode UTF-8.

azureRegion

string

Wajib. Region Azure tempat cluster berjalan.

Setiap region Google Cloud mendukung subset region Azure terdekat. Anda dapat memanggil locations.getAzureServerConfig untuk mencantumkan semua region Azure yang didukung dalam region Google Cloud tertentu.

resourceGroupId

string

Wajib. ID ARM grup resource tempat resource cluster di-deploy. Contoh: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>

azureClient

string

Opsional. Nama AzureClient yang berisi konfigurasi autentikasi untuk cara Anthos Multi-Cloud API terhubung ke Azure API.

azureClient atau azureServicesAuthentication harus diberikan.

Resource AzureClient harus berada di project dan region Google Cloud Platform yang sama dengan AzureCluster.

Nama AzureClient diformat sebagai projects/<project-number>/locations/<region>/azureClients/<client-id>.

Lihat Nama Resource untuk mengetahui detail selengkapnya tentang nama resource Google Cloud.

networking

object (AzureClusterNetworking)

Wajib. Konfigurasi jaringan seluruh cluster.

controlPlane

object (AzureControlPlane)

Wajib. Konfigurasi yang terkait dengan bidang kontrol cluster.

authorization

object (AzureAuthorization)

Wajib. Konfigurasi yang terkait dengan setelan RBAC cluster.

azureServicesAuthentication

object (AzureServicesAuthentication)

Opsional. Konfigurasi autentikasi untuk pengelolaan resource Azure.

azureClient atau azureServicesAuthentication harus diberikan.

state

enum (State)

Hanya output. Status cluster saat ini.

endpoint

string

Hanya output. Endpoint server API cluster.

uid

string

Hanya output. ID unik global untuk cluster.

reconciling

boolean

Hanya output. Jika disetel, saat ini ada perubahan yang sedang berlangsung pada cluster.

createTime

string (Timestamp format)

Hanya output. Waktu saat cluster ini dibuat.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Hanya output. Waktu saat cluster ini terakhir diperbarui.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

etag

string

Memungkinkan klien melakukan operasi baca-ubah-tulis yang konsisten melalui kontrol serentak optimis.

Dapat dikirim pada permintaan update dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.

annotations

map (key: string, value: string)

Opsional. Anotasi pada cluster.

Kolom ini memiliki batasan yang sama dengan anotasi Kubernetes. Ukuran total semua kunci dan nilai gabungan dibatasi hingga 256k. Kunci dapat memiliki 2 segmen: awalan (opsional) dan nama (wajib), yang dipisahkan dengan garis miring (/). Awalan harus berupa subdomain DNS. Nama harus terdiri dari maksimal 63 karakter, diawali dan diakhiri dengan alfanumerik, dengan tanda hubung (-), garis bawah (_), titik (.), dan alfanumerik di antaranya.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

workloadIdentityConfig

object (WorkloadIdentityConfig)

Hanya output. Setelan Workload Identity.

clusterCaCertificate

string

Hanya output. Sertifikat x509 berenkode PEM untuk root of trust cluster.

fleet

object (Fleet)

Wajib. Konfigurasi armada.

managedResources

object (AzureClusterResources)

Hanya output. Resource Azure terkelola untuk cluster ini.

loggingConfig

object (LoggingConfig)

Opsional. Konfigurasi logging untuk cluster ini.

errors[]

object (AzureClusterError)

Hanya output. Serangkaian error yang ditemukan di cluster.

monitoringConfig

object (MonitoringConfig)

Opsional. Konfigurasi pemantauan untuk cluster ini.

AzureClusterNetworking

ClusterNetworking berisi konfigurasi jaringan di seluruh cluster.

Representasi JSON
{
  "virtualNetworkId": string,
  "podAddressCidrBlocks": [
    string
  ],
  "serviceAddressCidrBlocks": [
    string
  ],
  "serviceLoadBalancerSubnetId": string
}
Kolom
virtualNetworkId

string

Wajib. ID Azure Resource Manager (ARM) VNet yang terkait dengan cluster Anda.

Semua komponen dalam cluster (yaitu bidang kontrol dan node pool) berjalan di satu VNet.

Contoh: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>

Kolom ini tidak dapat diubah setelah dibuat.

podAddressCidrBlocks[]

string

Wajib. Rentang alamat IP pod dalam cluster ini, dalam notasi CIDR (misalnya, 10.96.0.0/14).

Semua pod dalam cluster akan diberi alamat IPv4 unik dari rentang ini. Hanya satu rentang yang didukung.

Kolom ini tidak dapat diubah setelah dibuat.

serviceAddressCidrBlocks[]

string

Wajib. Rentang alamat IP untuk layanan di cluster ini, dalam notasi CIDR (misalnya, 10.96.0.0/14).

Semua layanan dalam cluster akan mendapatkan alamat IPv4 unik dari rentang ini. Hanya satu rentang yang didukung.

Kolom ini tidak dapat diubah setelah membuat cluster.

serviceLoadBalancerSubnetId

string

Opsional. ID ARM subnet tempat load balancer jenis layanan pribadi Kubernetes di-deploy. Jika tidak ditentukan, defaultnya adalah AzureControlPlane.subnet_id.

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

AzureControlPlane

AzureControlPlane merepresentasikan konfigurasi bidang kontrol.

Representasi 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
}
Kolom
version

string

Wajib. Versi Kubernetes yang akan dijalankan pada replika bidang kontrol (misalnya, 1.19.10-gke.1000).

Anda dapat mencantumkan semua versi yang didukung di region Google Cloud tertentu dengan memanggil locations.getAzureServerConfig.

subnetId

string

Opsional. ID ARM subnet default untuk bidang kontrol. VM bidang kontrol di-deploy di subnet ini, kecuali jika AzureControlPlane.replica_placements ditentukan. Subnet ini juga akan digunakan sebagai default untuk AzureControlPlane.endpoint_subnet_id jika AzureControlPlane.endpoint_subnet_id tidak ditentukan. Demikian pula, setelan ini akan digunakan sebagai default untuk AzureClusterNetworking.service_load_balancer_subnet_id.

Contoh: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default.

vmSize

string

Opsional. Nama ukuran VM Azure. Contoh: Standard_DS2_v2.

Untuk ukuran VM yang tersedia, lihat https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions.

Jika tidak ditentukan, setelan defaultnya adalah Standard_DS2_v2.

sshConfig

object (AzureSshConfig)

Wajib. Konfigurasi SSH untuk cara mengakses mesin bidang kontrol yang mendasarinya.

rootVolume

object (AzureDiskTemplate)

Opsional. Konfigurasi terkait volume root yang disediakan untuk setiap replika bidang kontrol.

Jika tidak ditentukan, defaultnya adalah Disk Azure 32-GiB.

mainVolume

object (AzureDiskTemplate)

Opsional. Konfigurasi terkait volume utama yang disediakan untuk setiap replika bidang kontrol. Volume utama bertanggung jawab untuk menyimpan semua status etcd cluster.

Jika tidak ditentukan, defaultnya adalah Disk Azure 8-GiB.

databaseEncryption

object (AzureDatabaseEncryption)

Opsional. Konfigurasi terkait enkripsi secret lapisan aplikasi.

proxyConfig

object (AzureProxyConfig)

Opsional. Konfigurasi proxy untuk traffic HTTP(S) keluar.

configEncryption

object (AzureConfigEncryption)

Opsional. Konfigurasi terkait enkripsi konfigurasi VM.

tags

map (key: string, value: string)

Opsional. Kumpulan tag yang akan diterapkan ke semua resource Azure bidang kontrol pokok.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

replicaPlacements[]

object (ReplicaPlacement)

Opsional. Konfigurasi untuk tempat menempatkan replika bidang kontrol.

Hingga tiga instance penempatan replika dapat ditentukan. Jika replicaPlacements disetel, instance penempatan replika akan diterapkan ke tiga replika bidang kontrol secara merata.

endpointSubnetId

string

Opsional. ID ARM subnet tempat load balancer bidang kontrol di-deploy. Jika tidak ditentukan, defaultnya adalah AzureControlPlane.subnet_id.

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

AzureDatabaseEncryption

Konfigurasi terkait enkripsi secret lapisan aplikasi.

Cluster Anthos di Azure mengenkripsi data Kubernetes Anda dalam penyimpanan di etcd menggunakan Azure Key Vault.

Representasi JSON
{
  "keyId": string
}
Kolom
keyId

string

Wajib. ID ARM kunci Azure Key Vault untuk mengenkripsi / mendekripsi data.

Misalnya: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.KeyVault/vaults/<key-vault-id>/keys/<key-name> Enkripsi akan selalu menggunakan versi terbaru kunci, sehingga versi tertentu tidak didukung.

ReplicaPlacement

Konfigurasi untuk penempatan replika bidang kontrol.

Representasi JSON
{
  "subnetId": string,
  "azureAvailabilityZone": string
}
Kolom
subnetId

string

Wajib. Untuk replika tertentu, ID ARM subnet tempat VM bidang kontrol di-deploy. Pastikan subnet tersebut berada di bawah jaringan virtual dalam konfigurasi cluster.

azureAvailabilityZone

string

Wajib. Untuk replika tertentu, zona ketersediaan Azure tempat VM bidang kontrol dan disk ETCD akan disediakan.

AzureAuthorization

Konfigurasi yang terkait dengan setelan RBAC cluster.

Representasi JSON
{
  "adminUsers": [
    {
      object (AzureClusterUser)
    }
  ],
  "adminGroups": [
    {
      object (AzureClusterGroup)
    }
  ]
}
Kolom
adminUsers[]

object (AzureClusterUser)

Opsional. Pengguna yang dapat melakukan operasi sebagai admin cluster. Managed ClusterRoleBinding akan dibuat untuk memberikan peran ClusterRole cluster-admin kepada pengguna. Hingga sepuluh pengguna admin dapat diberikan.

Untuk mengetahui info selengkapnya tentang RBAC, lihat https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles

adminGroups[]

object (AzureClusterGroup)

Opsional. Grup pengguna yang dapat melakukan operasi sebagai admin cluster. Managed ClusterRoleBinding akan dibuat untuk memberikan ClusterRole cluster-admin kepada grup. Maksimal sepuluh grup admin dapat diberikan.

Untuk mengetahui info selengkapnya tentang RBAC, lihat https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles

AzureClusterUser

Identitas subjek jenis pengguna untuk cluster Azure.

Representasi JSON
{
  "username": string
}
Kolom
username

string

Wajib. Nama pengguna, misalnya my-gcp-id@gmail.com.

AzureClusterGroup

Identitas subjek jenis grup untuk cluster Azure.

Representasi JSON
{
  "group": string
}
Kolom
group

string

Wajib. Nama grup, misalnya my-group@domain.com.

AzureServicesAuthentication

Konfigurasi autentikasi untuk pengelolaan resource Azure.

Representasi JSON
{
  "tenantId": string,
  "applicationId": string
}
Kolom
tenantId

string

Wajib. ID Tenant Azure Active Directory.

applicationId

string

Wajib. ID Aplikasi Azure Active Directory.

Negara bagian/Provinsi

Status siklus proses cluster.

Enum
STATE_UNSPECIFIED Belum ditetapkan.
PROVISIONING Status PROVISIONING menunjukkan bahwa cluster sedang dibuat.
RUNNING Status RUNNING menunjukkan bahwa cluster telah dibuat dan dapat digunakan sepenuhnya.
RECONCILING Status MENYAMAKAN menunjukkan bahwa beberapa pekerjaan sedang aktif dilakukan di cluster, seperti mengupgrade replika bidang kontrol.
STOPPING Status STOPPING menunjukkan bahwa cluster sedang dihapus.
ERROR Status ERROR menunjukkan bahwa cluster berada dalam status rusak yang tidak dapat dipulihkan.
DEGRADED Status DEGRADED menunjukkan bahwa cluster memerlukan tindakan pengguna untuk memulihkan fungsi penuh.

AzureClusterResources

Resource Azure terkelola untuk cluster.

Nilai dapat berubah dan kosong, bergantung pada status cluster.

Representasi JSON
{
  "networkSecurityGroupId": string,
  "controlPlaneApplicationSecurityGroupId": string
}
Kolom
networkSecurityGroupId

string

Hanya output. ID ARM grup keamanan jaringan cluster.

controlPlaneApplicationSecurityGroupId

string

Hanya output. ID ARM grup keamanan aplikasi bidang kontrol.

AzureClusterError

AzureClusterError menjelaskan error yang ditemukan di cluster Azure.

Representasi JSON
{
  "message": string
}
Kolom
message

string

Deskripsi error yang mudah dipahami.

Metode

create
(deprecated)

Membuat resource AzureCluster baru di project dan region Google Cloud Platform tertentu.

delete
(deprecated)

Menghapus resource AzureCluster tertentu.

generateAzureAccessToken
(deprecated)

Membuat token akses berjangka pendek untuk mengautentikasi ke resource AzureCluster tertentu.

generateAzureClusterAgentToken
(deprecated)

Membuat token akses untuk agen cluster.

get
(deprecated)

Menjelaskan resource AzureCluster tertentu.

getJwks
(deprecated)

Mendapatkan komponen publik kunci penandatanganan cluster dalam format JSON Web Key.

list
(deprecated)

Mencantumkan semua resource AzureCluster pada project dan region Google Cloud tertentu.

patch
(deprecated)

Memperbarui AzureCluster.