Gerenciamento de Integrações
Visão Geral
O módulo de gerenciamento de integrações (iPaaS) é o responsável por reunir todo o ciclo de vida de desenvolvimento de integrações no DHuO. As integrações são organizadas por workspaces, sendo esses uma representação de times ou áreas. Para saber mais sobre Workspaces, acesse a seção Workspaces.
O ciclo de vida de desenvolvimento consiste:
- no design da integração, na interface no-code (Canvas)
- na documentação do serviço de integração, utilizando Markdown
- na geração de uma release da integração desenvolvida
- na implantação da release em um ou mais clusters
- na publicação de documentação em um ou mais portais
Versionamento
O DHuO adota o padrão de versionamento semântico (Semantic Versioning ou SemVer) para a gestão de diferentes versões de uma integração durante seu ciclo de vida. Ele propõe um formato de representação de versões de forma que seja possível identificar o tipo e o impacto de uma mudança feita de uma versão para outra. Assim, é possível entender as mudanças, melhorias e possíveis incompatibilidades entre as versões. Para saber mais sobre versionamento semântico, acesse a documentação oficial semver.org.
O versionamento semântico propõe um conjunto simples de regras de como os números das versões são atribuídos e incrementados. Essa convenção é baseada em três números, separados por pontos, que representam, respectivamente, a versão major, minor e patch (Exemplo: 2.15.0). As regras podem variar segundo os padrões definidos pelos usuários, mas de forma geral:
- major (maior, principal): usada para controle de quebra de compatibilidade entre versões (breaking changes)
- minor (menor): usada para controle de novas funcionalidades ou incrementos que não geram quebra de compatibilidade
- patch (correção): usada para controle de correções de bugs e melhorias de desempenho que não alteram funcionalidades existentes
No DHuO cada versão possui seu próprio contexto e artefatos, como o canvas, a documentação e releases. O processo de alterar e salvar as modificações no canvas e documentação não implicam na geração de novas versões de uma integração, funcionando como rascunhos dela. O mesmo vale para a geração de releases durante o desenvolvimento.
A criação de versões é flexível e fica a cargo da empresa ou da pessoa responsável pela Organização. A necessidade de versionamento vai depender de como a empresa controla o processo do ciclo de vida de evoluções desses serviços de integração.
No contexto de serviços, normalmente mantem-se disponível em um mesmo ambiente diferentes versões majors por questões de retrocompatibilidade, até que todos os consumidores façam a migração para versões mais recentes e as mais antigas sejam desativadas. Seguindo esse princípio, no DHuO é possível implantar mais de uma versão major de uma integração em um cluster. Elas podem existir simultaneamente. Porém, não é possível existir mais de uma versão minor ou patch de uma integração em um cluster. Ao realizar uma implantação de uma release de uma versão com alteração somente nesses números, a implantação existente é substituída. Para saber mais sobre implantação de integrações, acesse a seção Implantação (Deploy) da integração.
Reuso
Para proporcionar o reuso e lógica e proporcionar eficiência no desenvolvimento de integrações, o DHuO possui o conceito de integrações reutilizáveis. Dessa forma, partes em comum de um fluxo, como validações de segurança, podem ser desenvolvidas uma única vez e incorporadas em outras integrações, facilitando a evolução e manutenção. Para saber mais sobre reuso de integrações, acesse a seção Catálogo de serviços.
Configuração
Integrações são gerenciadas no contexto do Workspace. A partir da home, acesse o menu > Integrações. Na página de integrações, elas podem ser cadastradas e gerenciadas. Ao criar ou visualizar uma integração, os dados serão exibidos no estúdio da integração.
Estúdio é uma interface de menus e contextos específicos para o gerenciamento de configurações da integração. No estúdio da integração é possível gerenciar:
- Versões da integração
- Canvas (desenvolvimento no-code)
- Documentação
- Geração e implantação de releases
- Publicação de documentação
Para criar uma nova integração, acesse o botão Criar > Integração no topo da página de integrações. Para criar uma nova versão da integração, acesse o botão Nova versão no topo da página do estúdio.
Os parâmetros da integração e suas versões podem ser gerenciados no menu > Configuração no estúdio da integração.
Caso a integração esteja marcada para ser reutilizável e esteja em uso por outra, é possível visualizar as dependências no botão Detalhes das versões no menu > Configuração no estúdio da integração.
A quantidade de integrações e versões permitidas pode ser limitada e está condicionada à licença DHuO adquirida. Para saber mais, acesse a seção Conta de produto e licença.
Permissões
Apenas usuários com papel de administrador da organização (Org Admin) ou provedor de APIs (API Provider) podem gerenciar integrações. Para saber mais, acesse a seção Papéis e permissões.
Parâmetros da integração
Aqui estão os parâmetros para configuração de uma integração:
- Nome: Obrigatório. Nome da integração. Deve conter pelo menos 5 caracteres.
As integrações são únicas por Organização. Não é possível ter mais de uma integração com o mesmo nome.
O nome de uma integração não pode conter espaços e pode conter apenas letras sem acentos, números e o caractere -.
Não é possível alterar o nome após a criação da integração. Caso seja necessário alterá-lo, é preciso excluir a integração e criar uma nova com as configurações desejadas.
- Categorias: Lista opcional de categorias para classificação da integração. Para saber mais sobre categorias, acesse a seção Categorias da Administração geral.
A quantidade suportada de categorias associadas a uma integração é limitada a 10.
- Reutilizar integração: Obrigatório. Determina se a integração estará disponível no catálogo de serviços para reuso como parte do fluxo de outra integração. Para saber mais sobre reuso de integrações, acesse a seção Catálogo de serviços.
Não é possível excluir uma integração caso ela:
- possua alguma versão implantada em algum ambiente
- possua alguma versão com documentação publicada em algum portal
É necessário remover todas as implantações e publicações de todas as versões relacionadas para excluir uma integração.
Ao excluir uma integração, todas as versões relacionadas a ela são excluídas permanentemente.
Parâmetros da versão de integração
Aqui estão os parâmetros para configuração de uma versão de integração:
- Versão de referência: Obrigatório. Versão que servirá de base para a nova versão. A nova versão conterá uma cópia do canvas e da documentação da versão de referência.
- Número da versão: Obrigatório. Número da nova integração, seguindo o padrão do versionamento semântico. Devem ser atribuídos 3 números (major, minor e patch).
- Descrição: Texto opcional para detalhes sobre a versão.
Não é possível excluir uma versão de integração caso ela:
- esteja implantada em algum ambiente
- esteja com documentação publicada em algum portal
É necessário remover todas as implantações e publicações relacionadas para excluir uma versão de integração.
Ao excluir uma versão de integração, todo o canvas, a documentação e releases relacionados a ela são excluídos permanentemente.