Implantação (Deploy)

Visão Geral

Após a criação da release de uma API, o próximo passo é disponibilizá-la em um ambiente para os usuários, no processo de implantação. Portanto, é necessário ter pelo menos uma release da API criada. Para saber mais, acesse a seção Releases da API.

A implantação (ou deploy) de uma API é o processo onde ela é disponibilizada em um ou mais API Gateways gerenciados pelo DHuO. Na geração da release, é criado um manifesto para cada ambiente e tipo de gateway correspondente às políticas de gateway configuradas, enquanto a implantação fará a instalação desse manifesto em um gateway.

Assim, é possível ter uma visão unificada de todos os ambientes e gateways onde determinada API está implantada, bem como suas versões.

Processo de deploy

O processo de implantação envolve a escolha de uma release, um ambiente e um gateway.

Ao final do processo de implantação, a API estará acessível para consumo no gateway, por meio do endereço configurado no campo URL de acesso do cadastro do gateway. Para saber mais, acesse a seção Gateways da Administração do API Manager.

Informação adicional

Não será possível implantar a API se a release escolhida não possuir manifesto configurado correspondente ao tipo do gateway e ao ambiente escolhido para implantação. Por exemplo, caso deseje implantar uma release em um API Gateway do tipo DHuO, no ambiente "desenvolvimento", é necessário ter configurado uma política de gateway para o tipo DHuO com um endpoint cadastrado para o ambiente "desenvolvimento". Assim, durante a geração de releases, será criado um manifesto para o tipo de gateway DHuO e o ambiente "desenvolvimento". Para saber mais, acesse a seção Releases da API.

Atenção!

Sobre certificados client

Para os gateways DHuO, Kong e APISIX é possível relacionar certificados utilizados na comunicação entre o API Gateway e o endpoint da API. Neste cenário, os certificados, também cadastrados e gerenciados pelo DHuO, devem ser implantados separadamente, pela gestão de implantação de certificados. Caso o certificado possua certificados de CA associados, eles também devem ser implantados para o correto funcionamento da API no gateway. Caso a API tenha certificado associado e ele não esteja implantado no gateway no momento da implantação da API, não ocorrerá erro, porém a configuração de certificado não será aplicada. Para saber mais sobre certificados e suas implantações, acesse as seções Certificados e Implantação (Deploy) da Administração do API Manager.

Configuração

As implantações de APIs 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 > Implantações, elas podem ser criadas, atualizadas e excluídas.

No botão Detalhes de uma implantação é possível visualizar os detalhes dela, como:

• configuração do manifesto implantado

Informação adicional

O processo de criação, atualização e exclusão de implantações pode levar alguns instantes. É possível acompanhar o status pela lista de implantações. Enquanto isso, é possível realizar outras atividades na plataforma.

Permissões

Apenas usuários com papel de administrador da organização (Org Admin), provedor de APIs (API Provider) ou operador de APIs (API Operator) podem gerenciar implantações. Para saber mais, acesse a seção Papéis e permissões.

Atenção!

A implantação em ambientes protegidos só é permitida para os papéis de administrador da organização e operador de APIs. Para saber mais sobre ambientes protegidos, acesse a seção Ambientes.

Parâmetros

Aqui estão os parâmetros para configuração de implantação de uma API:

• Release: Obrigatório. Release a ser implantada.
• Ambiente: Obrigatório. Ambiente do gateway no qual será implantado a release da API.
• Gateway: Obrigatório. API Gateway no qual será implantado a release da API.

Atenção!

As configurações de acesso do gateway devem estar corretas no cadastro de gateways (campos URL de deploy e token). Para saber mais sobre gateways, acesse a seção Gateways da Administração do API Manager.

Da mesma forma, as implantações no gateway devem ser feitas somente pelo DHuO, para ter o controle e rastreio de mudanças no ambiente.

Cuidado!

Ao excluir a implantação de uma API de um gateway, os consumidores do serviço serão afetados.