Déployer votre code

Pour exécuter votre application de commerce sur Managed Runtime, vous devez d’abord pousser un paquet de code et le déployer dans un environnement cible.

Ce guide vous montre comment :

  • Configurer votre clé API.
  • Utiliser un script de ligne de commande pour envoyer un paquet en push vers Managed Runtime.
  • Utiliser l'application Web Runtime Admin pour déployer un paquet dans l'environnement de production.

Avant de pouvoir utiliser Managed Runtime et Runtime Admin, ils doivent être activés et vous devez demander d’y avoir accès. Pour activer Managed Runtime et Runtime Admin pour votre organisation, contactez l’équipe de votre compte Salesforce. Pour y accéder, demandez à votre administrateur Commerce Cloud d’ajouter l’un des rôles suivants à votre compte à l’aide d’Account Manager : Managed Runtime User (Utilisateur Managed Runtime) ou Managed Runtime Admin (Administrateur Managed Runtime).

Si vous avez déjà un fichier .mobify dans votre répertoire personnel, vous pouvez passer cette section.

Avant de pouvoir envoyer un paquet en push, vous devez d'abord autoriser votre ordinateur.

Avant de débuter le processus d'autorisation, cherchez votre clé API personnelle :

  1. Connectez-vous à Runtime Admin.
  2. Cliquez sur l’icône du profil d’utilisateur (en haut à droite) puis sur Account Settings.
  3. Faites défiler la page jusqu’à la section intitulée API Key (Clé API) pour y trouver Personal API Key (Clé API personnelle).
    • Si vous n’avez pas encore créé de clé API, cliquez sur le lien Generate (Générer).
    • Si vous avez déjà une clé API, cliquez sur le lien Reset (Réinitialiser) puis sur Reset my API Key (Réinitialiser ma clé API) à l’invite de confirmation.
  4. Copiez la commande pour utiliser votre clé API.

Par sécurité, quand vous reviendrez sur la page Account Settings, la clé API ne sera pas affichée en entier ; vous devrez donc la réinitialiser pour copier à nouveau le texte complet de la clé API.

À partir de la ligne de commande, accédez au répertoire de votre projet PWA Kit et exécutez la commande que vous avez copiée.

Exécutez à nouveau la commande sur tous les autres ordinateurs que vous souhaitez utiliser pour pousser des paquets.

L'envoi d'un paquet en push implique l'exécution d'un script qui emballe votre code dans un paquet Webpack et le télécharge vers Runtime Manager.

Avant de pousser votre premier paquet, vérifiez que le fichier package.json qui se trouve dans le répertoire de votre projet PWA Kit est bien configuré :

  1. Connectez-vous à Runtime Admin.
  2. Cliquez sur le nom de votre projet.
  3. Dans le menu de navigation de gauche, cliquez sur Project Settings (Paramètres du projet).
  4. Copiez la chaîne Project ID. Exemple : my-project.
  5. Collez-la dans le champ name de package.json..

Pour que votre bundle fonctionne correctement une fois déployé, vous devez configurer vos proxys pour votre environnement dans Runtime Admin.

Si vous utilisez un client privé SLAS, vous devez définir la clé secrète client à l’aide d’une variable d’environnement.

Les projets générés à partir de PWA Kit 3.5 et versions ultérieures seront configurés pour utiliser un client privé SLAS par défaut.

Pour en savoir plus sur l’utilisation des clients privés SLAS, reportez-vous à la section Utiliser un client privé SLAS.

Pour pousser un paquet, allez sur la ligne de commande et exécutez la commande suivante depuis le répertoire de votre projet :

Pour afficher la liste des autres options que vous pouvez fournir au script push, exécutez npm run push -- --help.

Si l'envoi en push d'un paquet réussit, le message Beginning upload… s'affiche dans le terminal, suivi du message Bundle Uploaded!.

Si un problème est survenu, recherchez l'un des trois messages d'erreur possibles (basés sur les codes d'état de la réponse HTTP) dans votre terminal, après le message Beginning upload….

Voici comment dépanner chaque message d'erreur.

Une erreur HTTP 404 est renvoyée dans le terminal s'il n'existe pas de projet avec le nom spécifié dans package.json ou si vous n'êtes pas autorisé à modifier le projet.

Pour corriger l'erreur :

  1. Répétez les étapes pour pousser un paquet et vérifiez que les paramètres de l'adresse e-mail et de la clé API que vous transmettez au script push correspondent aux paramètres de Runtime Admin.
  2. Vérifiez que votre projet s'affiche sur la page d'accueil de Runtime Admin sous Projects (Projets).
    • Si votre projet ne s'affiche pas, contactez le support technique pour vous assurer que ce projet a bien été créé et que vous y avez accès en tant que membre de l'équipe.
  3. Ouvrez le projet sur Runtime Admin.
  4. Dans le menu de navigation de gauche, cliquez sur Project Settings.
  5. Copiez la chaîne Project ID. Exemple : my-project.
  6. Ouvrez package.json dans le répertoire de votre projet.
  7. Vérifiez que les valeurs de name et projectSlug correspondent toutes deux à la chaîne de l'identifiant du projet que vous avez copiée.

Une erreur HTTP 401 est renvoyée dans le terminal si vous n'avez pas l'autorisation de pousser des paquets. Pour corriger cette erreur, contactez votre administrateur Commerce Cloud Account Manager et demandez à modifier vos autorisations pour vous permettre d'envoyer des paquets en push.

Une erreur HTTP 413 est renvoyée dans le terminal si votre paquet est trop grand. La taille des paquets ne peut pas dépasser 400 Mo et la taille de tous les fichiers ssr_only et ssr_shared du paquet ne peut pas dépasser 249 Mo. Pour corriger cette erreur, vérifiez la taille de votre paquet en inspectant le dossier de la build dans votre projet. Si votre projet approche de la taille maximale ou l'a déjà dépassée, explorez ces options pour le réduire :

  • Supprimer les ressources inutilisées
  • Supprimer les ressources inutiles
  • Réduire l'échelle des images

Après avoir réduit la taille des fichiers de votre projet, essayez à nouveau de pousser le paquet.

Des erreurs HTTPS peuvent se produire si votre ordinateur local ou des proxys réseau (comme un VPN ou un pare-feu d’entreprise) n’ont pas été configurés pour communiquer avec l’API de Managed Runtime, hébergée sur cloud.mobify.com.

Ces erreurs peuvent inclure des messages comme unable to get local issuer certificate ou self signed certificate in certificate chain.

Pour résoudre ces erreurs, travaillez avec l’équipe informatique de votre société pour configurer votre installation Node.js pour votre environnement réseau d’entreprise.

Après avoir correctement transféré un paquet, vous pouvez le déployer dans un environnement cible.

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. Par défaut, chaque projet comporte un seul environnement, appelé production. Vous pouvez créer d'autres environnements en utilisant Runtime Admin ou l'API Managed Runtime.

Pour déployer un paquet :

  1. Connectez-vous à Runtime Admin.
  2. Cliquez sur le nom de votre projet.
  3. Sous Environments, cliquez sur le nom de l'environnement vers lequel vous souhaitez effectuer le déploiement (par exemple : Production).
  4. Sous Bundles (Paquets), cliquez sur le bouton Deploy (Déployer) à côté du paquet.
  5. Cliquez sur Confirm Deploy (Confirmer le déploiement).
  6. 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. Les déploiements ultérieurs prennent environ une minute, à moins que des modifications du CDN ne soient requises. Une modification du CDN prend environ 15 minutes. Elle est requise lorsque le déploiement implique des modifications du processeur de requests ou de la configuration du proxy.