Creación de un catálogo privado

Los catálogos privados proporcionan una forma de gestionar el acceso a los productos para los usuarios de su cuenta.

1. Ve a « Gestionar > Catálogos » en la consola de IBM Cloud y haz clic en « Crear un catálogo ».
2. Especifique un nombre y una descripción del catálogo.
3. Seleccione excluir o incluir todos los productos del catálogo de IBM Cloud en su catálogo privado. Para obtener más información sobre cómo afecta esto a la visibilidad en el catálogo, consulte Gestión de valores de catálogo.
4. Pulse Crear.

Importación de software a su catálogo privado

Siga estos pasos para importar el software a su catálogo privado:

1. En la página Productos privados, pulse Añadir.

2. Seleccione el método de despliegue.

3. Seleccione si va a añadir el producto desde un repositorio privado o público. O bien, si está incorporando un operador de un registro de Red Hat, seleccione el tipo de repositorio de Red Hat: Certificados, Mercado, Comunitarios.

   Si está añadiendo el producto desde un repositorio privado, puede proporcionar una señal de acceso personal o puede utilizar un secreto. En lugar de dar a los usuarios una señal de acceso personal, puede darles acceso a un secreto, añadir la señal a un secreto y gestionar de forma centralizada todas las señales y el acceso que permite el secreto.

   • Si utiliza una señal de acceso personal, seleccione No para indicar que no utiliza un secreto y proporcione su señal de acceso personal.
   • Si utiliza un secreto, seleccione Sí y pulse Seleccionar desde Secrets Manager. Seleccione su instancia de servicio, grupo de secretos y secreto. Si no ve el secreto, compruebe que esté utilizando el grupo de secretos y la instancia de servicio correctos.

   Puede que aparezca el mensaje No service instance available si no ha creado ningún secreto o si no tiene el acceso correcto para utilizar secretos, aunque tenga instancias de servicio creadas.

4. Especifique el URL de origen. Puede revisar la siguiente lista de formatos soportados por tipo de software:

   • Diagrama de 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
   • Paquete de operadores de un registro de « Red Hat OpenShift on IBM Cloud »: Por ejemplo, selecciona « Akka Cluster Operator » de la lista de operadores disponibles en el repositorio «Certified».
   • Imagen OVA: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Plantilla de Terraform: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Imagen de servidor virtual con Terraform: https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Imagen de servidor virtual para VPC: seleccione una imagen de la lista de imágenes disponibles que se han importado a la VPC o importe una imagen nueva a la cuenta.

   Una imagen de servidor virtual para VPC solo se puede añadir a un producto dentro de un catálogo privado a la vez. Si la imagen de servidor virtual que desea importar ya está importada en otro producto, debe eliminar la imagen de ese producto o suprimir el producto antes de añadir la imagen de servidor virtual a un nuevo producto.

5. Si es aplicable, introduzca la versión del software con el formato de versión principal, versión menor y revisión. Por ejemplo, especifique la versión 1.1.2.

6. Seleccione una categoría de catálogo para el producto. Las categorías se utilizan para organizar productos en el catálogo de IBM Cloud según su función, uso o soluciones comunes.

7. Pulse Añadir producto.

Adición de detalles de entrada de catálogo

Cuando publique el producto en el catálogo para usuarios con acceso a su catálogo privado, verá un mosaico con el nombre del producto y otros detalles que se añaden durante la incorporación. Además de la categoría que se establece al importar el software, puede añadir otros filtros relacionados con la industria, la conformidad, las tecnologías con las que trabaja y más. Cada uno de estos filtros se utiliza en el catálogo para que los usuarios encuentren software que se ajuste a sus necesidades. En la sección de detalles de entrada de catálogo, también puede evaluar y realizar actualizaciones en las descripciones abreviadas, el URL de documentación e incluso palabras clave para ayudar en la búsqueda de usuarios y encontrar el producto rápidamente.

1. En la sección Detalles de la entrada de catálogo, pulse el icono Editar .
2. Revise la información que se ha importado con el producto y realice las ediciones necesarias.
3. Revise los filtros y las opciones del sector para seleccionar los filtros de catálogo que se aplican. Puede seleccionar hasta cinco filtros del sector.
4. Compruebe la vista previa de la entrada de catálogo para ver cómo se muestra el mosaico de catálogo a los usuarios que están evaluando el software en el catálogo.
5. Pulse Guardar cuando esté satisfecho con sus cambios.

Para obtener más información, consulte Definición de los detalles del producto.

Configuración del software

Adición de acuerdos de licencia

Proporcione los URL a los acuerdos de licencia que los usuarios deben aceptar al instalar el producto. Los acuerdos de licencia se añaden al Acuerdo de servicios de IBM Cloud.

1. Haz clic en « Añadir acuerdos de licencia » > « Añadir licencia ».
2. Especifique el nombre y el URL y pulse Actualizar > Siguiente.

Edición del archivo readme

Cuando los usuarios instalan el software, pueden seleccionar el enlace a tu archivo «readme» para consultar la información del producto. La información del enlace «Readme» se genera a partir del archivo «readme» que has subido a tu repositorio de código fuente.

1. En el separador Editar archivo readme, obtenga una vista previa de cómo se mostrará la información del archivo readme a los usuarios cuando instalen el software.
2. Para realizar actualizaciones, pulse el icono Editar situado junto al título de la sección Readme.
3. Pulse Guardar.
4. Pulse Siguiente.

Si está importando una imagen de servidor virtual para VPC, el archivo léame no se genera automáticamente. Copie y pegue el contenido de la plantilla de archivo léame y realice las actualizaciones necesarias.

Validación del software

Cuando valida el software, está confirmando que la versión actual se puede instalar correctamente en el destino de despliegue. Los pasos de validación varían en función del método de despliegue.

Para supervisar el progreso del proceso de validación, pulse Ver registros.

Gestionar la conformidad

Puede añadir perfiles y controles a su software para demostrar que cumple los requisitos de seguridad y conformidad. Debe utilizar Compliance Manager para explorar los recursos creados durante la validación.

Sólo los perfiles y controles soportados por las exploraciones Compliance Manager y validados por Compliance Manager aparecen en el catálogo.

Compartir el software

Si desea compartir el producto con su cuenta o empresa, pulse el nombre del producto en la navegación para ir a la página de detalles del producto. En el menú « Acciones », haz clic en « Compartir ». Seleccione dónde desea compartir el producto y pulse Compartir.

Incorporación de software a su catálogo utilizando la CLI

Siga los pasos siguientes para añadir el software mediante la CLI. Puede utilizar esta tarea en un proceso CI/CD. Para añadir software desde un repositorio privado, debe incluir una señal de acceso personal.

1. Ejecute el mandato ibmcloud catalog create para crear un catálogo privado. Los catálogos privados proporcionan una forma de gestionar el acceso a los productos para los usuarios de su cuenta.

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

2. Ejecute el mandato ibmcloud catalog offering create para añadir software al catálogo privado.

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

   Si desea importar software de un repositorio privado, puede utilizar una señal de acceso personal añadiendo [-- token TOKEN] al mandato.

3. Ejecute el mandato ibmcloud catalog offering add-category para añadir una categoría al producto. De forma predeterminada, la categoría Herramientas de desarrollador se añade al producto.

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

4. Ejecute el mandato ibmcloud catalog offering import-version para importar la versión de software que desee en el catálogo.

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

   A continuación se muestra la lista de formatos soportados por tipo de software:

   • Diagrama de 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
   • Paquete de operadores de un registro de « Red Hat OpenShift on IBM Cloud »: Por ejemplo, selecciona « Akka Cluster Operator » de la lista de operadores disponibles en el repositorio «Certified».
   • Imagen OVA: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Plantilla de Terraform: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Imagen de servidor virtual con Terraform: https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Imagen de servidor virtual para VPC: seleccione una imagen de la lista de imágenes que se han importado a la VPC o importe una imagen nueva a la cuenta.

5. Ejecute el mandato ibmcloud catalog offering version validate para validar el software.

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

   El despliegue del software puede tardar unos minutos. Ejecute ibmcloud catalog offering version validate-status para comprobar el estado de validación consultando el estado de validación del producto.

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

6. Ejecute ibmcloud catalog offering publish account para publicar el software en los usuarios de su cuenta.

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

Creación de un catálogo privado utilizando la API

Los catálogos privados proporcionan una forma de gestionar el acceso a los productos para los usuarios de su cuenta. Puede crear mediante programación un catálogo privado llamando a la API de gestión de catálogos, tal como se muestra en la solicitud de ejemplo siguiente. Para obtener más información, consulte el apartado API de gestión de catálogos para crear un 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)

Importación de software a su catálogo privado utilizando la API

Puede añadir mediante programación software al catálogo llamando a la API de gestión de catálogos, tal como se muestra en la siguiente solicitud de ejemplo. Esta API crea el software y lo importa también. Para obtener información detallada sobre la API, consulte API de gestión 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)

Validación del software utilizando la API

Puede validar mediante programación el producto llamando a la API de gestión de catálogos, tal como se muestra en la siguiente solicitud de ejemplo. Este proceso puede durar unos minutos. Para obtener información detallada sobre la API, consulte API de gestión 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)

Publicar el software en su cuenta utilizando la API

Puede publicar mediante programación el software en su cuenta llamando a la API de gestión de catálogos, tal como se muestra en la siguiente solicitud de ejemplo.

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)

Creación de un catálogo privado utilizando Terraform

Utilice los pasos siguientes para crear un catálogo privado utilizando Terraform.

1. Añada el argumento al archivo main.tf. El ejemplo siguiente crea un catálogo privado utilizando el recurso ibm_cm_catalog, donde label es un nombre de visualización para identificar el catálogo.

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

   Para obtener más información, consulta los detalles de la referencia de argumentos en la página « Gestión del catálogo de Terraform ».

2. Después de terminar de crear el archivo de configuración, inicialice la CLI de Terraform. Para obtener más información, consulte Inicialización de directorios de trabajo.

   terraform init
   

3. Suministre los recursos desde el archivo main.tf. Para obtener más información, consulte Infraestructura de suministro con Terraform.

   1. Ejecute terraform plan para generar un plan de ejecución de Terraform para obtener una vista previa de las acciones propuestas.

      terraform plan
   

   1. Ejecute terraform apply para crear los recursos definidos en el plan.

      terraform apply
   

Importación de un producto a su catálogo utilizando Terraform

Utilice los pasos siguientes para importar un producto a su catálogo privado utilizando Terraform.

1. Añada el argumento al archivo main.tf. El ejemplo siguiente añade el producto utilizando el recurso ibm_cm_offering, donde label es un nombre de visualización para identificar el producto.

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

   Para obtener más información, consulta los detalles de la referencia de argumentos en la página « Gestión del catálogo de Terraform ».

2. Después de terminar de crear el archivo de configuración, inicialice la CLI de Terraform. Para obtener más información, consulte Inicialización de directorios de trabajo.

   terraform init
   

3. Suministre los recursos desde el archivo main.tf. Para obtener más información, consulte Infraestructura de suministro con Terraform.

   1. Ejecute terraform plan para generar un plan de ejecución de Terraform para obtener una vista previa de las acciones propuestas.

      terraform plan
   

   1. Ejecute terraform apply para crear los recursos definidos en el plan.

      terraform apply
   

Importación de una versión de su software utilizando Terraform

Después de añadir el producto, utilice los pasos siguientes para añadir una versión del software utilizando Terraform.

1. Añada el argumento al archivo main.tf. El ejemplo siguiente accede a la versión de software utilizando el recurso cm_version, donde offering_id identifica el software.

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

   Para obtener más información, consulta los detalles de la referencia de argumentos en la página « Gestión del catálogo de Terraform ».

2. Después de terminar de crear el archivo de configuración, inicialice la CLI de Terraform. Para obtener más información, consulte Inicialización de directorios de trabajo.

   terraform init
   

3. Suministre los recursos desde el archivo main.tf. Para obtener más información, consulte Infraestructura de suministro con Terraform.

   1. Ejecute terraform plan para generar un plan de ejecución de Terraform para obtener una vista previa de las acciones propuestas.

      terraform plan
   

   1. Ejecute terraform apply para crear los recursos definidos en el plan.

      terraform apply