Cómo ver un clúster de Google Cloud Managed Service para Apache Kafka

Para ver un clúster, puedes usar la consola de Google Cloud , Google Cloud CLI, la biblioteca cliente o la API de Managed Kafka. No puedes usar la API de Apache Kafka de código abierto para ver un clúster.

Roles y permisos obligatorios para ver un clúster

Para obtener los permisos que necesitas para ver un clúster, pídele a tu administrador que te otorgue el rol de IAM Visualizador de Kafka administrado (roles/managedkafka.viewer) en tu proyecto. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Este rol predefinido contiene los permisos necesarios para ver un clúster. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

Permisos necesarios

Se requieren los siguientes permisos para ver un clúster:

• Lista de clústeres: managedkafka.clusters.list
• Obtén detalles del clúster: managedkafka.clusters.get

También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.

Para obtener más información sobre el rol de visualizador de Kafka administrado, consulta Roles predefinidos de Managed Service para Apache Kafka.

Cómo ver un clúster

Para ver un clúster, sigue estos pasos:

Console

1. En la consola de Google Cloud , ve a la página Clústeres.

   Ir a los clústeres

   Se muestran los clústeres que creaste en un proyecto.

2. Para ver un clúster específico, haz clic en su nombre.

3. Se abrirá la página de detalles del clúster. Esta página tiene las siguientes pestañas:

   • Recursos: Muestra la lista de temas y grupos de consumidores asociados con el clúster.
   • Configuraciones: Muestra la configuración del clúster, incluida la lista de subredes asociadas con el clúster.
   • Monitoring: Muestra las alertas de supervisión asociadas con el clúster.
   • Registros: Muestra los registros relacionados con los clústeres del Explorador de registros.

gcloud

1. 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.

2. Ejecuta el comando gcloud managed-kafka clusters describe:

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

   Reemplaza lo siguiente:

   • CLUSTER_ID: Es el ID o el nombre del clúster.
   • LOCATION: Es la ubicación del clúster.

   La marca --full es opcional. Si incluyes esta marca, el comando devolverá información adicional, incluida la información sobre los agentes del clúster y el número de versión de Kafka que ejecuta el clúster.

REST

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

• PROJECT_ID: El ID de tu proyecto de Google Cloud
• LOCATION: Es la ubicación del clúster.
• CLUSTER_ID: ID del clúster

• CLUSTER_VIEW: Es la cantidad de metadatos que se devolverán. Especifica uno de los siguientes valores:

  • CLUSTER_VIEW_BASIC: Devuelve los metadatos básicos del clúster.
  • CLUSTER_VIEW_FULL: Devuelve todos los metadatos del clúster, incluida la información sobre los intermediarios del clúster y el número de versión de Kafka que ejecuta el clúster.

  Si no se especifica, el método predeterminado es CLUSTER_VIEW_BASIC.

Método HTTP y URL:

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

Para enviar tu solicitud, expande una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Nota: Con el siguiente comando, se supone que accediste a gcloud CLI con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login , o a través del uso de Cloud Shell, que accede de forma automática a gcloud CLI . Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Ejecuta el siguiente comando:

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)

Nota: El siguiente comando supone que accediste a gcloud CLI con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login . Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Ejecuta el siguiente comando:

$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

Deberías recibir una respuesta JSON similar a la que se muestra a continuación:

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

Antes de probar este ejemplo, sigue las instrucciones de configuración de Go en Instala las bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Managed Service para Apache Kafka en Go.

Para autenticarte en Managed Service for Apache Kafka, configura las credenciales predeterminadas de la aplicación(ADC). Para obtener más información, consulta Configura ADC para un entorno de desarrollo 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

Antes de probar este ejemplo, sigue las instrucciones de configuración de Java en Instala las bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Java de Managed Service for Apache Kafka.

Para autenticarte en el servicio administrado para Apache Kafka, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura ADC para un entorno de desarrollo 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

Antes de probar este ejemplo, sigue las instrucciones de configuración de Python en Instala las bibliotecas cliente. Si deseas obtener más información, consulta la documentación de referencia de la API de Python de Managed Service for Apache Kafka.

Para autenticarte en el servicio administrado para Apache Kafka, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura ADC para un entorno de desarrollo 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}")

Cómo ver las propiedades y los recursos del clúster

En las siguientes secciones, se describe cómo obtener detalles sobre diversas propiedades y recursos asociados a un clúster de Managed Service para Apache Kafka.

Dirección de arranque

Los clientes de Kafka usan la dirección de inicio del clúster para establecer una conexión con él. Para obtener la dirección de arranque, sigue estos pasos:

Console

1. Ve a la página Managed Service para Apache Kafka > Clústeres.

   Ir a los clústeres

2. Haz clic en el nombre del clúster.

3. Selecciona la pestaña Configuración.

4. Si usas SASL para la autenticación, la URL de arranque se muestra en URL de arranque de mTLS.

   Si usas TLS mutua (mTLS) para la autenticación, la URL de arranque se muestra en URL de arranque de mTLS.

   Haz clic en Copiar para copiar el valor.

gcloud

Para obtener la URL de arranque, usa el comando managed-kafka clusters describe.

Si usas SASL para la autenticación, ejecuta el siguiente comando:

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

Si usas la TLS mutua (mTLS) para la autenticación, ejecuta el siguiente comando:

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

Reemplaza lo siguiente:

• CLUSTER_ID: Es el ID o el nombre del clúster.
• LOCATION: Es la ubicación del clúster.

Para obtener más información sobre la autenticación SASL y mTLS, consulta Tipos de autenticación para agentes de Kafka.

Agentes

Managed Service para Apache Kafka aprovisiona automáticamente los agentes para un clúster. Un agente tiene las siguientes propiedades:

• brokerIndex: Es el índice basado en cero del agente.
• nodeId: Es el ID del nodo del agente.
• rack: La zona en la que se aprovisiona el agente, por ejemplo, us-central1-a.

Para ver los intermediarios de un clúster, realiza los siguientes pasos.

Console

1. Ve a la página Managed Service para Apache Kafka > Clústeres.

   Ir a los clústeres

2. Haz clic en el nombre del clúster.

3. Selecciona la pestaña Configuración. Los agentes del clúster se muestran en Active Brokers.

gcloud

Para obtener una lista de los intermediarios del clúster, usa el comando managed-kafka clusters describe con la marca --full.

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

Reemplaza lo siguiente:

• CLUSTER_ID: Es el ID o el nombre del clúster.
• LOCATION: Es la ubicación del clúster.

El resultado es similar al siguiente:

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

CLI de Kafka

Antes de ejecutar este comando, instala las herramientas de línea de comandos de Kafka en una VM de Compute Engine. La VM debe poder acceder a una subred conectada a tu clúster de Managed Service para Apache Kafka. Sigue las instrucciones en Produce and consume messages with the Kafka command-line tools.

Para obtener una lista de los intermediarios del clúster, usa el comando kafka-configs.sh --describe con la marca --entity-type=brokers.

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

Reemplaza BOOTSTRAP_ADDRESS por la dirección de arranque del clúster.

Este comando devuelve una lista de IDs de intermediarios, junto con sus parámetros de configuración dinámicos, si los hay. No devuelve la propiedad rack.

Grupos de consumidores

Un grupo de consumidores es un conjunto de consumidores que cooperan para consumir datos de varios temas. Para ver los grupos de consumidores de un clúster, consulta las siguientes páginas:

• Enumera tus grupos de consumidores
• Cómo ver un grupo de consumidores

Subredes

Para ver las subredes conectadas a tu clúster, realiza los siguientes pasos:

Console

1. En la consola de Google Cloud , ve a la página Clústeres.

   Ir a los clústeres

2. Haz clic en el nombre del clúster.

3. En la página de detalles del clúster, haz clic en la pestaña Configuraciones. Las subredes conectadas se enumeran en Subredes.

gcloud

1. Ejecuta el comando gcloud managed-kafka clusters describe:

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

   Reemplaza lo siguiente:

   • CLUSTER_ID: Es el ID o el nombre del clúster.
   • LOCATION: Es la ubicación del clúster.

Para obtener más información, consulta Configura la red para Managed Service for Apache Kafka.

Temas

Para ver los temas de un clúster, consulta las siguientes páginas:

• Enumera tus temas
• Cómo ver un tema

Próximos pasos

• Supervisa tu clúster.

• Crea un tema en tu clúster.

• Edita un clúster.

• Borra el clúster.

Apache Kafka® es una marca registrada de The Apache Software Foundation o sus afiliados en Estados Unidos y otros países.