IBM Cloud Docs
Incorporación de módulos a un catálogo privado

Incorporación de módulos a un catálogo privado

Un módulo es una unidad autónoma de código de automatización que los desarrolladores pueden reutilizar y compartir como parte de un sistema más grande. Puede elegir crear su propio módulo o seleccionar uno en el repositorio IBM Cloud módulo Terraform. Para compartir un módulo con otros en su organización o para validar el despliegue, puede añadir el módulo a un catálogo privado.

Antes de empezar

Antes de incorporar el módulo, asegúrese de completar los siguientes requisitos previos.

  • Verifique que está utilizando una cuenta de Pago según uso o Suscripción. Consulte Visualización del tipo de cuenta para obtener más detalles.
  • Verifique que tiene el acceso necesario para trabajar con catálogos y módulos privados.
    • Función de gestor en el servicio IBM Cloud Schematics
    • Rol de editor sobre el servicio de gestión de catálogos
    • Rol de visor en todos los grupos de recursos de su cuenta
    • Rol SecretsReader en el servicio Secrets Manager si tiene previsto almacenar los valores seguros en una instancia de Secrets Manager
    • Rol de lector en el servicio Security and Compliance Center
    • Otros roles que son necesarios para recursos específicos en el módulo personalizado.
  • Cree un catálogo privado.
  • Asegúrese de que tiene el código fuente para el módulo almacenado en un repositorio GitHub o GitLab. Para obtener ayuda para obtener el código fuente en un repositorio, consulte Configuración del repositorio de código fuente.

Empaquetado del código fuente

Para crear el archivo .tgz que necesita para incorporar el módulo a un catálogo privado, debe crear una versión de release del código fuente. Para obtener ayuda para crear un release, consulte Gestión de releases en un repositorio.

Si utiliza un repositorio de código fuente privado, asegúrese de que tiene un Señal de acceso personal de Git o un secreto almacenado en Secrets Manager.

Adición de un módulo al catálogo privado

  1. En la consola de IBM Cloud, vaya a la página Gestionar > catálogos > Catálogos privados de la consola.

  2. Seleccione el catálogo privado al que desea añadir un módulo. Se abre la página de detalles del catálogo.

  3. Pulse Añadir producto. Se abre un panel lateral.

  4. Seleccione Módulo para Tipo de producto.

  5. Seleccione Terraform como método de entrega.

  6. Seleccione el tipo de repositorio donde se encuentra el código fuente.

    Si el código fuente se encuentra en un repositorio privado, debe autenticarse utilizando una señal de acceso personal deGit o un secreto de Secrets Manager.

  7. Añada un enlace a su código fuente en el campo Fuente URL. Debe tener un aspecto similar a https://github.com/terraform-ibm-modules/terraform-ibm-cos/archive/refs/tags/v7.0.5.tar.gz.

  8. Seleccione el Ejemplo que desea utilizar.

  9. Introduzca la versión del software en el formato de versión mayor, versión menor y revisión. Por ejemplo, 1.0.0. Normalmente, esta versión coincide con el número de versión de la instantánea de release.

  10. Seleccione la categoría con la que desea que se agrupe el módulo en el catálogo.

  11. Pulse Añadir producto. Aparece una página de resumen.

Adición de ejemplos al módulo en un catálogo privado

Para añadir ejemplos adicionales al módulo, puede añadir una nueva versión.

  1. Vaya a la página Gestionar > Catálogos > Catálogos privados de la consola.
  2. Seleccione el catálogo privado al que ha añadido el módulo. Se abre la página de detalles del catálogo.
  3. Seleccione el módulo para el que desea proporcionar más detalles.
  4. En la pestaña Versiones, pulse Añadir versión.
  5. Siga el proceso descrito en la sección anterior: Adición de un módulo al catálogo privado.

Edición de la entrada de catálogo

Después de añadir correctamente el módulo a un catálogo privado, puede especificar la información que los usuarios ven cuando intentan utilizar el módulo. La información incluye descripciones del módulo, enlaces a la documentación y palabras clave que garantizan que el módulo se pueda encontrar fácilmente.

  1. Vaya a la página Gestionar > Catálogos > Catálogos privados de la consola.
  2. Seleccione el catálogo privado al que ha añadido el módulo. Se abre la página de detalles del catálogo.
  3. Seleccione el módulo para el que desea proporcionar más detalles.
  4. Edite los detalles de entrada de catálogo para el módulo.
    1. En la sección Detalles de entrada de catálogo, pulse Editar.
    2. Revise la información que se importó con su arquitectura desplegable y realice las modificaciones necesarias.
    3. Verifique que la entrada se muestra como se esperaba comprobando la Vista previa de entrada de catálogo.
    4. Cuando haya terminado de realizar las selecciones, pulse Guardar.
  5. Edite la página Acerca de para el módulo. Cuando los usuarios seleccionan el módulo del catálogo, se muestra una sección Acerca de que les permite obtener más información sobre las características disponibles.
    1. En el menú desplegable Acciones, seleccione Editar página del producto.
    2. Especifique una descripción del módulo que explique el valor y las ventajas del módulo para los usuarios.
    3. Para añadir información de característica específica, pulse Características > Añadir característica.
    4. Añada características a nivel de módulo que expliquen los procesos, las capacidades y los resultados del módulo.
    5. Pulse Actualizar.

Especificación de detalles de versión a través de la consola

Los usuarios ven la información de nivel de ejemplo que define como parte de la entrada de catálogo para el módulo. La información proporcionada como parte de este flujo puede ayudar a otros a comprender la funcionalidad de los componentes individuales que están asociados con él.

Después de especificar los detalles a través de la consola, puede generar un archivo de manifiesto y añadirlo al código fuente. Al hacerlo, puede asegurarse de que las especificaciones se traspasan a futuros releases y no es necesario reconfigurarlas con cada release.

Cómo obtener los detalles

Después de añadir el módulo a un catálogo privado, puede utilizar una guía paso a paso en la consola para actualizar la información general sobre el módulo. Para llegar a la página de la consola, puede utilizar los pasos siguientes.

  1. Vaya a la página Gestionar > Catálogos > Catálogos privados de la consola.
  2. Seleccione el catálogo privado al que ha añadido el módulo. Se abre la página de detalles del catálogo.
  3. Seleccione el módulo para el que desea proporcionar más detalles.
  4. En la pestaña Versiones, seleccione la versión específica para la que desea proporcionar información. Puede utilizar la consola para actualizar cualquiera de las secciones que necesite.

Configuración de los detalles de la versión

En el separador Configurar versión, puede revisar y actualizar información sobre la versión específica del módulo. También puede configurar los detalles de despliegue, definir el acceso de IAM necesario y detallar los avisos de cambios que desea que los usuarios conozcan.

Si el módulo requiere una versión de tiempo de ejecución de Terraform específica, puede alterar temporalmente la versión predeterminada. Si ha incluido TF_VERSION como variable de entrada en el repositorio de código fuente, se actualizará automáticamente al crear la entrada de catálogo.

Las variables de entrada son los parámetros que los usuarios especifican cuando utilizan el módulo. Puede revisar y modificar las variables de entrada y salida que se han importado con el código fuente, o puede añadir variables al módulo como parte de este paso. Cuando se añaden variables, puede actualizar si son necesarias, visibles o el formato en el que deben proporcionarse.

Cuando publique una nueva versión del módulo, es posible que haya cambios que desee notificar a los usuarios antes de que se inicien con la nueva versión. Puede separar la información en tres categorías: cambios de última hora, nuevas características y actualizaciones generales.

  • Cambios de última hora: detalla los cambios en el código de la nueva versión que pueden causar una experiencia disruptiva a los usuarios que están trabajando con una versión anterior.
  • Nuevas características: resalte las nuevas funciones que se proporcionan en la nueva versión que los usuarios pueden aprovechar.
  • Actualizaciones: describa las actualizaciones generales que se han realizado en la nueva versión. Por ejemplo, correcciones de errores o mejoras en las características existentes.

Adición de detalles de módulo

Cuando pone un módulo a disposición de otros usuarios en la nube, debe proporcionar la información siguiente:

  • Diagrama de arquitectura que detalla cómo funcionan juntos los componentes del módulo.

    Cada ejemplo de un módulo debe tener al menos un diagrama de arquitectura que describa las relaciones, restricciones y límites entre los componentes incluidos en el ejemplo de módulo. Los diagramas de arquitectura deben proporcionarse en formato .svg.

  • Cualquier resaltado que pueda ayudar a los usuarios a diferenciar entre qué versión o ejemplo de módulo puede ser más adecuado a sus necesidades. Por ejemplo, es posible que desee listar el número de VPC, el tipo de conectividad de red, la capacidad de alta disponibilidad u otros factores importantes que se pueden utilizar para diferenciar cada ejemplo.

Adición de acuerdos de licencia

Si los usuarios están obligados a aceptar cualquier acuerdo de licencia más allá del Acuerdo de servicios de IBM Cloud, proporcione el URL a cada acuerdo.

Edición del archivo readme

Documente las instrucciones para ejecutar el módulo en el archivo léame.

Validación de la versión

El proceso de validación prueba la plantilla de Terraform ejecutándola desde el servicio Schematics que ha configurado. Una validación satisfactoria garantiza que los usuarios pueden utilizar el módulo con las variables de entrada predeterminadas. Debe validar el módulo antes de poder compartirlo. Para supervisar el progreso del proceso de validación, pulse Ver registros en el menú Acciones. Se abre el espacio de trabajo Schematics.

Revisión del coste

Asegúrese de que comprende completamente los costes asociados a la incorporación del módulo. La versión debe validarse para poder generar un coste estimado.

gestión de la conformidad

Al incorporar un módulo a un catálogo privado, puede especificar los controles de conformidad que cumple el módulo cuando se ejecuta. La conformidad con los controles normativos es evaluada por IBM Cloud Security and Compliance Center. Para más información, véase Selección de recursos para evaluar.

  1. Pulse Añadir reclamaciones.

  2. Seleccione un perfil. El perfil se extrae del servicio Security and Compliance Center. Puede elegir seleccionar un perfil predefinido o ir a Security and Compliance Center y crear uno propio.

  3. Especifique si el módulo cumple todos los controles del perfil o si puede cumplir los requisitos de control para un subconjunto de los controles.

  4. Si el módulo sólo puede cumplir un subconjunto de los controles, debe seleccionar los controles que se pueden satisfacer y añadirlos como reclamaciones.

  5. Utilice Security and Compliance Center para confirmar las reclamaciones que ha identificado.

    1. En la consola IBM Cloud, haga clic en el ícono de menú Ícono de menú > Seguridad y cumplimiento para acceder a Security and Compliance Center.
    2. Cree una conexión entre el perfil que ha seleccionado y un ámbito que contenga los recursos que se han creado durante el despliegue de validación.
    3. Ejecute una exploración y espere a que los resultados estén disponibles.

  6. En el separador Gestionar conformidad de la interfaz de usuario del catálogo, pulse Añadir exploración.

  7. Seleccione una Instancia, Perfil y la exploración específica que desea añadir.

  8. Pulse Añadir

Revisión de requisitos

Cuando haya completado la guía paso a paso, debe revisar las selecciones y confirmar que está preparado para compartir el módulo en el catálogo. Cuando esté listo, pulse Listo para compartir.

Descarga del manifiesto

Siempre que se realicen cambios en la configuración del módulo a través de la consola, se recomienda generar y descargar un nuevo archivo de manifiesto para asegurarse de que los cambios se seleccionen en futuros releases del módulo.

Para descargar un manifiesto a través de la interfaz de usuario, puede utilizar los pasos siguientes.

  1. Vaya a la página Gestionar > Catálogos > Catálogos privados de la consola.
  2. Seleccione el módulo que se incorporó anteriormente. Se abre una página de detalles.
  3. En el separador Versiones, seleccione la versión para la que desea generar un manifiesto.
  4. En el menú desplegable Acciones, seleccione Exportar como código.
  5. Añada el archivo a la carpeta raíz del repositorio de código fuente como ibm_catalog.json.

Próximos pasos

Ahora que el módulo se ha añadido a un catálogo privado y los detalles están establecidos, está listo para compartirlo con otros miembros de la organización. Para obtener ayuda para compartir, consulte Compartir el producto.