AWSSupport-TroubleshootOpenSearchRedYellowCluster - AWS Systems Manager Referenz zum Automatisierungs-Runbook

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWSSupport-TroubleshootOpenSearchRedYellowCluster

Beschreibung

AWSSupport-TroubleshootOpenSearchRedYellowCluster Automation Runbook wird verwendet, um die Ursache für den Zustand roter oder gelber Cluster zu identifizieren und Sie durch das Zurücksetzen des Clusters auf Grün zu führen.

Wie funktioniert es?

Das Runbook AWSSupport-TroubleshootOpenSearchRedYellowCluster hilft Ihnen bei der Behebung der Ursache eines roten oder gelben Clusters und bietet die nächsten Schritte zur Behebung dieses Problems, indem es die Cluster-Konfiguration und die Ressourcenauslastung analysiert.

Das Runbook führt die folgenden Schritte aus:

  • Ruft die DescribeDomain API für die Zieldomäne auf, um die Cluster-Konfiguration abzurufen.

  • Prüft, ob die OpenSearch Service-Domain internetbasiert (öffentlich) oder Amazon Virtual Private Cloud (VPC) ist.

  • Erstellt je nach Clusterkonfiguration eine öffentliche oder Amazon-VPC-basierte AWS Lambda Funktion. Hinweis: Die Lambda-Funktion enthält den Fehlerbehebungscode, der die OpenSearch Service-APIs für den Cluster ausführt, um festzustellen, warum sich der Cluster im roten oder gelben Zustand befindet.

  • Löscht die Lambda-Funktion.

  • Zeigt die durchgeführten Prüfungen und die nächsten empfohlenen Schritte zur Behebung des roten oder gelben Clusterproblems an.

Dokumenttyp

Automatisierung

Eigentümer

Amazon

Plattformen

Linux, macOS, Windows

Parameter

Erforderliche IAM-Berechtigungen

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden.

  • 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

Der LambdaExecutionRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden:

  • es:ESHttpGet

  • ec2:CreateNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DeleteNetworkInterface

Übersicht über die LambdaExecutionRole Richtlinie:

Im Folgenden finden Sie ein Beispiel für die Ausführungsrolle (AWS Identity and Access Management (IAM)-Rolle einer Lambda-Funktion, die der Funktion die Berechtigung erteilt, auf die für dieses Runbook erforderlichen AWS Services und Ressourcen zuzugreifen. Weitere Informationen finden Sie unter Lambda-Ausführungsrolle.

Anmerkung

Die ec2:DescribeNetworkInterfaces, und ec2:DeleteNetworkInterface sind nur erforderlichec2:CreateNetworkInterface, wenn Ihr OpenSearch Service-Cluster Amazon-VPC-basiert ist, damit die Lambda-Funktion die Amazon-VPC-Netzwerkschnittstellen erstellen und verwalten kann. Weitere Informationen finden Sie unter Verbinden ausgehender Netzwerke mit Ressourcen in einer Amazon VPC und Lambda-Ausführungsrolle. 


        {
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Effect": "Allow",
                    "Action": "es:ESHttpGet",
                    "Resource": [
                        "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/",
                        "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/_cluster/health",
                        "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/_cat/indices",
                        "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/_cat/allocation",
                        "arn:<partition>:es:<region>:<account-id>:domain/<domain-name>/_cluster/allocation/explain"
                    ]
                },
                {
                    "Condition": {
                        "ArnLikeIfExists": {
                            "ec2:Vpc": "arn:<partition>:ec2:<region>:<account-id>:vpc/<vpc_id>"
                        }
                    },
                    "Action": [
                        "ec2:DeleteNetworkInterface",
                        "ec2:CreateNetworkInterface",
                        "ec2:DescribeNetworkInterfaces",
                        "ec2:UnassignPrivateIpAddresses",
                        "ec2:AssignPrivateIpAddresses"
                    ],
                    "Resource": "*",
                    "Effect": "Allow"
                }
                
            ]
        }

Anweisungen

Gehen Sie wie folgt vor, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie in der AWSSupport-TroubleshootOpenSearchRedYellowCluster AWS Systems Manager Konsole zur -.

  2. Wählen Sie Execute automation (Automatisierung ausführen).

  3. Geben Sie für die Eingabeparameter Folgendes ein:

    • AutomationAssumeRole (Optional):

      Der Amazon-Ressourcenname (ARN) der AWS Identity and Access Management (IAM)-Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen auszuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

    • LambdaExecutionRole (Erforderlich):

      Der ARN der IAM-Rolle, die Lambda zum Signieren von Anforderungen an Ihren Amazon- OpenSearch Service-Cluster verwendet.

    • DomainName (Erforderlich):

      Der Name der OpenSearch Service-Domain mit dem Zustandsstatus eines roten oder gelben Clusters.

    • UtilizationThreshold (Optional):

      Der Prozentsatz des Auslastungsschwellenwerts, der zum Vergleichen der CPUUtilization- und JVM-MemoryPressure Metriken verwendet wird. Der Standardwert ist 80.

  4. Wenn Sie die differenzierte Zugriffskontrolle auf einem - OpenSearch Service-Cluster aktiviert haben, stellen Sie sicher, dass der LambdaExecutionRole Rollen-ARN einer Rolle mit mindestens -cluster_monitorBerechtigung zugeordnet ist.

  5. Wählen Sie Ausführen aus.

  6. Die Automatisierung wird initiiert.

  7. Das Automatisierungs-Runbook führt die folgenden Schritte aus:

    • GetClusterConfiguration:

      Ruft die OpenSearch Service-Cluster-Konfiguration ab.

    • Erstellen von AWSLambdaFunctionStack:

      Erstellt eine temporäre Lambda-Funktion in Ihrem Konto mit AWS CloudFormation. Die Lambda-Funktion wird verwendet, um die OpenSearch Service-APIs auszuführen.

    • WaitForAWSLambdaFunctionStack:

      Wartet, bis der CloudFormation Stack abgeschlossen ist.

    • GetClusterMetricsFromCloudWatch:

      Ruft die Cluster-bezogenen Metriken von Amazon , CloudWatch ClusterStatus CPUUtilization und JVM MemoryPressure OpenSearch Service und das Erstellungsdatum ab.

    • RunOpenSearchAPIs:

      Verwendet die Lambda-Funktion, um die OpenSearch Service-APIs aufzurufen und die Cluster-Metrikdaten zu analysieren, um die Ursache für den roten oder gelben Clusterstatus zu diagnostizieren.

    • Löschen von AWSLambdaFunctionStack:

      Löscht die durch diese Automatisierung in Ihrem Konto erstellte Lambda-Funktion.

  8. Nachdem Sie fertig sind, überprüfen Sie den Abschnitt Outputs, um die detaillierten Ergebnisse der Ausführung zu erhalten.

    • RootCause:

      Bietet einen Überblick über die identifizierte Ursache für den Clusterzustand im roten oder gelben Zustand.

    • IssueDescription:

      Enthält Details dazu, warum sich der Cluster im roten oder gelben Zustand befindet, und mögliche Schritte, um den Cluster wieder in den grünen Zustand zu versetzen.

Referenzen

Systems Manager Automation

AWS -Servicedokumentation