Incorporación de una arquitectura implementable a un catálogo privado

Cuando esté listo para compartir su arquitectura implementable con otros miembros de su organización, puede añadirla a un catálogo privado. Además, puede utilizar el flujo de incorporación para validar su arquitectura.

La incorporación de su arquitectura implementable a un catálogo privado implica añadir su código fuente al catálogo, editar los detalles de su arquitectura implementable y, a continuación, validarla. A continuación, revisa la estimación de costes y la información de cumplimiento para tu arquitectura implementable. Cuando haya terminado, puede compartir la arquitectura implementable o publicarla en el IBM Cloud.

Proceso de alto nivel para la incorporación de una arquitectura implementable a un catálogo privado.

Antes de empezar

Antes de poder incorporar su arquitectura desplegable, asegúrese de cumplir 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 privados y arquitecturas implementables.
- Función de administrador 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
- SecretsReader rol en el servicio Secrets Manager si planea almacenar sus valores seguros en una instancia de Secrets Manager
- Función de lector en el servicio Workload Protection
- Otras funciones que se requieren para recursos específicos en su arquitectura implementable personalizada
Cree un catálogo privado.
Asegúrese de tener el código fuente de su arquitectura implementable almacenado en un repositorio GitHub o GitLab. Para obtener ayuda sobre cómo introducir tu código fuente en un repositorio, consulta Configuración del repositorio de código fuente.

¿Quieres ver cómo funciona pero no tienes una arquitectura implementable lista para usar? Utilice nuestra arquitectura implementable de muestra.

Empaquetar tu código fuente

Para crear el .tgz archivo que necesita para incorporar su arquitectura desplegable a un catálogo privado, debe crear una versión de lanzamiento de su código fuente. Para obtener ayuda sobre cómo crear una versión, consulta Gestión de versiones en un repositorio.

Si utiliza un repositorio de código fuente privado, asegúrese de tener un token de acceso personal Git o un secreto almacenado en Secrets Manager.

Añadir una arquitectura implementable a un catálogo privado

Para añadir su arquitectura implementable a un catálogo privado, puede seguir los siguientes pasos.

En la consola IBM Cloud, vaya a la página Administrar > Catálogos > Catálogos privados de la consola.
Selecciona el catálogo privado al que quieras añadir un producto. Se abre la página de detalles del catálogo.
Pulse Añadir producto. Se abre un panel lateral.
Seleccione Arquitectura implementable para Tipo de producto.
Seleccione Terraform o Stack como método de entrega.
Seleccione el tipo de repositorio donde se encuentra su código fuente.

Si su código fuente se encuentra en un repositorio privado, debe autenticarse utilizando un token de acceso personal Git o un secreto de Secrets Manager.
Añade un enlace a tu código fuente en el campo Fuente URL. Debería tener un aspecto similar a https://github.com/IBM-Cloud/terraform-sample/archive/refs/tags/v1.1.0.tar.gz.

Si está incorporando su arquitectura desplegable con fines de prueba, no es necesario que tenga un .tgz archivo. Puede proporcionar el enlace al nivel raíz de su arquitectura.
Selecciona una variante.

Una variación es un tipo de arquitectura desplegable que aplica diferentes capacidades o complejidades a una arquitectura desplegable existente. Por ejemplo, podría haber una variante de inicio rápido de su arquitectura implementable que cuente con capacidades básicas para una implementación sencilla y de bajo coste con fines de pruebas internas. Y es posible que tengas una variante estándar un poco más compleja que está lista para su uso en producción.
Introduce la versión del software en el formato «versión principal, versión secundaria y revisión». Por ejemplo, 1.0.0. Normalmente, esta versión coincide con el número de versión de tu instantánea de lanzamiento.
Seleccione la categoría con la que desea agrupar su arquitectura implementable en el catálogo.
Pulse Añadir producto. Se muestra la página de descripción general del producto.

Edición de la entrada del catálogo

Después de incorporar correctamente la arquitectura desplegable a su catálogo privado, debe especificar la información que verá el usuario cuando intente utilizar la arquitectura. La información incluye descripciones del producto, enlaces a documentación y palabras clave que garantizan que su producto sea fácil de encontrar.

Especificar detalles a través de la consola

Sus usuarios ven la información sobre el nivel de versión que usted define como parte de la entrada del catálogo de su producto. La información proporcionada como parte de este flujo puede ayudar a sus usuarios a comprender la funcionalidad de los componentes individuales asociados a él.

Para asegurarte de que tus selecciones se transfieran a la próxima versión, puedes generar un archivo de manifiesto. El archivo de manifiesto, ibm_catalog.json, es la fuente de verdad para tu entrada en el catálogo. Contiene toda la información sobre su producto y las selecciones que ha realizado. Después de generar el archivo, debe añadirlo al nivel raíz de su repositorio de código fuente. Si prefieres trabajar en el código, las siguientes secciones se pueden configurar directamente a través del archivo mainfest. Para obtener más información sobre cómo estructurar el archivo, consulte Edición local del archivo de manifiesto.

Entrando en detalles

Después de añadir su arquitectura implementable a un catálogo privado, podrá utilizar una guía paso a paso en la consola para actualizar la información general sobre su producto. Para acceder a la página de la consola, puede seguir los siguientes pasos.

Vaya a la página Administrar > Catálogos > Catálogos privados de la consola.
Seleccione el catálogo privado donde ha añadido su producto. Se abre la página de detalles del catálogo.
Seleccione el producto que ha incorporado anteriormente.
En la pestaña Versiones, seleccione la versión de su producto sobre la que desea proporcionar información.
Utilice la siguiente información como guía para configurar los detalles de su arquitectura implementable.

Configuración de los detalles de tu versión

En la pestaña Configurar versión, puede revisar y actualizar la información sobre la versión específica de su arquitectura. Configure los detalles de implementación, defina el acceso IAM necesario y detalle los avisos de cambios que desea que sus usuarios conozcan.

Si desea ampliar su arquitectura desplegable, puede hacerlo apilándola con otras arquitecturas. Puede incluir las dependencias que requiera su arquitectura, junto con arquitecturas opcionales que le ayuden a ampliar su solución para un caso de uso concreto. Para obtener más información, consulte Ampliación de una arquitectura implementable durante la incorporación.

Si su arquitectura implementable requiere una versión específica del tiempo de ejecución de Terraform, puede anular la versión predeterminada. Si incluyó TF_VERSION como variable de entrada en su repositorio de código fuente, debería haberse actualizado automáticamente cuando creó su entrada de catálogo.

Las variables de entrada son los parámetros que los usuarios especifican cuando utilizan su producto. Puede revisar y modificar las variables de entrada y salida que se importaron con su código fuente, o puede agregar variables a su arquitectura implementable como parte de este paso. Cuando se añaden variables, puedes actualizar si son obligatorias, visibles o el formato en el que deben proporcionarse.

Cuando lances una nueva versión de tu producto, es posible que haya cambios que desees comunicar a tus usuarios antes de que empiecen a utilizar la nueva versión. Puedes dividir la información en tres categorías: cambios importantes, nuevas funciones y actualizaciones generales.

Cambios importantes: Detalla cualquier cambio en el código de la nueva versión que pueda causar una experiencia disruptiva a los usuarios que están trabajando con una versión anterior.
Nuevas funciones: Destaque cualquier nueva funcionalidad que ofrezca la nueva versión y que el usuario pueda querer aprovechar.
Actualizaciones: Describa cualquier actualización general que se haya realizado en la nueva versión. Por ejemplo, correcciones de errores o mejoras en las funciones existentes.

Incluyendo preámbulos y posdatas

Puede ejecutar un pre-script o un post-script para sus arquitecturas implementables antes o después de la validación, implementación y desimplementación. Los scripts se configuran para una versión específica de su arquitectura implementable, tal y como se especifica en el archivo de manifiesto del catálogo, y deben ejecutarse y validarse a través de proyectos.

Los scripts son opcionales para una oferta, pero si se utilizan, deben estar en el repositorio en un directorio llamado scripts. Los archivos de script deben ajustarse a la siguiente convención de <action>-<stage>-ansible-playbook.yaml nomenclatura. Las opciones para action incluyen deploy, validate, y undeploy. Las opciones para stage incluyen pre y post. Por el momento, solo se admiten scripts Ansible en formato playbook.

Todos los scripts deben poder ejecutarse más de una vez sin fallar. Por ejemplo, un script previo o posterior a la implementación debe funcionar correctamente, incluso si se ejecuta varias veces. Los scripts posteriores a la implementación pueden añadir recursos a una base de datos de gestión de catálogos y deben asegurarse de no añadir recursos duplicados si se ejecutan más de una vez.

Para obtener más información, incluidos ejemplos, consulte Creación de scripts para una arquitectura implementable.

Añadir detalles de arquitectura desplegable

Cuando pones una arquitectura implementable a disposición de otros usuarios en la nube, debes proporcionar la siguiente información:

Un diagrama de arquitectura que detalla cómo funcionan conjuntamente los componentes de su arquitectura implementable.
Cualquier aspecto destacado que pueda ayudar a los usuarios a diferenciar qué versión o variante de su arquitectura podría ser la más adecuada para sus necesidades.

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 instalar su arquitectura desplegable en el archivo Léame.

Validación de la versión

Selecciona el objetivo que deseas validar. Cuando se valida un producto, se implementan los recursos. Para una arquitectura independiente implementable, el destino puede ser un espacio de trabajo de Schematics en su cuenta actual o un proyecto específico. Para una pila de arquitectura desplegable, debe utilizar un proyecto. Dependiendo de la opción que seleccione, es posible que se requiera más información de configuración. Una vez configurado el destino, debe proporcionar los valores de las variables de entrada y salida que son necesarios para que su arquitectura se implemente correctamente en el destino. Una vez configuradas las variables, puede validar la versión.

No elimine los recursos de su cuenta hasta después de ejecutar la evaluación de cumplimiento en la sección de gestión de seguridad y cumplimiento.

Si la versión no supera la validación debido a un análisis CRA, el administrador de la cuenta puede optar por ignorar el error y realizar la implementación de todos modos. Si la validación falla por cualquier otro motivo, se recomienda encarecidamente que solucione cualquier problema que se detecte antes de publicar su oferta.

Revisión de costes

Asegúrese de comprender completamente los costos asociados con la implementación de su arquitectura. La versión debe validarse antes de poder generar un coste estimado.

gestión de la conformidad

Cuando pone una arquitectura implementable a disposición de otras personas de su organización, puede especificar los controles de cumplimiento específicos que cumple su arquitectura utilizando la instalación predeterminada. IBM Cloud® Security and Compliance Center Workload Protection evalúa el cumplimiento de los controles reglamentarios.

Pulse Añadir controles.
Seleccione su instancia y política de Workload Protection. Puede elegir entre seleccionar una política predefinida o ir a Workload Protection y crear una propia.
Especifique si su arquitectura implementable cumple todos los controles de la política o si puede satisfacer los requisitos de un subconjunto de los controles.
Si su arquitectura solo puede cumplir una parte de los controles, debe seleccionar los controles que se pueden cumplir y añadirlos.
Utilice Workload Protection para confirmar el cumplimiento de los controles que ha identificado. Workload Protection utiliza un inventario para realizar un seguimiento del cumplimiento. Los resultados del inventario se actualizan diariamente. Implemente los recursos que crea su arquitectura y espere a que se actualicen los resultados del inventario. Para obtener más información, consulta la sección Revisar y priorizar las medidas correctoras.
En la pestaña Administrar cumplimiento de la interfaz de usuario del catálogo, haga clic en Agregar resultados.
Seleccione una instancia y haga clic en Aplicar para aplicar los últimos resultados del inventario.

Revisión de los requisitos

Cuando hayas completado el tutorial, debes revisar tus selecciones y confirmar que estás listo para compartir tu producto en tu catálogo. Cuando estés listo, haz clic en Listo para compartir.

Descarga del manifiesto

Siempre que se realicen cambios en la configuración de su producto a través de la consola, se recomienda generar y descargar el archivo de manifiesto para garantizar que los cambios se incorporen en futuras versiones del producto.

Para descargar un manifiesto, puede seguir los siguientes pasos.

Vaya a la página Administrar > Catálogos > Catálogos privados de la consola.
Seleccione el producto que se incorporó anteriormente. Se abre una página con detalles.
En la pestaña Versiones, seleccione la versión para la que desea generar un manifiesto.
En el menú desplegable Acciones, selecciona Generar manifiesto.
Añade el archivo a la carpeta raíz de tu repositorio de código fuente como ibm_catalog.json.

Descarga de la configuración de tu catálogo

Si está incorporando arquitecturas desplegables apiladas desde un proyecto, se generan archivos adicionales además de su archivo de manifiesto. Si ha realizado actualizaciones en la configuración de su catálogo mediante la consola, se recomienda descargar los archivos y añadirlos a su repositorio de código fuente para que los cambios se transfieran a la próxima versión.

Vaya a la página Administrar > Catálogos > Catálogos privados de la consola.
Seleccione el producto que se incorporó anteriormente. Se abre una página con detalles.
En la pestaña Versiones, seleccione la versión para la que desea generar un manifiesto.
En el menú desplegable Acciones, selecciona Generar manifiesto.
Añade los archivos a la carpeta raíz de tu repositorio de código fuente.

Añadir una variación

Puede añadir más variaciones que sean una nueva versión de su arquitectura diseñada para ampliar las funciones de la arquitectura básica implementable. Si ha creado varias variaciones en directorios de trabajo separados en su repositorio de origen y las ha especificado en la flavors matriz de su archivo ibm_catalog.json de manifiesto, debe incorporar cada variación por separado.

En este punto, ya has incorporado tu primera variación. Ahora, puede volver a empezar en Añadir una arquitectura implementable para incorporar su próxima variación. Aquí tienes algunos consejos para incorporar tu próxima variación:

La fuente URL de la versión del repositorio será la misma para todas las variaciones dentro de esa versión y deben importarse con el mismo número de versión. El nombre del producto y el número de versión son los elementos que vinculan las variaciones entre sí y que luego aparecen como opciones en el mismo mosaico del catálogo.
En la página Añadir detalles de la arquitectura implementable, el paso 3 incluye añadir elementos destacados. Estas se conocen como características en el ibm_catalog.json archivo de manifiesto. Es posible que ya los hayas añadido al manifiesto, por lo que puedes revisarlos aquí. Si no es así, añade algunos reflejos. Deben ser breves y referirse a las capacidades, procesos, prestaciones u otras características de esta arquitectura específica. Utilizará el mismo resaltado «Nombre» en todas las variaciones. La descripción es donde debería haber diferencias. Esto permite a los usuarios evaluar las diferencias entre las arquitecturas utilizando los resaltados de texto en la página de detalles del catálogo.

Próximos pasos: Compartir y publicar

Ahora que su arquitectura implementable se ha añadido a un catálogo privado y se han configurado los detalles, ya está listo para compartir el producto con otros miembros de su organización. Para obtener ayuda sobre cómo compartir, consulte Compartir su producto.

Si desea publicar su arquitectura implementable en el catálogo IBM Cloud, puede utilizar Partner Center para obtener la aprobación y publicarla para que todos los usuarios puedan aprovechar la solución que ha creado. Para obtener más información, consulte Publicación de su arquitectura implementable.