Update to version v2.1.1 (#226)

Co-authored-by: James Ma <[email protected]>

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.1] - 2023-12-05
+
+### Fixed
+
+- Fixed the issue that Log ingestion error in light engine when not specified time key in the log config #220
+- Fixed the issue that cannot deploy the Centralized Logging with OpenSearch solution in UAE region #221
+- Fixed the issue that EC2 instances should not be added to the same Instance Group #228
+
 ## [2.1.0] - 2023-11-15
 
 ### Added

docs/en/implementation-guide/applications/ec2-pipeline.md

@@ -73,7 +73,9 @@ You have created a log source for the log analytics pipeline. Now you are ready
 
 7. In the **Log Lifecycle** section, enter the number of days to manage the Amazon OpenSearch Service index lifecycle. The Centralized Logging with OpenSearch will create the associated [Index State Management (ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) policy automatically for this pipeline.
 
-8. Choose **Next**.
+13. In the **Select log processor** section, please choose the log processor. 
+    - (Optional) OSI as log processor is now supported in these [regions](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/). When OSI is selected, please type in the minimum and maximum number of OCU. See more information [here](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling). 
+14. Choose **Next**.
 
 9. Enable **Alarms** if needed and select an exiting SNS topic. If you choose **Create a new SNS topic**, please provide a name and an email address for the new SNS topic.
 

docs/en/implementation-guide/applications/eks-pipeline.md

@@ -62,7 +62,9 @@ You have created a log source for the log analytics pipeline. Now you are ready
 
 7. In the **Log Lifecycle** section, enter the number of days to manage the Amazon OpenSearch Service index lifecycle. The Centralized Logging with OpenSearch will create the associated [Index State Management (ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) policy automatically for this pipeline.
 
-8. Choose **Next**.
+13. In the **Select log processor** section, please choose the log processor. 
+    - (Optional) OSI as log processor is now supported in these [regions](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/). When OSI is selected, please type in the minimum and maximum number of OCU. See more information [here](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling). 
+14. Choose **Next**.
 
 9. Enable **Alarms** if needed and select an exiting SNS topic. If you choose **Create a new SNS topic**, please provide a name and an email address for the new SNS topic.
 

docs/en/implementation-guide/applications/syslog-pipeline.md

@@ -56,7 +56,9 @@ You have created a log source for the log analytics pipeline. Now you are ready
 
 7. In the **Log Lifecycle** section, enter the number of days to manage the Amazon OpenSearch Service index lifecycle. The Centralized Logging with OpenSearch will create the associated [Index State Management (ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) policy automatically for this pipeline.
 
-8. Choose **Next**.
+13. In the **Select log processor** section, please choose the log processor. 
+    - (Optional) OSI as log processor is now supported in these [regions](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/). When OSI is selected, please type in the minimum and maximum number of OCU. See more information [here](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling). 
+14. Choose **Next**.
 
 9. Enable **Alarms** if needed and select an exiting SNS topic. If you choose **Create a new SNS topic**, please provide a name and an email address for the new SNS topic.
 

docs/en/implementation-guide/aws-services/cloudtrail.md

@@ -19,7 +19,9 @@ You can create a log ingestion into Amazon OpenSearch Service either by using th
 10. Choose **Yes** for **Sample dashboard** if you want to ingest an associated built-in Amazon OpenSearch Service dashboard.
 11. You can change the **Index Prefix** of the target Amazon OpenSearch Service index if needed. The default prefix is your trail name.
 12. In the **Log Lifecycle** section, enter the number of days to manage the Amazon OpenSearch Service index lifecycle. Centralized Logging with OpenSearch will create the associated [Index State Management (ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) policy automatically for this pipeline.
-13. Choose **Next**.
+13. In the **Select log processor** section, please choose the log processor. 
+    - (Optional) OSI as log processor is now supported in these [regions](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/). When OSI is selected, please type in the minimum and maximum number of OCU. See more information [here](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling). 
+14. Choose **Next**.
 14. Add tags if needed.
 15. Choose **Create**.
 

docs/en/implementation-guide/aws-services/elb.md

@@ -27,7 +27,9 @@ You can create a log ingestion into Amazon OpenSearch Service or Light Engine ei
 9. Choose **Yes** for **Sample dashboard** if you want to ingest an associated templated Amazon OpenSearch Service dashboard.
 10. You can change the **Index Prefix** of the target Amazon OpenSearch Service index if needed. The default prefix is the `Load Balancer Name`.
 11. In the **Log Lifecycle** section, input the number of days to manage the Amazon OpenSearch Service index lifecycle. The Centralized Logging with OpenSearch will create the associated [Index State Management (ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) policy automatically for this pipeline.
-12. Choose **Next**.
+13. In the **Select log processor** section, please choose the log processor. 
+    - (Optional) OSI as log processor is now supported in these [regions](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/). When OSI is selected, please type in the minimum and maximum number of OCU. See more information [here](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling). 
+14. Choose **Next**.
 13. Add tags if needed.
 14. Choose **Create**.
 

docs/en/implementation-guide/aws-services/vpc.md

@@ -24,7 +24,9 @@ You can create a log ingestion into Amazon OpenSearch Service either by using th
  10. Choose **Yes** for **Sample dashboard** if you want to ingest an associated built-in Amazon OpenSearch Service dashboard.
  11. You can change the **Index Prefix** of the target Amazon OpenSearch Service index if needed. The default prefix is your VPC name.
  12. In the **Log Lifecycle** section, enter the number of days to manage the Amazon OpenSearch Service index lifecycle. The Centralized Logging with OpenSearch will create the associated [Index State Management (ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) policy automatically for this pipeline.
- 13. Choose **Next**.
+13. In the **Select log processor** section, please choose the log processor. 
+    - (Optional) OSI as log processor is now supported in these [regions](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/). When OSI is selected, please type in the minimum and maximum number of OCU. See more information [here](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling). 
+14. Choose **Next**.
  14. Add tags if needed.
  15. Choose **Create**.
 

docs/en/implementation-guide/aws-services/waf.md

@@ -32,7 +32,9 @@ You can create a log ingestion into Amazon OpenSearch Service or Light Engine ei
 10. Choose **Yes** for **Sample dashboard** if you want to ingest an associated templated Amazon OpenSearch Service dashboard.
 11. You can change the **Index Prefix** of the target Amazon OpenSearch Service index if needed. The default prefix is the `Web ACL Name`.
 12. In the **Log Lifecycle** section, enter the number of days to manage the Amazon OpenSearch Service index lifecycle. The Centralized Logging with OpenSearch will create the associated [Index State Management (ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) policy automatically for this pipeline.
-13. Choose **Next**.
+13. In the **Select log processor** section, please choose the log processor. 
+    - (Optional) OSI as log processor is now supported in these [regions](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/). When OSI is selected, please type in the minimum and maximum number of OCU. See more information [here](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling). 
+14. Choose **Next**.
 14. Add tags if needed.
 15. Choose **Create**.
 

docs/en/implementation-guide/domains/import.md

@@ -4,7 +4,7 @@ Once logged into the Centralized Logging with OpenSearch console, you can import
 
 ## Prerequisite
 
-1. Centralized Logging with OpenSearch supports Amazon OpenSearch Service, engine version Elasticsearch 7.10 or later, and engine version OpenSearch 1.0 or later.
+1. Centralized Logging with OpenSearch supports Amazon OpenSearch Service, and engine version OpenSearch 1.3 or later.
 2. Centralized Logging with OpenSearch supports OpenSearch clusters within VPC. If you don't have an Amazon OpenSearch Service domain yet, you can create an Amazon OpenSearch Service domain within VPC. See [Launching your Amazon OpenSearch Service domains within a VPC][vpc].
 3. Centralized Logging with OpenSearch supports OpenSearch clusters with [fine-grained access control](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html) only. In the security configuration, the Access policy should look like the image below:
    ![](../../images/domain/policy.png)

docs/en/implementation-guide/faq.md

@@ -60,7 +60,7 @@ The Centralized Logging with OpenSearch console is served via CloudFront distrib
 to the local regulations, any Internet information service must bind to a domain name with [ICP recordal](https://www.amazonaws.cn/en/support/icp/?nc2=h_l2_su).
 
 **Q: What versions of OpenSearch does the solution work with?**</br>
-Centralized Logging with OpenSearch supports Amazon OpenSearch Service, with engine version Elasticsearch 7.10 and later, Amazon OpenSearch 1.0 and later.
+Centralized Logging with OpenSearch supports Amazon OpenSearch Service, with OpenSearch 1.3 or later.
 
 **Q: What are the index name rules for OpenSearch created by the Log Analytics Pipeline?**</br>
 

docs/en/implementation-guide/getting-started/1.import-domain.md

@@ -6,7 +6,7 @@ Centralized Logging with OpenSearch supports Amazon OpenSearch domain with [fine
 
 !!! important "Important"
 
-    Currently, Centralized Logging with OpenSearch supports Amazon OpenSearch Service with engine version Elasticsearch 7.10 or later, and OpenSearch 1.0 or later.
+    Currently, Centralized Logging with OpenSearch supports Amazon OpenSearch Service with OpenSearch 1.3 or later.
 
 ## Prerequisite
 

docs/en/implementation-guide/plan-deployment/considerations.md

@@ -1,4 +1,4 @@
-This solution uses services which may not be currently available in all AWS Regions. Launch this solution in an AWS Region where required services are available. For the most current availability by Region, refer to the [AWS Regional Services List][services]. 
+This solution uses services which may not be currently available in all AWS Regions. Launch this solution in an AWS Region where required services are available. For the most current availability by Region, refer to the [AWS Regional Services List][services].
 
 Centralized Logging with OpenSearch provides two types of authentication, [Cognito User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html) and [OpenID Connect (OIDC) Provider](https://openid.net/connect/). You must choose to launch the solution with OpenID Connect if one of the following cases occurs:
 
@@ -13,6 +13,7 @@ Centralized Logging with OpenSearch provides two types of authentication, [Cogni
 | US East (Ohio)                            | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
 | US West (N. California)                   | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
 | US West (Oregon)                          | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
+| Canada (Central)                          | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
 | Africa (Cape Town)                        | :material-close-thick:{ .icon_cross } | :material-check-bold:{ .icon_check } |
 | Asia Pacific (Hong Kong)                  | :material-close-thick:{ .icon_cross } | :material-check-bold:{ .icon_check } |
 | Asia Pacific (Mumbai)                     | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
@@ -21,7 +22,7 @@ Centralized Logging with OpenSearch provides two types of authentication, [Cogni
 | Asia Pacific (Singapore)                  | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
 | Asia Pacific (Sydney)                     | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
 | Asia Pacific (Tokyo)                      | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
-| Canada (Central)                          | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
+| Middle East (Bahrain)                     | :material-check-bold:{ .icon_cross }  | :material-check-bold:{ .icon_check }  |
 | Europe (Frankfurt)                        | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
 | Europe (Ireland)                          | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
 | Europe (London)                           | :material-check-bold:{ .icon_check }  | :material-check-bold:{ .icon_check }  |
@@ -36,7 +37,7 @@ Centralized Logging with OpenSearch provides two types of authentication, [Cogni
 
 !!! Important "Important"
 
-    You can have only one active Centralized Logging with OpenSearch solution stack in one region. If your deployment failed, make sure you have deleted the failed stack before retrying the deployment. 
+    You can have only one active Centralized Logging with OpenSearch solution stack in one region. If your deployment failed, make sure you have deleted the failed stack before retrying the deployment.
 
 
 [services]: https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?nc1=h_ls

docs/en/implementation-guide/plan-deployment/cost.md

@@ -13,7 +13,7 @@ You will be responsible for the cost of the AWS services used when running the s
 - Location of logs
 - Additional features
 
-As of this revision, the following examples demonstrate the cost estimation of 10/100/1000 GB daily log ingestion for running this solution with default settings in the US East (N. Virginia) Region. The total cost is composed of [**Amazon OpenSearch Cost**](#amazon-opensearch-cost) Or [**Light Engine Cost**](#use-light-engine-as-log-process-engine), [**Solution Console Cost**](#solution-console-cost) and [**Additional Features Cost**](#additional-features-cost).
+As of this revision, the following examples demonstrate the cost estimation of 10/100/1000 GB daily log ingestion for running this solution with default settings in the US East (N. Virginia) Region. The total cost is composed of **Log Processor**: [**Amazon OpenSearch Cost**](#amazon-opensearch-cost) Or [**Light Engine Cost**](#use-light-engine-as-log-process-engine), [**Solution Console Cost**](#solution-console-cost) and [**Additional Features Cost**](#additional-features-cost).
 
 ## Use OpenSearch as log process engine
 

docs/en/implementation-guide/release-notes.md

@@ -5,4 +5,5 @@
 | June 2023 |  Released version 1.0.3</br>Fixed the EKS Fluent Bit deployment configuration generation issue.                                               |
 | Aug 2023 | Released version 2.0.0</br> <li> Added feature of ingesting log from S3 bucket continuously or on-demand</br> <li> Added log pipeline monitoring dashboard into the solution console</br> <li>Supported one-click enablement of pipeline alarms</br>  <li> Added an option to automatically attach required IAM policies when creating an Instance Group</br> <li> Displayed an error message on the console when the installation of log agent fails</br> <li> Updated Application log pipeline creation process by allowing customer to specify a log source</br> <li> Added validations to OpenSearch domain when importing a domain or selecting a domain to create log pipeline</br> <li> Supported installing log agent on AL2023 instances</br> <li>Supported ingesting WAF (associated with CloudFront) sampled logs to OpenSearch in other regions except us-east-1</br> <li> Allowed the same index name in different OpenSearch domains                                           |
 | September 2023 |  Released version 2.0.1</br>Fixed the following issues: <li> Automatically adjust log processor Lambda request's body size based on AOS instance type    </br><li>When you create an application log pipeline and select Nginx as log format, the default sample dashboard option is set to "Yes" </br>  <li>Monitoring page cannot show metrics when there is only one dot</br> <li>  The time of the data point of the monitoring metrics does not match the time of the abscissa                                   |
-| Nov 2023 |  Released version 2.1.0</br><li> Added Light Engine to provide an Athena-based serverless and cost-effective log analytics engine to analyze infrequent access logs	     </br><li>Added OpenSearch Ingestion to provide more log processing capabilities, with which OSI can provision compute resource (OCU)and pay per ingestion capacity  </br>  <li> Supported parsing logs in nested JSON format</br> <li>  Supported CloudTrail logs ingestion from the specified bucket manually   </br> <li> Fix can not list instances when creating instance group issue </br> <li> Fix the EC2 instance launch by the Auto Scaling group will fail to pass the health check issue                                |
+| Nov 2023 |  Released version 2.1.0</br><li> Added Light Engine to provide an Athena-based serverless and cost-effective log analytics engine to analyze infrequent access logs	     </br><li>Added OpenSearch Ingestion to provide more log processing capabilities, with which OSI can provision compute resource (OCU)and pay per ingestion capacity  </br>  <li> Supported parsing logs in nested JSON format</br> <li>  Supported CloudTrail logs ingestion from the specified bucket manually   </br> <li> Fix can not list instances when creating instance group issue </br> <li> Fix the EC2 instance launch by the Auto Scaling group will fail to pass the health check issue                                |
+| Dec 2023 |  Released version 2.1.1</br> Fixed the following issues: <li> Instance should not be added to the same Instance Group	     </br><li>Cannot deploy CLO in UAE region  </br>  <li> Log ingestion error in light engine when not specified time key in the log config </br>    |

docs/zh/implementation-guide/applications/ec2-pipeline.md

@@ -72,7 +72,9 @@
 
 7. 在 **日志生命周期** 部分，输入天数以管理Amazon OpenSearch Service索引生命周期。与OpenSearch一起的中央化日志将为这个管道自动创建关联的 [索引状态管理(ISM)](https://opensearch.org/docs/latest/im-plugin/ism/index/) 政策。
 
-8. 选择 **下一步**。
+13. 在 **选择日志处理器** 部分中，请选择日志处理器。
+     - （可选）这些[区域](https://aws.amazon.com/about-aws/whats-new/2023/04/amazon-opensearch-service-ingestion/)现在支持 OSI 作为日志处理器。 当选择 OSI 时，请输入 OCU 的最小和最大数量。 请参阅[此处](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html#ingestion-scaling) 的更多信息。
+14. 选择**下一步**。
 
 9. 如果需要，请启用 **警报** 并选择一个现有的SNS主题。如果您选择 **创建一个新的SNS主题**，请为新的SNS主题提供一个名称和电子邮件地址。