Pour plateformes LINUX

Déploiement des serveurs Node.js à l'aide des API REST de déploiement

Vous pouvez déployer des applications Node.js comme membres d'une collectivité à l'aide des API REST DeployService. Un membre de collectivité Node.js est appelé un serveur Node.js dans cette documentation.

Avant de commencer

Déterminez les hôtes cibles sur lesquels vous souhaitez installer des serveurs Node.js. Installez Node.js V4 et le package npm apiconnect-collective-member sur les hôtes cibles. La commande permettant d'installer une prise en charge pour les serveurs Node.js sur Linux est :

npm install -g apiconnect-collective-member

Chaque hôte cible requiert RXA ou SSH. Voir Configuration de RXA pour les opérations de collectivité Liberty.

Procédure

  1. Définissez un nom d'utilisateur et un mot de passe pour le contrôleur de collectivité dans le fichier server.xml du contrôleur, par exemple :
    <collectiveController user="admin" password="adminpwd" />
  2. Ajoutez une application Node.js au contrôleur de collectivité.
    1. Sélectionnez une application Node.js à installer. L'application doit avoir résolu ses dépendances.
      Vous allez déployer sur Liberty une archive TAR compressée d'application de noeud avec l'extension .tgz. L'application possède généralement la structure de répertoire suivante :
      package/
            app.js
            package.json
            node_modules/.. 
            server.json
      • app.js est l'application.
      • package.json possède des dépendances pour l'application, comme requis par le npm Node.js.
      • Les répertoires node_modules/.. fournissent des éléments include utilisés par l'application que génère package.json.
      • server.json est un fichier facultatif qui configure les ports et d'autres paramètres.

      Pour en savoir plus sur l'application à déployer, voir la description de la commande pack dans Commandes apiconnect-collective-member wlpn-server et wlpn-collective.

    2. Placez l'application Node.js dans un répertoire auquel le contrôleur de collectivité peut accéder.
    3. Ajoutez au fichier server.xml du contrôleur une instruction remoteFileAccess pointant vers le répertoire, par exemple :
      <remoteFileAccess readDir="/tmp/nodejsApplications" />

      Ce répertoire est la variable d'entrée applicationDir qui est spécifiée pour le déploiement deployService à l'étape 5. Le répertoire applicationDir se trouve sur le contrôleur.

  3. Vérifiez que le fichier server.xml du contrôleur contient des instructions qui définissent le nom d'utilisateur, le mot de passe et les variables de déploiement du contrôleur, par exemple :
       <collectiveController user="admin" password="adminpwd" />
    ... 
       <deployVariable name="appPort" value="9090" increment="1"/> 
       <deployVariable name="adminPort" value="9453" increment="1"/>

    Les variables de déploiement doivent définir des valeurs qui permettent à chaque membre d'avoir un numéro de port unique sur les hôtes cible. Voir DeployVariable (deployVariable).

  4. Enregistrez l'hôte sur lequel vous souhaitez installer un serveur Node.js avec le contrôleur de collectivité.

    L'enregistrement d'un hôte permet au contrôleur de collectivité d'accéder aux fichiers, aux commandes et aux autres ressources de l'hôte. Utilisez la commande wlpn-collective registerHost pour enregistrer l'hôte cible. Consultez le fichier server.xml du contrôleur pour trouver les valeurs des paramètres --host, --port, --user et --password. Pour ne pas utiliser un fichier de clé privée, comme pour les hôtes cibles sur les systèmes d'exploitation Linux ou Windows, incluez un nom d'utilisateur et un mot de passe du système d'exploitation en définissant les paramètres --rpcUser et --rpcUserPassword. L'utilisateur spécifié par --rpcUser doit disposer de droits de système d'exploitation sur l'emplacement de déploiement cible. Vérifiez que la commande inclut --autoAcceptCertificates.

    wlpn-collective registerHost targetHost --host=controllerHost --port=controllerHTTPSPort 
    --user=controllerAdmin --password=controllerAdminPassword --rpcUser=osUser --rpcUserPassword=osUserPassword --autoAcceptCertificates

    Si un hôte est déjà enregistré, vous pouvez utiliser la commande updateHost pour réinitialiser les informations d'enregistrement. Pour plus d'informations, voir Commandes apiconnect-collective-member wlpn-server et wlpn-collective.

    Vérifiez que vous exécutez la commande wlpn-collective registerHost ou updateHost avec le nom d'utilisateur que vous utiliserez plus tard pour déployer le serveur membre. Par exemple, si vous exécutez la commande avec le nom d'utilisateur root et déployer ensuite un membre avec un nom d'utilisateur différent, le déploiement échouera car DeployService n'a pas les droits nécessaires pour envoyer un fichier au répertoire /root/wlpn.

  5. Examinez les règles de déploiement disponibles.
    1. Appelez une API REST renvoyant les règles de déploiement disponibles dans la structure JSON.
      GET https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/rule 

      L'appel renvoie les règles de déploiement dans la structure JSON :

      {"rules":
      [
        {"id":"Node.js Server Rule","description":"Deploy rule for Liberty Node.js servers.","type":"Node.js" 
        ...
        }
      ]
      }
    2. Si nécessaire, créez vos propres règles de déploiement en ajoutant DeployRules à votre configuration de contrôleur. Voir Règle de déploiement (deployRule).
  6. Déployez le serveur Node.js.

    La règle de déploiement contient des variables que vous pouvez utiliser pour spécifier la valeur d'entrée de l'opération, comme le serveur Node.js à utiliser et le nom de conteneur à créer. Le corps du retour contient un jeton que vous pouvez utiliser pour les demandes d'état et de résultats.

    POST https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/deploy
    
    {
       "rule":"Node.js Server Rule",
       "hosts":["localhost"],
       "variables": [
          { "name":"applicationPackage","value":"express-example-app-1.0.2.tgz" },
          { "name":"serverName","value":"ds-member-ctrl5" },
          { "name":"clusterName","value":"MyCluster" }
          { "name":"keystorePassword","value":"password" },
          { "name":"applicationDir","value":"%2Ftmp%2FnodejsApplications" }
       ]
    }
    Avertissement : La variable applicationDir est un chemin de répertoire codé UTF-8. La variable applicationDir est l'emplacement de l'application Node.js sur le contrôleur de collectivité.

    Utilisez le jeton de retour, par exemple {"id":3}, pour obtenir l'état et les résultats. La sortie peut être obtenue au format JSON.

Que faire ensuite

Demande et révision de l'état et des résultats du déploiement.

  • Obtenez une liste des jetons de déploiement pour les opérations de déploiement sollicitées.
    GET
    https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/deploy
  • Obtenez un état abrégé des opérations de déploiement. Utilisez le jeton de l'étape 4 pour {token}. Par conséquent, pour un jeton de retour {"id":3} obtenu à l'étape 4, utilisez 3 pour {token}.
    GET
    https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/{token}/status 
    Durant le déploiement, l'API renvoie IN_PROGRESS:
    {"status":{"hôte_cible":"IN_PROGRESS"}}
    Après le déploiement, l'API renvoie FINISHED:
    {"status":{"hôte_cible":"FINISHED"}}

    Vous pouvez également obtenir un état final de ERROR si le déploiement présente des problèmes. Utilisez les informations suivantes pour obtenir des résultats complets. Les informations stdout et stderr qui sont renvoyées peuvent vous aider à diagnostiquer les problèmes.

  • Obtenez les résultats complets d'une opération de déploiement. Utilisez le jeton de l'étape 4 pour {token}. Par conséquent, pour un jeton de retour {"id":3} obtenu à l'étape 4, utilisez 3 pour {token}.
    GET
    https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/{token}/results
    Une fois le déploiement terminé, les résultats contiennent des informations sur l'opération. L'exemple suivant affiche les résultats de FINISHED :
    {"results":[{"nom_hôte":"hôte_cible","status":"FINISHED","result":0,"stdout":"sortstd_déploiement",
    "stderr":"errstd_déploiement", "deployedArtifactName":"nomServeur_de_varEntrée",
    "deployedUserDir":"répertoire_hôte_cible_pour serveur_déployé"}]}
Annulez le déploiement du serveur Node.js. Vous n'avez pas besoin de spécifier une règle de déploiement. La règle utilisée pour le déploiement a été enregistrée lors du déploiement. Vous pouvez utiliser la règle pour l'annulation du déploiement. Le tuple serveur du nom d'hôte, du répertoire utilisateur et du nom de serveur est utilisé pour annuler le déploiement du serveur. Ce tuple s'affiche sur les pages serveur de l'outil Explore de Centre d'administration.
  • Annulez le déploiement d'un serveur Node.js.
    POST
    https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/undeploy
    {     
       "host": "myHostName",
       "userDir":"/root/wlpn",     
       "serverName":"myServerName"
    }
  • Obtention d'une liste de jetons pour les opérations d'annulation de déploiement.
    GET
    https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/undeploy
    Pour obtenir le statut et les résultats, les étapes à suivre sont similaires à celles des déploiements.

Icône indiquant le type de rubrique Rubrique Tâche



Icône d'horodatage Dernière mise à jour: 7 juin 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-dist&topic=twlp_deployservice_nodejs
Nom du fichier : twlp_deployservice_nodejs.html