updated docs

aws-samples · Feb 15, 2025 · 5007653 · 5007653
1 parent e18d547
commit 5007653
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -136,13 +136,15 @@ Upgrade the domain to OpenSearch 1.0 - 2.11 or Elasticsearch version 7.10. Some
 If you completed the initial setup using CloudFormation, move on to the next step. If you completed the initial setup using the AWS CDK, see  
 "Updating SIEM with the AWS CDK" section in [Advanced Deployment](docs/deployment.md).
 
-### Updating the CloudFormation stack
+### Checking es-loader Layer (Configuration File) Version
 
-You can update the CloudFormation stack by specifying the CloudFormation template below:
+The es-loader Lambda function currently specifies Python 3.11. The lambda layer for configuration file must be compatible with the same version. Check the [Compatible runtimes] of the relevant AWS Lambda layer and modify it to include the same version if it's not already included.
 
-```text
-https://aes-siem-<REGION>.s3.amazonaws.com/siem-on-amazon-opensearch-service.template
-```
+Reference: [Adding user.ini to an AWS Lambda layer (recommended)](docs/configure_siem.md#adding-userini-to-an-aws-lambda-layer-recommended)
+
+### Updating the CloudFormation stack
+
+You can update the CloudFormation stack by specifying the CloudFormation template. Please see [CloudFormation Templates for All Regions](docs/cloudformation_list.md) for template URLs.
 
 1. Navigate to the [CloudFormation console](https://console.aws.amazon.com/cloudformation/home?)
 1. Choose stack [**aes-siem**]

diff --git a/README_ja.md b/README_ja.md
@@ -142,13 +142,15 @@ OpenSearch Service を OpenSearch 1.0 - 2.11 または Elasticsearch 7.10 にア
 
 CloudFormation で初期インストールした場合は次へ進み、AWS CDK で初期インストールしている場合は [高度なデプロイ](docs/deployment_ja.md) のアップデートを参照してください。
 
-### CloudFormation スタックの更新
+### es-loader レイヤー (設定ファイル) のバージョン確認
 
-CloudFormation のテンプレートを指定して更新します。テンプレートの URL は下記です。
+Lambda 関数の es-loaderは現在、Python 3.11 を指定しています。設定ファイルのレイヤーも同じバージョンで利用できる必要があります。該当の AWS Lambda レイヤーの [**互換性のあるバージョン**] を確認して、同じバージョンが含まれていなければ、含めるよう変更してください。
 
-```text
-https://aes-siem-<REGION>.s3.amazonaws.com/siem-on-amazon-opensearch-service.template
-```
+参考: [AWS Lambda レイヤーによる追加方法(推奨)](docs/configure_siem_ja.md#aws-lambda-レイヤーによる追加方法推奨)
+
+### CloudFormation スタックの更新
+
+CloudFormation のテンプレートを指定して更新します。テンプレートの URL は [CloudFormation テンプレート 全リージョン](docs/cloudformation_list_ja.md) をご確認下さい。
 
 1. [CloudFormation コンソール](https://console.aws.amazon.com/cloudformation/home?) に移動
 1. [**aes-siem**] のスタックを選択

diff --git a/README_zh-cn.md b/README_zh-cn.md
@@ -172,11 +172,7 @@ SIEM on OpenSearch Service大概需要30分钟来完成部署。随后即可着
 
 ### 更新CloudFormation堆栈（Stack）
 
-您可以按以下方式指定CloudFormation模板，藉此更新CloudFormation堆栈：
-
-```text
-https://aes-siem-<REGION>.s3.amazonaws.com/siem-on-amazon-opensearch-service-china.template
-```
+您可以按以下方式指定CloudFormation模板，藉此更新CloudFormation堆栈: [CloudFormation Template For All Regions](docs/cloudformation_list_zh-cn.md).
 
 1. 导航至 [CloudFormation控制台](https://console.aws.amazon.com/cloudformation/home?)
 1. 选择堆栈 [**aes-siem**]

diff --git a/README_zh-tw.md b/README_zh-tw.md
@@ -182,11 +182,7 @@ We have published the workshop, [SIEM on Amazon OpenSearch Service Workshop](htt
 
 ### 更新CloudFormation堆棧（Stack）
 
-您可以按以下方式指定CloudFormation模板，藉此更新CloudFormation堆棧：
-
-```text
-https://aes-siem-<REGION>.s3.amazonaws.com/siem-on-amazon-opensearch-service.template
-```
+您可以按以下方式指定CloudFormation模板，藉此更新CloudFormation堆棧: [CloudFormation Template For All Regions](docs/cloudformation_list_zh-tw.md).
 
 1. 導航至 [CloudFormation控制臺](https://console.aws.amazon.com/cloudformation/home?)
 1. 選擇堆棧 [**aes-siem**]

diff --git a/docs/cloudformation_list.md b/docs/cloudformation_list.md
@@ -1,4 +1,4 @@
-# CloudFormation Template For All Region
+# CloudFormation Template For All Regions
 
 [View this page in Japanese (日本語)](cloudformation_list_ja.md) | [Chinese (简体中文)](cloudformation_list_zh-cn.md) | [Chinese (繁體中文)](cloudformation_list_zh-tw.md) | [Back to README](../README.md)
 

diff --git a/docs/cloudformation_list_zh-cn.md b/docs/cloudformation_list_zh-cn.md
@@ -1,4 +1,4 @@
-# CloudFormation Template For All Region
+# CloudFormation Template For All Regions
 
 [In English](cloudformation_list.md) | [Back to README](../README_zh-cn.md)
 

diff --git a/docs/cloudformation_list_zh-tw.md b/docs/cloudformation_list_zh-tw.md
@@ -1,4 +1,4 @@
-# CloudFormation Template For All Region
+# CloudFormation Template For All Regions
 
 [In English](cloudformation_list.md) | [Back to README](../README_zh-tw.md)
 

diff --git a/docs/configure_siem.md b/docs/configure_siem.md
@@ -75,13 +75,15 @@ Then create a Lambda layer following the steps below:
    * Name: aes-siem-configure-es-loader (any name)
    * Check Upload a .zip file
    * Choose Upload and then select configure-es-loader.zip
-   * Compatible runtimes: Choose Python 3.11 (check current runtime version from **aes-siem-es-loader** layers pane)
+   * Compatible architectures: Leave blank. Do **NOT** select anything
+   * Compatible runtimes: Choose [**Python 3.11**] and [**Python 3.13**]
 1. Choose [**Create**]
+1. After creation, select [Layers] from the left menu and verify that the above versions are included in [Compatible versions] for the created layer
 
 Finally, add the Lambda layer that you have just created to Lambda function es-loader:
 
 1. Choose [**Functions**] from the left pane of the Lambda console => Choose [**aes-siem-es-loader**]
-1. From [Configuration] tab, choose [**Layers**] in the center of the [Designer] pane.
+1. Choose [Code] tab
 1. From the [Layers] pane at the bottom of the screen, choose [**Add a layer**]
 1. Check Custom layers, and from the drop-down menu of the Custom layers, choose [**aes-siem-configure-es-loader**](or, choose the right one if you gave it a different name) and then choose [**Add**]
 

diff --git a/docs/configure_siem_ja.md b/docs/configure_siem_ja.md
@@ -24,7 +24,7 @@ SIEM on OpenSearch Service へのログの取り込みをカスタマイズで
 
 user.ini の保存は、Lambda レイヤーによる追加(推奨)か、AWS マネジメントコンソールから直接編集をしてください。SIEM on OpenSearch Service をアップデートすると、Lambda 関数が新しい関数に入れ替わります。Lambda レイヤーであれば独立しているので user.ini は維持されますが、AWS マネジメントコンソールから直接編集した user.ini は削除されるので、再度 user.ini を作成する必要があります。
 
-注) 設定ファイル( aws.ini/user.ini )の読み込みは Python3 の標準ライブラリ configparser を使用しています。文法等はこのライブラリに従います。空白等を含んだ設定値であってもそのまま記載してください。ダブルクオーテーションやシングルクオーテーションで囲う必要はありませんのでご注意ください。例えば、設定項目に key、設定値として "This is a sample value" を定義する場合、下記のようになります。
+注) 設定ファイル (aws.ini/user.ini) の読み込みは Python3 の標準ライブラリ configparser を使用しています。文法等はこのライブラリに従います。空白等を含んだ設定値であってもそのまま記載してください。ダブルクオーテーションやシングルクオーテーションで囲う必要はありませんのでご注意ください。例えば、設定項目に key、設定値として "This is a sample value" を定義する場合、下記のようになります。
 
 正しい設定例)
 
@@ -75,13 +75,15 @@ zip -r configure-es-loader.zip user.ini
     * 名前: aes-siem-configure-es-loader (任意の名前)
     * zipファイルのアップロードにチェック
     * アップロードを選択して、configure-es-loader.zip を選択
-    * 互換性のあるランタイム: Python 3.8 を選択
+    * 互換性のあるアーキテクチャ: 空欄のまま。選択を **しない** でください
+    * 互換性のあるランタイム: [**Python 3.11**] と [**Python 3.13**] を選択
 1. [**作成**] を選択
+1. 作成後に画面左メニューの [レイヤー] を選択して、作成したランタイムの [互換性のあるバージョン] で上記バージョンが含んでいることを確認してください
 
 最後に、Lambda 関数 es-loader に、作成した Lambada レイヤーを設定します
 
 1. Lambda コンソールの左メニューの [**関数**] => 関数名の [**aes-siem-es-loader**] を選択
-1. [設定] タブ、[デザイナー] パネルの画面中央にある [**Layers**] を選択
+1. [コード] タブをを選択
 1. 画面下の [レイヤー] パネルの、[**レイヤーの追加**] を選択
 1. カスタムレイヤーにチェックを入れて、カスタムレイヤーのプルダウンメニューから、[**aes-siem-configure-es-loader**] または任意で設定した名前を選択し、[**追加**] を選択
 

diff --git a/docs/configure_siem_zh-cn.md b/docs/configure_siem_zh-cn.md
@@ -68,7 +68,7 @@ zip -r configure-es-loader.zip user.ini
     * 名称：aes-siem-configure-es-loader（任意名称）
     * 检查上传 .zip 文件
     * 选择上传，然后选择 configure-es-loader.zip
-    * 兼容的运行时：选择 Python 3.8
+    * 兼容的运行时：选择 Python 3.11 and Python 3.13
 1. 选择[**Create**]
 
 最后，将刚刚创建的 Lambda 层添加到 Lambda 函数 es-loader：