Releases
Visão Geral
Uma das etapas do ciclo de vida de desenvolvimento de APIs consiste em instalá-la em um API Gateway para estar disponível para consumo. Uma vez exposta em um gateway, os consumidores farão chamadas para ele que, por sua vez, fará as validações de políticas de segurança e encaminhará as requisições para as devidas aplicações de backend.
O primeiro passo para essa distribuição é a geração de uma release da API. A release é uma entidade no DHuO que representa o artefato gerado a partir do empacotamento de todas as políticas de segurança configuradas, por ambiente.
Após a criação da release, o próximo passo é disponibilizá-la em um API Gateway, no processo de implantação. Para saber mais, acesse a seção Implantação (Deploy) da API.
Construção da release
O processo de geração de uma release consiste nas seguintes etapas:
- Mapeamento dos tipos de gateway das políticas configuradas
- Validação das políticas
- Geração de manifestos
Na etapa de mapeamento, o DHuO identifica todas as políticas de gateway configuradas e o tipo do gateway correspondente a cada uma. Cada tipo de gateway possui um modelo de manifesto diferente a ser gerado. Para saber mais, acesse a seção Políticas de Gateway da API.
Na etapa de validação, são feitas checagens de cada política cadastrada, conforme o tipo do gateway de cada política. Por exemplo, para políticas para gateways DHuO e Kong, é necessário ter pelo menos um endpoint e uma rota configurados. Sem esses pré-requisitos, não é possível gerar o manifesto para esses gateways. Para saber mais sobre cada política, acesse as seções DHuO Gateway e Kong e APISIX do API Gateway.
A geração dos manifestos da release será feita somente se todas as políticas de gateways estiverem com as configurações mínimas cadastradas.
Por fim, na etapa de geração de manifestos, ocorre a criação dos manifestos baseados em todas as informações cadastradas nos formulários das políticas de gateway. O manifesto é uma entidade no DHuO correspondente a um arquivo no formato preparado para instalação em um API Gateway correspondente aquele tipo. Por exemplo, para políticas para gateways DHuO e Kong, é gerado um arquivo no formato JSON.
É gerado um manifesto por ambiente relacionado na política. Para os gateways DHuO, Kong e APISIX os ambientes são relacionados no cadastro de endpoints. Por exemplo, se houver uma política de gateway do tipo DHuO cadastrada com um endpoint configurado para o ambiente "desenvolvimento" e um endpoint configurado para o ambiente "produção", serão gerados dois manifestos: um com configurações para implantação no ambiente "desenvolvimento" e outro com configurações para implantação no ambiente "produção".
Adicionalmente, para os gateways DHuO e Kong, ocorre a adição de um prefixo nos paths das rotas caso a configuração Base Path esteja presente no cadastro do endpoint. Para saber mais, acesse a seção Endpoints e Services do API Gateway.
Configuração
As releases são gerenciadas pela interface do estúdio da API. A partir da home, acesse o menu > APIs. Na página de APIs, visualize a API desejada e acesse o menu > Implantação. Na aba > Releases, elas podem ser criadas e excluídas.
No botão Detalhes de uma release é possível visualizar os manifestos gerados para ambiente conforme os tipos de gateway de cada política existente.
Permissões
Apenas usuários com papel de administrador da organização (Org Admin) ou provedor de APIs (API Provider) podem gerenciar releases. Para saber mais, acesse a seção Papéis e permissões.
Parâmetros
Aqui estão os parâmetros para configuração de uma release de API:
- Nome: Obrigatório. Nome da release.
As releases são únicas. Não é possível ter mais de uma release com o mesmo nome.
O nome de uma release não pode conter espaços e pode conter apenas letras sem acentos, números e os caracteres ., - e _.
- Descrição: Texto opcional para detalhes sobre a release.
Não é possível excluir uma release caso ele esteja implantada em algum gateway. É necessário remover todas as implantações para excluir uma release.