View a markdown version of this page

AWSSupport-TroubleshootOpenSearchRedYellowCluster - AWS Systems Manager Referencia del manual de automatización

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AWSSupport-TroubleshootOpenSearchRedYellowCluster

Descripción

AWSSupport-TroubleshootOpenSearchRedYellowClusterEl manual de automatización se utiliza para identificar la causa del estado de salud de los clústeres rojos o amarillos y sirve de guía para cambiar el clúster a verde.

¿Cómo funciona?

El manual le AWSSupport-TroubleshootOpenSearchRedYellowCluster ayuda a solucionar la causa del clúster rojo o amarillo y proporciona los siguientes pasos para resolver este problema mediante el análisis de la configuración del clúster y el uso de los recursos.

El manual de ejecución lleva a cabo los siguientes pasos:

  • Llama a la DescribeDomainAPI en el dominio de destino para obtener la configuración del clúster.

  • Comprueba si el dominio del OpenSearch servicio está basado en Internet (público) o en Amazon Virtual Private Cloud (VPC).

  • Crea una función pública o de Amazon en VPC-based AWS Lambda función de la configuración del clúster. Nota: La función Lambda contiene el código de solución de problemas que ejecuta las API de OpenSearch servicio en el clúster para determinar por qué el clúster está en rojo o amarillo.

  • Elimina la función Lambda.

  • Muestra las comprobaciones realizadas y los siguientes pasos recomendados para resolver el problema del clúster rojo o amarillo.

Tipo de documento

Automatización

Propietario

Amazon

Plataformas

Linux, macOS, Windows

Parámetros

Permisos de IAM necesarios

El parámetro AutomationAssumeRole requiere las siguientes acciones para utilizar el manual de procedimientos correctamente.

  • cloudformation:CreateStack

  • cloudformation:DescribeStacks

  • cloudformation:DescribeStackEvents

  • cloudformation:DeleteStack

  • lambda:CreateFunction

  • lambda:DeleteFunction

  • lambda:InvokeFunction

  • lambda:GetFunction

  • es:DescribeDomain

  • es:DescribeDomainConfig

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

  • ec2:DeleteNetworkInterface

  • ec2:DescribeInstances

  • ec2:AttachNetworkInterface

  • cloudwatch:GetMetricData

  • iam:PassRole

El LambdaExecutionRole parámetro requiere las siguientes acciones para utilizar correctamente el runbook:

  • es:ESHttpGet

  • ec2:CreateNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DeleteNetworkInterface

Descripción general de la LambdaExecutionRole política:

A continuación, se muestra un ejemplo del rol de ejecución de una función Lambda (rol AWS Identity and Access Management (IAM)) que otorga a la función permiso para acceder a los AWS servicios y recursos que requiere este manual. Para obtener más información, consulte Rol de ejecución de Lambda.

nota

Los ec2:DescribeNetworkInterfacesec2:CreateNetworkInterface, y solo ec2:DeleteNetworkInterface son necesarios si su clúster de OpenSearch servicios es Amazon VPC-based para permitir que la función Lambda cree y gestione las interfaces de red de Amazon VPC. Para obtener más información, consulte Conexión de redes salientes a recursos en una función de ejecución de Amazon VPC y Lambda.

JSON
{
    "Version":"2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "es:ESHttpGet",
            "Resource": [
                "arn:aws:es:us-east-1:111122223333:domain/domain-name/",
                "arn:aws:es:us-east-1:111122223333:domain/domain-name/_cluster/health",
                "arn:aws:es:us-east-1:111122223333:domain/domain-name/_cat/indices",
                "arn:aws:es:us-east-1:111122223333:domain/domain-name/_cat/allocation",
                "arn:aws:es:us-east-1:111122223333:domain/domain-name/_cluster/allocation/explain"
            ]
        },
        {
            "Condition": {
                "ArnLikeIfExists": {
                    "ec2:Vpc": "arn:aws:ec2:us-east-1:111122223333:vpc/vpc_id"
                }
            },
            "Action": [
                "ec2:DeleteNetworkInterface",
                "ec2:CreateNetworkInterface",
                "ec2:DescribeNetworkInterfaces",
                "ec2:UnassignPrivateIpAddresses",
                "ec2:AssignPrivateIpAddresses"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

Instrucciones

Siga estos pasos para configurar la automatización:

  1. Navegue hasta la consola AWSSupport-TroubleshootOpenSearchRedYellowCluster. AWS Systems Manager

  2. Elija Execute automation (Ejecutar automatización).

  3. Para los parámetros de entrada, introduzca lo siguiente:

    • AutomationAssumeRole (Opcional):

      El nombre del recurso de Amazon (ARN) del rol AWS Identity and Access Management (IAM) que permite a Systems Manager Automation realizar las acciones en su nombre. Si no se especifica ningún rol, Systems Manager Automation utiliza los permisos del usuario que comienza este manual de procedimientos.

    • LambdaExecutionRole (Obligatorio):

      El ARN de la función de IAM que Lambda utilizará para firmar las solicitudes a tu clúster de Amazon Service. OpenSearch

    • DomainName (Obligatorio):

      El nombre del dominio del OpenSearch servicio con el estado de salud del clúster en rojo o amarillo.

    • UtilizationThreshold (Opcional):

      El porcentaje del umbral de utilización utilizado para comparar la utilización de la CPU y JVMMemoryPressure las métricas. El valor predeterminado es 80.

    Formulario de parámetros de entrada con campos para AutomationAssumeRole LambdaExecutionRole DomainName, y UtilizationThreshold.

  4. Si ha habilitado un control de acceso detallado en un clúster de OpenSearch servicios, asegúrese de que el LambdaExecutionRole rol arn esté asignado a un rol con al menos permiso. cluster_monitor

    La pestaña de permisos muestra la sección de permisos con el Clúster permiso cluster_monitor seleccionado.
    Campo de roles de backend que muestra un AWS IAM ARN de rol con los botones Eliminar y Mapa.

  5. Seleccione Ejecutar.

  6. Se inicia la automatización.

  7. El manual de procedimientos de automatización realiza los siguientes pasos:

    • GetClusterConfiguration:

      Obtiene la configuración del clúster de OpenSearch servicios.

    • CreateAWSLambdaFunctionStack:

      Crea una función Lambda temporal en su cuenta mediante. CloudFormation La función Lambda se utiliza para ejecutar las API de OpenSearch servicio.

    • WaitForAWSLambdaFunctionStack:

      Espera a que se complete la CloudFormation pila.

    • GetClusterMetricsFromCloudWatch:

      Obtiene las métricas relacionadas con los clústeres de Amazon CloudWatch ClusterStatus, CPUUtilization y JVMMemoryPressure OpenSearch Service y su fecha de creación.

    • RunOpenSearchAPIs:

      Utiliza la función Lambda para llamar a las API de OpenSearch servicio y analizar los datos de las métricas del clúster para diagnosticar la causa del estado rojo o amarillo del clúster.

    • DeleteAWSLambdaFunctionStack:

      Elimina la función Lambda creada por esta automatización en su cuenta.

  8. Una vez finalizada, consulte la sección de resultados para ver los resultados detallados de la ejecución.

    • RootCause:

      Proporciona una descripción general de la causa identificada por la que el estado del clúster está en rojo o amarillo.

    • IssueDescription:

      Proporciona detalles sobre por qué el clúster está en estado rojo o amarillo y las posibles medidas para devolverlo al estado verde.

Referencias

Automatización de Systems Manager

AWS documentación de servicio