View a markdown version of this page

AWSSupport-TroubleshootOpenSearchRedYellowCluster - AWS Systems Manager Referensi Buku Runbook Otomasi

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

AWSSupport-TroubleshootOpenSearchRedYellowCluster

Deskripsi

AWSSupport-TroubleshootOpenSearchRedYellowClusterRunbook otomatisasi digunakan untuk mengidentifikasi penyebab status kesehatan klaster merah atau kuning dan memandu Anda mengubah cluster kembali menjadi hijau.

Bagaimana cara kerjanya?

Runbook AWSSupport-TroubleshootOpenSearchRedYellowCluster membantu Anda memecahkan masalah penyebab cluster merah atau kuning dan memberikan langkah selanjutnya untuk mengatasi masalah ini dengan menganalisis konfigurasi cluster dan pemanfaatan sumber daya.

Runbook melakukan langkah-langkah berikut:

  • Memanggil DescribeDomainAPI terhadap domain target untuk mendapatkan konfigurasi cluster.

  • Memeriksa apakah domain OpenSearch Layanan berbasis internet (publik) atau berbasis Amazon Virtual Private Cloud (VPC).

  • Membuat VPC-based AWS Lambda fungsi publik atau Amazon tergantung pada konfigurasi cluster. Catatan: Fungsi Lambda berisi kode pemecahan masalah yang menjalankan API OpenSearch Layanan terhadap klaster untuk menentukan mengapa klaster dalam keadaan merah atau kuning.

  • Menghapus fungsi Lambda.

  • Menampilkan pemeriksaan yang dilakukan dan langkah-langkah yang disarankan berikutnya untuk menyelesaikan masalah klaster merah atau kuning.

Jenis dokumen

Otomatisasi

Pemilik

Amazon

Platform

Linux,macOS, Windows

Parameter

Izin IAM yang diperlukan

AutomationAssumeRoleParameter memerlukan tindakan berikut untuk menggunakan runbook dengan sukses.

  • 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

LambdaExecutionRoleParameter memerlukan tindakan berikut agar berhasil menggunakan runbook:

  • es:ESHttpGet

  • ec2:CreateNetworkInterface

  • ec2:DescribeNetworkInterfaces

  • ec2:DeleteNetworkInterface

Ikhtisar LambdaExecutionRole kebijakan:

Berikut ini adalah contoh peran eksekusi fungsi Lambda (AWS Identity and Access Management (IAM)) yang memberikan izin fungsi untuk mengakses AWS layanan dan sumber daya yang diperlukan oleh runbook ini. Untuk informasi selengkapnya, silakan lihat Peran eksekusi Lambda.

catatan

Theec2:DescribeNetworkInterfaces,ec2:CreateNetworkInterface, dan hanya ec2:DeleteNetworkInterface diperlukan jika kluster OpenSearch Layanan Anda adalah Amazon VPC-based untuk mengizinkan fungsi Lambda membuat dan mengelola antarmuka jaringan Amazon VPC. Untuk informasi selengkapnya, lihat Menghubungkan jaringan keluar ke sumber daya dalam peran eksekusi Amazon VPC dan 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"
        }
    ]
}

Instruksi

Ikuti langkah-langkah ini untuk mengonfigurasi otomatisasi:

  1. Arahkan ke AWSSupport-TroubleshootOpenSearchRedYellowClusterdalam AWS Systems Manager konsol.

  2. Pilih Jalankan otomatisasi.

  3. Untuk parameter input masukkan yang berikut ini:

    • AutomationAssumeRole (Opsional):

      Nama Sumber Daya Amazon (ARN) dari peran AWS Identity and Access Management (IAM) yang memungkinkan Otomasi Systems Manager untuk melakukan tindakan atas nama Anda. Jika tidak ada peran yang ditentukan, Systems Manager Automation menggunakan izin pengguna yang memulai runbook ini.

    • LambdaExecutionRole (Diperlukan):

      ARN dari peran IAM yang akan digunakan Lambda untuk menandatangani permintaan ke kluster Layanan Amazon Anda. OpenSearch

    • DomainName (Diperlukan):

      Nama domain OpenSearch Layanan dengan status kesehatan klaster merah atau kuning.

    • UtilizationThreshold (Opsional):

      Persentase ambang batas pemanfaatan yang digunakan untuk membandingkan CPUUutilization dan metrik. JVMMemoryPressure Nilai default adalah 80.

    Parameter masukan terbentuk dengan bidang untuk AutomationAssumeRole LambdaExecutionRole,, DomainName, dan UtilizationThreshold.

  4. Jika Anda telah mengaktifkan kontrol akses berbutir halus pada kluster OpenSearch Service, pastikan bahwa LambdaExecutionRole peran arn dipetakan ke peran dengan setidaknya izin. cluster_monitor

    Tab izin yang menampilkan bagian Klaster izin dengan izin cluster_monitor dipilih.
    Bidang peran backend menunjukkan peran AWS IAM ARN dengan tombol Hapus dan tombol Peta.

  5. Pilih Jalankan.

  6. Otomatisasi dimulai.

  7. Runbook otomatisasi melakukan langkah-langkah berikut:

    • GetClusterConfiguration:

      Mengambil konfigurasi kluster OpenSearch Layanan.

    • CreateAWSLambdaFunctionStack:

      Membuat fungsi Lambda sementara di akun Anda menggunakan. CloudFormation Fungsi Lambda digunakan untuk menjalankan API OpenSearch Layanan.

    • WaitForAWSLambdaFunctionStack:

      Menunggu CloudFormation tumpukan selesai.

    • GetClusterMetricsFromCloudWatch:

      Mendapatkan metrik terkait Amazon CloudWatch ClusterStatus, CPUUutilization, dan JVMMemoryPressure OpenSearch Service cluster serta tanggal pembuatannya.

    • RunOpenSearchAPIs:

      Menggunakan fungsi Lambda untuk memanggil API OpenSearch Layanan dan menganalisis data metrik klaster untuk mendiagnosis penyebab status klaster merah atau kuning.

    • DeleteAWSLambdaFunctionStack:

      Menghapus fungsi Lambda yang dibuat oleh otomatisasi ini di akun Anda.

  8. Setelah selesai, tinjau bagian Output untuk hasil eksekusi yang terperinci.

    • RootCause:

      Memberikan gambaran umum tentang penyebab yang diidentifikasi untuk kesehatan cluster berada dalam keadaan merah atau kuning.

    • IssueDescription:

      Memberikan detail mengapa cluster dalam keadaan merah atau kuning dan langkah-langkah yang mungkin untuk mengembalikan cluster ke status hijau.

Referensi

Otomatisasi Systems Manager

AWS dokumentasi layanan