Integrando software ao seu catálogo privado

O processo para integrar seu software inclui a importação de uma versão para o seu catálogo privado, configurar os detalhes da implementação, configurar quaisquer requisitos de licença e validar que a versão possa ser instalada com sucesso na infraestrutura de destino que você requerer.

Antes de Iniciar

  1. Envie seu código-fonte para uma versão em seu repositório no GitHub,, GitLab, ou Azure. Para obter mais informações, consulte Configurando seu repositório de código fonte.

  2. Verifique se você está usando uma conta Pré-paga ou de Assinatura. Consulte Visualizando o seu tipo de conta para obter mais informações.

  3. Certifique-se de que você tenha sido designado à função de editor no serviço de gerenciamento de catálogo. Consulte Designando o acesso aos serviços de gerenciamento de contas.

  4. Configure o ambiente de teste que foi criado anteriormente para você:

Importando uma versão no seu catálogo privado

Conclua as etapas a seguir para importar uma versão de seu software no seu catálogo privado. Seu catálogo privado foi criado para você como parte de Configurando para vender software.

  1. No console do IBM Cloud, clique no ícone “ Menu de navegação ” ( Ícone do menu de navegação ) > “ Central de Parceiros ” > “ Meus produtos ”.

  2. Selecione o produto que está sendo integrado.

  3. Na guia Software, clique em Importar uma versão.

  4. Selecione seu método de implementação.

  5. Selecione se você está incluindo seu produto de um repositório privado ou público. Para os operadores, selecione seu repositório de origem e, em seguida, escolha repositório privado ou público.

  6. Insira sua URL de origem.

    É possível revisar a lista a seguir de formatos suportados por tipo de software:

    • Gráfico Helm: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
    • Operador Node-Red: https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
    • Pacote de operadores de um registro do Red Hat OpenShift on IBM Cloud: Para ver um exemplo, selecione o Akka Cluster Operator na lista de operadores disponíveis no repositório certificado.
    • Imagem do OVA: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
    • Modelo do Terraform: https://github.com/IBM-Cloud/terraform-sample/archive/refs/tags/v1.1.0.tar.gz.
    • Imagem do servidor virtual com Terraform: https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
    • Imagem do servidor virtual para VPC: selecione uma imagem na lista de imagens disponíveis que foram importadas para sua VPC ou importe uma nova imagem para sua conta.

    Uma imagem do servidor virtual para VPC só pode ser incluída em um produto dentro de um catálogo privado por vez, Se a imagem do servidor virtual que você deseja importar já estiver importada para outro produto, você deverá remover a imagem desse produto ou excluir o produto antes de incluir a imagem do servidor virtual em um novo produto.

    Se você estiver incluindo seu produto de um repositório privado, será possível optar por fornecer um token de acesso pessoal ou usar um segredo. Em vez de dar aos usuários um token de acesso pessoal, é possível fornecer a eles acesso a um segredo, incluir o token em um segredo e gerenciar centralmente todos os tokens e o acesso que o segredo permitir.

    Se o seu software estiver localizado em, GitLab, você deve usar um token de acesso pessoal, pois GitLab não suporta o download de versões usando tokens de acesso ao projeto. Você pode criar um token de acesso pessoal com a permissão " read_api necessária seguindo as instruções aqui.

    • Se você estiver usando um token de acesso pessoal, selecione Não para indicar que você não está usando um segredo e forneça o seu token de acesso pessoal.
    • Se você estiver usando um segredo, selecione Sim e clique em Selecionar do Secrets Manager. Selecione sua instância de serviço, seu grupo de segredos e seu segredo. Se seu segredo não for exibido, certifique-se de que você esteja usando o grupo de segredos e a instância de serviço corretos.

    A mensagem No service instance available poderá ser exibida se você não tiver criado um segredo ou não tiver o acesso correto para usar segredos, mesmo que você tenha instâncias de serviço criadas.

  7. Se aplicável, configure seu destino de implementação e inclua sua versão de software.

  8. Clique em Incluir versão.

Configurando os detalhes da versão

  1. Na lista de versões, clique na linha que contém seu software.
  2. Revise os detalhes da versão e clique em Avançar.
  3. Dependendo do seu tipo de software, pode ser necessário realizar etapas adicionais, incluindo a configuração de valores de implementação.
  4. Clique em Avançar.

Configurar valores de implementação

Se aplicável ao seu tipo de software, é possível configurar valores de implementação que os usuários são obrigados a especificar quando eles instalam o software. É possível incluir novos valores de implementação ou importar valores de implementação a partir de uma versão existente.

Incluir novos valores de implementação.

  1. Clique em Configurar versão > Próximo.
  2. Clique em Incluir valores de implementação.
  3. Na tabela, selecione Parâmetro > Incluir para selecionar e incluir todas as opções..
  4. Se necessário, é possível customizar os parâmetros selecionando-os na tabela e clicando em Editar.

Importar valores existentes

Siga estas etapas se você já tiver definido valores de implantação para uma versão existente e quiser importar esses valores para a sua versão atual.

Os valores importados não substituem quaisquer valores de implementação que você já incluiu em sua versão atual.

  1. Clique em Configurar versão > Próximo.
  2. Clique em Incluir valores de implementação.
  3. Clique em “Importar valores de uma versão anterior
  4. Selecione a versão que contém os valores que você deseja importar.
  5. Clique em Importar.
  6. Se necessário, é possível customizar os parâmetros selecionando-os na tabela e clicando em Editar.

Editar descrições de valor de saída

Você pode melhorar as descrições para os valores de saída do seu modelo Terraform para ajudar os usuários a entender melhor a finalidade dos parâmetros. A descrição de qualquer valor de saída que você inclua em seu template pode ser atualizada.

Para adicionar valores de saída, é necessário incluí-los em uma nova versão importada do seu modelo Terraform.

Complete as seguintes etapas para editar as descrições de valor de saída do produto:

  1. Clique em Configurar versão > Próximo.
  2. A partir da seção de descrições de valor de saída, forneça uma nova descrição para o parâmetro que você deseja atualizar.
  3. Clique em Avançar.

Definir acesso do IAM

Se aplicável ao seu tipo de software, é possível incluir as funções de acesso de serviço e de acesso de plataforma que são necessárias para instalar o seu produto a partir do catálogo do IBM Cloud.. É possível definir novo acesso do IAM ou importar o acesso do IAM configurado em uma versão anterior.

Definindo novo acesso do IAM

Utilize as seguintes etapas para definir o acesso do seu produto:

  1. Clique em “Configurar versão ” > “Avançar ” > “Avançar ”.
  2. Clique em Incluir.
  3. Selecione o serviço e o serviço necessário e acesso à plataforma.
    • A função de acesso ao serviço permite o acesso para utilizar o serviço e realizar chamadas à API do serviço.
    • A função de acesso à plataforma permite a execução de ações nos recursos da plataforma, como criar uma instância, conectar instâncias a aplicativos e atribuir acesso aos usuários.
  4. Clique em Salvar.

Importando acesso do IAM existente

Conclua as etapas a seguir se você tiver definido anteriormente o acesso do IAM para uma versão existente e desejar importar os valores para a versão atual.

O acesso do IAM importado não substitui nenhum acesso do IAM que você já tenha incluído em sua versão atual

  1. Clique em “Configurar versão ” > “Avançar ” > “Avançar ”.
  2. Clique em Incluir.
  3. Clique em “Importar acesso ao IAM de uma versão anterior ”.
  4. Selecione a versão que contém o acesso ao IAM que você deseja importar.
  5. Clique em Incluir.

Incluindo contratos de licença

Se os usuários forem obrigados a aceitar quaisquer acordos de licença além do Acordo de Serviços da IBM Cloud ao instalar o software, forneça a URL a todos os acordos ou licenças de importação de uma versão existente.

Incluir novos contratos de licença

  1. Clique em “Adicionar contratos de licença ” > “Adicionar licença ”.
  2. Insira o nome e a URL e clique em Incluir licença.
  3. Depois de inserir todos os contratos de licença adicionais, clique em Avançar.

Importar contratos de licença

Conclua estas etapas se você tiver incluído anteriormente contratos de licença para uma versão existente e desejar importar as licenças para sua versão atual

As licenças importadas não substituem quaisquer acordos de licença que você já tenha incluído em sua versão atual.

  1. Clique em “Adicionar contratos de licença ” > “Adicionar licença ”.
  2. Clique em Importar licenças de uma versão anterior.
  3. Selecione a versão que contém as licenças que você deseja importar.
  4. Clique em Importar.

Revisando seu arquivo leia-me

Quando os usuários instalam o software, eles podem visualizar as informações do produto clicando no link Leia-me. As informações contidas no link “Readme” são geradas a partir do arquivo “readme” que você enviou para o seu repositório de código-fonte.

  1. A partir da aba Editar do leia-me, clique no ícone Editar Editar ícone.
  2. Visualize como as informações no arquivo leia-me serão exibidas para os usuários quando eles estiverem instalando o software.
  3. Para fazer atualizações, clique no ícone Editar ícone Editar ao lado do título da seção Leia-me.
  4. Clique em Salvar.
  5. Clique em Avançar.

Se estiver importando uma imagem do servidor virtual para VPC, o arquivo leia-me não será gerado automaticamente. Copie e cole o conteúdo do modelo de arquivo leia-me e faça atualizações, conforme necessário

Validando o produto

As etapas para validar o seu produto podem variar com base no tipo de software que você está integrando.

  1. Na guia Validar produto, configure seu destino de validação e clique em Avançar. Esta etapa se aplica apenas a gráficos e Operadores Helm.
  2. Configure sua área de trabalho e clique em Avançar. Esta etapa se aplica apenas a gráficos do Helm, Operadores, modelos Terraform e imagens de servidor virtual com o Terraform.
  3. Clique em Validar.

Para monitorar o progresso do processo de validação, clique em Visualizar logs.

Validando seu software usando a API

É possível validar seu software chamando a API do Catalog Management.

String authRefreshToken = "{authRefreshToken}";
String versionLocator = "{versionLocator}";
ValidationInstallOptions installOptions = new ValidationInstallOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build();
Response<Void> response = service.validationInstall(installOptions).execute();
System.out.println(response.getResult());
versionLocator = "{versionLocator}";
authRefreshToken = "{authRefreshToken}";
response = await service.validationInstall({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });
console.log(response);
authRefreshToken="{authRefreshToken}"
versionLocator = "{versionLocator}"
response = self.service.validation_install(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)
print(response)
versionLocator := "{versionLocator}"
authRefreshToken := "{authRefreshToken}"
installOptions := service.NewValidationInstallOptions(versionLocator, authRefreshToken)
response, _ := service.ValidationInstall(installOptions)
fmt.Println(response)

Gerenciamento de controles de segurança e conformidade

Os controles são proteções usadas para atender aos requisitos de segurança e conformidade. Apenas os controles compatíveis com Workload Protection aparecem no catálogo. Para obter mais informações, consulte Formatação de controles em seu arquivo leia-me

Adicionando controles

Para adicionar controles, siga estas etapas:

  1. Na página Gerenciar conformidade, selecione Adicionar controles.

  2. Selecione uma Workload Protection instância e, em seguida, uma política.

    Se você ainda não provisionou uma Workload Protection instância, é necessário configurar uma a partir do IBM Cloud catálogo e habilitar o Cloud Security Posture Management(CSPM) para sua IBM Cloud conta. Em seguida, conclua as etapas para integrar com uma instância Workload Protection existente ou uma nova instância.

  3. Selecione se deseja adicionar toda a política ou apenas um subconjunto de controles.

  4. Se você optar por adicionar uma política inteira, continue para a próxima etapa. Se você optar por adicionar um subconjunto de controles, selecione os controles que deseja adicionar.

  5. Clique em Incluir.

Adicionar resultados de inventário de Workload Protection

Você pode adicionar resultados de Workload Protection inventário para que os usuários possam ver a conformidade declarada ao avaliar seu produto no catálogo.

Em Workload Protection, seu inventário é atualizado uma vez por dia. Você deve distribuir seus recursos e aguardar a atualização do inventário antes de adicioná-lo à sua lista de catálogo. Para obter mais informações, acesse Inventário.

Para adicionar resultados de inventário, siga estas etapas:

  1. Na página “Gerenciar conformidade”, clique em “Adicionar resultados ”.
  2. Selecione a Workload Protection instância que você provisionou anteriormente.
  3. Clique em Aplicar para aplicar os resultados mais recentes do inventário.