Afficher un cluster Google Cloud Managed Service pour Apache Kafka

Pour afficher un cluster, vous pouvez utiliser la Google Cloud console, Google Cloud CLI, la bibliothèque cliente ou l'API Managed Kafka. Vous ne pouvez pas utiliser l'API Apache Kafka Open Source pour afficher un cluster.

Rôles et autorisations requis pour afficher un cluster

Pour obtenir les autorisations nécessaires pour afficher un cluster, demandez à votre administrateur de vous accorder le rôle IAM Lecteur de Managed Kafka (roles/managedkafka.viewer) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient les autorisations requises pour afficher un cluster. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour afficher un cluster :

  • Répertorier les clusters : managedkafka.clusters.list
  • Obtenir les détails du cluster : managedkafka.clusters.get

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Afficher un cluster

Pour afficher un cluster, procédez comme suit :

Console

  1. Dans la console Google Cloud , accédez à la page Clusters.

    accéder aux clusters

    Les clusters que vous avez créés dans un projet sont listés.

  2. Pour afficher un cluster spécifique, cliquez sur son nom.

  3. La page des détails du cluster s'ouvre. Elle comporte les onglets suivants :

    • Ressources : affiche la liste des sujets et des groupes de consommateurs associés au cluster.
    • Configurations : affiche la configuration du cluster, y compris la liste des sous-réseaux associés au cluster.
    • Surveillance : affiche les alertes de surveillance associées au cluster.
    • Journaux : affiche les journaux liés aux clusters à partir de l'explorateur de journaux.

gcloud

  1. Dans la Google Cloud console, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la Google Cloud console, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  2. Exécutez la gcloud managed-kafka clusters describe commande :

    gcloud managed-kafka clusters describe CLUSTER_ID \
    --location=LOCATION \
    --full

    Remplacez les éléments suivants :

    • CLUSTER_ID : ID ou nom du cluster.
    • LOCATION : emplacement du cluster.

    L'option --full est facultative. Si vous incluez cette option, la commande renvoie des informations supplémentaires, y compris des informations sur les agents du cluster's brokers et le numéro de version de Kafka que le cluster est exécute.

REST

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID: ID de votre Google Cloud projet
  • LOCATION : emplacement du cluster
  • CLUSTER_ID : ID du cluster

  • CLUSTER_VIEW : quantité de métadonnées à renvoyer. Spécifiez une des valeurs suivantes :

    • CLUSTER_VIEW_BASIC : renvoie les métadonnées de base du cluster.
    • CLUSTER_VIEW_FULL : renvoie toutes les métadonnées du cluster, y compris des informations sur les agents du cluster et le numéro de version de Kafka que le cluster exécute.

    Si aucune valeur n'est spécifiée, la méthode utilise par défaut CLUSTER_VIEW_BASIC.

Méthode HTTP et URL : 

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

Pour envoyer votre requête, développez l'une des options suivantes :

Vous devriez recevoir une réponse JSON de ce type :

{
  "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

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go dans Installer les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Managed Service pour Apache Kafka en langage Go.

Pour vous authentifier auprès de Managed Service pour Apache Kafka, configurez les identifiants par défaut de l'application(ADC). Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local.

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

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java dans Installer les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Managed Service pour Apache Kafka en langage Java.

Pour vous authentifier auprès de Managed Service pour Apache Kafka, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local.

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

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python dans Installer les bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Python de Managed Service pour Apache Kafka.

Pour vous authentifier auprès de Managed Service pour Apache Kafka, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer les ADC pour un environnement de développement local.

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}")

Afficher les propriétés et les ressources du cluster

Les sections suivantes décrivent comment obtenir des informations sur différentes propriétés et ressources associées à un cluster Managed Service pour Apache Kafka.

Adresse bootstrap

Les clients Kafka utilisent l'adresse bootstrap du cluster pour établir une connexion avec le cluster. Pour obtenir l'adresse bootstrap, procédez comme suit :

Console

  1. Accédez à la page Managed Service pour Apache Kafka > Clusters.

    accéder aux clusters

  2. Cliquez sur le nom du cluster.

  3. Accédez à l'onglet Configurations.

  4. Si vous utilisez SASL pour l'authentification, l'URL bootstrap est listée sous URL bootstrap mTLS.

    Si vous utilisez le protocole TLS mutuel (mTLS) pour l'authentification, l'URL bootstrap est listée sous URL bootstrap mTLS.

    Cliquez sur Copier pour copier la valeur.

gcloud

Pour obtenir l'URL bootstrap, utilisez la managed-kafka clusters describe commande.

Si vous utilisez SASL pour l'authentification, exécutez la commande suivante :

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

Si vous utilisez le protocole TLS mutuel (mTLS) pour l'authentification, exécutez la commande suivante :

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

Remplacez les éléments suivants :

  • CLUSTER_ID : ID ou nom du cluster.
  • LOCATION : emplacement du cluster.

Pour en savoir plus sur l'authentification SASL et mTSL, consultez Types d'authentification pour les agents Kafka.

Courtiers

Pour afficher les agents de votre cluster, consultez Afficher les agents dans un cluster Managed Service pour Apache Kafka.

Groupes de consommateurs

Un groupe de consommateurs est un ensemble de consommateurs qui coopèrent pour consommer des données provenant de différents sujets. Pour afficher les groupes de consommateurs d'un cluster, consultez les pages suivantes :

Sous-réseaux

Pour afficher les sous-réseaux connectés à votre cluster, procédez comme suit :

Console

  1. Dans la console Google Cloud , accédez à la page Clusters.

    accéder aux clusters

  2. Cliquez sur le nom du cluster.

  3. Sur la page d'informations du cluster, cliquez sur l'onglet Configurations. Les sous-réseaux connectés sont listés sous Sous-réseaux.

gcloud

  1. Exécutez la gcloud managed-kafka clusters describe commande :

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

    Remplacez les éléments suivants :

    • CLUSTER_ID : ID ou nom du cluster.
    • LOCATION : emplacement du cluster.

Pour en savoir plus, consultez Configurer la mise en réseau pour Managed Service pour Apache Kafka.

Thèmes

Pour afficher les sujets d'un cluster, consultez les pages suivantes :

Étape suivante

Apache Kafka® est une marque déposée d'Apache Software Foundation ou de ses filiales aux États-Unis et/ou dans d'autres pays.