Einrichtung einer benutzerfreundlichen URL für OpenSearch UI-Anwendungen (Self-Service)

So richten Sie eine benutzerfreundliche URL für Ihre OpenSearch UI-Anwendungen ein

1. Erstellen Sie eine JSON-Datei, die Ihre benutzerfreundlichen Namen den Anwendungs-URLs zuordnet. Jeder Schlüssel wird zu einer Subdomain (Schlüssel prod wird beispielsweisehttps://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"}
     ]
   }

   Speichern Sie diese Datei als opensearch-ui-friendly-url-app-mappings-v1.json. Das v1 Suffix identifiziert dies als die erste Version Ihrer Mappings. Sie erhöhen diese Version, wenn Sie Ihre Mappings aktualisieren.

2. Laden Sie die Zuordnungsdatei in einen Amazon S3-Bucket in Ihrem Konto hoch:

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

3. Erteilen Sie die CloudFront Erlaubnis, die Zuordnungsdatei zu lesen, indem Sie eine Bucket-Richtlinie hinzufügen. Ersetze your-bucket-name und your-account-id durch deine Werte:

   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"}}
       }]
     }'

   Anmerkung

   Diese Bucket-Richtlinie ermöglicht CloudFront das Lesen der Zuordnungsdatei während der KeyValueStore Erstellung. Ohne sie schlägt die Stack-Bereitstellung mit der Fehlermeldung „SourceARN ist nicht zugänglich“ fehl.

4. Stellen Sie den CloudFormation Stack mithilfe einer der folgenden Optionen bereit:

   Option 1: Stack starten (empfohlen)

   Kopieren Sie die folgende URL und fügen Sie sie in Ihren Browser ein, um die AWS CloudFormation Schnellerstellungsseite mit der vorinstallierten Vorlage zu öffnen. Füllen Sie die Parameter aus und wählen Sie Stapel erstellen.

   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

   Option 2: AWS CLI

   Ersetzen Sie die Platzhalterwerte durch Ihre eigenen:

   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. Wenn Sie die AWS CLI verwendet haben (Option 2), stellen Sie den Stack in der us-east-1 Region bereit. CloudFront erfordert, dass ACM-Zertifikate vorhanden sind. us-east-1 Ihre OpenSearch UI-Anwendungen können sich in allen unterstützten Regionen und Kontingenten für OpenSearch Benutzeroberflächen befinden.

6. Warten Sie, bis der Stapel vollständig ist (ungefähr 15 Minuten). Sie können den Fortschritt überwachen:

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

7. Testen Sie die Weiterleitung. Öffnen Sie Ihren Browser und navigieren Sie zuhttps://prod.your-domain.com. Sie sollten zu Ihrer OpenSearch UI-Anwendung weitergeleitet werden.

   Sie können dies auch überprüfen mitcurl:

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

1. Bearbeiten Sie Ihre Zuordnungsdatei, um Einträge hinzuzufügen oder zu entfernen. Speichern Sie sie mit einem inkrementierten Versionssuffix (z. B.). opensearch-ui-friendly-url-app-mappings-v2.json

2. Laden Sie die neue Version auf S3 hoch:

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

3. Aktualisiere den Stack mit der neuen MappingsKey undMappingsVersion:

   Mithilfe der Konsole: Öffnen Sie die CloudFormation Konsole, wählen Sie Ihren Stack aus, wählen Sie Aktualisieren und dann Aktuelle Vorlage verwenden aus und aktualisieren Sie dann die MappingsVersion Parameter MappingsKey und mit den neuen Werten.

   Verwenden der AWS CLI:

   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

Um eine benutzerfreundliche URL-Weiterleitung ohne Route 53 einzurichten

1. Fordern Sie ein Zertifikat in ACM an

   1. Öffnen Sie die ACM-Konsole https://console.aws.amazon.com/acm/ in der us-east-1 Region.

   2. Wählen Sie Zertifikat anfordern.

   3. Geben Sie als Domainname *.your-domain.com (Wildcard-Zertifikat) ein.

   4. Wählen Sie als Validierungsmethode die Option DNS-Validierung aus.

   5. Wählen Sie Anfrage aus.

   6. Notieren Sie sich auf der Seite mit den Zertifikatsdetails den Namen und den Wert des CNAME-Eintrags unter Domainvalidierung. Erstellen Sie diesen CNAME-Eintrag bei Ihrem DNS-Anbieter, um den Domainbesitz zu überprüfen.

   7. Warten Sie, bis der Zertifikatsstatus auf Ausgestellt geändert wird (in der Regel 5 bis 30 Minuten nach der Erstellung des DNS-Eintrags).

2. Erstellen Sie eine CloudFront KeyValueStore

   1. Öffnen Sie die CloudFront Konsole unter https://console.aws.amazon.com/cloudfront/.

   2. Wählen Sie im Navigationsbereich Funktionen aus. Wählen Sie dann den KeyValueStores Tab.

   3. Wählen Sie Erstellen KeyValueStore aus.

   4. Geben Sie einen Namen ein (z. B.opensearch-ui-friendly-url-app-mappings-store).

   5. Wählen Sie Erstellen aus.

   6. Wählen Sie nach der Erstellung Bearbeiten, um Schlüssel-Wert-Paare hinzuzufügen. Fügen Sie für jede Anwendung einen Schlüssel (den Subdomainnamen, z. B.prod) und einen Wert (die vollständige URL der OpenSearch UI-Anwendung) hinzu.

3. Erstellen Sie eine Funktion CloudFront

   1. Öffnen Sie die CloudFront Konsole unter https://console.aws.amazon.com/cloudfront/.

   2. Wählen Sie im Navigationsbereich Funktionen aus.

   3. Wählen Sie auf der Registerkarte Funktionen die Option Funktion erstellen aus.

   4. Geben Sie einen Namen für die Funktion ein (z. B.opensearch-ui-friendly-url-redirect-function).

   5. Wählen Sie für Runtime cloudfront-js-2.0.

   6. Ersetzen Sie den Funktionscode durch Folgendes:

      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_IDErsetzen Sie ihn durch die ID des von KeyValueStore Ihnen erstellten (sichtbar auf der KeyValueStore Detailseite).

   7. Ordnen KeyValueStore Sie die von Ihnen erstellten KeyValueStore Verknüpfungen in Verknüpfungen zu.

   8. Wählen Sie Änderungen speichern und dann die Funktion Veröffentlichen.

4. Erstellen Sie eine CloudFront Distribution

   1. Wählen Sie in der CloudFront Konsole Create distribution aus.

   2. Geben Sie für die Ursprungsdomäne eine beliebige gültige Domäne ein (z. B.example.com). Der Ursprung wird nie kontaktiert, da die Funktion eine Antwort zurückgibt, bevor sie ihn erreicht hat.

   3. Wählen Sie unter Standard-Cacheverhalten für Viewer-Protokollrichtlinie die Option HTTP zu HTTPS umleiten aus.

   4. Wählen Sie für Cache-Richtlinie CachingDisabled.

   5. Wählen Sie unter Funktionszuordnungen für Viewer-Anfrage Ihre CloudFront Funktion aus.

   6. Geben *.your-domain.com Sie unter Einstellungen für Alternative Domainnamen (CNAMES) den Wert ein.

   7. Wählen Sie für Benutzerdefiniertes SSL-Zertifikat das Zertifikat aus, das Sie in ACM erstellt haben.

   8. Wählen Sie Create distribution (Distribution erstellen) aus.

   9. Notieren Sie sich den Namen der Vertriebsdomäne (z. B.d1234abcdef8.cloudfront.net).

5. Konfigurieren Sie DNS bei Ihrem Anbieter

   Erstellen Sie bei Ihrem DNS-Anbieter einen CNAME-Eintrag, der *.your-domain.com auf Ihren CloudFront Vertriebsdomänennamen verweist (z. B.d1234abcdef8.cloudfront.net).

   Anmerkung

   Einige DNS-Anbieter unterstützen keine CNAME-Einträge mit Platzhaltern. Erstellen Sie in diesem Fall individuelle CNAME-Einträge für jede Subdomain, die Sie verwenden möchten (z. B.,). prod.your-domain.com staging.your-domain.com

1. Öffnen Sie die CloudFront Konsole unter. https://console.aws.amazon.com/cloudfront/

2. Wählen Sie im Navigationsbereich Funktionen aus. Wählen Sie dann den KeyValueStores Tab.

3. Wählen Sie Ihren KeyValueStore Namen (zum Beispielopensearch-ui-friendly-url-app-mappings-store).

4. Wählen Sie Bearbeiten aus.

5. Wählen Sie Paar hinzufügen. Geben Sie den Subdomainnamen als Schlüssel und die vollständige URL der OpenSearch UI-Anwendung als Wert ein.

6. Wählen Sie Änderungen speichern aus.