Invocar um endpoint privado compatível com o VPC Service Controls

É possível segmentar um endpoint privado para chamadas HTTP da execução do fluxo de trabalho usando o registro de serviço do Diretório de serviços com o Workflows. Ao criar um endpoint particular em uma rede de nuvem privada virtual (VPC), ele pode ser compatível com o VPC Service Controls.

O VPC Service Controls oferece uma camada extra de defesa de segurança que é independente do Identity and Access Management (IAM). Enquanto o IAM permite um controle de acesso baseado em identidade granular, o VPC Service Controls permite uma segurança de perímetro baseada em contexto mais ampla, incluindo o controle da saída de dados em todo o perímetro.

  • O Diretório de serviços é um registro de serviços que armazena informações sobre serviços de rede registrados, incluindo nomes, locais e atributos. Independentemente da infraestrutura, é possível registrar serviços automaticamente e capturar os detalhes deles. Isso permite que você descubra, publique e conecte serviços em grande escala para todos os endpoints de serviço.

  • Uma rede VPC oferece conectividade para instâncias de máquina virtual (VM) e permite criar endpoints particulares na rede VPC usando endereços IP internos. As chamadas HTTP para um recurso de rede VPC são enviadas por uma rede privada enquanto aplicam o IAM e o VPC Service Controls.

  • O VPC Service Controls é um recurso do Google Cloud que permite configurar um perímetro de serviço e criar um limite de transferência de dados. É possível usar o VPC Service Controls com Workflows para ajudar a proteger seus serviços e reduzir o risco de exfiltração de dados.

Neste documento, mostramos como registrar uma VM em uma rede VPC como um endpoint do diretório de serviços. Isso permite que você forneça ao fluxo de trabalho um nome de serviço do Diretório de serviços. A execução do fluxo de trabalho usa as informações recuperadas do registro de serviço para enviar a solicitação HTTP adequada, sem sair para uma rede pública.

Este diagrama apresenta uma visão geral:

Como enviar uma solicitação HTTP para um número de porta em uma instância de VM usando informações do diretório de serviços

Em geral, você precisa fazer o seguinte:

  1. Conceda permissões ao agente de serviço do Cloud Workflows para que ele possa acessar os recursos do Diretório de serviços e acessar redes VPC usando o Diretório de serviços.
  2. Crie uma rede VPC para fornecer funcionalidade de rede.
  3. Crie uma regra de firewall da VPC para permitir ou negar tráfego de/para instâncias de VM na rede VPC.
  4. Crie uma instância de VM na rede VPC. Uma instância de VM do Compute Engine é uma máquina virtual hospedada na infraestrutura do Google. Os termos instância do Compute Engine, instância de VM e VM são sinônimos e são usados de forma intercambiável.
  5. Implantar um aplicativo na VM. É possível executar um app na instância de VM e confirmar se o tráfego está sendo veiculado conforme o esperado.
  6. Configure o Diretório de serviços para que a execução do fluxo de trabalho possa invocar um endpoint do Diretório de serviços.

  7. Crie e implante seu fluxo de trabalho. O valor private_service_name no seu fluxo de trabalho especifica o endpoint do diretório de serviços que você registrou na etapa anterior.

Conceder permissões ao agente de serviço do Cloud Workflows

Alguns serviços do Google Cloud têm agentes de serviços que permitem que os serviços acessem seus recursos. Se uma API exigir um agente de serviço, o Google criará esse agente depois que você ativar e começar a usar a API.

  1. Quando você implanta um fluxo de trabalho pela primeira vez, o agente de serviço do Cloud Workflows é criado automaticamente com o seguinte formato:

    service-PROJECT_NUMBER@gcp-sa-workflows.iam.gserviceaccount.com

    É possível criar manualmente a conta de serviço em um projeto sem fluxos de trabalho com este comando:

    gcloud beta services identity create \
        --service=workflows.googleapis.com \
        --project=PROJECT_ID

    Substitua o PROJECT_ID pelo ID do projeto do Google Cloud.

  2. Para acessar os recursos do Diretório de serviços, conceda o papel de leitor do Diretório de serviços (servicedirectory.viewer) no projeto ao agente de serviço Workflows:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-workflows.iam.gserviceaccount.com \
        --role=roles/servicedirectory.viewer

    Substitua PROJECT_NUMBER pelo número do projeto do Google Cloud. Encontre o número do projeto na página Boas-vindas do console do Google Cloud ou executando o seguinte comando:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'
  3. Para acessar redes VPC usando o Diretório de serviços, conceda a função de serviço autorizado do Private Service Connect (roles/servicedirectory.pscAuthorizedService) no projeto ao agente de serviço de Workflows:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-workflows.iam.gserviceaccount.com \
        --role=roles/servicedirectory.pscAuthorizedService

Crie uma rede VPC

Uma rede VPC é uma versão virtual de uma rede física, implementada dentro da rede de produção do Google Ela fornece conectividade para suas instâncias de VM do Compute Engine.

É possível criar uma rede VPC de modo automático ou personalizado. Cada rede nova que você cria precisa ter um nome exclusivo no mesmo projeto.

Por exemplo, o comando a seguir cria uma rede VPC de modo automático:

gcloud compute networks create NETWORK_NAME \
    --subnet-mode=auto

Substitua NETWORK_NAME por um nome para a rede VPC.

Para mais informações, consulte Criar e gerenciar redes VPC.

Criar uma regra de firewall da VPC

Com as regras de firewall da VPC, é possível permitir ou negar o tráfego de/para instâncias de VM em uma rede VPC com base em número de porta, tag ou protocolo.

As regras de firewall são identificadas no nível da rede e se aplicam apenas à rede em que são criadas. No entanto, o nome escolhido para cada regra precisa ser único no projeto.

Por exemplo, o comando a seguir cria uma regra de firewall para uma rede VPC especificada e permite o tráfego de entrada de qualquer endereço IPv4, 0.0.0.0/0. O valor da flag --rules de all torna a regra aplicável a todos os protocolos e todas as portas de destino.

gcloud compute firewall-rules create RULE_NAME \
    --network=projects/PROJECT_ID/global/networks/NETWORK_NAME \
    --direction=INGRESS \
    --action=ALLOW \
    --source-ranges=0.0.0.0/0 \
    --rules=all

Substitua RULE_NAME por um nome para a regra de firewall.

Para mais informações, consulte Usar regras de firewall da VPC.

Criar uma instância de VM na rede VPC

As instâncias de VM incluem clusters do Google Kubernetes Engine (GKE), instâncias de ambiente flexível do App Engine e outros produtos do Google Cloud criados em VMs do Compute Engine. Para oferecer suporte ao acesso de rede particular, um recurso de rede VPC pode ser uma instância de VM, um endereço IP do Cloud Interconnect ou um balanceador de carga interno de camada 4.

As instâncias do Compute Engine podem executar imagens públicas para Linux e Windows Server fornecidas pelo Google, além de imagens particulares personalizadas que você pode criar ou importar dos seus sistemas atuais. Também é possível implantar contêineres do Docker.

Escolha as propriedades de máquina das instâncias, como o número de CPUs virtuais e a quantidade de memória. Use um conjunto de tipos de máquina predefinidos ou crie os próprios tipos de máquina personalizados.

Por exemplo, o comando a seguir cria uma instância de VM Linux a partir de uma imagem pública com uma interface de rede anexada à rede VPC criada anteriormente.

  1. Crie e inicie uma instância de VM:

    gcloud compute instances create VM_NAME \
        --image-family=debian-11 \
        --image-project=debian-cloud \
        --machine-type=e2-micro \
        --network-interface network=projects/PROJECT_ID/global/networks/NETWORK_NAME

    Substitua VM_NAME por um nome para a VM.

  2. Se você receber uma solicitação para confirmar a zona da instância, digite y.

    Depois de criar a instância da VM, anote o endereço INTERNAL_IP que é retornado.

  3. No console do Google Cloud, acesse a página Instâncias de VMs.

    Acessar instâncias de VM

  4. Na coluna Nome, clique no nome da instância da VM apropriada.

  5. Se a VM estiver em execução, clique em Stop para interromper.

  6. Para editar a VM, clique em Editar.

  7. Na seção Networking > Firewalls, para permitir o tráfego HTTP ou HTTPS na VM, selecione Permitir tráfego HTTP ou Permitir tráfego HTTPS.

    Neste exemplo, marque a caixa de seleção Permitir tráfego HTTP.

    O Compute Engine adiciona uma tag de rede à VM, que associa a regra de firewall à VM. Em seguida, ele cria a regra de firewall de entrada correspondente que permite todo o tráfego de entrada em tcp:80 (HTTP) ou tcp:443 (HTTPS).

  8. Para salvar as alterações, clique em Save.

  9. Para reiniciar a VM, clique em Iniciar/Retomar.

Para mais informações, consulte Criar e iniciar uma instância de VM.

Implantar um aplicativo na VM

Para testar a configuração de rede e confirmar se o tráfego está sendo veiculado conforme esperado, implante um app simples na VM que detecta uma porta.

Por exemplo, os comandos a seguir criam um serviço da Web Node.js que escuta na porta 3000.

  1. Estabeleça uma conexão SSH com a instância da VM.

  2. Atualize os repositórios de pacotes:

    sudo apt update
  3. Instale o NVM, o Node.js e o npm.

    Para mais informações, consulte Como configurar um ambiente de desenvolvimento em Node.js.

  4. Crie um arquivo package.json de forma interativa:

    npm init

    Exemplo:

    {
    "name": "test",
    "version": "1.0.0",
    "description": "",
    "main": "index.js",
    "scripts": {
    "test": "hello"
    },
    "author": "",
    "license": "ISC"
    }
  5. Instale o Express, um framework de aplicativos da Web para Node.js:

    npm install express
  6. Escreva o código para o app de teste:

    vim app.js

    O exemplo a seguir cria um app que responde a solicitações GET ao caminho raiz (/) com o texto "Hello, world!"

    const express = require('express');
    const app = express();
    
    app.get('/', (req, res) => {
      res.status(200).send('Hello, world!').end();
    });
    
    app.listen(3000, () => {
      console.log('Sample app listening on port 3000.');
    });

    Anote a porta em que o app está detectando. O mesmo número de porta precisa ser usado ao configurar o endpoint do Diretório de serviços.

  7. Confirme se o app está escutando na porta 3000:

    node app.js

O Compute Engine oferece várias opções de implantação. Para mais informações, consulte Escolher uma estratégia de implantação do Compute Engine para sua carga de trabalho.

Configurar o diretório de serviços

Para oferecer suporte à invocação de um endpoint privado em uma execução de fluxo de trabalho, é necessário configurar um namespace do Diretório de serviços, registrar um serviço no namespace e adicionar um endpoint ao serviço.

Por exemplo, os comandos a seguir criam um namespace, um serviço e um endpoint que especificam a rede VPC e o endereço IP interno da instância de VM.

  1. Para criar um namespace:

    gcloud service-directory namespaces create NAMESPACE \
        --location=REGION

    Substitua:

    • NAMESPACE: o ID do namespace ou do identificador totalmente qualificado do namespace.
    • REGION: a região do Google Cloud que contém o namespace. Por exemplo, us-central1.
  2. Crie um serviço:

    gcloud service-directory services create SERVICE \
        --namespace=NAMESPACE \
        --location=REGION

    Substitua SERVICE pelo nome do serviço que você está criando.

  3. Configure um endpoint.

    gcloud service-directory endpoints create ENDPOINT \
        --namespace=NAMESPACE \
        --service=SERVICE \
        --network=projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME \
        --port=PORT_NUMBER \
        --address=IP_ADDRESS \
        --location=REGION

    Substitua:

    • ENDPOINT: o nome do endpoint que você está criando.
    • PORT_NUMBER: a porta em que o endpoint está sendo executado, por exemplo, 3000.
    • IP_ADDRESS: o endereço IPv6 ou IPv4 do endpoint. Esse é o endereço IP interno que você anotou anteriormente.

Para mais informações, consulte Configurar o diretório de serviços e Configurar o acesso de rede particular.

Criar e implantar seu fluxo de trabalho

A chamada ou invocação de um endpoint particular do Workflows é feita por uma solicitação HTTP. Os métodos de solicitação HTTP mais comuns têm um atalho de chamada (como http.get e http.post), mas é possível fazer qualquer tipo de solicitação HTTP definindo o campo call como http.request e especificando o tipo de solicitação usando o campo method. Para mais informações, consulte Fazer uma solicitação HTTP.

  1. Crie um arquivo de código-fonte para seu fluxo de trabalho:

    touch call-private-endpoint.JSON_OR_YAML

    Substitua JSON_OR_YAML por yaml ou json, dependendo do formato do seu fluxo de trabalho.

  2. Em um editor de texto, copie o seguinte fluxo de trabalho (que, neste caso, usa um protocolo HTTP para o valor url) para o arquivo de código-fonte:

    YAML

    main:
      steps:
        - checkHttp:
            call: http.get
            args:
              url: http://IP_ADDRESS
              private_service_name: "projects/PROJECT_ID/locations/REGION/namespaces/NAMESPACE/services/SERVICE"
            result: res
        - ret:
            return: ${res}

    JSON

    {
      "main": {
        "steps": [
          {
            "checkHttp": {
              "call": "http.get",
              "args": {
                "url": "http://IP_ADDRESS",
                "private_service_name": "projects/PROJECT_ID/locations/REGION/namespaces/NAMESPACE/services/SERVICE"
              },
              "result": "res"
            }
          },
          {
            "ret": {
              "return": "${res}"
            }
          }
        ]
      }
    }

    O valor private_service_name precisa ser uma string que especifique um nome de serviço registrado do diretório de serviços com o seguinte formato:

    projects/PROJECT_ID/locations/LOCATION/namespaces/NAMESPACE_NAME/services/SERVICE_NAME

  3. Implante o fluxo de trabalho. Para fins de teste, é possível anexar a conta de serviço padrão do Compute Engine ao fluxo de trabalho para representar a identidade dele:

    gcloud workflows deploy call-private-endpoint \
        --source=call-private-endpoint.JSON_OR_YAML \
        --location=REGION \
        --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com
  4. Execute o fluxo de trabalho:

    gcloud workflows run call-private-endpoint \
        --location=REGION

    O resultado será semelhante a este:

    argument: 'null'
    duration: 0.650784403s
    endTime: '2023-06-09T18:19:52.570690079Z'
    name: projects/968807934019/locations/us-central1/workflows/call-private-endpoint/executions/4aac88d3-0b54-419b-b364-b6eb973cc932
    result: '{"body":"Hello, world!","code":200,"headers":{"Connection":"keep-alive","Content-Length":"21","Content-Type":"text/html;
    charset=utf-8","Date":"Fri, 09 Jun 2023 18:19:52 GMT","Etag":"W/\"15-NFaeBgdti+9S7zm5kAdSuGJQm6Q\"","Keep-Alive":"timeout=5","X-Powered-By":"Express"}}'
    startTime: '2023-06-09T18:19:51.919905676Z'
    state: SUCCEEDED

A seguir