Configuration d'une URL conviviale pour les applications d' OpenSearch interface utilisateur (libre-service)

Pour configurer une URL conviviale pour vos applications d' OpenSearch interface utilisateur

1. Créez un fichier JSON qui associe vos noms conviviaux aux URL des applications. Chaque clé devient un sous-domaine (par exemple, la clé prod devienthttps://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"}
     ]
   }

   Enregistrez ce fichier en tant que opensearch-ui-friendly-url-app-mappings-v1.json. Le v1 suffixe indique qu'il s'agit de la première version de vos mappages. Vous incrémentez cette version lorsque vous mettez à jour vos mappages.

2. Téléchargez le fichier de mappages dans un compartiment Amazon S3 de votre compte :

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

3. Accordez CloudFront l'autorisation de lire le fichier de mappages en ajoutant une politique de compartiment. Remplacez your-bucket-name et your-account-id par vos valeurs :

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

   Note

   Cette politique de compartiment permet CloudFront de lire le fichier de mappages lors de sa KeyValueStore création. Sans cela, le déploiement de la pile échoue et le message d'erreur « SourceARN est inaccessible » s'affiche.

4. Déployez la CloudFormation pile à l'aide de l'une des options suivantes :

   Option 1 : Launch Stack (recommandé)

   Copiez l'URL suivante et collez-la dans votre navigateur pour ouvrir la page de AWS CloudFormation création rapide avec le modèle préchargé. Renseignez les paramètres et choisissez Créer une pile.

   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

   Remplacez les valeurs des espaces réservés par les vôtres :

   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. Si vous avez utilisé l' AWS interface de ligne de commande (option 2), déployez la pile dans la us-east-1 région. CloudFront nécessite la présence de certificats ACM. us-east-1 Vos applications d' OpenSearch interface utilisateur peuvent se trouver dans n'importe quelle région prise en charge et avoir des quotas pour l' OpenSearch interface utilisateur.

6. Attendez que la pile soit complète (environ 15 minutes). Vous pouvez suivre les progrès :

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

7. Testez la redirection. Ouvrez votre navigateur et accédez àhttps://prod.your-domain.com. Vous devriez être redirigé vers votre application d' OpenSearch interface utilisateur.

   Vous pouvez également vérifier auprès de curl :

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

1. Modifiez votre fichier de mappages pour ajouter ou supprimer des entrées. Enregistrez-le avec un suffixe de version incrémenté (par exemple,opensearch-ui-friendly-url-app-mappings-v2.json).

2. Téléchargez la nouvelle version sur 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. Mettez à jour la pile avec la nouvelle MappingsKey et MappingsVersion :

   À l'aide de la console : ouvrez la CloudFormation console, sélectionnez votre pile, choisissez Mettre à jour, sélectionnez Utiliser le modèle actuel, puis mettez à jour les MappingsVersion paramètres MappingsKey et avec les nouvelles valeurs.

   À l'aide de la 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

Pour configurer une redirection d'URL conviviale sans Route 53

1. Demandez un certificat dans ACM

   1. Ouvrez la console ACM à l'adresse https://console.aws.amazon.com/acm/ In the us-east-1 Region.

   2. Choisissez Demander un certificat.

   3. Dans le champ Nom de domaine, saisissez *.your-domain.com (certificat générique).

   4. Pour Méthode de validation, choisissez Validation DNS.

   5. Cliquez sur Demander.

   6. Sur la page des détails du certificat, notez le nom et la valeur de l'enregistrement CNAME sous Validation du domaine. Créez cet enregistrement CNAME auprès de votre fournisseur DNS pour valider la propriété du domaine.

   7. Attendez que le statut du certificat passe à Émis (généralement 5 à 30 minutes après la création de l'enregistrement DNS).

2. Créez un CloudFront KeyValueStore

   1. Ouvrez la CloudFront console à l'adresse https://console.aws.amazon.com/cloudfront/.

   2. Dans le volet de navigation, choisissez Fonctions. Choisissez ensuite l'KeyValueStoresonglet.

   3. Choisissez Créer KeyValueStore.

   4. Entrez un nom (par exemple,opensearch-ui-friendly-url-app-mappings-store).

   5. Choisissez Créer.

   6. Après la création, choisissez Modifier pour ajouter des paires clé-valeur. Pour chaque application, ajoutez une clé (le nom du sous-domaine, par exempleprod) et une valeur (l'URL complète de l'application d' OpenSearch interface utilisateur).

3. Création d'une CloudFront fonction

   1. Ouvrez la CloudFront console à l'adresse https://console.aws.amazon.com/cloudfront/.

   2. Dans le volet de navigation, choisissez Fonctions.

   3. Dans l'onglet Fonctions, choisissez Créer une fonction.

   4. Entrez un nom pour la fonction (par exemple,opensearch-ui-friendly-url-redirect-function).

   5. Pour Runtime, choisissez cloudfront-js-2.0.

   6. Remplacez le code de fonction par le code suivant :

      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_IDRemplacez-le par l'ID KeyValueStore que vous avez créé (visible sur la page de KeyValueStore détails).

   7. Dans KeyValueStore les associations, associez celles que KeyValueStore vous avez créées.

   8. Choisissez Enregistrer les modifications, puis fonction de publication.

4. Création d'une CloudFront distribution

   1. Dans la CloudFront console, choisissez Créer une distribution.

   2. Pour Domaine d'origine, entrez n'importe quel domaine valide (par exemple,example.com). L'origine n'est jamais contactée car la fonction renvoie une réponse avant de l'atteindre.

   3. Dans Comportement du cache par défaut, pour Politique du protocole Viewer, choisissez Rediriger HTTP vers HTTPS.

   4. Pour Politique de cache, choisissez CachingDisabled.

   5. Dans Associations de fonctions, pour la requête Viewer, sélectionnez votre CloudFront fonction.

   6. Dans Paramètres, dans la zone Noms de domaine alternatifs (CNAME), entrez*.your-domain.com.

   7. Pour le certificat SSL personnalisé, sélectionnez le certificat que vous avez créé dans ACM.

   8. Choisissez Créer une distribution.

   9. Notez le nom du domaine de distribution (par exemple,d1234abcdef8.cloudfront.net).

5. Configurez le DNS chez votre fournisseur

   Chez votre fournisseur DNS, créez un enregistrement CNAME qui pointe *.your-domain.com vers votre nom de domaine de CloudFront distribution (par exemple,d1234abcdef8.cloudfront.net).

   Note

   Certains fournisseurs DNS ne prennent pas en charge les enregistrements CNAME génériques. Dans ce cas, créez des enregistrements CNAME individuels pour chaque sous-domaine que vous souhaitez utiliser (par exempleprod.your-domain.com,staging.your-domain.com).

1. Ouvrez la CloudFront console à l'adresse https://console.aws.amazon.com/cloudfront/.

2. Dans le volet de navigation, choisissez Fonctions. Choisissez ensuite l'KeyValueStoresonglet.

3. Choisissez votre KeyValueStore nom (par exemple,opensearch-ui-friendly-url-app-mappings-store).

4. Choisissez Modifier.

5. Choisissez Ajouter une paire. Entrez le nom du sous-domaine comme clé et l'URL complète de l'application d' OpenSearch interface utilisateur comme valeur.

6. Sélectionnez Enregistrer les modifications.