A instância não está relatando o status do grupo de ambientes

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Sintomas

As implantações de proxies de API ou fluxos compartilhados falham com o erro Instance INSTANCE_NAME is not reporting status for environment group ENV_GROUP_NAME na UI da Apigee híbrida.

Mensagens de erro

O erro The Instance INSTANCE_NAME is not reporting status for environment group ENV_GROUP_NAME é exibido no menu Proxies de API na guia Visão geral ao passar o cursor sobre o ponto de exclamação vermelho que aparece na coluna Status da seção Implantações:

instance-not-reporting-status

Causas possíveis

Causa Descrição
O seletor app: apigee-ingressgateway está ausente Ao usar a entrada da Apigee, o arquivo overrides.yaml precisa ter o seletor app: apigee-ingressgateway na seção virtualhosts.
ApigeeRoute desatualizado ou ambiente excluído apenas no plano de controle Um ambiente ou uma implantação foi removido do plano de controle ou do cluster sem concluir o fluxo de trabalho de Full Delete, deixando recursos de ambiente ou ApigeeRoute desatualizados no cluster.
Saída de rede bloqueada para APIs do Google Os nós de trabalho do cluster não podem estabelecer conexões de saída com as APIs de autenticação do Google e do plano de controle da Apigee em *.googleapis.com:443.
O gateway de entrada ou os pods de ambiente de execução não estão prontos Os pods apigee-ingressgateway não estão em execução com todos os contêineres prontos (2/2) ou os pods apigee-runtime não estão prontos (0/1) devido a uma falha na verificação de READINESS:VersionLoadProbe.

Causa: o seletor app: apigee-ingressgateway está ausente

Ao usar o gateway de entrada da Apigee, o arquivo overrides.yaml inclui uma seção para a configuração virtualhosts, em que o seletor app: apigee-ingressgateway precisa ser configurado.

Diagnóstico

Primeiro, confirme se você está usando o gateway de entrada da Apigee, disponível na versão 1.8 híbrida e em versões híbridas mais recentes. A configuração a seguir não funciona para o Istio ASM gerenciado pelo cliente. No arquivo overrides.yaml que inclui o grupo de ambientes mencionado no erro, encontre a seção virtualhosts e verifique se os seguintes seletores estão ausentes:

  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME

Resolução

Edite o arquivo overrides.yaml para que a seção virtualhosts[].selector seja semelhante ao seguinte exemplo:

    virtualhosts:
    - name: my-environment-group
      sslCertPath: my-cert.crt
      sslKeyPath: my-cert.key
      selector:
        app: apigee-ingressgateway
        ingress_name: INGRESS_NAME
  

Depois de editar o arquivo overrides.yaml, aplique a nova configuração usando o Helm:

Simulação:

helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
--namespace APIGEE_NAMESPACE \
--atomic \
--set envgroup=ENV_GROUP \
-f OVERRIDES_FILE \
--dry-run=server

Inclua todas as configurações mostradas, incluindo --atomic, para que a ação seja revertida em caso de falha.

Sua instalação pode ou não ter sido configurada usando um ENV_GROUP_RELEASE_NAME diferente de ENV_GROUP. Para informações sobre as configurações, consulte Instalar a Apigee híbrida usando o Helm.

Instale o gráfico:

helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
--namespace APIGEE_NAMESPACE \
--atomic \
--set envgroup=ENV_GROUP \
-f OVERRIDES_FILE

Causa: ApigeeRoute desatualizado ou ambiente excluído apenas no plano de controle

Quando uma implantação de ambiente ou ambiente de execução é removida do plano de controle ou do cluster sem concluir o fluxo de trabalho de Full Delete, recursos ApigeeRoute ou de ambiente desatualizados podem permanecer no cluster. Quando o apigee-watcher tenta reconciliar o roteamento do grupo de ambiente e encontra um serviço, uma implantação ou um ambiente do plano de controle do Kubernetes ausente, ele não consegue concluir a atualização da rota ou informar o status da implantação ao plano de controle.

Diagnóstico

  1. Verifique os registros do pod apigee-watcher para ver se há erros de serviço ou ambiente ausentes:

    kubectl logs -n APIGEE_NAMESPACE -l app=apigee-watcher --since=2h
    

    Procure entradas de registro semelhantes a estas:

    • Um ApigeeRoute desatualizado faz referência a um serviço ou implantação de ambiente de execução excluído:

      {"level":"error","caller":"watcher/watcher.go:60","msg":"error during watch","name":"ingressstatus","error":"INTERNAL: NOT_FOUND: failed to get service: services \"apigee-runtime-ORG_ENV_HASH\" not found"}
    • Um ambiente foi excluído no plano de controle, mas os recursos de ambiente de execução permanecem no cluster:

      {"level":"error","caller":"watcher/watcher.go:60","msg":"error during watch","name":"ingress","error":"INVALID_ARGUMENT: err fetching environment data: NOT_FOUND: {\n  \"error\": {\n    \"code\": 404,\n    \"message\": \"generic::not_found: resource organizations/ORG_NAME/environments/ENV_NAME not found\",\n    \"status\": \"NOT_FOUND\"\n  }\n}"}
  2. Inspecione os recursos ApigeeRoute no namespace (apigee por padrão) para identificar qualquer rota que aponte para um ApigeeDeployment ou serviço inexistente:

    kubectl get ApigeeRoute -n APIGEE_NAMESPACE
    kubectl describe ApigeeRoute APIGEE_ROUTE_NAME -n APIGEE_NAMESPACE
    

Resolução

  1. Exclua o recurso ApigeeRoute inválido:

    kubectl delete ApigeeRoute APIGEE_ROUTE_NAME -n APIGEE_NAMESPACE
    
  2. Recrie a configuração de rota reaplicando o gráfico Helm apigee-virtualhost:

    helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
      -n APIGEE_NAMESPACE \
      --atomic \
      --set envgroup=ENV_GROUP \
      -f OVERRIDES_FILE
    
  3. Se um ambiente foi excluído apenas no plano de controle (causando err fetching environment data: NOT_FOUND), desinstale a versão do Helm do ambiente (helm delete ENV_RELEASE_NAME -n APIGEE_NAMESPACE) e remova o ambiente do arquivo overrides.yaml, conforme descrito em Excluir ambientes.

Causa: saída de rede bloqueada para as APIs do Google

O componente apigee-synchronizer pesquisa o plano de controle da Apigee para fazer o download de contratos de configuração do ambiente de execução para os pods apigee-runtime, e o apigee-watcher se conecta ao plano de controle para buscar a configuração de entrada e informar o status da implantação. Se o tráfego de saída dos nós de trabalho do cluster para as APIs do Google for bloqueado, esses componentes não poderão se autenticar ou se comunicar com o plano de controle.

Diagnóstico

  1. Verifique os registros do pod apigee-synchronizer para ver se há erros de autenticação e de tempo limite de conexão:

    kubectl logs -n APIGEE_NAMESPACE -l app=apigee-synchronizer --since=2h
    

    Procure erros de tempo limite de GoogleAuthException ao buscar um token de acesso:

    "logger":"CONTRACT-REPLICATION","exceptionStackTrace":"com.google.auth.oauth2.GoogleAuthException: Error getting access token for service account: connect timed out, iss: SERVICE_ACCOUNT_EMAIL"
  2. Verifique se há falhas de conectividade do plano de controle nos registros do pod apigee-watcher:

    kubectl logs -n APIGEE_NAMESPACE -l app=apigee-watcher --since=2h
    

    Procure erros control-plane connectivity test failed com um tempo limite de TCP para a porta 443:

    {"level":"error","caller":"issuescan/cp_connectivity_scanner.go:68","msg":"control-plane connectivity test failed","organization":"ORG_NAME","error":"Get \"https://apigee.googleapis.com/v1/organizations/ORG_NAME\": oauth2: cannot fetch token: Post \"https://oauth2.googleapis.com/token\": dial tcp IP_ADDRESS:443: i/o timeout"}

Resolução

Verifique se as regras de firewall de saída, os gateways NAT, as ACLs de rede e as configurações de proxy de encaminhamento HTTP ou HTTPS permitem que os nós de trabalho do cluster alcancem *.googleapis.com:443 (incluindo apigee.googleapis.com e oauth2.googleapis.com). Para ver a lista completa de domínios necessários e as etapas de solução de problemas de conectividade, consulte URLs do Google Cloud para permitir o Hybrid e Sem conectividade de rede entre o plano de ambiente de execução e o plano de controle.

Causa: o gateway de entrada ou os pods de ambiente de execução não estão prontos

Para verificar e informar o status da implantação, o apigee-watcher recupera despejos de configuração de roteamento dos pods apigee-ingressgateway e verifica a prontidão dos pods apigee-runtime. Se os pods do gateway de entrada não estiverem em execução e prontos ou se os pods do ambiente de execução não tiverem carregado o contrato do ambiente, o relatório de status da implantação vai falhar.

Diagnóstico

  1. Verifique o status dos pods apigee-ingressgateway:

    kubectl get pods -n APIGEE_NAMESPACE -l app=apigee-ingressgateway
    

    Verifique se todos os pods apigee-ingressgateway estão no estado Running com contêineres 2/2 prontos. Se os pods do gateway de entrada não estiverem executando 2/2, apigee-watcher não poderá recuperar o despejo de configuração do Envoy necessário para verificar a implantação.

  2. Verifique o status dos pods apigee-runtime:

    kubectl get pods -n APIGEE_NAMESPACE -l app=apigee-runtime
    

    Se os pods apigee-runtime estiverem Running, mas não prontos (0/1), inspecione os eventos e registros do pod:

    kubectl describe pod RUNTIME_POD_NAME -n APIGEE_NAMESPACE
    kubectl logs RUNTIME_POD_NAME -n APIGEE_NAMESPACE
    

    Procure falhas na sondagem de prontidão (Readiness probe failed: HTTP probe failed with statuscode: 500) e erros READINESS:VersionLoadProbe que indicam que o contrato do ambiente de execução não foi carregado:

    {"level":"SEVERE","className":"com.apigee.probe.ProbeServiceImpl","severity":"SEVERE","message":"probe \"READINESS:VersionLoadProbe\" execution failed due to Version not loaded by Message Processor","logger":"ProbeServiceImpl"}

Resolução

Resolva as falhas de inicialização de pods, as restrições de recursos do cluster (limites de CPU ou memória) ou os problemas de download do contrato do sincronizador para que os pods apigee-ingressgateway alcancem 2/2 prontos e os pods apigee-runtime alcancem 1/1 prontos antes da reimplantação. Para mais etapas de solução de problemas de prontidão do apigee-runtime, consulte o Guia de solução de problemas do processador de mensagens.

Referências