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

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

Antes de empezar

Antes de poder incorporar su arquitectura implementable, 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 tenga el acceso necesario para trabajar con catálogos privados y arquitecturas implementables.
- 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
- Función SecretsReader en el servicio Secrets Manager si planea almacenar sus valores seguros en una instancia de Secrets Manager
- Rol de lector en el servicio Security and Compliance Center
- Otros roles 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 de GitHub o GitLab. Para obtener ayuda para colocar su código fuente en un repositorio, consulte Configurar su 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.

Empaquetando su código fuente

Para crear el archivo .tgz que necesita para incorporar su arquitectura implementable a un catálogo privado, debe crear una versión de lanzamiento de su código fuente. Para obtener ayuda con la creación de una versión, consulte Administrar versiones en un repositorio.

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

Agregar una arquitectura implementable a un catálogo privado

Para agregar su arquitectura implementable a un catálogo privado, puede utilizar los siguientes pasos.

En la consola IBM Cloud, vaya a la página Administrar > Catálogos > Catálogos privados de la consola.
Seleccione el catálogo privado al que desea 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 el tipo de producto.
Seleccione Terraform o Stack como su 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ñada un enlace a su código fuente en el campo URL la fuente. Debería verse similar a https://github.com/IBM-Cloud/terraform-sample/archive/refs/tags/v1.1.0.tar.gz.

Si está incorporando su arquitectura implementable para fines de prueba, no necesita tener un archivo .tgz. Puede proporcionar el enlace al nivel raíz de su arquitectura.
Seleccione una variación.

Una variación es un tipo de arquitectura implementable que aplica diferentes capacidades o complejidad a una arquitectura implementable existente. Por ejemplo, podría haber una variación de inicio rápido en su arquitectura implementable que tenga capacidades básicas para una implementación simple y de bajo costo para probar internamente. Además, es posible que tenga una variación estándar que sea un poco más compleja y que esté lista para usarse en producción.
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 su instantánea de lanzamiento.
Seleccione la categoría con la que desea que se agrupe su arquitectura implementable en el catálogo.
Pulse Añadir producto. Aparece la página de resumen de productos.

Edición de su entrada de catálogo

Después de incorporar con éxito su arquitectura implementable a su catálogo privado, debe especificar la información que ve un usuario cuando intenta utilizar la arquitectura. La información incluye descripciones del producto, enlaces a la documentación y palabras clave que garantizan que su producto se pueda encontrar fácilmente.

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

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

Para garantizar que sus selecciones se transfieran a su próxima versión, puede generar un archivo de manifiesto. El archivo de manifiesto, ibm_catalog.json, es la fuente de verdad para su entrada de catálogo. Contiene toda la información sobre su producto y las selecciones que ha realizado. Después de generar el archivo, debes agregarlo al nivel raíz de tu 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 de su archivo de manifiesto.

Llegando a los detalles

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

Vaya a la página Administrar > Catálogos > Catálogos privados de la consola.
Selecciona el catálogo privado donde agregaste tu producto. Se abre la página de detalles del catálogo.
Seleccione el producto que incorporó 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.

Configurar los detalles de su versión

En la pestaña Configurar versión, puede revisar y actualizar información sobre la versión específica de su arquitectura. Configura los detalles de implementación, define el acceso IAM requerido y detalla los avisos de cambio que quieres que tus usuarios conozcan.

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

Si su arquitectura implementable requiere una versión de ejecución de Terraform específica, puede anular la versión predeterminada. Si incluyó TF_VERSION como una variable de entrada dentro de 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 agregan variables, puede actualizar si son obligatorias, visibles o el formato en que deben proporcionarse.

Cuando lanza una nueva versión de su producto, es posible que haya cambios que desee notificar a sus usuarios antes de que comiencen a utilizar la nueva versión. Puede separar la información en tres categorías: cambios importantes, nuevas funciones y actualizaciones generales.

Cambios importantes: detalle cualquier cambio en el código de la nueva versión que pueda causar una experiencia disruptiva para los usuarios que trabajan con una versión anterior.
Nuevas características: resalte cualquier funcionalidad nueva proporcionada en la nueva versión que un usuario podría querer aprovechar.
Actualizaciones: describe cualquier actualización general que se haya realizado a la nueva versión. Por ejemplo, correcciones de errores o mejoras en funciones existentes.

Incluyendo pre- y post-guiones

Puede ejecutar un script previo o posterior para sus arquitecturas implementables antes o después de validar, implementar y anular la implementación. Los scripts se configuran para una versión específica de su arquitectura implementable 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, es necesario que estén en el repositorio en un directorio llamado scripts. Los archivos de script deben cumplir con la siguiente convención de nombres <action>-<stage>-ansible-playbook.yaml. Las opciones para action incluyen deploy, validate y undeploy. Las opciones para stage incluyen pre y post. En este 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 agregar recursos a una base de datos de administración de catálogo y se debe garantizar que no agreguen 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.

Agregar detalles de arquitectura implementable

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

Un diagrama de arquitectura que detalla cómo funcionan juntos los componentes de su arquitectura implementable.
Cualquier aspecto destacado que pueda ayudar a los usuarios a diferenciar qué versión o variación 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 implementable en el archivo Léame.

Validando la versión

Seleccione el objetivo para la validación. Cuando se valida un producto, se implementan los recursos. Para una arquitectura implementable independiente, el destino puede ser un espacio de trabajo Schematics en su cuenta actual o un proyecto específico. Para una pila de arquitectura implementable, 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 para las variables de entrada y salida que se requieren para que su arquitectura se implemente correctamente en el destino. Una vez configuradas las variables, puedes validar la versión.

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

Si la versión falla la validación debido a un escaneo de CRA, un administrador de la cuenta puede elegir anular la falla e implementar de todos modos. Si la validación falla por cualquier otro motivo, se recomienda encarecidamente que solucione cualquier problema que encuentre antes de publicar su oferta.

Revisando costos

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 costo estimado.

gestión de la conformidad

Cuando pone una arquitectura implementable a disposición de otros en su organización, puede especificar los controles de cumplimiento específicos que cumple su arquitectura mediante la instalación predeterminada. El cumplimiento de los controles reglamentarios se evalúa mediante IBM Cloud Security and Compliance Center. Para más información, véase Selección de recursos para evaluar.

Haga clic en Agregar reclamaciones.
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.
Especifique si su arquitectura implementable cumple con todos los controles del perfil o si puede satisfacer los requisitos de control para un subconjunto de los controles.
Si su arquitectura solo puede cumplir con un subconjunto de los controles, entonces debe seleccionar los controles que se pueden satisfacer y agregarlos como reclamos.
Utilice Security and Compliance Center para confirmar las afirmaciones que ha identificado.
1. En la consola IBM Cloud, haga clic en el ícono de menú > Seguridad y cumplimiento para acceder a Security and Compliance Center.
2. Crea un archivo adjunto utilizando el perfil que hayas seleccionado.
El alcance que defina como parte de la creación de un archivo adjunto debe contener los recursos que se implementaron cuando validó su producto.
1. Ejecute un escaneo y espere hasta que los resultados estén disponibles.
En la pestaña Administrar cumplimiento de la interfaz de usuario del catálogo, haga clic en Agregar escaneo.
Seleccione una Instancia, un Perfil y el escaneo específico que desea agregar.
Pulse Añadir

Revisión de requisitos

Cuando haya completado el tutorial, deberá revisar sus selecciones y confirmar que está listo para compartir su producto en su catálogo. Cuando esté listo, haga clic en Listo para compartir.

Descargar el manifiesto

Siempre que se realicen cambios en la configuración de su producto a través de la consola, es una buena práctica generar y descargar su archivo de manifiesto para garantizar que los cambios se implementen en futuras versiones de su producto.

Para descargar un manifiesto, puede utilizar 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 de detalles.
En la pestaña Versiones, seleccione la versión para la que desea generar un manifiesto.
En el menú desplegable Acciones, seleccione Exportar como código.
Agregue el archivo a la carpeta raíz de su repositorio de código fuente como ibm_catalog.json.

Descargar la configuración de su catálogo

Si está trabajando con una pila de arquitectura implementable, hay archivos adicionales que se generan 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 agregarlos a su repositorio de código fuente para que los cambios se transfieran a su 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 de detalles.
En la pestaña Versiones, seleccione la versión para la que desea generar un manifiesto.
En el menú desplegable Acciones, seleccione Exportar como código.
Agregue los archivos a la carpeta raíz de su repositorio de código fuente.

Agregar una variación

Puede agregar más variaciones que sean una nueva versión de su arquitectura diseñada para desarrollar las funciones de la arquitectura implementable base. Si creó varias variaciones en directorios de trabajo separados en su repositorio de origen y las especificó en la matriz flavors en su archivo de manifiesto ibm_catalog.json, debe incorporar cada variación por separado.

En este punto, ya has incorporado tu primera variación. Ahora, puedes volver a comenzar a agregar una arquitectura implementable para incorporar tu próxima variación. A continuación se ofrecen algunos consejos para incorporar su próxima variación:

La URL origen de la versión del repositorio será la misma para todas las variaciones de esa versión y deberán importarse con el mismo número de versión. El nombre del producto y el número de versión son la forma en que se vinculan las variaciones entre sí y luego resultan como opciones en el mismo mosaico del catálogo.
En la página Agregar detalles de arquitectura implementable, el paso 3 incluye agregar aspectos destacados. Estas se conocen como características en el archivo de manifiesto ibm_catalog.json. Es posible que ya los hayas agregado en el manifiesto, por lo que puedes revisarlos aquí. Si no es así, sigue adelante y agrega algunos aspectos destacados. Estas deben ser capacidades, procesos, habilidades u otras características breves de esta arquitectura específica. Utilizarás 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 en las arquitecturas utilizando los textos resaltados en la página de detalles del catálogo.

Próximos pasos: compartir y publicar

Ahora que su arquitectura implementable está agregada a un catálogo privado y los detalles están configurados, está listo para compartir el producto con otros miembros de su organización. Para obtener ayuda con el uso compartido, consulte Cómo compartir su producto.

Si desea publicar su arquitectura implementable en el catálogo IBM Cloud, puede usar el Centro de socios para obtener la aprobación y publicar para que todos los usuarios aprovechen la solución que creó. Para obtener más información, consulte Publicación de su arquitectura implementable.