Criando um catálogo privado

Os catálogos privados oferecem uma maneira de você gerenciar o acesso a produtos para usuários em sua conta.

1. Acesse Gerenciar > Catálogos no console do IBM Cloud e clique em Criar um catálogo.
2. Insira um nome e uma descrição de seu catálogo.
3. Selecione para excluir ou incluir todos os produtos no catálogo do IBM Cloud em seu catálogo privado. Para obter mais informações sobre como isso afeta a visibilidade no catálogo, consulte Gerenciando configurações do catálogo.
4. Clique em Criar.

Importando software para seu catálogo privado

Conclua as etapas a seguir para importar software para o seu catálogo privado:

1. Na página Produtos privados, clique em Incluir.

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

3. Selecione se você está incluindo seu produto de um repositório privado ou público. Ou, se você estiver integrando um Operador de um registro do Red Hat, selecione seu tipo de repositório do Red Hat: Certificado, Mercado, Comunidade.

   Se você estiver incluindo seu produto por meio de um repositório privado, poderá 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 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.

4. Insira sua URL de origem. É possível revisar a lista a seguir de formatos suportados por tipo de software:

   • Helm gráfico: 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/releases/tag/v1.0.0
   • 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 de 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 de servidor virtual para VPC só pode ser adicionada a um produto dentro de um catálogo privado de cada vez. Se a imagem do servidor virtual que você deseja importar já é importada para outro produto, deve-se remover a imagem desse produto ou excluir o produto antes de adicionar a imagem do servidor virtual a um novo produto.

5. Se aplicável, insira a versão do software no formato de versão principal, versão secundária e revisão. Por exemplo, digite versão 1.1.2.

6. Selecione uma categoria de catálogo para o produto. As categorias são usadas para organizar produtos no catálogo do IBM Cloud com base em função, uso ou soluções comuns.

7. Clique em Incluir produto.

Incluindo detalhes da entrada do catálogo

Ao publicar seu produto no catálogo para usuários com acesso ao seu catálogo privado, eles visualizam um tile com o nome do produto e outros detalhes que você inclui durante a integração. Além da categoria que você configura ao importar o seu software, é possível incluir outros filtros que estão relacionados à indústria, conformidade, tecnologias com as quais ele trabalha e muito mais. Cada um desses filtros é usado no catálogo para que os usuários encontrem um software que se ajuste às suas necessidades. Na seção de detalhes da entrada do catálogo, também é possível avaliar e fazer atualizações nas descrições curtas, URL de documentação e até palavras-chave para ajudar o usuário a procurar e encontrar seu produto rapidamente.

1. Na seção Detalhes de entrada do catálogo, clique no ícone Editar .
2. Revise as informações que foram importadas com o seu produto e faça edições conforme necessário.
3. Revise os filtros e as opções do setor para selecionar filtros de catálogo que se apliquem. É possível selecionar até cinco filtros do setor.
4. Verifique a visualização de entrada do seu catálogo para ver como seu tile de catálogo é exibido para usuários que estão avaliando seu software no catálogo.
5. Clique em Salvar quando estiver satisfeito com suas mudanças.

Para obter mais informações, consulte Definindo detalhes do produto.

Configurando o software

Incluindo contratos de licença

Forneça as URLs para os contratos de licença que os usuários devem aceitar quando instalam o produto. Os contratos de licença são adicionais ao Contrato de serviços do IBM Cloud.

1. Clique em “Adicionar contratos de licença ” > “Adicionar licença ”.
2. Insira o nome e a URL e clique em Atualização > Avançar.

Editando seu arquivo leia-me

Quando os usuários instalam o software, eles podem clicar no link para o seu arquivo “readme” para visualizar as informações do produto. 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. Na guia Editar leia-me, visualize como as informações no arquivo leia-me serão exibidas aos usuários quando eles instalarem o software.
2. Para fazer atualizações, clique no ícone Editar ao lado do título da seção Leia-me.
3. Clique em Salvar.
4. Clique em Avançar.

Se você estiver importando uma imagem de servidor virtual para VPC, o arquivo readme 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 software

Ao validar seu software, você está confirmando que a versão atual pode ser instalada com sucesso no destino de implementação. As etapas de validação variam com base em seu método de implementação.

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

Gerenciar a conformidade

É possível incluir perfis e controles no software para provar que ele atende aos requisitos de segurança e conformidade. Deve-se usar Compliance Manager para varrer os recursos criados durante a validação.

Somente perfis e controles que são suportados pelas varreduras Compliance Manager e validados por Compliance Manager aparecem no catálogo.

Compartilhando o software

Se você deseja compartilhar o seu produto em sua conta ou empresa, clique no nome do produto na navegação para ir até a página de detalhes do produto. No menu “Ações ”, clique em “Compartilhar ”. Selecione onde você deseja compartilhar seu produto e clique em Compartilhar.

Software de integração para seu catálogo usando a CLI

Conclua as etapas a seguir para incluir o seu software usando a CLI. É possível usar essa tarefa em um processo do CI/CD. Para adicionar software de um repositório privado, você deve incluir um token de acesso pessoal.

1. Execute o criação de catálogo ibmcloud comando para criar um catálogo privado. Os catálogos privados oferecem uma maneira de você gerenciar o acesso a produtos para usuários em sua conta.

   ibmcloud catalog create --name CATALOG [--catalog-description "DESCRIPTION"]
   

2. Execute o criação de oferta de catálogo ibmcloud comando para adicionar software ao seu catálogo privado.

   ibmcloud catalog offering create [--catalog CATALOG-NAME] [--zipurl URL]
   

   Se você deseja importar software de um repositório privado, é possível usar um token de acesso pessoal incluindo [--token TOKEN] no seu comando.

3. Execute o catálogo ibmcloud oferecendo categoria adicional comando para adicionar uma categoria ao seu produto. Por padrão, a categoria Ferramentas de desenvolvedor é incluída em seu produto.

   ibmcloud catalog offering add-category --catalog CATALOG_NAME [--offering OFFERING] [--category CATEGORY]
   

4. Execute o Catálogo ibmcloud oferecendo versão de importação comando para importar a versão do software que você deseja em seu catálogo.

   ibmcloud catalog offering import-version --catalog CATALOG --offering OFFERING_NAME --zipurl URL
   

   A seguir mostra a lista de formatos suportados por tipo de software:

   • Helm gráfico: 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/releases/tag/v1.0.0
   • 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 de servidor virtual para VPC: selecione uma imagem na lista de imagens que foram importadas para sua VPC ou importe uma nova imagem para sua conta.

5. Execute o Validação da versão da oferta do catálogo ibmcloud comando para validar o software.

   ibmcloud catalog offering version validate --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME [--timeout TIMEOUT] [--wait WAIT]
   

   A implementação do software pode levar alguns minutos. Execute o Catálogo ibmcloud oferecendo status de validação de versão para verificar o status de validação consultando o estado de validação do produto.

   ibmcloud catalog offering version validate-status --version-locator VERSION_NUMBER [--output FORMAT]
   

6. Execute o catálogo ibmcloud oferecendo conta de publicação para publicar seu software para usuários em sua conta.

   ibmcloud catalog offering publish account [--catalog CATALOG][--offering OFFERING]
   

Criando um catálogo privado usando a API

Os catálogos privados oferecem uma maneira de você gerenciar o acesso a produtos para usuários em sua conta. É possível criar programaticamente um catálogo privado chamando a API de gerenciamento de catálogo, conforme mostrado na solicitação de amostra a seguir. Para obter mais informações, consulte a API de gerenciamento de catálogo para a criação de um catálogo.

String label = "{label}";
String shortDesc = "{shortDesc}";
CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build();
Response<Catalog> response = service.createCatalog(createOptions).execute();
System.out.println(response.getResult());

label = "{label}";
shortDesc = "{shortDesc}";
response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc });
console.log(response);

label = "{label}"
shortDesc = "{shortDesc}"
response = self.service.create_catalog(label=label, short_description=shortDesc)
print(response)

label := "{label}"
shortDesc := "{shortDesc}"
createOptions := service.NewCreateCatalogOptions()
createOptions.SetLabel(label)
createOptions.SetShortDescription(shortDesc)
_, response, _ := service.CreateCatalog(createOptions)
fmt.Println(response)

Importando software em seu catálogo privado usando a API

É possível importar um software em seu catálogo programaticamente chamando a API de gerenciamento de catálogo como mostrado na solicitação de amostra a seguir. Esta API cria o software e importa-o também. Para obter informações detalhadas sobre a API, consulte a API de gerenciamento de catálogo.

id = "{id}";
offeringURL = "{offeringURL}";
ImportOfferingOptions offeringOptions = new ImportOfferingOptions.Builder().catalogIdentifier(id).zipurl(offeringURL).build();
Response<Offering> response = service.importOffering(offeringOptions).execute();
System.out.println(response.getResult());

id = "{id}";
offeringURL = "{offeringURL}";
response = await service.importOffering({ 'catalogIdentifier': id, 'zipurl': offeringURL });
console.log(response);

id = "{id}"
offeringURL = "{offeringURL}"
response = self.service.import_offering(catalog_identifier=id, zipurl=offeringURL)
print(response)

id := "{id}"
offeringURL := "{offeringURL}"
offeringOptions := service.NewImportOfferingOptions(id, offeringURL)
_, response, _ := service.ImportOffering(offeringOptions)
fmt.Println(response)

Validando seu software usando a API

É possível validar seu produto programaticamente chamando a API de gerenciamento de catálogo, conforme mostrado na solicitação de amostra a seguir. Este processo pode demorar vários minutos. Para obter informações detalhadas sobre a API, consulte a API de gerenciamento de catálogo.

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)

Publicando seu software em sua conta usando a API

É possível publicar seu software na sua conta programaticamente chamando a API de gerenciamento de catálogo como mostrado na solicitação de amostra a seguir.

String versionLocator = "{versionLocator}";
AccountPublishVersionOptions publishOption = new AccountPublishVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.accountPublishVersion(publishOption).execute();
System.out.println(response.getResult());

versionLocator = "{versionLocator}";
response = await service.accountPublishVersion({ 'versionLocId': versionLocator});
console.log(response);

versionLocator = "{versionLocator}"
response = self.service.account_publish_version(version_loc_id=versionLocator)
print(response)

versionLocator := "{versionLocator}"
publishOptions := service.NewAccountPublishVersionOptions(versionLocator)
response, _ := service.AccountPublishVersion(publishOptions)
fmt.Println(response)

Criando um catálogo privado usando o Terraform

Use as etapas a seguir para criar um catálogo privado usando Terraform.

1. Inclua seu argumento em seu arquivo main.tf. O exemplo a seguir cria um catálogo privado usando o recurso ibm_cm_catalog, em que label é um nome de exibição para identificar o catálogo.

   resource "ibm_cm_catalog" "cm_catalog" {
   label = "label"
   short_description = "short_description"
   }
   

   Para obter mais informações, consulte os detalhes da referência de argumentos na página “Gerenciamento do Catálogo do Terraform ”.

2. Após finalizar a construção do seu arquivo de configuração, inicialize o CLI Terraform. Para obter mais informações, consulte Inicializando as Diretorias de Trabalho.

   terraform init
   

3. Provisionar os recursos a partir do arquivo main.tf. Para obter mais informações, consulte Infraestrutura Provisória com Terraform.

   1. Execute terraform plan para gerar um plano de execução Terraforme para pré-visualizar as ações propostas.

      terraform plan
   

   1. Execute terraform apply para criar os recursos que estão definidos no plano.

      terraform apply
   

Importando um produto para seu catálogo usando o Terraform

Use as seguintes etapas para importar um produto para o seu catálogo privado usando Terraform.

1. Inclua seu argumento em seu arquivo main.tf. O exemplo a seguir inclui seu produto usando o recurso ibm_cm_offering, em que label é um nome de exibição para identificar o produto.

   resource "ibm_cm_offering" "cm_offering" {
   catalog_id = "catalog_id"
   label = "label"
   tags = [ "tags" ]
   }
   

   Para obter mais informações, consulte os detalhes da referência de argumentos na página “Gerenciamento do Catálogo do Terraform ”.

2. Após finalizar a construção do seu arquivo de configuração, inicialize o CLI Terraform. Para obter mais informações, consulte Inicializando as Diretorias de Trabalho.

   terraform init
   

3. Provisionar os recursos a partir do arquivo main.tf. Para obter mais informações, consulte Infraestrutura Provisória com Terraform.

   1. Execute terraform plan para gerar um plano de execução Terraforme para pré-visualizar as ações propostas.

      terraform plan
   

   1. Execute terraform apply para criar os recursos que estão definidos no plano.

      terraform apply
   

Importando uma versão do seu software usando o Terraform

Depois de adicionar seu produto, use as seguintes etapas para adicionar uma versão do seu software usando Terraform.

1. Inclua seu argumento em seu arquivo main.tf. O exemplo a seguir acessa a versão do software usando o recurso cm_version, em que offering_id identifica o software.

   resource "cm_version" "cm_version" {
   catalog_identifier = "catalog_identifier"
   offering_id = "offering_id"
   zipurl = "zipurl"
   }
   

   Para obter mais informações, consulte os detalhes da referência de argumentos na página “Gerenciamento do Catálogo do Terraform ”.

2. Após finalizar a construção do seu arquivo de configuração, inicialize o CLI Terraform. Para obter mais informações, consulte Inicializando as Diretorias de Trabalho.

   terraform init
   

3. Provisionar os recursos a partir do arquivo main.tf. Para obter mais informações, consulte Infraestrutura Provisória com Terraform.

   1. Execute terraform plan para gerar um plano de execução Terraforme para pré-visualizar as ações propostas.

      terraform plan
   

   1. Execute terraform apply para criar os recursos que estão definidos no plano.

      terraform apply