Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da
Apigee Edge.
Os desenvolvedores de proxy de API geralmente usam um ou mais mecanismos de persistência de dados da Apigee para armazenar dados de configuração para que possam acessá-los posteriormente em um proxy de API. Este tópico discute como escolher o mecanismo de persistência correto, dependendo do seu caso de uso.
Mecanismos de persistência
A tabela a seguir descreve brevemente os mecanismos de persistência disponíveis na Apigee:| Mecanismo | Uso |
|---|---|
| Mapas de chave/valor | Os mapas de chave-valor (KVMs, na sigla em inglês) fornecem um armazenamento de ambiente de execução geral para dados que podem mudar periodicamente. Por exemplo: dados de sessão do usuário, carrinho de compras etc. As entradas de KVM podem ser criptografadas. Consulte também Como usar mapas de chave-valor. |
| Conjuntos de propriedades | Os conjuntos de propriedades são adequados para armazenar dados de configuração que não mudam com frequência. Consulte também Como usar conjuntos de propriedades. |
| Secrets do Kubernetes | (Somente para a Apigee híbrida) Use secrets para armazenar dados confidenciais, como credenciais do usuário. Consulte também Como armazenar dados em um secret do Kubernetes. |
Escopo de mecanismos de persistência
Cada um dos mecanismos de persistência disponíveis tem um escopo específico que determina onde você pode acessar os dados armazenados. A tabela a seguir resume os escopos disponíveis para cada mecanismo de persistência. Para mais informações sobre escopos, consulte Sobre o escopo de persistência e Escopos do conjunto de propriedades.
| Organização | Ambiente | Proxy da API | |
|---|---|---|---|
| Mapas de chave/valor | Sim | Sim | Sim |
| Conjuntos de propriedades | Não | Sim | Sim |
| Secrets do Kubernetes | Não | Sim | Não |
Como decidir qual mecanismo de persistência usar
Nesta seção, descrevemos casos de uso de cada mecanismo de persistência para ajudar você a decidir qual é mais adequado para armazenar dados de configuração.
Quando usar os mapas de valor-chave
A Apigee não fornece APIs para armazenar, atualizar ou excluir dados KVM. É necessário executar essas tarefas usando a política KeyValueMapOperations. Com a política, é possível executar operações de KVM no ambiente de execução quando o proxy está em execução.
Considere usar KVMs quando:
- Você tem milhares, centenas de milhares ou milhões de entradas de mapas de chave-valor (qualquer número até os limites de tamanho da KVM documentado).
- Você tem entradas que não são conhecidas no momento do projeto.
Por exemplo, use o KVM para armazenar dados da sessão do usuário quando ele fizer login e excluí-los quando o usuário sair.
Quando usar conjuntos de propriedades
Considere usar conjuntos de propriedades quando:
- As chaves e os valores são conhecidos no momento do projeto. Os valores do conjunto de propriedades não podem ser alterados pelo proxy da API quando ele está em execução. Eles estão disponíveis no fluxo do proxy como variáveis somente leitura.
- Você tem algumas poucas centenas de chaves (menos de 110 KB no total). As chaves e os valores de conjuntos de propriedades são sempre armazenados na memória para acesso rápido.
- Você quer a conveniência de permitir que os administradores alterem os conjuntos de propriedades em um ambiente sem reimplantar proxies de API.
Por exemplo, os conjuntos de propriedades são adequados para armazenar regras de rota. Regras de rota são pares de chave-valor em que os valores são URLs de endpoint de destino. Esses valores normalmente variam entre ambientes e podem ser compartilhados por vários proxies de API implantados em um ambiente. Os conjuntos de propriedades também podem ser uma boa opção para armazenar chaves e certificados públicos.
Quando usar os secrets do Kubernetes
Essa opção está disponível apenas com o híbrido da Apigee. Ele permite que um proxy de API acesse dados armazenados em Secrets do Kubernetes. Essa opção é semelhante aos conjuntos de propriedades, em que os dados armazenados estão disponíveis como variáveis do fluxo de mensagens no proxy em execução. No entanto, os dados permanecem sempre dentro do plano do ambiente de execução. Eles nunca serão definidos como o plano de gerenciamento na nuvem da Apigee.
Use os secrets do Kubernetes quando:
- É preciso armazenar informações confidenciais que você nunca quer que sejam armazenadas no plano de gerenciamento. Por exemplo, use um secret do Kubernetes para armazenar chaves privadas ou credenciais necessárias para acessar sistemas externos.
- Você precisa compartilhar dados armazenados com vários proxies de API implantados no mesmo ambiente.