View a markdown version of this page

AWSSupport-TroubleshootOpenSearchRedYellowCluster - AWS Systems Manager Référence du dossier d’exploitation Automation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWSSupport-TroubleshootOpenSearchRedYellowCluster

Description

AWSSupport-TroubleshootOpenSearchRedYellowClusterLe runbook d'automatisation est utilisé pour identifier la cause de l'état de santé du cluster rouge ou jaune et vous aider à le remettre en vert.

Fonctionnement

Le runbook vous AWSSupport-TroubleshootOpenSearchRedYellowCluster aide à trouver la cause d'un cluster rouge ou jaune et indique les étapes suivantes pour résoudre ce problème en analysant la configuration du cluster et l'utilisation des ressources.

Le runbook exécute les étapes suivantes :

  • Appelle l'DescribeDomainAPI sur le domaine cible pour obtenir la configuration du cluster.

  • Vérifie si le domaine de OpenSearch service est basé sur Internet (public) ou Amazon Virtual Private Cloud (VPC).

  • Crée une fonction publique ou Amazon en VPC-based AWS Lambda fonction de la configuration du cluster. Remarque : La fonction Lambda contient le code de dépannage qui exécute les API de OpenSearch service sur le cluster afin de déterminer pourquoi le cluster est en rouge ou en jaune.

  • Supprime la fonction Lambda.

  • Affiche les vérifications effectuées et les prochaines étapes recommandées pour résoudre le problème de cluster rouge ou jaune.

Type de document

 Automatisation

Propriétaire

Amazon

Plateformes

LinuxmacOS, Windows

Paramètres

Autorisations IAM requises

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook.

  • 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

Le LambdaExecutionRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook :

  • es:ESHttpGet

  • ec2:CreateNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DeleteNetworkInterface

Aperçu de la LambdaExecutionRole politique :

Voici un exemple du rôle d'exécution d'une fonction Lambda (rôle Gestion des identités et des accès AWS (IAM)) qui accorde à la fonction l'autorisation d'accéder aux AWS services et aux ressources requis par ce runbook. Pour plus d’informations, consultez Rôle d’exécution Lambda.

Note

Les ec2:DescribeNetworkInterfacesec2:CreateNetworkInterface, et ne ec2:DeleteNetworkInterface sont requis que si votre cluster de OpenSearch services est Amazon VPC-based pour permettre à la fonction Lambda de créer et de gérer les interfaces réseau Amazon VPC. Pour plus d'informations, consultez Connexion du réseau sortant aux ressources d'un rôle d'exécution Amazon VPC et 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"
        }
    ]
}

Instructions

Pour configurer l'automatisation, procédez comme suit :

  1. Accédez à AWSSupport-TroubleshootOpenSearchRedYellowCluster dans la AWS Systems Manager console.

  2. Sélectionnez Execute automation (Exécuter l'automatisation).

  3. Pour les paramètres d'entrée, entrez les informations suivantes :

    • AutomationAssumeRole (Facultatif) :

      Le nom de ressource Amazon (ARN) du rôle Gestion des identités et des accès AWS (IAM) qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui démarre ce runbook.

    • LambdaExecutionRole (Obligatoire) :

      L'ARN du rôle IAM que Lambda utilisera pour signer les demandes adressées à votre cluster Amazon OpenSearch Service.

    • DomainName (Obligatoire) :

      Nom du domaine de OpenSearch service dont l'état de santé du cluster est rouge ou jaune.

    • UtilizationThreshold (Facultatif) :

      Pourcentage du seuil d'utilisation utilisé pour comparer l'utilisation du processeur et les JVMMemoryPressure mesures. La valeur par défaut est 80.

    Les paramètres d'entrée se présentent sous forme de champs pour AutomationAssumeRole LambdaExecutionRole DomainName,, et UtilizationThreshold.

  4. Si vous avez activé un contrôle d'accès précis sur un cluster de OpenSearch services, assurez-vous que le LambdaExecutionRole rôle arn est mappé à un rôle avec au moins une autorisation. cluster_monitor

    Onglet Cluster Autorisations affichant la section des autorisations avec l'autorisation cluster_monitor sélectionnée.
    Champ des rôles principaux affichant un ARN de AWS IAM rôle avec le bouton Supprimer et le bouton Map.

  5. Sélectionnez Exécuter.

  6. L'automatisation démarre.

  7. Le runbook d'automatisation exécute les étapes suivantes :

    • GetClusterConfiguration:

      Récupère la configuration du cluster OpenSearch de services.

    • CreateAWSLambdaFunctionStack:

      Crée une fonction Lambda temporaire dans votre compte à l'aide CloudFormation de. La fonction Lambda est utilisée pour exécuter les API de OpenSearch service.

    • WaitForAWSLambdaFunctionStack:

      Attend que la CloudFormation pile soit terminée.

    • GetClusterMetricsFromCloudWatch:

      Obtient les métriques liées au cluster Amazon CloudWatch ClusterStatus, CPUUtilization et JVMMemoryPressure OpenSearch Service ainsi que sa date de création.

    • RunOpenSearchAPIs:

      Utilise la fonction Lambda pour appeler les API de OpenSearch service et analyser les données des métriques du cluster afin de diagnostiquer la cause de l'état du cluster rouge ou jaune.

    • DeleteAWSLambdaFunctionStack:

      Supprime la fonction Lambda créée par cette automatisation dans votre compte.

  8. Une fois terminé, consultez la section Sorties pour obtenir les résultats détaillés de l'exécution.

    • RootCause:

      Fournit un aperçu de la cause identifiée pour laquelle l'état de santé du cluster est affiché en rouge ou en jaune.

    • IssueDescription:

      Fournit des informations détaillées sur les raisons pour lesquelles le cluster est en rouge ou en jaune et les étapes possibles pour le ramener à l'état vert.

Références

Systems Manager Automation

AWS documentation de service