Tutorial: cómo crear un manual de procedimientos utilizando la experiencia de diseño visual

En este tutorial, aprenderá los conceptos básicos del trabajo con la experiencia de diseño visual que proporciona la automatización de Systems Manager. En la experiencia de diseño visual, puede crear un manual de procedimientos que utilice múltiples acciones. Utilice la característica de arrastrar y soltar para organizar las acciones en el lienzo. También puede buscar, seleccionar y configurar estas acciones. Luego, puedes ver el código YAML generado automáticamente para el flujo de trabajo de su manual de procedimientos, salir de la experiencia de diseño visual, ejecutar el manual de procedimientos y revisar los detalles de la ejecución.

En este tutorial también se muestra cómo actualizar el manual de procedimientos y ver la nueva versión. Al final del tutorial, realizará un paso de limpieza y eliminará su manual de procedimientos.

Después de completar este tutorial, sabrá cómo usar la experiencia de diseño visual para crear un manual de procedimientos. También sabrá cómo actualizar, ejecutar y eliminar su manual de procedimientos.

nota

Antes de empezar este tutorial, asegúrese de completar Configuración de Automation.

Paso 1: navegue hasta la experiencia de diseño visual

1. Inicie sesión en la consola de automatización de Systems Manager.

2. Elija Crear runbook de automatización.

Paso 2: Cree un flujo de trabajo

En la experiencia de diseño visual, un flujo de trabajo es una representación gráfica de su manual de procedimientos en el lienzo. Puede utilizar la experiencia de diseño visual para definir, configurar y examinar las acciones individuales de su manual de procedimientos.

Para crear un flujo de trabajo

1. Junto a los botones Diseño y Código, seleccione el icono del lápiz e introduzca un nombre para el manual de procedimientos. En este tutorial, escriba VisualDesignExperienceTutorial.

   

2. En la sección Atributos del documento del panel Formulario, expanda el menú desplegable Parámetros de entrada y seleccione Agregar un parámetro.

   1. En el campo Nombre del parámetro, introduzca InstanceId.

   2. En el menú desplegable Tipo, elija AWS::EC2::Instance.

   3. Seleccione el botón Requerido.

   

3. En el navegador de API de AWS, ingrese DescribeInstances en la barra de búsqueda.

4. Arrastre una acción Amazon EC2 – DescribeInstances al lienzo vacío.

5. Para Nombre del paso, ingrese un valor. Para este tutorial, puede utilizar el nombre GetInstanceState.

   

   1. Amplíe el menú desplegable de Entradas adicionales y, en el campo Nombre de entrada, introduzca InstanceIds.

   2. Seleccione la pestaña Entradas.

   3. En el campo Valor de entrada, elija la entrada del documento InstanceId. Esto hace referencia al valor del parámetro de entrada que haya creado al principio del procedimiento. Como la entrada InstanceIds de la acción DescribeInstances acepta valores StringList, debes escribir la entrada de InstanceId entre corchetes. El YAML del valor de entrada debe coincidir con lo siguiente: ['{{ InstanceId }}'].

   4. En la pestaña Salidas, seleccione Añadir una salida e InstanceState introdúzcala en el campo Nombre.

   5. En el campo Selector, introduzca $.Reservations[0].Instances[0].State.Name.

   6. En el menú desplegable Tipo, seleccione Cadena.

6. Arrastre una acción Ramificación desde el navegador Acciones y suéltela debajo del paso GetInstanceState.

7. Para Nombre del paso, escriba un valor. Para este tutorial, use el nombre BranchOnInstanceState.

   Para definir la lógica de ramificación, haga lo siguiente:

   1. Elija el estado Branch en el lienzo. Luego, en Entradas y Opciones, seleccione el icono del lápiz para editar la Regla #1.

   2. Elija Agregar condiciones.

   3. En el cuadro de diálogo Condiciones de la regla #1, elija la salida del paso GetInstanceState.InstanceState en el menú desplegable Variable.

   4. En Operador, seleccione es igual a.

   5. Para Valor, escoja Cadena de la lista desplegable. Escriba stopped.

      

   6. Seleccione Guardar condiciones.

   7. Seleccione Agregar nueva regla.

   8. Elija Añadir condiciones para la Regla #2.

   9. En el cuadro de diálogo Condiciones de la regla #2, elija la salida del paso GetInstanceState.InstanceState en el menú desplegable Variable.

   10. En Operador, seleccione es igual a.

   11. Para Valor, escoja Cadena de la lista desplegable. Escriba stopping.

   12. Seleccione Guardar condiciones.

   13. Seleccione Agregar nueva regla.

   14. Para la Regla #3, seleccione Añadir condiciones.

   15. En el cuadro de diálogo Condiciones de la regla #3, elija la salida del paso GetInstanceState.InstanceState en el menú desplegable Variable.

   16. En Operador, seleccione es igual a.

   17. Para Valor, escoja Cadena de la lista desplegable. Escriba running.

   18. Seleccione Guardar condiciones.

   19. En la Regla predeterminada, seleccione Ir al final para el Paso predeterminado.

8. Arrastre una acción para cambiar el estado de la instancia hasta el cuadro vacío Arrastrar la acción aquí bajo la condición {{getInstanceState.instanceState}} == “stopped”.

   1. Para el Nombre del paso, introduzca StartInstance.

   2. En la pestaña Entradas, bajo ID de instancia, escoja el valor de entrada del documento Instanceld del desplegable.

   3. Para el Estado deseado, especifique running.

9. Arrastre una acción Esperar un recurso de AWS hasta el cuadro vacío Arrastrar la acción aquí bajo la condición {{getInstanceState.instanceState}} == “stopping”.

10. Para Nombre del paso, escriba un valor. Para este tutorial, use el nombre WaitForInstanceStop.

    1. Para el campo Servicio, elija Amazon EC2.

    2. Para el campo API, elija Describir instancias.

    3. Para el campo Selector de propiedades, introduzca $.Reservations[0].Instances[0].State.Name.

    4. Para el parámetro Valores deseados, introduzca ["stopped"].

    5. En la pestaña Configuración de la acción Esperar por la detención de la instancia, escoja Iniciar instancia del desplegable Paso siguiente.

11. Arrastre una acción Ejecutar el comando en instancias hasta el cuadro vacío Arrastrar acción aquí bajo la condición {{getInstanceState.instanceState}} == “running”.

12. Para el Nombre del paso, introduzca SayHello.

    1. En la pestaña Entradas, introduzca AWS-RunShellScript para el parámetro Nombre del documento.

    2. Para ID de instancia, elija el valor de entrada del documento ID de instancia en el menú desplegable.

    3. Expanda el desplegable Entradas adicionales y, en el menú desplegable Nombre de entrada, escoja Parámetros.

    4. En el campo Valor de entrada, introduzca {"commands": "echo 'Hello World'"}.

13. Revisa el manual de procedimientos completo en el lienzo y seleccione Crear runbook para guardar el manual de procedimientos del tutorial.

    

Paso 3: Revise el código generado automáticamente

Al arrastrar y soltar acciones desde el navegador de Acciones al lienzo, la experiencia de diseño visual compone automáticamente el contenido YAML o JSON de su manual de procedimientos en tiempo real. Puede ver y editar este código. Para ver el código generado automáticamente, seleccione Código para los botones Diseño y Código.

Paso 4: Ejecute su nuevo manual de procedimientos

Después de crear su manual de procedimientos, puede ejecutar la automatización.

Para ejecutar su nuevo manual de procedimientos de automatización

1. Abra la consola de AWS Systems Manager en https://console.aws.amazon.com/systems-manager/.

2. En el panel de navegación, elija Automatización y, después, seleccione Ejecutar automatización.

3. En la lista Documento de automatización, elija un manual de procedimientos. Elija una o más opciones en el panel Categorías de documentos para filtrar documentos SSM según su propósito. Para ver un manual de procedimientos que le pertenezca, seleccione la pestaña De mi propiedad. Para ver un manual de procedimientos que se haya compartido con su cuenta, elija la pestaña Compartido conmigo. Para ver todos los manuales de procedimientos, seleccione la pestaña Todos los documentos.

   nota

   Puede ver información acerca de un manual de procedimientos al seleccionar su nombre.

4. En la sección Detalles del documento, verifique que Versión del documento esté establecido como la versión que desea ejecutar. El sistema incluye las siguientes opciones de versión:

   • Versión predeterminada en tiempo de ejecución: seleccione esta opción si el manual de procedimientos de automatización se actualiza de forma periódica y se asigna una nueva versión predeterminada.

   • Última versión en tiempo de ejecución: seleccione esta opción si el manual de procedimientos de automatización se actualiza de forma periódica y desea ejecutar la versión que se ha actualizado más recientemente.

   • 1 (Predeterminado): seleccione esta opción para ejecutar la primera versión del documento, que es la predeterminada.

5. Elija Siguiente.

6. En la página Ejecutar el runbook de automatización, elija Ejecución simple.

7. En la sección Parámetros de entrada, especifique las entradas necesarias: De forma opcional, puede elegir un rol de servicio de IAM de la lista AutomationAssumeRole.

8. (Opcional) Elija una alarma de Amazon CloudWatch que desee aplicar a la automatización para fines de monitoreo. Para adjuntar una alarma de CloudWatch a su automatización, la entidad principal de IAM que ejecuta esta última debe tener permiso para la acción iam:createServiceLinkedRole. Para obtener más información sobre las alarmas de CloudWatch, consulte Uso de alarmas de Amazon CloudWatch. Si la alarma se activa, la automatización se detiene. Si usa AWS CloudTrail, verá la llamada a la API en el registro de seguimiento.

9. Elija Ejecutar.

Paso 5: Eliminar

Para eliminar el manual de procedimientos

1. Abra la consola de AWS Systems Manager en https://console.aws.amazon.com/systems-manager/.

2. En el panel de navegación, elija Documentos.

3. Elija la pestaña De mi propiedad.

4. Busque el manual de procedimientos de Experiencia de diseño visual.

5. Seleccione el botón en la página de la tarjeta del documento y, a continuación, Eliminar documento del desplegable Acciones.