Für LINUX-Plattformen

Liberty-Docker-Container mit REST-Implementierungs-APIs implementieren

Mit den DeployService-REST-APIs können Sie Liberty-Server als Member eines Verbunds in Docker-Containern implementieren.

Vorbereitende Schritte

Legen Sie die Zielhosts fest, auf denen Sie ein Docker-Image installieren möchten. Installieren Sie Docker auf den Zielhosts. Jeder Zielhost benötigt RXA oder SSH. Informationen hierzu finden Sie unter RXA für Operationen des Liberty-Verbunds einrichten.

Multimedia Hinweis: Das Video Managing an On-Premise, Polyglot Environment with WebSphere Liberty Collectives in einem WASdev-Artikel ergänzt die in diesem Abschnitt beschriebene Prozedur.

Vorgehensweise

  1. Erstellen Sie ein Docker-Image.
    1. Verwenden Sie eine Docker-Datei, um ein Liberty-Image zu erstellen.

      Die folgende Docker-Beispieldatei kann ein Liberty Network Deployment-Image erstellen. Das auf dem Docker-Hub verfügbare Image kann nicht auf Network Deployment-Features wie scalingMember-1.0 zugreifen. Verwenden Sie diese Datei zum Erstellen eines Liberty Network Deployment-Image. Sie können die letzte Zeile verwenden, um eine Anwendung in das Docker-Image zu kopieren.

      # 
      # Docker-Datei zum Erstellen eines Liberty Network Deployment-Image
      #
      # Diese Docker-Datei geht von folgenden Voraussetzungen aus:
      # - Die Scripts für die Verbundaktivierung (joinMember, removeMember) werden in den Pfad
      #   /opt/ibm/docker im Docker-Container kopiert.
      # - WebSphere Liberty wird in /opt/ibm/wlp installiert.
      # - Der WebSphere Liberty-Server ist "defaultServer"
      #   (z. B. /opt/ibm/wlp/usr/servers/defaultServer).
      # - Der Docker-Container wird mit --net=host ausgeführt, sodass keine Ports
      #   explizit in diese Datei exportiert werden.
      
      FROM websphere-liberty
      
      #
      # Liberty-Server automatisch mit dem Container starten
      #
      ENTRYPOINT ["/opt/ibm/wlp/bin/server", "run", "defaultServer"]
      #
      #
      
      #
      # Scripts für Verbundaktivierung hinzufügen
      #
      ADD joinMember /opt/ibm/docker/
      RUN chmod +x /opt/ibm/docker/joinMember
      ADD removeMember /opt/ibm/docker/
      RUN chmod +x /opt/ibm/docker/removeMember
      
      #
      # Betriebssystem aktualisieren
      #
      RUN apt-get update
      
      #
      # Weitere erforderliche Features hinzufügen
      #
      RUN installUtility install --acceptLicense scalingMember-1.0 clusterMember-1.0
      collectiveMember-1.0
      
      ADD server.xml /opt/ibm/wlp/usr/servers/defaultServer/
      
      #
      # Dateinamen der Anwendung einfügen. Diese Anweisung kopiert die Anwendung in das
      # Docker-Image.
      # 
      ADD Anwendungsdatei /opt/ibm/wlp/usr/servers/defaultServer/dropins/
      Anmerkung: Das Docker-Image enthält ein Script joinMember, das den Member-Server im Docker-Container mit einem Verbundcontroller verknüpft:
      #!/bin/bash
      
      #
      # Script zum Verknüpfen eines Liberty-Docker-Containers mit einem Verbundcontroller.
      #
      # Erforderlich: <containerName> - positionsgebundener Parameter, der den Namen
      #                             dieses Docker-Containers angibt
      #           --host - Hostname des Verbundcontrollers
      #           --port - HTTPS-Port des Verbundcontrollers
      #           --user - Verbundcontrolleradministrator
      #           --password - Kennwort des Verbundcontrolleradministrators
      #           --keystorePassword - Kennwort für den Member-Keystore
      #           --dockerHost - Hostname des Docker-Hosts, auf dem sich dieser Container befindet
      #
      # Optional: --clusterName - Clustername für die Memberkonfiguration.
      #                           Wenn der Clustername angegeben wird, werden auch die
      #                           Skalierungsfeatures für Cluster und Member hinzugefügt.
      #
      
      # Anfangswerte festlegen
      
      containerName=$1
      
      # Befehlszeile parsen
      
      failure="false"
      
      if [[ -z $1 ]]; then
          # Keine Werte empfangen
          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
      
          # Erforderliche Parameter validieren
          if [[ -z "$containerName" ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
      
          # if a containerName is not specified, bash uses the 
          # 1st "--" parameter as the containerName
      
          if [[ $containerName == --* ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
          
          # Tritt ein Fehler in Bezug auf den positionsgebundenen Parameter containerName auf,
          # Validierungsberichte aussetzen
          
          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
          # Datei env.properties für das Liberty-Docker-Member erstellen
      
          echo containerName=$containerName > /opt/ibm/docker/env.properties
          echo containerHost=$dockerHost >> /opt/ibm/docker/env.properties
      
      
          # Verbunddienstprogramm aufrufen
      
          /opt/ibm/wlp/bin/collective join defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword --hostName=$dockerHost --createConfigFile --keystorePassword=$memberKeystorePassword --autoAcceptCertificates --genDeployVariables
      
      
          # Weitere Konfigurations-Drop-in-Snippets erstellen
      
          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
      
      
          # Konfigurationssnippets zur Verwendung an die richtige Position verschieben
      
          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
          # Mindestens ein erforderlicher Parameter fehlt -
          # Benutzer über die richtige Syntax informieren
          printf "Syntax: joinMember <Containername> \n\t--host <Controller-Host> \n\t--port <HTTPS-Port des Controllers> \n\t--user <Controllerbenutzer> \n\t--password <Controllerkennwort> \n\t--keystorePassword <Kennwort für Member-Keystore> \n\t--dockerHost <Hostname des Docker-Hosts> \n\t[--clusterName <Clustername für das Member>]\n"
      fi
      Das Docker-Image enthält auch ein Script removeMember, das den Member-Server im Docker-Container aus dem Verbund entfernt:
      #!/bin/bash
      
      # Script zum Entfernen eines Liberty-Docker-Containers aus einem Verbundcontroller.
      #
      # Erforderlich: <Containername> - positionsgebundener Parameter, der den Namen
      #                             dieses Docker-Containers angibt
      #           --host - Hostname des Verbundcontrollers
      #           --port - HTTPS-Port des Verbundcontrollers
      #           --user - Verbundcontrolleradministrator
      #           --password - Kennwort des Verbundcontrolleradministrators
      #           --dockerHost - Hostname des Docker-Hosts, auf dem sich dieser Container befindet
      #
      #
      
      # Anfangswerte festlegen
      
      containerName=$1
      
      # Befehlszeile parsen
      
      failure="false"
      
      if [[ -z $1 ]]; then
          # Keine Werte empfangen
          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
      
          # Erforderliche Parameter validieren
          if [[ -z "$containerName" ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
      
          # if a containerName is not specified, bash uses the 
          # 1st "--" parameter as the containerName
      
          if [[ $containerName == --* ]]; then
              echo "Error: no containerName specified, validation suspended"
              failure="true"
          fi
      
          # Tritt ein Fehler in Bezug auf den positionsgebundenen Parameter containerName auf,
          # Validierungsberichte aussetzen
      
          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
      
          # Verbunddienstprogramm aufrufen
      if [[ $failure == false ]]; then
      
          /opt/ibm/wlp/bin/collective remove defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword  --hostName=$dockerHost --autoAcceptCertificates
      
      else
          # Mindestens ein erforderlicher Parameter fehlt -
          # Benutzer über die richtige Syntax informieren
          printf "Syntax: removeMember <Containername> \n\t--host=<Controller-Host> \n\t--port=<HTTPS-Port des Controllers> \n\t--user=<Controllerbenutzer> \n\t--password=<Controllerkennwort> \n\t--dockerHost=<Docker-Host> \n"
      fi
    2. Konfigurieren Sie die Datei server.xml für die Docker-Datei, z. B.:
      <server description="Default Server">
         <featureManager>
            <feature>webProfile-6.0</feature>
         </featureManager>
      
         <httpEndpoint id="defaultHttpEndpoint"
                       httpPort="${memberHttpPort}"
                       httpsPort="${memberHttpsPort}" />
      
      </server>
    3. Stellen Sie sicher, dass die Verbundcontrollerdatei server.xml Anweisungen enthält, die den Benutzernamen und das Kennwort für den Controller sowie Implementierungsvariablen definiert, z. B.:
         <collectiveController user="admin" password="adminpwd" />
      ... 
         <deployVariable name="memberHttpPort" value="9090" increment="1"/> 
         <deployVariable name="memberHttpsPort" value="9453" increment="1"/>

      Die Implementierungsvariablen müssen Werte setzen, die es jedem Member ermöglichen, eine eindeutige Portnummer auf den Zielhosts zu haben. Informationen hierzu finden Sie unter DeployVariable (deployVariable).

    4. Führen Sie den Docker-Befehl "build" aus, um das Image zu erstellen.
      1. Kopieren Sie die Docker-Datei, die Scripts joinMember und removeMember und die in der Docker-Datei angegebene Datei server.xml auf einen Computer, auf dem Docker installiert ist. Speichern Sie die Dateien in demselben Verzeichnis.
      2. Öffnen Sie ein Befehlsfenster in dem Verzeichnis, in dem die Dateien enthalten sind.
      3. Führen Sie den Docker-Befehl zum Erstellen des Image aus:
        docker build -t Imagename .
      4. Überprüfen Sie die Imageerstellung. Der folgende Befehl gibt den Imagenamen zurück, wenn die Erstellung erfolgreich war.
        docker images
    5. Optional: Übertragen Sie das Docker-Image auf einen Docker-Hub.
      1. Melden Sie sich an dem Host an, z. B. mit Telnet oder SSH.
      2. Melden Sie sich bei der Docker-Registry an.
      3. Laden Sie das Docker-Image mit einem Befehl wie dem folgenden in die Registry hoch:
        docker push Imagename
  2. Registrieren Sie den Docker-Zielhost beim Verbundcontroller.

    Durch das Registrieren eines Hosts kann der Verbundcontroller das Docker-Image aus der Registry auf diesen Host extrahieren und auf Dateien, Befehle und andere Ressourcen auf dem Host zugreifen. Verwenden Sie zum Registrieren des Zielhosts den Befehl registerHost. Suchen Sie in der Datei server.xml des Controllers nach den Werten für die Parameter --host, --port, --user und --password. Definieren Sie mit den Parametern --rpcUser und --rpcUserPassword einen Benutzer und ein Kennwort für die Betriebssystemanmeldung, damit keine SSH-Datei mit privatem Schlüssel wie für Zielhosts mit Linux- oder Windows-Betriebssystemen verwendet werden muss. Der mit --rpcUser angegebene Benutzer muss über die Betriebssystemrechte für die Zielimplementierungsposition verfügen.

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

    Wenn bereits ein Host registriert ist, können Sie den Befehl updateHost verwenden, um die Registrierungsinformationen neu zu definieren. Weitere Informationen finden Sie unter Host-Computer bei einem Liberty-Verbund registrieren.

  3. Wenn das zu implementierende Docker-Image in einer Registry und nicht lokal auf dem Docker-Host, auf dem Sie die Implementierung durchführen, gespeichert ist, können Sie den Verbundcontroller für den Zugriff auf die Registry konfigurieren.Informationen hierzu finden Sie unter Docker-Registry für einen Verbundcontroller konfigurieren.
  4. Sehen Sie sich die verfügbaren Implementierungsregeln an.
    1. Rufen Sie eine REST-API auf, die die verfügbaren Implementierungsregeln zurückgibt.
      GET https://Controller-Host:Controller-Port/ibm/api/collective/v1/deployment/rule

      Der Aufruf gibt die Implementierungsregeln in einer JSON-Struktur zurück, z. B.:

      {"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. Erstellen Sie bei Bedarf eigene Implementierungsregeln, indem Sie DeployRules zu Ihrer Controllerkonfiguration hinzufügen. Informationen hierzu finden Sie unter Implementierungsregel (deployRule).
  5. Implementieren Sie das Docker-Image.

    Die Implementierungsregel enthält Variablen, die Sie verwenden können, um Eingabewerte für die Operation anzugeben, wie z. B. das zu verwendende Docker-Image oder den Namen des zu erstellenden Containers. Der Hauptteil der Rückgabe enthält ein Token, das Sie zum Anfordern von Status und Ergebnissen verwenden können.

    POST https://Controller-Host:Controller-Port/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" }
       ]
    }

    Das Rückgabetoken könnte beispielsweise {"id":3} sein und Sie könnten dieses Token zum Abrufen des Status und der Ergebnisse verwenden.

Nächste Schritte

Fordern Sie den Implementierungsstatus und die Ergebnisse an und überprüfen Sie sie.

  • Rufen Sie eine Liste der Token für angeforderte Implementierungsoperationen ab.
    GET https://Controller-Host:Controller-Port/ibm/api/collective/v1/deployment/deploy
  • Rufen Sie den Kurzstatus der Implementierungsoperationen ab. Verwenden Sie das Token aus Schritt 4 für {token}. Verwenden Sie also für das Rückgabetoken {"id":3} aus Schritt 3 für {token}.
    GET https://Controller-Host:Controller-Port/ibm/api/collective/v1/deployment/{token}/status 
    Während der Implementierung gibt die API IN_PROGRESS zurück:
    {"status":{"Zielhost":"IN_PROGRESS"}}
    Nach der Implementierung gibt die API FINISHED zurück:
    {"status":{"Zielhost":"FINISHED"}}
  • Rufen Sie die vollständigen Ergebnisse einer Implementierungsoperation ab. Verwenden Sie das Token aus Schritt 4 für {token}. Verwenden Sie also für das Rückgabetoken {"id":3} aus Schritt 3 für {token}.
    GET https://Controller-Host:Controller-Port/ibm/api/collective/v1/deployment/{token}/results 
    Nach Abschluss der Implementierung enthalten die Ergebnisse Informationen zur Operation. Das folgende Beispiel zeigt die Ergebnisse für FINISHED:
    {"results":[{"Hostname":"Zielhost","status":"FINISHED","result":0}]}
Deimplementieren Sie einen Docker-Container. Sie müssen keine Implementierungsregel angeben. Die für die Implementierung verwendete Regel wurde zur Implementierungszeit gespeichert. Sie können die Regel für die Deimplementierung verwenden. Die Variable userDir muss den Wert Docker haben.
  • Deimplementieren Sie einen Container.
    POST https://Controller-Host:Controller-Port/ibm/api/collective/v1/deployment/undeploy
    {     
       "host": "myHostName",
       "userDir":"Docker",     
       "serverName":"myContainerName"
    }
  • Rufen Sie eine Liste der Token für Deimplementierungsoperationen ab.
    GET https://Controller-Host:Controller-Port/ibm/api/collective/v1/deployment/undeploy
    Zum Abrufen des Status und der Ergebnisse führen Sie ähnliche Schritte wie für Implementierungen ab.

Symbol das den Typ des Artikels anzeigt. Taskartikel



Symbol für Zeitmarke Letzte Aktualisierung: 16.06.2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-dist&topic=twlp_deployservice_docker
Dateiname: twlp_deployservice_docker.html