Pour plateformes LINUX

Déploiement des conteneurs Liberty Docker à l'aide des API REST de déploiement

Vous pouvez déployer les serveurs Liberty dans des conteneurs Docker comme membres d'une collectivité à l'aide des API REST DeployService.

Avant de commencer

Déterminez les hôtes cibles sur lesquels vous souhaitez installez une image Docker. Installez Docker sur les hôtes cible. Chaque hôte cible requiert RXA ou SSH. Voir Configuration de RXA pour les opérations de collectivité Liberty.

Multimédia Visionner : La vidéo Gestion d'un environnement polyglotte sur site avec les collectivités WebSphere Liberty contenue dans un article du site WASdev offre un supplément à la procédure décrite dans cette rubrique.

Procédure

  1. Créez une image Docker.
    1. Utilisez un fichier Dockerfile pour créer une image Liberty.

      L'exemple de fichier Dockerfile suivant peut créer une image Liberty Network Deployment. L'image qui est disponible sur le concentrateur Docker ne peut pas accéder aux fonctions de Network Deployment telles que scalingMember-1.0. Utilisez ce fichier pour créer une image Liberty Network Deployment. Vous pouvez utiliser la dernière ligne pour copier une application afin de l'utiliser sur l'image Docker.

      # 
      # Fichier Dockerfile permettant de créer une image Liberty Network Deployment
      #
      # Ce fichier Dockerfile suppose que :
      # - Les scripts d'activation de la collectivité (joinMember, removeMember) seront placés dans
      #   /opt/ibm/docker dans le conteneur Docker
      # - WebSphere Liberty sera installé sous /opt/ibm/wlp
      # - Le serveur WebSphere Liberty sera "defaultServer"
      #   (par exemple, /opt/ibm/wlp/usr/servers/defaultServer)
      # - Le conteneur Docker s'exécute avec --net=host de sorte qu'aucun port n'est explicitement
      #   exporté dans ce fichier
      
      FROM websphere-liberty
      
      #
      # Démarrage automatique du serveur Liberty avec le conteneur
      #
      ENTRYPOINT ["/opt/ibm/wlp/bin/server", "run", "defaultServer"]
      #
      #
      
      #
      # Ajoutez les scripts d'activation de la collectivité
      #
      ADD joinMember /opt/ibm/docker/
      RUN chmod +x /opt/ibm/docker/joinMember
      ADD removeMember /opt/ibm/docker/
      RUN chmod +x /opt/ibm/docker/removeMember
      
      #
      # Mettez à jour le système d'exploitation 
      #
      RUN apt-get update
      
      #
      # Ajoutez les fonctions obligatoires additionnelles
      #
      RUN installUtility install --acceptLicense scalingMember-1.0 clusterMember-1.0
      collectiveMember-1.0
      
      ADD server.xml /opt/ibm/wlp/usr/servers/defaultServer/
      
      #
      # Insérez le nom de votre fichier d'application. Cette instruction copie l'application
      # sur l'image Docker.
      # 
      ADD fichier_application /opt/ibm/wlp/usr/servers/defaultServer/dropins/
      Remarque : L'image du Docker contient un script joinMember qui relie le serveur membre dans le conteneur Docker à un contrôleur de collectivité :
      #!/bin/bash
      
      #
      # Script permettant de joindre un conteneur Docker Liberty à un contrôleur de collectivité.
      #
      # Obligatoire : <containerName> - paramètre positionnel qui est le nom 
      #                             du conteneur Docker
      #           --host - nom d'hôte du contrôleur de collectivité
      #           --port - port https du contrôleur de collectivité
      #           --user - administrateur du contrôleur de collectivité
      #           --password - mot de passe de l'administrateur du contrôleur de collectivité
      #           --keystorePassword - à utiliser pour le magasin de clés du membre
      #           --dockerHost - nom d'hôte de l'hôte Docker sur lequel réside ce conteneur
      #
      # Facultatif : --clusterName - nom du cluster de la configuration de membre.  
      #                           Si spécifié, il ajoute également les fonctions de membre 
      #                           de la mise à l'échelle et du cluster.
      #
      
      # Définissez les valeurs initiales
      
      containerName=$1
      
      # Analysez la ligne de commande
      
      failure="false"
      
      if [[ -z $1 ]]; then
          # No values received
          echo "Error: no parameters specified"
          failure="true"
      else
          TEMP=`getopt --long host:,port:,user:,password:,keystorePassword:,dockerHost:,clusterName:: -- "$@"`
          eval set -- "$TEMP"
          OPTIND=-1
          
          while true ; do
              case "$1" in
                 --host) controllerHost=$2; shift 2;;
                 --port) controllerPort=$2; shift 2;;
                 --user) controllerUser=$2; shift 2;;
                 --password) controllerPassword=$2; shift 2;;
                 --keystorePassword) memberKeystorePassword=$2; shift 2;;
                 --dockerHost) dockerHost=$2; shift 2;;
                 --clusterName) clusterName=$2; shift 2;;
                 *) break;;
              esac
          done
      
          # Validez les paramètres obligatoires
          if [[ -z "$containerName" ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
      
          # si un containerName n'est pas spécifié, bash utilise le 
          # 1er paramètre "--" comme containerName
      
          if [[ $containerName == --* ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
          
          # Si le paramètre positionnel containerName échoue, 
          # interrompez la génération du rapport de validation
          
          if [[ $failure == false ]]; then
              if [[ -z "${controllerHost// }" ]]; then
                  echo "Error: no host specified"
                  failure="true"
              fi
              if [[ -z "${controllerPort// }" ]]; then
                  echo "Error: no port specified"
                  failure="true"
              fi
              if [[ -z "${controllerUser// }" ]]; then
                  echo "Error: no user specified"
                  failure="true"
              fi
              if [[ -z "${controllerPassword// }" ]]; then
                  echo "Error: no password specified"
                  failure="true"
              fi
              if [[ -z "${memberKeystorePassword// }" ]]; then
                  echo "Error: no keystorePassword specified"
                  failure="true"
              fi
              if [[ -z "${dockerHost// }" ]]; then
                  echo "Error: no dockerHost specified"
                  failure="true"
              fi
          fi
      fi
      
      if [[ $failure == false ]]; then
          # Créez le fichier env.properties pour le membre Docker Liberty
      
          echo containerName=$containerName > /opt/ibm/docker/env.properties
          echo containerHost=$dockerHost >> /opt/ibm/docker/env.properties
      
      
          # Appelez l'utilitaire de collectivité
      
          /opt/ibm/wlp/bin/collective join defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword --hostName=$dockerHost --createConfigFile --keystorePassword=$memberKeystorePassword --autoAcceptCertificates --genDeployVariables
      
      
          # Générez des fragments config dropin supplémentaires
      
          if [[ $clusterName = *[!\ ]* ]]; then
              echo \<?xml version=\"1.0\" encoding=\"UTF-8\" ?\> > /opt/ibm/wlp/usr/servers/defaultServer/cfgfeatures.xml
              echo \<server\> >> /opt/ibm/wlp/usr/servers/defaultServer/cfgfeatures.xml
              echo $'\t'\<featureManager\> >> /opt/ibm/wlp/usr/servers/defaultServer/cfgfeatures.xml
              echo $'\t'$'\t'\<feature\>clusterMember-1.0\</feature\> >>  /opt/ibm/wlp/usr/servers/defaultServer/cfgfeatures.xml
              echo $'\t'$'\t'\<feature\>scalingMember-1.0\</feature\> >>  /opt/ibm/wlp/usr/servers/defaultServer/cfgfeatures.xml
              echo $'\t'\</featureManager\> >> /opt/ibm/wlp/usr/servers/defaultServer/cfgfeatures.xml
              echo \</server\> >> /opt/ibm/wlp/usr/servers/defaultServer/cfgfeatures.xml
              echo \<?xml version=\"1.0\" encoding=\"UTF-8\" ?\> > /opt/ibm/wlp/usr/servers/defaultServer/cluster-config.xml
              echo \<server\> >> /opt/ibm/wlp/usr/servers/defaultServer/cluster-config.xml
              echo $'\t'\<clusterMember name=\"$clusterName\" /\> >> /opt/ibm/wlp/usr/servers/defaultServer/cluster-config.xml
              echo \</server\> >> /opt/ibm/wlp/usr/servers/defaultServer/cluster-config.xml
          else
              echo "No clusterName provided, the container will not be configured as a cluster or scaling member."
          fi
      
      
          # Déplacez les fragments config à l'emplacement d'utilisation approprié
      
          mkdir -p /opt/ibm/wlp/usr/servers/defaultServer/configDropins/overrides
          mv /opt/ibm/wlp/usr/servers/defaultServer/c*.xml /opt/ibm/wlp/usr/servers/defaultServer/configDropins/overrides
          if [ -f /opt/ibm/wlp/usr/servers/defaultServer/user-collective-include.xml ]
          then
              cp /opt/ibm/wlp/usr/servers/defaultServer/user-collective-include.xml /opt/ibm/wlp/usr/servers/defaultServer/configDropins/overrides
          fi
      else
          # Au moins un paramètre obligatoire était manquant, 
          # indiquez la syntaxe correct à l'utilisateur
          printf "Usage:  joinMember <containerName> \n\t--host <controller host> \n\t--port <controller https port> \n\t--user <controller user> \n\t--password <controller password> \n\t--keystorePassword <member keystore password> \n\t--dockerHost <hostname of the Docker host> \n\t[--clusterName <cluster name for the member>]\n"
      fi
      L'image du Docker possède également un script removeMember qui supprime le serveur membre contenu dans le conteneur Docker de la collectivité :
      #!/bin/bash
      
      # Script permettant de supprimer un conteneur Docker Liberty d'un contrôleur de collectivité.
      #
      # Obligatoire : <containerName> - paramètre positionnel qui est le
      #                             nom de ce conteneur Docker
      #           --host - nom d'hôte du contrôleur de collectivité
      #           --port - port https du contrôleur de collectivité
      #           --user - administrateur du contrôleur de collectivité
      #           --password - mot de passe de l'administrateur du contrôleur de collectivité
      #           --dockerHost - nom d'hôte de l'hôte Docker sur lequel réside ce conteneur
      #
      #
      
      # Définissez les valeurs initiales
      
      containerName=$1
      
      # Analysez la ligne de commande
      
      failure="false"
      
      if [[ -z $1 ]]; then
          # No values received
          echo "Error: no parameters specified"
          failure="true"
      else
          TEMP=`getopt --long host:,port:,user:,password:,dockerHost:: -- "$@"`
          eval set -- "$TEMP"
          OPTIND=-1
      
          while true ; do
              case "$1" in
                 --host) controllerHost=$2; shift 2;;
                 --port) controllerPort=$2; shift 2;;
                 --user) controllerUser=$2; shift 2;;
                 --password) controllerPassword=$2; shift 2;;
                 --dockerHost) dockerHost=$2; shift 2;;
                 *) break;;
              esac
          done
      
          # Validez les paramètres obligatoires
          if [[ -z "$containerName" ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
      
          # si un containerName n'est pas spécifié, bash utilise le
          # 1er paramètre "--" comme containerName
      
          if [[ $containerName == --* ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
      
          # Si le paramètre positionnel containerName échoue, 
          # interrompez la génération du rapport de validation
      
          if [[ $failure == false ]]; then
              if [[ -z "${controllerHost// }" ]]; then
                  echo "Error: no host specified"
                  failure="true"
              fi
              if [[ -z "${controllerPort// }" ]]; then
                  echo "Error: no port specified"
                  failure="true"
              fi
              if [[ -z "${controllerUser// }" ]]; then
                  echo "Error: no user specified"
                  failure="true"
              fi
              if [[ -z "${controllerPassword// }" ]]; then
                  echo "Error: no password specified"
                  failure="true"
              fi
              if [[ -z "${dockerHost// }" ]]; then
                  echo "Error: no dockerHost specified"
                  failure="true"
              fi
          fi
      fi
      
          # Appelez l'utilitaire de collectivité
      if [[ $failure == false ]]; then
      
          /opt/ibm/wlp/bin/collective remove defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword  --hostName=$dockerHost --autoAcceptCertificates
      
      else
          # Au moins un paramètre obligatoire était manquant, 
          # indiquez la syntaxe correct à l'utilisateur
          printf "Usage:  removeMember <containerName> \n\t--host=<controller host> \n\t--port=<controller https port> \n\t--user=<controller user> \n\t--password=<controller password> \n\t--dockerHost=<docker host> \n"
      fi
    2. Configurez le fichier server.xml pour être utilisé avec le fichier Dockerfile, par exemple :
      <server description="Default Server">
         <featureManager>
            <feature>webProfile-6.0</feature>
         </featureManager>
      
         <httpEndpoint id="defaultHttpEndpoint"
                       httpPort="${memberHttpPort}"
                       httpsPort="${memberHttpsPort}" />
      
      </server>
    3. Assurez-vous que le fichier server.xml du contrôleur de collectivité contient des instructions qui définissent le nom d'utilisateur et le mot de passe du contrôleur et les variables de déploiement, par exemple :
         <collectiveController user="admin" password="adminpwd" />
      ... 
         <deployVariable name="memberHttpPort" value="9090" increment="1"/> 
         <deployVariable name="memberHttpsPort" 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. Exécutez la commande de génération Docker pour créer l'image.
      1. Copiez le fichier Dockerfile, les scripts joinMember et removeMember et le fichier server.xml nommé dans le fichier Dockerfile sur un ordinateur ayant Docker installé. Placez les fichiers dans le même répertoire.
      2. Ouvrez une fenêtre de commande au niveau du répertoire contenant les fichiers.
      3. Exécutez la commande Docker pour créer l'image :
        docker build -t image_name .
      4. Vérifiez la création d'image. La commande suivante renvoie le nom de l'image lorsque la création aboutit.
        images docker
    5. Facultatif : Publiez l'image Docker sur un concentrateur Docker.
      1. Connectez-vous à l'hôte à l'aide de Telnet ou de SSH par exemple.
      2. Connectez-vous au registre Docker.
      3. Téléchargez l'image Docker dans le registre en exécutant une commande telle que :
        docker push nom_image
  2. Enregistrez l'hôte Docker cible avec le contrôleur de collectivité.

    L'enregistrement d'un hôte permet au contrôleur de collectivité d'extraire l'image Docker depuis le registre vers cet hôte, ainsi que d'accéder aux fichiers, aux commandes et aux autres ressources se trouvant sur l'hôte. Utilisez la commande 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.

    wlp/bin/collective registerHost targetHost --host=controllerHost --port=controllerHTTPSPort --user=controllerAdmin --password=controllerAdminPassword --rpcUser=osUser --rpcUserPassword=osUserPassword

    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 Enregistrement des ordinateurs hôte auprès d'une collectivité Liberty.

  3. Si l'image Docker à déployer est stockée dans un registre au lieu d'être disponible localement sur l'hôte Docker sur lequel vous allez déployer, vous pouvez configurer le contrôleur de collectivité pour accéder au registre. Voir Configuration d'un registre Docker pour son utilisation par un contrôleur de collectivité.
  4. Examinez les règles de déploiement disponibles.
    1. Appelez une API REST renvoyant les règles de déploiement disponibles.
      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, par exemple :

      {"rules":
      [
        {"id":"Liberty Docker Rule","description":"Deploy rule for Liberty containers.","type":"docker","deployCommands":"docker 
        run -d -e LICENSE=accept --net=host --name=${containerName} ${imageName} ; docker exec 
        -t ${containerName} bash /opt/ibm/docker/joinMember ${containerName} --clusterName=${clusterName} 
        --dockerHost=${wlp.deploy.host} --host=${wlp.admin.host} --port=${wlp.admin.port}
        --user=${wlp.admin.user} --password=${wlp.admin.password}
        --keystorePassword=${containerName}","undeployCommands":"docker rm ${containerName} ; 
        docker rmi
        ${imageName}","startCommands":"docker start
        ${containerName}","stopCommands":"docker stop 
        ${containerName}","retartCommands":" ","inputVariables":[
         {"name":"containerName","type":"String","description":"Name of Liberty Docker container.","defaultValue":"${imageName}_container"},
         {"name":"imageName","type":"String","description":"Name of Liberty Docker image."},
         {"name":"clusterName","type":"String","description":"Name of Liberty Docker container cluster.","defaultValue":"${imageName}_cluster"}
      ]}
    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).
  5. Déployez l'image Docker.

    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 par exemple l'image Docker à utiliser et le nom du 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": "Liberty Docker Rule", 
       "hosts": [ "myHostName" ],
       "variables": [
          { "name":"imageName", "value":"myImageName" },
          { "name":"containerName", "value":"myContainerName" },
          { "name":"clusterName", "value":"myClusterName" },
          { "name":"keystorePassword", "value":"thePassword" }
       ]
    }

    Par exemple, si le jeton de retour est {"id":3}, vous pouvez utiliser cette valeur pour obtenir l'état et les résultats.

Que faire ensuite

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

  • Obtenez une liste de jetons 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"}}
  • 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}]}
Annulez le déploiement d'un conteneur Docker. 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. La variable userDir doit être Docker.
  • Annulation du déploiement d'un conteneur.
    POST
    https://hôte_contrôleur:port_contrôleur/ibm/api/collective/v1/deployment/undeploy
    {     
       "host": "myHostName",
       "userDir":"Docker",     
       "serverName":"myContainerName"
    }
  • 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_docker
Nom du fichier : twlp_deployservice_docker.html