Criar um registro de esquema

Um registro de esquema é um repositório para gerenciar esquemas usados pelos produtores e consumidores do Kafka.

Neste documento, mostramos como criar um recurso de registro de esquema no Serviço gerenciado para Apache Kafka usando o consoleGoogle Cloud , a Google Cloud CLI ou a API Managed Kafka.

Antes de começar

Antes de criar um registro de esquema, faça o seguinte:

Papéis e permissões necessárias

Para receber as permissões necessárias para criar um registro de esquema, peça ao administrador para conceder a você o papel do IAM de Editor do registro de esquema do Kafka gerenciado (roles/managedkafka.schemaRegistryEditor) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esse papel predefinido contém as permissões necessárias para criar um registro de esquema. Para acessar as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para criar um registro de esquema:

  • Conceda essa permissão no local principal: managedkafka.schemaRegistries.create

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Funções de nível mais alto, como Administrador do registro de esquema gerenciado do Kafka, também permitem criar e gerenciar registros de esquema.

Para mais informações sobre os papéis predefinidos disponíveis para o serviço gerenciado para Apache Kafka, consulte a documentação de controle de acesso.

Criar um registro de esquema

Console

  1. No console do Google Cloud , acesse a página Registros de esquema.

    Acessar registros de esquema

    A página Registros de esquema é aberta.

  2. Na página Registros de esquema, clique em Criar.

    A página Criar registro de esquema é aberta.

  3. Em Nome do registro de esquema, insira um identificador exclusivo para seu registro.

    O nome precisa começar com uma letra, conter apenas letras (a-z, A-Z), números (0-9) e sublinhados (_) e ter 63 caracteres ou menos.

  4. Selecione ou insira uma Região no menu.

    Você já precisa ter um ou vários clusters ativos do Serviço gerenciado para Apache Kafka na região especificada. Para verificar as regiões dos seus clusters, consulte a documentação sobre como listar seus clusters.

    Para ver uma lista de locais compatíveis, consulte Locais do serviço gerenciado para Apache Kafka.

  5. Clique em Criar.

gcloud

  1. Instale a CLI do Google Cloud. Após a instalação, inicialize a CLI do Google Cloud executando o seguinte comando: 

    gcloud init

    Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

  2. Use o comando gcloud beta managed-kafka schema-registries create para criar um registro de esquema:

    gcloud beta managed-kafka schema-registries create SCHEMA_REGISTRY_ID \
    --location=LOCATION \

    Substitua:

    • SCHEMA_REGISTRY_ID (obrigatório): um identificador exclusivo para seu novo registro de esquema. Isso faz parte do nome do recurso do registro. O nome precisa começar com uma letra, conter apenas letras (a-z, A-Z), números (0-9) e sublinhados (_) e ter 63 caracteres ou menos.
    • LOCATION (obrigatório): a região do Google Cloud em que o registro de esquema será criado. Esse local precisa corresponder à região do cluster ou dos clusters do Serviço gerenciado para Apache Kafka que usam esse registro. Para conferir os locais compatíveis, consulte Locais do Serviço gerenciado para Apache Kafka.

    Para criar um registro de esquema chamado test_schema_registry na região us-central1, execute o seguinte comando:

    gcloud beta managed-kafka schema-registries create test_schema_registry \
    --location=us-central1

    Depois que o comando for concluído, o registro de esquema será criado. Em seguida, configure os clientes do Kafka para usar o URL. Para conferir o URL do registro de esquema, consulte Detalhes da página do registro de esquema.

REST

Para criar uma instância do registro de esquema usando a API REST, siga estas etapas.

  1. Envie uma solicitação POST semelhante a esta:
    2. POST https://managedkafka.googleapis.com/v1main/projects/PROJECT_ID/locations/LOCATION/schemaRegistries
Authorization: Bearer $(gcloud auth application-default print-access-token)
Content-Type: application/json --data @response-body.json
  2. Crie um arquivo JSON request-body.json com a seguinte estrutura:
    3. {
  "schemaRegistryId": "SCHEMA_REGISTRY_ID"
}

    Substitua:

    • SCHEMA_REGISTRY_ID (obrigatório): um identificador exclusivo para seu novo registro de esquema. Isso faz parte do nome do recurso do registro. O nome precisa começar com uma letra, conter apenas letras (a-z, A-Z), números (0-9) e sublinhados (_) e ter 63 caracteres ou menos.

    Execute a solicitação POST com o URI, os cabeçalhos e o corpo construídos. Se a solicitação for bem-sucedida, a API vai retornar um código de status 200 OK e um corpo de resposta que contém a representação JSON do recurso SchemaRegistry recém-criado.

    Confira a seguir um exemplo de resposta bem-sucedida.

    {
  "name": "projects/testing-311516/locations/us-central1/schemaRegistries/test",
  "contexts": [
    "projects/testing-311516/locations/us-central1/schemaRegistries/test/contexts/."
  ]
}

    O projects/testing-311516/locations/us-central1/schemaRegistries/test/contexts/. representa o contexto padrão. Os recursos no contexto padrão não exigem que um contexto seja especificado.

    Para mais informações, consulte a documentação da API REST.

Apache Kafka® é uma marca registrada da The Apache Software Foundation ou afiliadas nos Estados Unidos e/ou em outros países.

A seguir