Creación de un libro de ejecución

Cree un runbook personalizado en Fleet Application Management mediante el diseñador visual.

Fleet Application Management proporciona varios libros de ejecución con pasos predefinidos que puede utilizar para realizar tareas comunes de gestión del ciclo de vida, como comprobaciones del sistema previas a la ejecución y detección del servidor HTTP de Oracle. Estos runbooks están disponibles en la biblioteca de runbooks. También puede crear sus runbooks personalizados y publicarlos para todos los usuarios.
  • En la página de lista Libros de ejecución, seleccione Crear libro de ejecución. Si necesita ayuda para encontrar la página de lista, consulte List Runbooks.

    La creación de un runbook consta de las siguientes páginas:

    Ejecute cada uno de los siguientes flujos de trabajo en orden. Para volver a una página anterior, seleccione Anterior.

    1. Información básica

    En la página Información básica se proporciona la información básica para el libro de ejecución.

    Introduzca la siguiente información:

    • Nombre: Introduzca un nombre fácil de recordatorio para el libro de ejecución. El nombre no tiene que ser único, pero no se puede cambiar en la consola. Sin embargo, puede cambiarlo con la API. Evite introducir información confidencial.
    • Descripción: introduzca una descripción adecuada para el libro de ejecución.
    • Crear en compartimento: seleccione el compartimiento en el que desea crear el libro de ejecución.
    • Compartimento de operación de ciclo de vida: seleccione un compartimento en el que exista la operación de ciclo de vida específica. Para obtener información sobre varias operaciones de ciclo de vida, consulte Operación de ciclo de vida en Fleet Application Management.
    • Operación de ciclo de vida: seleccione una operación de ciclo de vida, por ejemplo, parche, detección, aprovisionamiento o personalizado.
    • Para operaciones de ciclo de vida de detección o aplicación de parches, introduzca la siguiente información:
      • Compartimento de pila de producto/producto: seleccione el compartimento en el que se encuentra la pila de producto o producto.
      • Pila de producto/producto: seleccione un producto o pila de producto al que pertenezca la tarea del compartimento.
    • Tipo de sistema operativo: seleccione una plataforma soportada entre las opciones en las que se ejecuta el runbook.
    • Tiempo estimado (horas): seleccione el tiempo estimado en horas para completar la ejecución del libro de ejecución.
    • Definir como runbook por defecto: active el conmutador para permitir que Fleet Application Management utilice este runbook como runbook por defecto para realizar operaciones de ciclo de vida.
      Nota

      Solo puede definir un runbook para una operación de ciclo de vida concreta y una combinación de producto o pila de producto como runbook por defecto. Fleet Application Management utiliza el runbook de detección por defecto de un producto o pila de productos para detectar el inventario de software del producto y el runbook de aplicación de parches por defecto para seleccionar automáticamente un runbook durante las tareas de creación de programas y corrección de conformidad.
    • Este libro de ejecución necesita acceso SUDO: active el conmutador si el tipo de sistema operativo es Oracle Linux para detectar y aplicar parches para el software que se ejecuta en instancias informáticas.

      El acceso sudo es necesario cuando se necesita soporte de producto para Oracle WebLogic Server, Oracle HTTP Server (OHS) y Oracle Java, que no son específicos de OCI.

      Nota

      Cuando el libro de ejecución tiene activado el acceso sudo, el plugin Fleet Application Management ejecuta las tareas con el privilegio sudo. El plugin Fleet Application Management utiliza un privilegio sudo incorporado, pero se controla completamente a través de la propiedad runbook isSudoAccessNeeded. Consulte Referencia de Runbook.

    Seleccione Next (Siguiente) para continuar con el siguiente paso.

    2. Optimización (Design Runbook)

    La página Optimización (libro de ejecución de diseño) es donde se diseña un flujo de trabajo de libro de ejecución mediante el diseñador visual o el código de libro de ejecución.

    Con el diseñador visual, puede arrastrar una acción desde el panel acciones al lienzo, colocándola donde desee en el flujo de trabajo del libro de ejecución. También puede reordenar las acciones en el flujo de trabajo arrastrándolas a una ubicación diferente.

    1. Seleccione una de las opciones siguientes:
      • Vista de diseño: utilice el diseñador visual arrastrando los componentes y configurándolos. Vaya al paso 2.
      • Vista de código: cargue el código del libro de ejecución en un archivo YAML o JSON. Vaya al paso 3.
    2. Si ha seleccionado Vista de diseño para la creación del libro de ejecución, realice los siguientes pasos:
      Importante

      Para agregar una tarea, primero debe agregar un grupo de recursos paralelo o sucesivo. Una tarea debe estar dentro de un grupo. Para obtener más información sobre el uso del diseñador visual, consulte Diseño de un libro de ejecución con el diseñador visual.
      1. En el separador Componentes del panel de acciones, seleccione un grupo de recursos paralelo o un grupo de recursos dinámico y arrástrelo al lienzo. Agregue tantos grupos como necesite.
        • Para la ejecución en paralelo de tareas de runbook entre recursos, seleccione un grupo paralelo. Un grupo de recursos paralelo es un marcador de posición para una o más tareas dentro de él u otro grupo de tareas paralelo que ejecuta varias tareas en un recurso de destino en paralelo. Para cada tarea que se agrega a un grupo de recursos paralelo, la lista de tareas se ejecuta una tras otra en un recurso específico, pero simultáneamente en una lista de recursos.
        • Para la ejecución secuencial de tareas de runbook, seleccione un grupo de recursos rolling. Un grupo de recursos sucesivos es un marcador de posición para una o más tareas en las que la lista de tareas se ejecuta una tras otra en un recurso específico. Una vez que las tareas se ejecutan correctamente en el recurso, la siguiente tarea se ejecuta en otro recurso.
        Consejo

        Puede reordenar los componentes mediante el icono de arrastrar manejador (arrastrar-manejador) en la esquina derecha de un componente y arrastrarlo a una ubicación diferente en el área de trabajo del libro de ejecución. Después de colocar un componente en el lienzo, su código se genera automáticamente y se agrega al código del libro de ejecución.
      2. Seleccione una tarea nueva y arrástrela a un grupo de recursos que haya agregado. Introduzca los detalles en la página Crear tarea. Para obtener instrucciones, consulte los pasos del 4 al 17 en Creación de una tarea mediante la consola. También puede agregar una tarea predefinida arrastrándola a un grupo de recursos.
        • Las tareas que crea en el runbook son locales del runbook y no pueden ser reutilizadas por otros runbooks.
        • La biblioteca de tareas proporciona una lista de tareas reutilizables que existen o que creó. Puede utilizar el icono de arrastrar manejador (icono de arrastrar) en la esquina derecha de una tarea para arrastrarla al grupo de recursos.
          Consejo

          Primero puede crear tareas de runbook según sea necesario y, a continuación, agregarlas a uno o más runbooks más tarde.
        • Para crear una copia de la tarea en la biblioteca de tareas, seleccione Make a copy of this task in library (Realizar una copia de esta tarea en la biblioteca). Esta tarea forma parte del libro de ejecución y de la biblioteca de tareas. Sin embargo, puede reutilizar y actualizar la tarea de biblioteca independientemente de la tarea de runbook.
      3. Para actualizar las propiedades de una tarea, seleccione el icono de edición junto a la tarea y, a continuación, actualice los valores de campo en la página Editar tarea.
      4. Después de agregar los componentes necesarios al libro de ejecución, seleccione el icono de propiedades (Icono de configuración) del componente para configurarlo mediante el separador Propiedades.
      5. Introduzca un nombre de paso único de preferencia en función de su finalidad. Evite introducir información confidencial.
      6. Seleccione una de las siguientes acciones de la lista En caso de fallo para configurar cómo la automatización puede manejar errores en el flujo de trabajo del runbook:
        Nota

        Por defecto, cuando un componente de libro de ejecución informa de un error, la automatización de Fleet Application Management para el flujo de trabajo del libro de ejecución por completo. Esto se debe a que el valor predeterminado para la propiedad On Failure para todos los componentes es Abort.
        • Abortar: Detenga por completo el flujo de trabajo del runbook cuando falle la ejecución del componente. Esta acción está definida de forma predeterminada.
        • Continuar: continúe con el siguiente paso del flujo de trabajo de runbook cuando falle la ejecución del componente.
        • Anulación: Deshaga el cambio y vuelva al nivel en el que estaba inicialmente el componente de runbook.

          Para realizar un rollback, asegúrese de seleccionar la propiedad En caso de fallo como Revertir. Puede especificar la función de rollback en los niveles de destino o grupo (grupo de acciones). Para realizar un rollback en el nivel de destino, seleccione En caso de fallo de tareas o seleccione En caso de fallo de tareas de rollback para realizar un rollback en el nivel de grupo.

      7. Para crear sentencias condicionales para cada componente del libro de ejecución mediante la opción Condición,
        Escriba una variable en el cuadro de condiciones, seleccione uno de los operadores aritméticos, como Y, NOT u otros, e introduzca un valor para la condición. A continuación, se muestra un ejemplo de sentencia condicional:
        Para la siguiente condición, si la variable backuptype de una tarea es igual al valor hot, se ejecuta la tarea o el creador de condiciones omite y continúa con la siguiente tarea.
        backuptype=hot
      8. Configure Ejecutar en para seleccionar una de las siguientes opciones para ejecutar una tarea:
        • Instancias especificadas por programa: para permitir que una tarea se ejecute de forma condicional solo en determinados componentes aplicables al producto (tal como se definen en los metadatos del producto) en el recurso, seleccione Filtrar instancias. Para obtener instrucciones sobre cómo agregar condiciones de filtro, consulte el subpaso i.
        • Instancia autoalojada: para comprobar la actividad posterior al aprovisionamiento si es necesario, seleccione una instancia autoalojada adecuada que haya creado en Gestión de metadatos en la sección Administración.
          Nota

          La selección de una instancia garantiza que la tarea se ejecute solo en este host (instancia).

          Por ejemplo, puede haber dos tareas en las que el tipo de acción de la primera tarea sea Ejecutar un Terraform que aprovisione los recursos. La segunda tarea puede ser con el tipo de acción Ejecutar un script, donde el script incluye la instancia autoalojada (host central) que comprueba si los recursos están aprovisionados y en ejecución.

          Importante

          Asegúrese de activar el plugin Fleet Application Management en la instancia autoalojada y su instancia asociada. Este paso garantiza que Fleet Application Management pueda considerar eficazmente estas instancias para las operaciones de ciclo de vida.
        • Instancia especificada por la tarea anterior: para comprobar si los recursos aprovisionados se crean y ejecutan cuando no configura un host central.
          Por ejemplo, puede haber dos tareas que realizan las siguientes operaciones:
          1. Cree una primera tarea con el tipo de acción Ejecutar un Terraform que aprovisione las instancias informáticas y devuelva el OCID de los recursos aprovisionados como una variable de salida.
          2. Cree una segunda tarea con el tipo de acción Ejecutar un script.
          3. Seleccione Variable de salida de tarea anterior para proporcionar las variables de tarea.
          4. Introduzca el OCID de recurso que devuelve el subpaso i o un tipo de recurso opcional. Agregue más información de host como la creó la primera tarea. Los OCID o los tipos de recursos sirven como entrada para la segunda tarea.
            Consejo

            La información del host se puede proporcionar como un archivo JSON con los OCID de recursos descritos como una matriz.

          Fleet Application Management ahora analiza las variables de salida y ejecuta el script en los recursos.

      9. Si ha seleccionado Instancias especificadas por programa en el subpaso h, seleccione instancias para abrir el cuadro de diálogo Filtrar instancias.
        • Seleccione las propiedades de producto o componente en el cuadro de la izquierda para agregarlas al cuadro de filtro de la derecha.
        • Seleccione uno de los operadores aritméticos, como AND, NOT u otros.
        • Introduzca un valor para la condición en el cuadro de condición.
          Nota

          Al seleccionar las propiedades de producto o componente, el cuadro de filtro se rellena con una condición de gramática relevante.
          Un ejemplo de la condición de gramática Ejecutar en es el siguiente:
          target.product.name = <product_name>
          target.product.properties.<property_name> = <property_value>
          target.product.components.has(<component_name>)
          target.product.components.<component_name>.properties.<property_name> = <property_value>
          Nota

          Las condiciones basadas en propiedades dependen de que conozca la detección de productos.
        Agregue más instancias de filtro según sea necesario. Estas instancias se agregan a la siguiente fila del cuadro de filtro.
      10. Active el conmutador Pausar ejecución para detener o retrasar la ejecución de tareas durante un tiempo específico hasta que se cumplan determinadas condiciones. Por ejemplo, puede optar por pausar la ejecución de una tarea indefinidamente o hasta que reanude la tarea o durante un tiempo específico que seleccione.
      11. Para recibir notificaciones cuando cambie el estado de la tarea, active el conmutador Notificación y, a continuación, active la casilla de control de la actividad de la tarea para la que desea recibir notificaciones, por ejemplo, en caso de fallo de la tarea, en pausa o cuando la tarea se realice correctamente.
      12. Configure las propiedades de las tareas que agregue. Para obtener una descripción del campo de las propiedades de la tarea, consulte los pasos del 4 al 17 en Creación de una tarea mediante la consola.
    3. Si ha seleccionado Vista de código para la creación del libro de ejecución en el paso 1, seleccione si está utilizando JSON o YAML y, a continuación, seleccione Cargar código de libro de ejecución para agregar el archivo adecuado.
    Seleccione Next (Siguiente) para continuar con el siguiente paso.

    3. Revisar

    Verifique el contenido del libro de ejecución en la página Review. Edite la configuración o vuelva a las pantallas anteriores para agregar información.

    Seleccione Guardar como borrador para guardar el libro de ejecución inicialmente hasta que esté seguro de todos los componentes.
    Nota

    Esta versión provisional del libro de ejecución no está activa, no se puede utilizar y está marcada como Borrador.

    Para que el runbook se pueda utilizar después de que esté seguro de todas sus tareas y de la optimización (secuencia de ejecución), seleccione Publicar última versión en la página de detalles del runbook.

    El libro de ejecución publicado está disponible para su uso en el aprovisionamiento, la detección, la aplicación de parches o el rollback, y tiene un estado activo.
    Nota

    El libro de ejecución se crea con la versión 1 como versión inicial y tiene un estado activo.
  • Utilice el comando oci flota-apps-management flota-apps-management-runbooks runbook create y los parámetros necesarios para crear un runbook personalizado:

    oci fleet-apps-management fleet-apps-management-runbooks runbook create --compartment-id <compartment_OCID> --display-name <text> --operation <text> --runbook-version <json_file_or_string> [OPTIONS]

    Para obtener una lista completa de los indicadores y las opciones de variables para los comandos de la CLI de Fleet Application Management, consulte la CLI for Fleet Application Management.

  • Ejecute la operación CreateRunbook para crear un runbook personalizado.