Melihat cluster Google Cloud Managed Service for Apache Kafka

Untuk melihat cluster, Anda dapat menggunakan konsol Google Cloud , Google Cloud CLI, library klien, atau Managed Kafka API. Anda tidak dapat menggunakan Apache Kafka API open source untuk melihat cluster.

Peran dan izin yang diperlukan untuk melihat cluster

Untuk mendapatkan izin yang diperlukan guna melihat cluster, minta administrator untuk memberi Anda peran IAM Managed Kafka Viewer (roles/managedkafka.viewer) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Peran bawaan ini berisi izin yang diperlukan untuk melihat cluster. Untuk melihat izin yang benar-benar diperlukan, perluas bagian Izin yang diperlukan:

Izin yang diperlukan

Izin berikut diperlukan untuk melihat cluster:

Mencantumkan cluster: managedkafka.clusters.list
Dapatkan detail cluster: managedkafka.clusters.get

Anda mungkin juga bisa mendapatkan izin ini dengan peran khusus atau peran bawaan lainnya.

Untuk mengetahui informasi selengkapnya tentang peran Managed Kafka Viewer, lihat Peran standar Managed Service for Apache Kafka.

Melihat cluster

Untuk melihat cluster, ikuti langkah-langkah berikut:

Konsol

Di konsol Google Cloud , buka halaman Clusters.

Buka Cluster

Cluster yang Anda buat dalam project akan dicantumkan.
Untuk melihat cluster tertentu, klik nama cluster.
Halaman detail cluster akan terbuka. Halaman ini memiliki tab berikut:
- Resources: Menampilkan daftar topik dan grup konsumen yang terkait dengan cluster.
- Konfigurasi: Menampilkan konfigurasi cluster, termasuk daftar subnet yang terkait dengan cluster.
- Monitoring: Menampilkan pemberitahuan pemantauan yang terkait dengan cluster.
- Log: Menampilkan log terkait cluster dari Logs Explorer.

gcloud

In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
Jalankan perintah gcloud managed-kafka clusters describe:
```
gcloud managed-kafka clusters describe CLUSTER_ID \
    --location=LOCATION \
    --full
```
Ganti kode berikut:
- CLUSTER_ID: ID atau nama cluster.
- LOCATION: Lokasi cluster.
Flag --full bersifat opsional. Jika Anda menyertakan tanda ini, perintah akan menampilkan informasi tambahan, termasuk informasi tentang broker cluster dan nomor versi Kafka yang dijalankan cluster.

REST

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

PROJECT_ID: Project ID Google Cloud Anda
LOCATION: lokasi cluster
CLUSTER_ID: ID cluster
CLUSTER_VIEW: jumlah metadata yang akan ditampilkan. Tentukan salah satu nilai berikut:
- CLUSTER_VIEW_BASIC: Menampilkan metadata dasar untuk cluster.
- CLUSTER_VIEW_FULL: Menampilkan semua metadata untuk cluster, termasuk informasi tentang broker cluster dan nomor versi Kafka yang dijalankan cluster.
Jika tidak ditentukan, metode defaultnya adalah CLUSTER_VIEW_BASIC.

Metode HTTP dan URL:

GET https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW"

PowerShell (Windows)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Jalankan perintah berikut:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW" | Select-Object -Expand Content

Anda akan melihat respons JSON seperti berikut:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID",
  "createTime": "CREATE_TIME",
  "updateTime": "UPDATE_TIME",
  "capacityConfig": {
    "vcpuCount": "CPU_COUNT",
    "memoryBytes": "MEMORY"
  },
  "rebalanceConfig": {},
  "gcpConfig": {
    "accessConfig": {
      "networkConfigs": [
        {
          "subnet": "projects/PROJECT_ID/locations/LOCATION/subnetworks/SUBNET_ID"
        }
      ]
    }
  },
  "state": "ACTIVE",
  "satisfiesPzi": false,
  "satisfiesPzs": false,
  "tlsConfig": {
    "trustConfig": {}
  },
  "updateOptions": {}
}

Go

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Go di Menginstal library klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Managed Service for Apache Kafka Go API.

Untuk melakukan autentikasi ke Managed Service untuk Apache Kafka, siapkan Kredensial Default Aplikasi(ADC). Untuk mengetahui informasi selengkapnya, lihat Menyiapkan ADC untuk lingkungan pengembangan lokal.

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
	"google.golang.org/api/option"

	managedkafka "cloud.google.com/go/managedkafka/apiv1"
)

func getCluster(w io.Writer, projectID, region, clusterID string, opts ...option.ClientOption) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	// clusterID := "my-cluster"
	ctx := context.Background()
	client, err := managedkafka.NewClient(ctx, opts...)
	if err != nil {
		return fmt.Errorf("managedkafka.NewClient got err: %w", err)
	}
	defer client.Close()

	clusterPath := fmt.Sprintf("projects/%s/locations/%s/clusters/%s", projectID, region, clusterID)
	req := &managedkafkapb.GetClusterRequest{
		Name: clusterPath,
	}
	cluster, err := client.GetCluster(ctx, req)
	if err != nil {
		return fmt.Errorf("client.GetCluster got err: %w", err)
	}
	fmt.Fprintf(w, "Got cluster: %#v\n", cluster)
	return nil
}

Java

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Java di Menginstal library klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Managed Service for Apache Kafka Java API.

Untuk melakukan autentikasi ke Managed Service for Apache Kafka, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan ADC untuk lingkungan pengembangan lokal.

import com.google.api.gax.rpc.ApiException;
import com.google.cloud.managedkafka.v1.Cluster;
import com.google.cloud.managedkafka.v1.ClusterName;
import com.google.cloud.managedkafka.v1.ManagedKafkaClient;
import java.io.IOException;

public class GetCluster {

  public static void main(String[] args) throws Exception {
    // TODO(developer): Replace these variables before running the example.
    String projectId = "my-project-id";
    String region = "my-region"; // e.g. us-east1
    String clusterId = "my-cluster";
    getCluster(projectId, region, clusterId);
  }

  public static void getCluster(String projectId, String region, String clusterId)
      throws Exception {
    try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
      // This operation is being handled synchronously.
      Cluster cluster = managedKafkaClient.getCluster(ClusterName.of(projectId, region, clusterId));
      System.out.println(cluster.getAllFields());
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaClient.getCluster got err: %s", e.getMessage());
    }
  }
}

Python

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Menginstal library klien. Untuk mengetahui informasi selengkapnya, lihat dokumentasi referensi Managed Service for Apache Kafka Python API.

from google.api_core.exceptions import NotFound
from google.cloud import managedkafka_v1

# TODO(developer)
# project_id = "my-project-id"
# region = "us-central1"
# cluster_id = "my-cluster"

client = managedkafka_v1.ManagedKafkaClient()

cluster_path = client.cluster_path(project_id, region, cluster_id)
request = managedkafka_v1.GetClusterRequest(
    name=cluster_path,
)

try:
    cluster = client.get_cluster(request=request)
    print("Got cluster:", cluster)
except NotFound as e:
    print(f"Failed to get cluster {cluster_id} with error: {e.message}")

Melihat properti dan resource cluster

Bagian berikut menjelaskan cara mendapatkan detail tentang berbagai properti dan resource yang terkait dengan cluster Managed Service for Apache Kafka.

Alamat bootstrap

Klien Kafka menggunakan alamat bootstrap cluster untuk membuat koneksi dengan cluster. Untuk mendapatkan alamat bootstrap, lakukan langkah-langkah berikut:

Konsol

Buka halaman Managed Service for Apache Kafka > Clusters.

Buka Cluster
Klik nama cluster.
Pilih tab Configurations.
Jika Anda menggunakan SASL untuk mengautentikasi, URL bootstrap tercantum di bagian mTLS bootstrap URL.

Jika Anda menggunakan TLS bersama (mTLS) untuk mengautentikasi, URL bootstrap dicantumkan di bagian URL bootstrap mTLS.

Klik Salin untuk menyalin nilai.

gcloud

Untuk mendapatkan URL bootstrap, gunakan perintah managed-kafka clusters describe.

Jika Anda menggunakan SASL untuk mengautentikasi, jalankan perintah berikut:

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --format="value(bootstrapAddress)"

Jika Anda menggunakan TLS bersama (mTLS) untuk mengautentikasi, jalankan perintah berikut:

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --format="value(bootstrapAddressMTLS)"

Ganti kode berikut:

CLUSTER_ID: ID atau nama cluster.
LOCATION: Lokasi cluster.

Untuk mengetahui informasi selengkapnya tentang autentikasi SASL dan mTLS, lihat Jenis autentikasi untuk broker Kafka.

Broker

Managed Service for Apache Kafka secara otomatis menyediakan broker untuk cluster. Broker memiliki properti berikut:

brokerIndex: Indeks broker berbasis nol.
nodeId: ID node untuk broker.
rack: Zona tempat broker disediakan, misalnya us-central1-a.

Untuk melihat broker cluster, lakukan langkah-langkah berikut.

Konsol

Buka halaman Managed Service for Apache Kafka > Clusters.

Buka Cluster
Klik nama cluster.
Pilih tab Configurations. Broker cluster tercantum di bagian Active Brokers.

gcloud

Untuk mendapatkan daftar broker cluster, gunakan perintah managed-kafka clusters describe dengan flag --full.

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --full \
  --format="yaml(brokerDetails)"

Ganti kode berikut:

CLUSTER_ID: ID atau nama cluster.
LOCATION: Lokasi cluster.

Outputnya akan terlihat mirip seperti berikut:

brokerDetails:
- brokerIndex: '0'
  nodeId: '10'
  rack: us-central1-c
- brokerIndex: '1'
  nodeId: '11'
  rack: us-central1-f
- brokerIndex: '2'
  nodeId: '12'
  rack: us-central1-b

Kafka CLI

Sebelum menjalankan perintah ini, instal alat command line Kafka di VM Compute Engine. VM harus dapat menjangkau subnet yang terhubung ke cluster Managed Service untuk Apache Kafka. Ikuti petunjuk di Membuat dan menggunakan pesan dengan alat command line Kafka.

Untuk mendapatkan daftar broker cluster, gunakan perintah kafka-configs.sh --describe dengan flag --entity-type=brokers.

kafka-configs.sh --describe --entity-type brokers \
  --bootstrap-server=BOOTSTRAP_ADDRESS \
  --command-config client.properties

Ganti BOOTSTRAP_ADDRESS dengan alamat bootstrap cluster.

Perintah ini akan menampilkan daftar ID broker, beserta setelan konfigurasi dinamisnya, jika ada. Metode ini tidak menampilkan properti rack.

Grup konsumen

Grup konsumen adalah sekumpulan konsumen yang bekerja sama untuk menggunakan data dari berbagai topik. Untuk melihat grup konsumen untuk cluster, lihat halaman berikut:

Subnet

Untuk melihat subnet yang terhubung ke cluster Anda, lakukan langkah-langkah berikut:

Konsol

Di konsol Google Cloud , buka halaman Clusters.

Buka Cluster
Klik nama cluster.
Di halaman detail cluster, klik tab Configurations. Subnet yang terhubung tercantum di bagian Subnet.

gcloud

Jalankan perintah gcloud managed-kafka clusters describe:

gcloud managed-kafka clusters describe CLUSTER_ID \
    --location=LOCATION \
    --format="yaml(gcpConfig.accessConfig.networkConfigs)"

Ganti kode berikut:

CLUSTER_ID: ID atau nama cluster.
LOCATION: Lokasi cluster.

Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi jaringan untuk Managed Service for Apache Kafka.

Topik

Untuk melihat topik dalam cluster, lihat halaman berikut:

Apa langkah selanjutnya?

Apache Kafka® adalah merek dagang terdaftar milik The Apache Software Foundation atau afiliasinya di Amerika Serikat dan/atau negara lain.

Melihat cluster Google Cloud Managed Service for Apache Kafka Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Peran dan izin yang diperlukan untuk melihat cluster

Izin yang diperlukan

Melihat cluster

Konsol

gcloud

REST

curl (Linux, macOS, atau Cloud Shell)

PowerShell (Windows)

Go

Java

Python

Melihat properti dan resource cluster

Alamat bootstrap

Konsol

gcloud

Broker

Konsol

gcloud

Kafka CLI

Grup konsumen

Subnet

Konsol

gcloud

Topik

Apa langkah selanjutnya?

Melihat cluster Google Cloud Managed Service for Apache Kafka