Administration de Managed Runtime

Managed Runtime facilite la gestion des organisations, projets, environnements et paquets associés à votre boutique PWA Kit. Ce guide décrit la liste croissante des tâches d'administration possibles dans l'outil Web Runtime Admin. (Toutes les tâches d'administration décrites dans ce guide, et bien d'autres, peuvent également être effectuées à l'aide de l'API Managed Runtime.)

Les projets vous aident à gérer plusieurs environnements au sein d'une organisation. Chaque projet PWA Kit nécessite un projet correspondant au sein de Managed Runtime pour déployer et héberger le code de la boutique sur l’infrastructure cloud publique de Salesforce.

Pour créer un projet dans Runtime Admin :

1. Connectez-vous à Runtime Admin.
2. Cliquez sur New project (Nouveau projet).
3. Indiquez un nom pour le projet.
4. Cliquez sur Create Project (Créer le projet).

Pour le reste des tâches d'administration de ce guide, les instructions supposent toutes que vous démarrez à partir d'une page de vue d'ensemble (Overview) du projet dans Runtime Admin.

Pour trouver un projet existant et ouvrir sa page Overview :

1. Connectez-vous à Runtime Admin.
2. Sélectionnez une organisation dans le menu des organisations (en haut à gauche), si nécessaire.
3. Cliquez sur le nom du projet. (Pour voir le projet, vous devez avoir reçu l'un des rôles de projet indiqués précédemment).

Pour passer rapidement d'un projet à l'autre, utilisez le menu des projets en haut de la page.

La page Project Settings vous permet d'effectuer les tâches suivantes :

• Rechercher l'identifiant du projet et vérifier qu'il correspond à une configuration PWA Kit.
• Modifier l'identifiant du projet.
• Afficher et modifier le nom et l'URL du projet.
• Supprimer le projet.
• Gérer les notifications de déploiement. (Voir la section suivante.)

Pour accéder à la page Project Settings :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur Project Settings (Paramètres du projet) dans le menu de navigation de gauche.

Pour modifier les paramètres, cliquez sur Edit (Modifier), effectuez vos modifications, puis cliquez sur Update (Mettre à jour). Pour annuler vos modifications, cliquez sur Cancel (Annuler).

Pour supprimer un projet, cliquez sur Delete (Supprimer), saisissez le nom du projet pour confirmer, puis cliquez sur Yes, Delete (Oui, supprimer). Pour conserver le projet, cliquez sur No, Keep (Non, conserver).

Vous pouvez choisir d'être informé par e-mail lorsque l'un des événements de déploiement suivants se produit :

• Démarrage du déploiement
• Déploiement réussi
• Échec du déploiement

Pour ajouter une notification :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur Project Settings (Paramètres du projet) dans le menu de navigation de gauche.
3. Cliquez sur Add Notification (Ajouter une notification).
4. Sélectionnez un ou plusieurs environnements pour lesquels vous souhaitez recevoir une notification.
5. Sélectionnez un ou plusieurs événements de déploiement.
6. Saisissez les adresses électroniques de tous les destinataires de la notification.
7. Cliquez sur Add Notification.

Pour modifier une notification :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur Project Settings (Paramètres du projet) dans le menu de navigation de gauche.
3. Cliquez sur le bouton … à côté de la notification.
4. Cliquez sur Edit (Modifier).
5. Modifiez l'un des paramètres de notification.
6. Cliquez sur Update Notification (Mettre à jour la notification).

Pour supprimer une notification :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur Project Settings (Paramètres du projet) dans le menu de navigation de gauche.
3. Cliquez sur le bouton … à côté de la notification.
4. Cliquez sur Remove (Supprimer).
5. Cliquez sur Yes, Remove (Oui, supprimer).

Les environnements sont utilisés pour séparer votre boutique de production des autres boutiques déployées à d'autres fins, comme le développement ou les tests. Pour en savoir plus sur les environnements et d'autres concepts connexes, consultez Présentation de Managed Runtime.

Pour créer un environnement dans Runtime Admin :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur New Environment (Nouvel environnement).
3. Indiquez un nom pour l'environnement.
4. Sélectionnez une région pour le déploiement sur l'infrastructure cloud publique de Salesforce.
5. Si l’environnement est un environnement de production, indiquez-le comme tel. Si vous avez atteint votre limite d’environnements de production, contactez le Support.
6. Cliquez sur Create Environment (Créer l'environnement).

Pour tout site utilisant PWA Kit et Managed Runtime, vous ne pouvez désigner comme déployé qu'un seul paquet à la fois pour chaque environnement.

1. Accédez à la page Overview d'un projet.
2. Cliquez sur le nom de l'environnement dans lequel vous souhaitez effectuer le déploiement. Par exemple : production.
3. Sous la rubrique Bundles (Paquets), cliquez sur le bouton Deploy (Déployer) à côté du paquet que vous souhaitez déployer.
4. Cliquez sur Confirm Deploy (Confirmer le déploiement).
5. Attendez que le déploiement soit terminé.

Si le déploiement s'est terminé correctement, le paquet s'affiche dans la section Deployed Bundle (Paquet déployé). (Pour votre premier déploiement dans un nouvel environnement, le processus peut prendre jusqu'à une heure).

La page Environment Settings vous permet d'effectuer de nombreuses tâches administratives centralisées, notamment :

• Renommer un environnement ou un identifiant d'environnement.
• Changer la région de déploiement.
• Autoriser des adresses IP spécifiques à accéder à l'environnement.
• Configurer des proxies pour l'environnement. Voir Requests via proxy pour en savoir plus.
• Indiquer un environnement comme environnement de production.
• Supprimer un environnement.

Pour accéder à la page Environment Settings :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur le nom de l'environnement dont vous voulez modifier les paramètres.
3. Cliquez sur Environment Settings (Paramètres d'environnement) dans le menu de navigation de gauche.

Pour effectuer des modifications, cliquez sur le bouton Edit (Modifier) à côté de General settings (Paramètres généraux) ou d'Advanced settings (Paramètres avancés). Après avoir effectué vos modifications, cliquez sur Update (Mettre à jour) pour les enregistrer ou sur Cancel (Annuler) pour les abandonner.

Les variables d’environnement vous permettent d’ajouter des variables dans le processus d’application exécuté dans un environnement, sans avoir à modifier le code. Les variables d’environnement sont stockées de façon sécurisée. Elles sont donc idéales pour des cas d’utilisation tels que :

• Clés API pour les intégrations de tierces parties
• Indicateurs de fonctionnalités pour la logique d’application
• Configuration différente d’un environnement à l’autre

Vous pouvez gérer les variables d’environnement à l’aide de l’API Managed Runtime et y accéder dans Node.js à l’aide de process.env.

Pour définir, mettre à jour et supprimer des variables d’environnement, utilisez projects_target_env_var_partial_update :

Choisissez des noms de variables d’environnement logiques dans le contexte de votre application. Les valeurs des variables d’environnement peuvent être des booléens, des entiers ou des chaînes de caractères. Pour définir des valeurs complexes, encodez du JSON dans une chaîne.

Pour supprimer une variable d’environnement, définissez sa valeur sur null.

La modification des variables d’environnement entraîne un redéploiement du paquet actuel pour l’environnement.

Pour récupérer toutes les variables d’environnement définies sur un environnement, utilisez projects_target_env_var_list :

L’utilisation des variables d’environnement est soumise aux contraintes suivantes :

• Chaque environnement comporte une limite de 100 variables d’environnement.
• La taille des valeurs des variables d’environnement définies pour un environnement ne peut pas dépasser 32 Ko.
• Les noms de variables d’environnement ne peuvent pas comporter plus de 512 caractères et ne peuvent pas commencer par des préfixes réservés : AWS, MRT, X_MRT, MOBIFY, X_MOBIFY, SSR_PROXY.
• Les noms de variables d’environnement ne peuvent pas utiliser les noms réservés : BUNDLE_ID, DEPLOY_ID, DEPLOY_TARGET, EXTERNAL_DOMAIN_NAME, HANDLER, LAMBDA_RUNTIME_DIR, LAMBDA_TASK_ROOT, NODE_ENV, REDIRECT_BUCKET, REDIRECT_KEY, REDIRECT_UPDATE, REMOTE, X_AMZN_TRACE_ID.

Une redirection permet de transférer une request de l'URL demandée vers une autre URL. Les redirections peuvent aider à éviter les perturbations de l'expérience utilisateur causées par des modifications de votre boutique en ligne. Prenons l'exemple d'une page de campagne saisonnière pour le printemps. Lorsque la campagne de printemps se termine et est remplacée par une campagne d'été, vous pouvez rediriger de l'URL du printemps vers l'URL de l'été.

Les redirections sont une fonctionnalité puissante. Elles peuvent avoir des conséquences importantes en matière de sécurité sur votre boutique, par exemple la redirection vers des URL ou des ressources malveillantes. Soyez prudent lorsque vous attribuez des rôles offrant un accès à la redirection à vos utilisateurs.

Pour créer une redirection :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur le nom de l'environnement dans lequel vous voulez créer la redirection.
3. Cliquez sur URL Redirects (Redirections des URL) dans le menu de navigation de gauche.
4. Cliquez sur Create Redirect (Créer une redirection).
5. Dans le champ Redirect From (Rediriger à partir de), saisissez un chemin d'accès URL relatif. Par exemple, pour rediriger les visiteurs depuis l'URL www.example.com/winter, indiquez /winter.
6. Dans le champ Redirect To (Rediriger vers), saisissez un chemin d'accès URL relatif.
7. Si nécessaire, activez le transfert des paramètres de la requête et du chemin d'accès générique. (Plus d'informations sur les paramètres de transfert dans un moment).
8. Dans le menu déroulant Redirect Type (Type de redirection), sélectionnez un type de redirection en fonction du code d'état HTTP. (Plus d'informations sur les codes d'état dans un moment).
9. Cliquez sur Create Redirect (Créer une redirection).

Examinons plus en détail les options permettant de créer une redirection.

La valeur que vous saisissez dans le champ Redirect From doit toujours être un chemin d'accès relatif. Le champ Redirect To peut être soit un chemin d'accès relatif, soit une URL complète. Par exemple, supposons que l'on souhaite rediriger les visiteurs de www.example.com/spring vers www.example.com/summer. Le champ Redirect From doit être /spring. Le champ Redirect To peut être soit /summer soit www.example.com/summer.

Vous pouvez ajouter un caractère astérisque (*) à la fin de l'URL Redirect From pour indiquer un caractère générique. Un caractère générique correspond à n'importe quel nombre de n'importe quels caractères dans l'URL. Par exemple, une redirection de /a/* correspondrait à /a/, /a/b et /a/b/c.

Un caractère générique ne peut être utilisé qu'à la fin de l'URL Redirect From.

Les redirections standard sont traitées en premier par Managed Runtime, puis viennent les redirections avec des caractères génériques.

La plupart des redirections utilisent le code d'état 301 permanent, mais vous pouvez également sélectionner le code 302 temporaire. Si vous n'êtes pas sûr du code d'état HTTP à utiliser, consultez cette explication des codes d'état sur MOZ.com.

Certaines requests contiennent des paramètres de chaîne de requête que vous avez également besoin d'inclure dans la request redirigée. Par exemple, le chemin relatif /spring-landing-page peut être ajouté à une chaîne de requête pour le suivi analytique, comme /spring-landing-page?gclid=123.

Pour activer le transfert des paramètres de requête, accédez à la section Forward (Transférer) du formulaire et sélectionnez Query Parameters (Paramètres de requête). Sinon, les paramètres de la chaîne de requête de l'URL source ne sont pas inclus dans l'URL de redirection.

Que se passe-t-il si les URL Redirect From et Redirect To comportent toutes les deux des chaînes de requête et que le transfert est activé ? Dans ce cas, l'URL de redirection inclut une combinaison des deux chaînes de requête. Les paramètres de requête de l'URL Redirect To sont ajoutés à la chaîne de requête dans la request. Par exemple, supposez que votre application reçoive une request pour le chemin relatif /spring?year=2019. Si vous avez choisi de rediriger /spring vers /summer?year=2020, l'URL de redirection sera /summer?year=2019&year=2020 si le transfert est activé.

Vous pouvez inclure automatiquement tout chemin d'accès qui vient après la partie générique de l'URL Redirect From dans l'URL Redirect To. Par exemple : si /a/* correspond à /a/b/c dans l'URL Redirect From, et que l'URL Redirect To est /z/, l'URL de redirection est /z/b/c.

Pour activer le transfert d'un chemin d'accès générique, accédez à la section Forward du formulaire et sélectionnez Wildcard Path (Chemin d'accès générique).

Vous pouvez copier toutes les redirections d'un environnement à l'autre à l'aide de la fonction de clonage des redirections.

Pour cloner des redirections :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur le nom de l'environnement qui contient les redirections que vous souhaitez cloner.
3. Cliquez sur URL Redirects dans le menu de navigation de gauche.
4. Cliquez sur Clone Redirects (Cloner des redirections). Le formulaire Clone Redirects s'affiche. L'environnement actuel est répertorié sous From Environment (la source).
5. Dans To Environment, sélectionnez l'environnement dans lequel vous souhaitez cloner les redirections (la destination).
6. Cliquez sur Clone n Redirects. (Où n correspond au nombre de redirections à cloner).

Pour modifier les paramètres d'une redirection existante :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur le nom de l'environnement qui contient la redirection que vous voulez modifier.
3. Cliquez sur URL Redirects dans le menu de navigation de gauche.
4. Cliquez sur le bouton points de suspension (…) à côté de la redirection.
5. Cliquez sur Edit (Modifier).
6. Mettez à jour les paramètres.
7. Cliquez sur Update Redirect (Mettre à jour la redirection).

Pour supprimer une redirection :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur le nom de l'environnement qui contient la redirection que vous voulez supprimer.
3. Cliquez sur URL Redirects dans le menu de navigation de gauche.
4. Cliquez sur le bouton points de suspension (…) à côté de la redirection.
5. Cliquez sur Delete (Supprimer).
6. Cliquez sur Yes, Delete Redirect (Oui, supprimer la redirection).

Si une redirection ne fonctionne pas comme prévu, essayez ces étapes de dépannage :

• Videz le cache de votre navigateur car les redirections sont mises en cache.
• Vérifiez que vous consultez les paramètres du bon environnement.
• Modifiez la redirection et vérifiez que les valeurs saisies dans les champs Redirect From et Redirect To sont correctes.

Les redirections ont les limitations techniques suivantes :

• Chaque environnement peut avoir un maximum de 10 000 redirections.
• Chaque environnement possède son propre lot de redirections. Il vous incombe de les maintenir synchronisées à l’aide du clonage.
• La fonction de redirection prend en charge les redirections simples d’un chemin vers un autre. Pour les redirections complexes avec des conditions, utilisez la prise en charge des redirections Express.js dans ssr.js.
• Les redirections créées avec l’outil Runtime Admin ou l’API Managed Runtime ne sont pas exécutées sur les environnements de développement locaux.
• Les redirections ne sont pas déclenchées par des transitions de page dans l’application PWA Kit ; elles ne peuvent être déclenchées que par une request HTTP.

Voici comment gérer vos utilisateurs.

Pour ajouter un utilisateur à un projet :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur Users & Permissions (Utilisateurs et autorisations) dans le menu de navigation de gauche.
3. Cliquez sur New User (Nouvel utilisateur).
4. Saisissez l'adresse électronique de l'utilisateur. (Vérifiez que l'utilisateur fait partie de votre organisation et qu'il dispose d'un des rôles suivants dans Account Manager : Managed Runtime User ou Managed Runtime Admin.)
5. Sélectionnez un rôle.
6. Cliquez sur Add User (Ajouter l'utilisateur).

Pour changer le rôle d'un utilisateur :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur Users & Permissions dans le menu de navigation de gauche.
3. Cliquez sur le bouton … à côté du nom de l'utilisateur.
4. Cliquez sur Edit (Modifier).
5. Sélectionnez un rôle.
6. Cliquez sur le menu contextuel qui s'affiche.
7. Sélectionnez un nouveau rôle.
8. Cliquez sur Save (Enregistrer).

Pour obtenir la liste des capacités utilisateur associées à chaque rôle, consultez Présentation de Managed Runtime.

Pour supprimer un utilisateur d'un projet :

1. Accédez à la page Overview d'un projet.
2. Cliquez sur Users & Permissions dans le menu de navigation de gauche.
3. Cliquez sur le bouton … à côté du nom de l'utilisateur.
4. Cliquez sur Remove (Supprimer).
5. Cliquez sur Yes, Remove User (Oui, supprimer l'utilisateur).