为 OpenSearch UI 应用程序设置友好 URL（自助服务）

为您的 OpenSearch UI 应用程序设置友好 URL

1. 创建一个 JSON 文件，将您的友好名称映射到应用程序 URL。每个密钥都成为一个子域（例如，密钥prod变成https://prod.example.com）。

   {
     "data": [
       {"key": "prod", "value": "https://application-prod-abc123.us-west-2.opensearch.amazonaws.com"},
       {"key": "staging", "value": "https://application-staging-def456.us-east-1.opensearch.amazonaws.com"},
       {"key": "analytics", "value": "https://application-analytics-ghi789.eu-west-1.opensearch.amazonaws.com"}
     ]
   }

   将此文件另存为 opensearch-ui-friendly-url-app-mappings-v1.json。后v1缀将其标识为您的映射的第一个版本。更新映射时，您可以递增此版本。

2. 将映射文件上传到您账户中的 Amazon S3 存储桶：

   aws s3 cp opensearch-ui-friendly-url-app-mappings-v1.json \
     s3://your-bucket-name/opensearch-ui-friendly-url-app-mappings-v1.json

3. 通过添加存储桶策略来 CloudFront 授予读取映射文件的权限。将your-bucket-name和your-account-id替换为您的值：

   aws s3api put-bucket-policy \
     --bucket your-bucket-name \
     --policy '{
       "Version": "2012-10-17",
       "Statement": [{
         "Sid": "AllowCloudFrontKVSImport",
         "Effect": "Allow",
         "Principal": {"Service": "cloudfront.amazonaws.com"},
         "Action": "s3:GetObject",
         "Resource": "arn:aws:s3:::your-bucket-name/*",
         "Condition": {"StringEquals": {"aws:SourceAccount": "your-account-id"}}
       }]
     }'

   注意

   此存储桶策略 CloudFront 允许在 KeyValueStore 创建过程中读取映射文件。没有它，堆栈部署将失败，出现 “SourceARN无法访问” 错误。

4. 使用以下选项之一部署 CloudFormation 堆栈：

   选项 1：启动堆栈（推荐）

   复制以下 URL 并将其粘贴到浏览器中，打开预先 AWS CloudFormation 加载了模板的快速创建页面。填写参数并选择创建堆栈。

   https://us-east-1.console.aws.amazon.com/cloudformation/home?region=us-east-1#/stacks/quickcreate?templateURL=https://opensearch-ui-quickstart-sample-cfn-templates.s3.us-west-2.amazonaws.com/opensearch-ui-friendly-url/main.yaml&stackName=opensearch-ui-friendly-url&param_MappingsVersion=v1

   选项 2： AWS CLI

   将占位符值替换为你自己的值：

   aws cloudformation create-stack \
     --stack-name opensearch-ui-friendly-url \
     --template-url https://opensearch-ui-quickstart-sample-cfn-templates.s3.us-west-2.amazonaws.com/opensearch-ui-friendly-url/main.yaml \
     --parameters \
       ParameterKey=DomainName,ParameterValue=your-domain.com \
       ParameterKey=HostedZoneId,ParameterValue=Z0123456789ABCDEFG \
       ParameterKey=MappingsBucket,ParameterValue=your-bucket-name \
       ParameterKey=MappingsKey,ParameterValue=opensearch-ui-friendly-url-app-mappings-v1.json \
       ParameterKey=MappingsVersion,ParameterValue=v1 \
     --region us-east-1

5. 如果您使用了 AWS CLI（选项 2），请在us-east-1区域中部署堆栈。 CloudFront 需要 ACM 证书才能进入。us-east-1您的 OpenSearch UI 应用程序可以位于任何支持区域和 OpenSearch UI 配额中。

6. 等待堆栈完成（大约 15 分钟）。您可以监控进度：

   aws cloudformation wait stack-create-complete \
     --stack-name opensearch-ui-friendly-url \
     --region us-east-1

7. 测试重定向。打开浏览器并导航至https://prod.your-domain.com。您应该被重定向到您的 OpenSearch UI 应用程序。

   您也可以通过以下方式进行验证curl：

   curl -I https://prod.your-domain.com
   # Expected: HTTP/2 302
   # location: https://application-prod-abc123.us-west-2.opensearch.amazonaws.com

1. 编辑您的映射文件以添加或删除条目。使用增量版本后缀（例如，opensearch-ui-friendly-url-app-mappings-v2.json）进行保存。

2. 将新版本上传到 S3：

   aws s3 cp opensearch-ui-friendly-url-app-mappings-v2.json \
     s3://your-bucket-name/opensearch-ui-friendly-url-app-mappings-v2.json

3. 使用新的MappingsKey和MappingsVersion以下内容更新堆栈：

   使用控制台：打开CloudFormation 控制台，选择您的堆栈，选择更新，选择使用当前模板，然后使用新值更新MappingsKey和MappingsVersion参数。

   使用 C AWS LI：

   aws cloudformation update-stack \
     --stack-name opensearch-ui-friendly-url \
     --use-previous-template \
     --parameters \
       ParameterKey=DomainName,UsePreviousValue=true \
       ParameterKey=HostedZoneId,UsePreviousValue=true \
       ParameterKey=MappingsBucket,UsePreviousValue=true \
       ParameterKey=MappingsKey,ParameterValue=opensearch-ui-friendly-url-app-mappings-v2.json \
       ParameterKey=MappingsVersion,ParameterValue=v2 \
     --region us-east-1

在没有 Route 53 的情况下设置友好 URL 重定向

1. 在 ACM 中申请证书

   1. 在us-east-1区域https://console.aws.amazon.com/acm/中打开 ACM 控制台。

   2. 选择 “申请证书” 。

   3. 对于域名，输入*.your-domain.com（通配符证书）。

   4. 对于验证方法，选择 DNS 验证。

   5. 选择请求。

   6. 在证书详细信息页面上，记下 “域验证” 下的 CNAME 记录名称和值。在您的 DNS 提供商处创建此 CNAME 记录以验证域所有权。

   7. 等待证书状态更改为已颁发（通常在创建 DNS 记录后 5 到 30 分钟）。

2. 创建一个 CloudFront KeyValueStore

   1. 在处打开 CloudFront 控制台https://console.aws.amazon.com/cloudfront/。

   2. 在导航窗格中，选择函数。然后选择KeyValueStores选项卡。

   3. 选择创建 KeyValueStore。

   4. 输入名称（例如，opensearch-ui-friendly-url-app-mappings-store）。

   5. 选择创建。

   6. 创建后，选择 “编辑” 以添加键值对。为每个应用程序添加一个密钥（子域名，例如prod）和一个值（完整的 OpenSearch UI 应用程序 URL）。

3. 创建 CloudFront 函数

   1. 在处打开 CloudFront 控制台https://console.aws.amazon.com/cloudfront/。

   2. 在导航窗格中，选择函数。

   3. 在函数选项卡上，选择创建函数。

   4. 输入函数的名称（例如，opensearch-ui-friendly-url-redirect-function）。

   5. 对于运行时，选择 c loudfront-js-2.0 。

   6. 将函数代码替换为以下内容：

      import cf from 'cloudfront';
      
      const kvsHandle = cf.kvs("YOUR_KVS_ID");
      
      async function handler(event) {
        var request = event.request;
        var host = request.headers.host.value;
        var subdomain = host.split('.')[0];
      
        try {
          var targetUrl = await kvsHandle.get(subdomain);
          return {
            statusCode: 302,
            statusDescription: 'Found',
            headers: {
              'location': { value: targetUrl },
              'cache-control': { value: 'no-cache, no-store, must-revalidate' }
            }
          };
        } catch (e) {
          return {
            statusCode: 404,
            statusDescription: 'Not Found',
            headers: { 'content-type': { value: 'text/html' } },
            body: {
              encoding: 'text',
              data: '<html><body><h1>Application Not Found</h1><p>No OpenSearch application is mapped to the requested subdomain.</p></body></html>'
            }
          };
        }
      }

      YOUR_KVS_ID替换 KeyValueStore 为您创建的 ID（在 KeyValueStore 详细信息页面上可见）。

   7. 在KeyValueStore 关联中，关联 KeyValueStore 您创建的。

   8. 选择 “保存更改”，然后选择 “发布函数” 。

4. 创建 CloudFront 发行版

   1. 在 CloudFront 控制台中，选择 “创建分发” 。

   2. 对于 Origin 域，输入任何有效的域（例如，example.com）。由于该函数在到达源之前会返回响应，因此永远不会联系到源。

   3. 在 “默认缓存行为” 下，对于查看器协议策略，选择 “将 HTTP 重定向到 HTTPS” 。

   4. 对于缓存策略，选择CachingDisabled。

   5. 在 “函数关联” 下，对于查看者请求，选择您的 CloudFront函数。

   6. 在 “设置” 下，在 “备用域名 (CNAME)” 中输入*.your-domain.com。

   7. 对于自定义 SSL 证书，选择您在 ACM 中创建的证书。

   8. 选择创建分配。

   9. 记下分发域名（例如d1234abcdef8.cloudfront.net）。

5. 在您的提供商处配置 DNS

   在您的 DNS 提供商处，创建指*.your-domain.com向您的 CloudFront分发域名的 CNAME 记录（例如，d1234abcdef8.cloudfront.net）。

   注意

   某些 DNS 提供商不支持通配符 CNAME 记录。在这种情况下，为要使用的每个子域名创建单独的 CNAME 记录（例如prod.your-domain.com，staging.your-domain.com）。

1. 在处打开 CloudFront 控制台https://console.aws.amazon.com/cloudfront/。

2. 在导航窗格中，选择函数。然后选择KeyValueStores选项卡。

3. 选择你的 KeyValueStore 名字（例如，opensearch-ui-friendly-url-app-mappings-store）。

4. 选择编辑。

5. 选择 “添加配对” 。输入子域名作为密钥，输入完整的 OpenSearch UI 应用程序 URL 作为值。

6. 选择保存更改。