For the complete documentation index, see llms.txt. This page is also available as Markdown.

Recetas de inquilino

Cómo crear y usar recetas de inquilino en VergeOS para automatizar implementaciones completas de inquilinos, incluida la red, las VM, la configuración y las preguntas de configuración personalizada.

Las recetas de inquilino permiten automatizar la implementación de inquilinos. Una receta de inquilino puede incluir todo lo necesario para crear una nueva instancia de inquilino completamente funcional, incluyendo: configuración del inquilino, configuración de red, máquinas virtuales incluidas y automatización de tareas como crear contraseñas aleatorias, establecer nombres de host/contraseñas/nombres de usuario únicos, registrar entradas de DHCP y DNS, enviar notificaciones y más. Esta página le guiará por el proceso básico de creación y uso de recetas de inquilino.

Beneficios de usar recetas de inquilino:

  • Despliegue rápido de inquilinos completos

  • Coherencia en las configuraciones de inquilino

  • Menor tiempo de configuración manual, reduciendo a su vez la posibilidad de error humano

  • Imágenes doradas para cumplimiento normativo

Crear una receta de inquilino

  1. Cree un inquilino para que sirva como plantilla base. Una receta de inquilino se basa en un inquilino que sirve como plantilla inicial. Cree el inquilino para incluir la configuración, las VM y las redes que deban formar parte de la configuración genérica. El inquilino debe estar apagado antes de crear la receta.

  1. Navegue hasta la Panel de recetas de inquilino (Repositorios > Recetas de inquilino).

  2. Haga clic en Nuevo en el menú de la izquierda.

  3. Configurar la receta de inquilino campos:

    • Nombre: Use un nombre que identifique adecuadamente la receta para ayudar a los usuarios a localizar las recetas adecuadas.

    • Descripción: (opcional) Puede guardar aquí cualquier información adicional sobre la receta. Puede ser un buen lugar para proporcionar documentación básica sobre el propósito previsto y cualquier directriz general.

    • Icono: (opcional) se puede asociar un icono de Font Awesome con la receta. Los iconos pueden ayudar a los usuarios a identificar fácilmente distintas recetas/tipos de receta. Hay una lista de iconos disponibles en FontAwesome .

    • Catálogo: Seleccione un catálogo en el que almacenar la receta. Los catálogos son útiles para mantener las recetas organizadas. Consulte Organización de recetas para obtener más información sobre los catálogos.

    • Inquilino: Seleccione el inquilino que servirá como base de la receta.

    • Versión: Este campo se incrementará automáticamente cada vez que se modifique la receta, para ayudar a rastrear los cambios. El valor predeterminado es 1.0.0, pero puede cambiarse si desea empezar el versionado con un número distinto.

    Numeración de versiones

    Un número de versión de 1.0.0 se incrementaría a 1.0.0-1 y luego a 1.0.0-2, y así sucesivamente. Además, puede editar manualmente el número de versión para reflejar cambios de versión más importantes, como cambiar la versión a 2.0.0 después de realizar modificaciones significativas en la receta.

    • Conservar certificados SSL: Cuando se selecciona, los certificados SSL instalados en el inquilino base se copian a las instancias de inquilino creadas con la receta.

    • Dependencias de versión: (no aplicable para recetas que solo se usarán en el sistema local y en sus propios inquilinos). Las dependencias pueden especificarse cuando haya funciones de VergeOS necesarias para que la receta funcione correctamente (para evitar que un sistema remoto use una receta que no puede admitir).

  4. Haga clic en Enviar para guardar la receta. El panel de recetas de inquilino mostrará dónde se pueden personalizar las preguntas de la receta.

Preguntas

Las preguntas proporcionan valores de personalización para los inquilinos individuales creados con una receta, capturando la entrada del usuario o interactuando con la base de datos de VergeOS. Una receta de inquilino incluirá automáticamente preguntas del sistema. Algunas de estas preguntas están deshabilitadas de forma predeterminada y deberán habilitarse si desea utilizarlas.

(Opcional) Habilite las preguntas deshabilitadas predeterminadas: Haga clic en Preguntas (menú izquierdo o tarjeta del panel), seleccione la(s) pregunta(s), y haga clic en Habilitar en el menú de la izquierda.

Para configurar preguntas adicionales, haga clic en Preguntas en el menú izquierdo y luego en Nuevo.

Campos de la pregunta:

  • Sección: Las secciones le permiten agrupar sus preguntas en el formulario de entrada. Algunas secciones se crean automáticamente y puede crear secciones adicionales para sus preguntas desde el panel de recetas de inquilino.

  • Nombre: sirve como el nombre de variable que puede referenciarse en los scripts; use un nombre descriptivo para facilitar el mantenimiento y la resolución de problemas en los scripts; solo caracteres alfanuméricos, sin espacios ni caracteres especiales.

  • Tipo: determina cómo se recopilan los datos: mediante la entrada del usuario, interactuando con la base de datos de VergeOS, etc.

  • ID de orden: se usa para determinar el orden en que se muestran las preguntas, dentro de la sección seleccionada.

  • Mostrar: la etiqueta de texto que se muestra en el formulario de entrada del usuario para la pregunta

  • Valor predeterminado: (opcional) define un valor de respuesta inicial para la pregunta

  • Validación Regex: (opcional) cadena de expresión regular utilizada para validar la entrada (sintaxis estándar de Regex)

  • Texto del marcador de posición: (opcional) texto atenuado que se muestra para dar al usuario un ejemplo de la entrada esperada

  • Texto de información sobre herramientas: (opcional) texto de ayuda del usuario que se muestra en un emergente cuando se pasa el ratón sobre el campo

  • Texto de nota: (opcional) texto de ayuda del usuario que se muestra directamente debajo del campo de entrada para proporcionar orientación adicional al usuario.

  • Al cambiar: permite ocultar/mostrar otras preguntas cuando se cambia este campo. (Se muestra código de ejemplo en este campo al crear una nueva pregunta.)

Pueden estar disponibles opciones de configuración adicionales según el tipo seleccionado.

Interactuar con la base de datos de VergeOS

Algunos tipos de pregunta permiten buscar información en la base de datos o crear/editar registros de la base de datos. Observe el texto de marcador de posición (texto atenuado que muestra un ejemplo de entrada) al configurar preguntas de interacción con la base de datos para obtener pistas. Estos artículos de la Base de Conocimientos proporcionan información adicional sobre el trabajo con la base de datos de VergeOS: La descripción de las tablas de la API y La guía de la API

Contexto de base de datos

La Contexto de base de datos el campo le permite elegir interactuar con la base de datos local (el sistema principal) o con la base de datos del inquilino recién creado. Esto se aplica a los tipos de pregunta: Creación en base de datos, edición en base de datos y búsqueda en base de datos.

Referencia de preguntas del sistema

Cuando se crea una receta de inquilino, el sistema genera automáticamente un conjunto de preguntas integradas organizadas en secciones. Muchas de estas preguntas están deshabilitadas de forma predeterminada y deben habilitarse si desea utilizarlas. Las preguntas del sistema no pueden eliminarse, pero sí pueden habilitarse o deshabilitarse.

Para habilitar una pregunta del sistema deshabilitada: vaya a Preguntas (menú izquierdo o tarjeta del panel), seleccione la(s) pregunta(s), y haga clic en Habilitar en el menú de la izquierda.

Sección de inquilino

Estas preguntas controlan la configuración principal del inquilino, como la identidad, las credenciales de administrador y la configuración SSL.

Nombre
Mostrar
Tipo
Predeterminado
Habilitada de forma predeterminada

YB_URL

URL

Cadena

YB_DESCRIPTION

Descripción

Área de texto

YB_USER_NAME

Usuario administrador

Cadena

admin

YB_USER_PASSWORD

Contraseña

Contraseña

YB_USER_EMAIL

Correo electrónico

Cadena

No

YB_USER_CHANGE_PASSWORD

Requerir cambio de contraseña

Booleano

falso

No

YB_EXPOSE_CLOUD_SNAPSHOTS

Exponer instantáneas del sistema

Booleano

true

No

YB_HELP_URL

URL de ayuda

Cadena

default

No

YB_THEME_ACCESS

Acceso al tema

Lista

host_only

YB_SPECIFIED_THEME

Tema

Selección de fila

YB_CLUSTER

Clúster

Clúster

No

YB_CERT_TYPE

Tipo de certificado SSL

Oculto

manual

No

YB_CERT_DOMAIN

Dominio del certificado SSL

Cadena

No

YB_CERT_PUBLIC

Certificado SSL público

Área de texto

No

YB_CERT_PRIVATE

Certificado SSL privado

Área de texto

No

YB_CERT_CHAIN

Cadena de certificados SSL

Área de texto

No

Sección de nodos

Estas preguntas definen los recursos de cómputo asignados a los nodos del inquilino.

Nombre
Mostrar
Tipo
Predeterminado
Habilitada de forma predeterminada

YB_NODE_1_CPU_CORES

Núcleos del nodo 1

Número

8

YB_NODE_1_RAM

RAM del nodo 1

RAM

16384

YB_NODE_1_INSTANCES

Instancias del nodo 1

Número

1

No

YB_NODE_1_CLUSTER

Clúster del nodo 1

Clúster

No

YB_NODE_1_CLUSTER_FAILOVER

Clúster de conmutación por error del nodo 1

Clúster

No

Sección de red

Estas preguntas configuran las direcciones de red del inquilino.

Nombre
Mostrar
Tipo
Predeterminado
Habilitada de forma predeterminada

YB_NET_1_IP

Dirección IP de la interfaz de usuario

Dirección IP virtual

YB_NET_2_IP

Dirección IP

Dirección IP virtual

Modificar una receta

Cuando se realizan cambios en una receta, será necesario republicarla para que esos cambios estén disponibles. En la parte superior del panel de la receta se mostrará un mensaje indicando que debe republicarse para que los cambios surtan efecto. Puede usar el Republicar enlace dentro de este mensaje o hacer clic en Republicar en el menú izquierdo.

Usar una receta de inquilino

Crear un inquilino a partir de una receta

  1. Desde el menú superior, vaya a Inquilinos > + Nuevo inquilino.

  2. Haga clic en el catalog deseado

  3. desde la sección de catálogos de la izquierda. Seleccione la receta deseada y haga clic en Siguiente en la parte inferior de la pantalla.

  4. Los campos de entrada se presentan según lo definido por las preguntas de la receta.

  5. Introduzca/configure los campos y haga clic en Enviar para crear el nuevo inquilino. La configuración de las preguntas de la receta determinará los campos obligatorios y otra validación de campos.

Instancias de la receta

Una instancia se refiere a un inquilino específico que está asociado con una receta de inquilino. Cuando se crea un inquilino a partir de una receta se considera una instancia de la receta hasta que se elimina o se desvincula de la receta.

Haga clic en Instancias en el menú izquierdo del panel de recetas de inquilino para acceder rápidamente a una lista de los inquilinos asociados. Una receta no puede eliminarse cuando hay instancias asociadas.

Las recetas permiten una amplia variedad de soluciones potenciales. Póngase en contacto con el soporte de VergeOS para obtener ayuda adicional para automatizar sus implementaciones de inquilinos mediante recetas.

Última actualización

¿Te fue útil?