Files
gestao_de_manutencao/documentacao/arquitetura/configuracao_acesso_gcp.md

46 lines
2.9 KiB
Markdown

# Configuração de Acesso Administrativo ao Google Cloud
Esta documentação descreve as permissões e configurações necessárias no Google Cloud Platform (GCP) para que o aplicativo possa ler e monitorar as métricas de latência e cota de uso da API Google Sheets em tempo real.
---
## 1. Permissões Necessárias no GCP (IAM)
Para consultar as métricas de uso e limites do console do Google Cloud, a conta de serviço (Service Account) utilizada pelo aplicativo precisa dos seguintes papéis (IAM Roles) associados:
1. **Leitura de Métricas (Cloud Monitoring):**
- Papel: **Leitor do Monitoring** (`roles/monitoring.viewer`)
- Motivo: Permite fazer requisições para a API do Cloud Monitoring v3 (`monitoring.googleapis.com`) para consultar a série temporal de contagem de requisições (`request_count`).
2. **Leitura de Limites de Cota (Service Usage):**
- Papel: **Visualizador do Service Usage** (`roles/serviceusage.serviceUsageViewer`)
- Motivo: Permite consultar os limites das APIs ativas no projeto (como os limites de cota da Sheets API por minuto) via API Service Usage (`serviceusage.googleapis.com`).
---
## 2. Configuração de Credenciais no Aplicativo
O aplicativo aceita duas abordagens para gerenciar as chaves de acesso:
### Opção A: Credencial Única (Padrão)
Se a chave de serviço padrão (`chaveacesso_sheets.apikey.json` em `assets` ou `SHEETS_CREDENTIALS_JSON` nas variáveis de ambiente) tiver os papéis de visualização IAM citados acima vinculados a ela no GCP Console, nenhuma configuração extra de credencial é necessária. O aplicativo utilizará a mesma chave para sincronizar as planilhas e ler as métricas.
### Opção B: Credenciais Administrativas Separadas (Recomendado para Segurança)
Por boas práticas de privilégio mínimo, você pode querer que a chave de leitura/escrita do Google Sheets seja restrita, e usar outra chave distinta com privilégios de monitoramento.
Para fazer isso:
1. Gere um arquivo de credenciais JSON de uma Conta de Serviço no GCP que possua os papéis `roles/monitoring.viewer` e `roles/serviceusage.serviceUsageViewer`.
2. Renomeie o arquivo gerado para `chaveacesso_admin.apikey.json`.
3. Adicione-o à pasta de ativos do projeto: `app/src/main/assets/chaveacesso_admin.apikey.json`.
4. Opcionalmente, configure a variável de ambiente `ADMIN_CREDENTIALS_JSON` no arquivo `.env` para que ela seja injetada via Gradle em produção (semelhante ao fluxo padrão do Sheets).
---
## 3. Fluxo de Tratamento de Erros no App
Se o aplicativo tentar conectar e:
- A chave de acesso administrativo não for reconhecida,
- Faltarem as permissões IAM necessárias na conta de serviço,
- O dispositivo estiver sem internet na primeira tentativa,
A tela de configurações exibirá um status de erro visual (ex: `"Erro de Autenticação"` ou `"Acesso Negado"`). Valores e métricas em tempo real só serão exibidos após uma conexão e validação bem-sucedidas.