OpenSearch

AWS OpenSearch Well-Architected Custom Lens

• About
• Prepare the json file
• Create custom lens on Well-Architected Tool
• Intended Audience
• Contributing

About

AWS OpenSearch Well-Architected Custom Lens specifies best practices in Operational Excellence, Security, Performance Efficiency, Reliability and Cost Optimization pillars. The best practices are designed for OpenSearch workload.

Prepare the json file

Prepare your custom lens Well-Architected template json file or just download the provided recommended glue custom lens file.

{
    "schemaVersion": "2021-11-01",
    "name": "OpenSearch Best Practice - For WA Custom Lens",
    "description": "Best practices for configuring OpenSearch",
    "pillars": [
        {
            "id": "AOSSOPS",
            "name": "Operational Excellence",
            "questions": [
                {
                    "id": "aossops1",
                    "title": "How do you monitor and analyze your Amazon OpenSearch domains performance?",
                    "description": "Amazon OpenSearch Service emits performance metrics to Amazon CloudWatch. Regularly review your cluster and instance metrics and configure recommended CloudWatch alarms based on your workload performance.",
                    "helpfulResource": {
                        "displayText": "Amazon OpenSearch Service exposes OpenSearch error logs, search slow logs, indexing slow logs, and audit logs in Amazon CloudWatch Logs. You can enable log publishing through AWS Console, CLI, SDK, or CloudFormation.",
                        "url": "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html"
                    },
                    "choices": [
                        {
                            "id": "aossops1_1",
                            "title": "Setup the recommended CloudWatch alarms for your Amazon OpenSearch Service.",
                            "helpfulResource": {
                                "displayText": "Understand what recommended CloudWatch alarms are for your Amazon OpenSearch Service.",
                                "url": "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cloudwatch-alarms.html"
                            },
                            "improvementPlan": {
                                "displayText": "Setup CloudWatch alarms for Amazon OpenSearch Service.",
                                "url": "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cloudwatch-alarms.html"
                            }
                        }
                    ]
                }
             ]
      }
   ]
}

Create custom lens on Well-Architected Tool

After you prepare your custom lens Well-Architected template json file, you can navigate to the AWS Well-Architected Tool on the AWS console and create custom lens.

Upload the your custom lens Well-Architected template json template, and submit it.

And then you will find your Well-Architected custom lens in draft version.

Publish your draft version and provide a version tag.

After your Well-Architected custom lens is published, you can define a workload in your AWS Well-Architected console.

Input your workload information, and select the Well-Architected custom lens you just published.

Choose Continue reviewing for the just published OpenSearch Well-Architected custom lens.

Now you can review your OpenSearch workload with OpenSearch Well-Architected Custom Lens.

Intended Audience

CTO, Technical Leader or technical owner for an AWS OpenSearch workload

Contributing

• Shih-Yong Wang, Manager, Solutions Architect, AWS
• Ray Wang, Solutions Architect, AWS
• Ankush Agarwal, OpenSearch SME, APAC, AWS