Estendendo uma arquitetura implantável durante a integração
Ao integrar uma arquitetura implantável a um catálogo privado, você pode optar por estendê-la empilhando-a com outras arquiteturas. Ao adicionar essas outras arquiteturas, você especifica se elas são necessárias para implantar sua arquitetura
conforme pretendido ou se podem ser usadas opcionalmente para estender o caso de uso. Ao concluir a integração, o resultado é uma solução robusta de ponta a ponta, composta por diversas arquiteturas implantáveis que funcionam juntas.
As arquiteturas implantáveis que você deseja empilhar já estão disponíveis em um catálogo? Se for o caso, você pode empilhar essas arquiteturas em um projeto e integrar essa solução como uma entrada de catálogo separada. Atualmente, quando você empilha arquiteturas implantáveis em um projeto, não há suporte para incluir arquiteturas opcionais ou intercambiáveis. Portanto, essa abordagem funciona melhor se todas as arquiteturas que você deseja empilhar forem necessárias para implantar a solução de ponta a ponta.
Por que estender uma arquitetura implantável?
Você pode estender uma arquitetura implantável por diferentes motivos. Por exemplo, se a arquitetura que você está integrando exigir uma dependência, você pode empilhá-la junto com a arquitetura da qual ela depende. Se a dependência for listada como necessária, ela será incluída junto com sua arquitetura implantável quando um usuário a configurar e implantar.
Da mesma forma, para incentivar a segurança por padrão para uma arquitetura implantável que você está integrando, você pode empilhar outras arquiteturas com ela que atendam às necessidades de segurança. Se as outras arquiteturas implantáveis forem incluídas conforme recomendado, isso ajudará a garantir que os usuários em sua organização implantem a arquitetura de uma maneira específica com essas proteções de segurança em vigor. As arquiteturas recomendadas são incluídas por padrão, mas os usuários podem removê-las.
Você também pode estender uma arquitetura implantável para fornecer mais opções de personalização aos usuários, para que eles possam aproveitar um caso de uso estendido. Talvez sua arquitetura funcione bem com outra arquitetura implantável que não seja necessária para atender a uma dependência ou satisfazer a conformidade. Você pode adicionar a arquitetura implantável como opcional, e os usuários podem optar por incluí-la ao adicionar sua arquitetura implantável a um projeto.
Antes de Iniciar
Ao concluir as etapas para integrar sua arquitetura implantável a um catálogo privado, você será solicitado a configurar os detalhes da versão. Acesse Estender sua arquitetura para empilhar outras arquiteturas implantáveis junto com aquela que você está integrando.
Se você já integrou sua arquitetura implantável, edite a versão em seu catálogo privado e vá para Estender sua arquitetura.
Prefere trabalhar com código? Você pode especificar detalhes sobre outras arquiteturas implantáveis que deseja empilhar com aquela que está integrando no arquivo de manifesto do catálogo. Defina o dependency_version_2 propriedade
para true e usar o dependencies matriz para especificar quais arquiteturas você deseja incluir naquela que está sendo integrada. Para obter mais informações sobre como estruturar o manifesto do catálogo, consulte
Editando localmente seu arquivo de manifesto.
Adicionando arquiteturas implantáveis
Ao integrar uma arquitetura implantável, você pode estendê-la empilhando-a com outras arquiteturas. Especifique um relacionamento ao adicionar outras arquiteturas e, em seguida, defina variáveis para os usuários configurarem nas arquiteturas que você está empilhando. Conclua as etapas a seguir:
- Ao integrar uma arquitetura implantável a um catálogo, na seção Estender sua arquitetura, clique em Adicionar.
- Use o menu Produto para selecionar a arquitetura implantável que você deseja adicionar. Você pode selecionar qualquer arquitetura implantável à qual sua conta tenha acesso em seus catálogos.
- Selecione uma opção de Relacionamento para a arquitetura implantável que você está adicionando. A arquitetura é necessária e não pode ser removida. É opcional e os usuários podem optar por incluí-lo ou não. Ou ele é recomendado e incluído por padrão, embora os usuários possam optar por removê-lo. Para obter mais informações, acesse Especificando um relacionamento.
- Opcional: se você estiver adicionando duas ou mais arquiteturas implantáveis que sejam intercambiáveis dependendo das preferências do usuário, selecione-as na tabela Estender sua arquitetura e clique em Agrupar como intercambiáveis. Os usuários podem selecionar qual arquitetura desejam usar com base em suas necessidades.
- Quando terminar de adicionar arquiteturas implantáveis, clique em Avançar > Definir variáveis para definir variáveis para seus usuários. A partir daí, você pode conectar as arquiteturas implantáveis para que os usuários possam configurar entradas em uma única interface, em vez de configurar as arquiteturas uma por uma. Para obter mais informações, acesse Definindo variáveis para seus usuários.
Especificando um relacionamento
Ao empilhar arquiteturas implantáveis junto com aquela que você está integrando, você será solicitado a especificar um Relacionamento. Qual é a relação entre a arquitetura implantável que você está adicionando e a solução geral que você está integrando ao seu catálogo privado? Você pode escolher entre três opções: Obrigatório, Opcional e Recomendado. A tabela a seguir descreve e explica como cada opção afeta a personalização da solução de ponta a ponta quando um usuário adiciona a arquitetura a um projeto do catálogo privado:
| Opção | Descrição |
|---|---|
| Obrigatório | Incluído quando um usuário adiciona sua arquitetura a um projeto. O usuário não pode remover as arquiteturas necessárias porque elas são necessárias para que sua solução geral funcione conforme o esperado. |
| Opcional | Não incluído por padrão. Os usuários podem optar por incluir arquiteturas opcionais se quiserem aproveitar um caso de uso estendido. |
| Recomendado | Incluído por padrão, mas os usuários podem removê-lo se quiserem.
Por exemplo, talvez você queira incentivar implantações seguras adicionando IBM Cloud Secrets Manager conforme recomendado à sua arquitetura implantável. Secrets Manager é então incluído por padrão quando um usuário adiciona sua arquitetura implantável a um projeto. No entanto, se eles tiverem outra ferramenta para gerenciar segredos ou não exigirem Secrets Manager, o usuário pode optar por excluí-lo. |
Definindo variáveis para seus usuários
Depois de estender sua arquitetura implantável empilhando outras arquiteturas a ela, você precisa definir variáveis para seus usuários. O objetivo final é vincular as arquiteturas implantáveis para que os usuários possam configurar entradas em uma única interface, em vez de configurar as arquiteturas uma por uma. Considere as perguntas a seguir:
-
Quais entradas dentro das arquiteturas implantáveis os usuários precisam configurar? Essas entradas precisam ser adicionadas ao seu produto para que os usuários possam configurá-las sem editar as arquiteturas individuais uma por uma. Selecione Adicionar ao produto para fazer isso.
-
Quais arquiteturas implantáveis precisam ser vinculadas com referências a entradas ou saídas? Por exemplo, se uma entrada em uma arquitetura depende da saída de outra, adicione uma referência na entrada para conectá-la à saída. Selecione Referenciar uma variável para fazer isso.
Somente entradas que você adiciona ao seu produto podem fazer referência a uma saída. Se você adicionou uma arquitetura e uma de suas entradas precisa referenciar uma saída de outra arquitetura, selecione Adicionar ao produto para essa entrada. Em seguida, selecione Referenciar uma variável para a entrada que você adicionou. A partir daí, você pode selecionar a arquitetura que contém a saída. Selecione Saída como o tipo de variável e, em seguida, selecione o nome da saída que você deseja que a entrada faça referência.
-
Todas as entradas necessárias foram resolvidas para os usuários? Para entradas obrigatórias que não são adicionadas ao produto, forneça um valor fixo ou uma referência para resolver essas entradas. Isso conecta as arquiteturas dentro dessa solução de ponta a ponta e torna mais fácil para os usuários configurá-la e implantá-la.
Valores padrão não podem ser fornecidos no console. Use o
default_valuepropriedade dentro doconfigurationmatriz no arquivo de manifesto do catálogo para especificar valores padrão. Para obter mais informações, consulte Editando localmente seu arquivo de manifesto. -
Os usuários precisam de alguma informação extra sobre uma variável para ajudá-los a configurá-la? Ao adicionar uma variável de entrada ao seu produto, você pode alterar a maneira como a entrada aparece para os usuários. Muitas vezes, pode ser útil fornecer um novo nome para uma variável ou uma descrição, especialmente se duas variáveis semelhantes forem incluídas. Por exemplo, se a arquitetura que você está integrando contém um
regionentrada e você adiciona umregionentrada de uma arquitetura de infraestrutura também, considere nomear a entradaregion-infrastructurequando você o adiciona ao seu produto. Um nome significativo ajuda a identificar onde a entrada é usada e facilita a configuração.
Todas as entradas adicionadas ao seu produto são incluídas na tabela de variáveis de entrada. Se precisar remover uma variável adicionada, selecione-a e clique em Excluir.
Próximas etapas
Depois que as variáveis forem definidas para seus usuários, continue integrando sua arquitetura implantável. Quando terminar, os usuários que têm acesso ao seu catálogo privado poderão adicionar sua arquitetura implantável a um projeto. Ao fazer isso, eles podem personalizá-lo selecionando quais arquiteturas desejam incluir com base no que você especificou durante o processo de integração.