Para plataformas LINUX

Despliegue de contenedores Liberty Docker utilizando API REST de despliegue

Puede desplegar servidores Liberty en contenedores Docker como miembros de un colectivo utilizando las API REST DeployService.

Antes de empezar

Determine los hosts de destino en los cuales desea instalar una imagen de Docker. Instale Docker en los hosts de destino. Cada host de destino necesita RXA o SSH. Consulte Configuración de RXA para operaciones de colectivo de Liberty.

Multimedia Ver: El vídeo Managing an On-Premise, Polyglot Environment with WebSphere Liberty Collectives de un artículo WASdev complementa el procedimiento en este tema.

Procedimiento

  1. Cree una imagen de Docker.
    1. Utilice un Dockerfile para crear una imagen de Liberty.

      El ejemplo siguiente de Dockerfile puede crear una imagen de Liberty Network Deployment. La imagen que está disponible en el hub Docker no puede acceder a las características de Network Deployment como, por ejemplo, scalingMember-1.0. Utilice este archivo para crear una imagen de Liberty Network Deployment. Puede utilizar la última línea para copiar una aplicación para su uso en la imagen de Docker.

      # 
      # Dockerfile para crear una imagen de Liberty Network Deployment
      #
      # Este Dockerfile presupone que:
      # - El colectivo que habilita scripts (joinMember,
      removeMember) se colocará en
      #   /opt/ibm/docker en el contenedor Docker
      # - WebSphere Liberty se instalará en /opt/ibm/wlp
      # - El servidor WebSphere Liberty será el "defaultServer"
      #   (por ejemplo, /opt/ibm/wlp/usr/servers/defaultServer)
      # - El contenedor Docker se ejecuta utilizando
      --net=host, así que ningún puerto se ha
      #   exportado explícitamente en este archivo
      
      FROM websphere-liberty
      
      #
      # Inicio automático del servidor Liberty con el contenedor
      #
      ENTRYPOINT ["/opt/ibm/wlp/bin/server", "run", "defaultServer"]
      #
      #
      
      #
      # Añadir colectivo que habilita scripts
      #
      ADD joinMember /opt/ibm/docker/
      RUN chmod +x /opt/ibm/docker/joinMember
      ADD removeMember /opt/ibm/docker/
      RUN chmod +x /opt/ibm/docker/removeMember
      
      #
      # Actualizar el sistema operativo
      #
      RUN apt-get update
      
      #
      # Añadir las características adicionales necesarias
      #
      RUN installUtility install --acceptLicense scalingMember-1.0
      clusterMember-1.0
      collectiveMember-1.0
      
      ADD server.xml /opt/ibm/wlp/usr/servers/defaultServer/
      
      #
      # Insertar el nombre de archivo de aplicación. Esta sentencia copia
      la aplicación
      # en la imagen de Docker.
      # 
      ADD archivo_aplicación
      /opt/ibm/wlp/usr/servers/defaultServer/dropins/
      Nota: La imagen de Docker tiene un script joinMember que une el servidor miembro en el contenedor Docker a un controlador colectivo:
      #!/bin/bash
      
      #
      # Script para unir un contenedor Liberty Docker a un
      controlador colectivo.
      #
      # Obligatorio: <containerName> - parámetro posicional que es el nombre
      #                             de este contenedor Docker
      #           --host - nombre de host de controlador colectivo
      #           --port - puerto https de controlador colectivo
      #           --user - usuario administrativo de controlador colectivo
      #           --password - contraseña de usuario administrativo de controlador colectivo
      #           --keystorePassword - para utilizarse para el almacén de claves de miembro.
      #           --dockerHost - nombre de host del host Docker en el que reside este contenedor
      #
      # Opcional: --clusterName - nombre de clúster para la configuración del miembro.
      #                           Si se especifica, añade también se añade las características de
      #                           clúster y escalado.
      #
      
      # Establecer valores iniciales
      
      containerName=$1
      
      # Analizar la línea de mandatos
      
      failure="false"
      
      if [[ -z $1 ]]; then
          # Ningún valor recibido
          echo "Error: no se han especificado parámetros"
          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
      
          # Validar los parámetros necesarios
          if [[ -z "$containerName" ]]; then
              echo "Error: no se ha especificado containerName, validación suspendida"
              failure="true"
          fi
      
          # si no se ha especificado un containerName, bash utiliza el
          # primer parámetro "--" como el containerName
      
          if [[ $containerName == --* ]]; then
              echo "Error: no se ha especificado containerName, validación suspendida"
              failure="true"
          fi
          
          # Cuando el parámetro posicional containerName falla,
          # suspender informes de validación
          
          if [[ $failure == false ]]; then
              if [[ -z "${controllerHost// }" ]]; then
                  echo "Error: ningún host especificado"
                  failure="true"
              fi
              if [[ -z "${controllerPort// }" ]]; then
                  echo "Error: ningún puerto especificado"
                  failure="true"
              fi
              if [[ -z "${controllerUser// }" ]]; then
                  echo "Error: ningún usuario especificado"
                  failure="true"
              fi
              if [[ -z "${controllerPassword// }" ]]; then
                  echo "Error: ninguna contraseña especificada"
                  failure="true"
              fi
              if [[ -z "${memberKeystorePassword// }" ]]; then
                  echo "Error: ninguna keystorePassword especificada"
                  failure="true"
              fi
              if [[ -z "${dockerHost// }" ]]; then
                  echo "Error: ningún dockerHost especificado"
                  failure="true"
              fi
          fi
      fi
      
      if [[ $failure == false ]]; then
          # Crear el archivo env.properties para el miembro de Liberty Docker
      
          echo containerName=$containerName > /opt/ibm/docker/env.properties
          echo containerHost=$dockerHost >> /opt/ibm/docker/env.properties
      
      
          # Invocar el programa de utilidad de colectivo
      
          /opt/ibm/wlp/bin/collective join defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword --hostName=$dockerHost --createConfigFile --keystorePassword=$memberKeystorePassword --autoAcceptCertificates --genDeployVariables
      
      
          # Crear fragmentos de dropin de config adicionales
      
          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 "Ningún clusterName proporcionado, el contenedor no
      se configurará como un miembro de clúster o escalado."
          fi
      
      
          # Mover fragmentos de config a la ubicación correcta para su consumo
      
          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
          # Al menos, faltaba un parámetro necesario,
          # notificar al usuario la sintaxis correcta
          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
      La imagen de Docker también tiene un script removeMember que elimina el servidor miembro en el contenedor Docker del colectivo:
      #!/bin/bash
      
      # Script para eliminar un contenedor Liberty Docker de un controlador colectivo.
      #
      # Obligatorio: <containerName> - parámetro posicional que es
      #                             el nombre de este contenedor Docker
      #           --host - nombre de host de controlador colectivo
      #           --port - puerto https de controlador colectivo
      #           --user - usuario administrativo de controlador colectivo
      #           --password - contraseña de usuario administrativo de controlador colectivo
      #           --dockerHost - nombre de host del host Docker en el que reside este contenedor
      #
      #
      
      # Establecer valores iniciales
      
      containerName=$1
      
      # Analizar la línea de mandatos
      
      failure="false"
      
      if [[ -z $1 ]]; then
          # Ningún valor recibido
          echo "Error: no se han especificado parámetros"
          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
      
          # Validar los parámetros necesarios
          if [[ -z "$containerName" ]]; then
              echo "Error: no se ha especificado containerName, validación suspendida"
              failure="true"
          fi
      
          # si no se ha especificado un containerName, bash utiliza el
          # primer parámetro "--" como el containerName
      
          if [[ $containerName == --* ]]; then
              echo "Error: no se ha especificado containerName, validación suspendida"
              failure="true"
          fi
      
          # Cuando el parámetro posicional containerName falla,
          # suspender informes de validación
      
          if [[ $failure == false ]]; then
              if [[ -z "${controllerHost// }" ]]; then
                  echo "Error: ningún host especificado"
                  failure="true"
              fi
              if [[ -z "${controllerPort// }" ]]; then
                  echo "Error: ningún puerto especificado"
                  failure="true"
              fi
              if [[ -z "${controllerUser// }" ]]; then
                  echo "Error: ningún usuario especificado"
                  failure="true"
              fi
              if [[ -z "${controllerPassword// }" ]]; then
                  echo "Error: ninguna contraseña especificada"
                  failure="true"
              fi
              if [[ -z "${dockerHost// }" ]]; then
                  echo "Error: ningún dockerHost especificado"
                  failure="true"
              fi
          fi
      fi
      
          # Invocar el programa de utilidad de colectivo
      if [[ $failure == false ]]; then
      
          /opt/ibm/wlp/bin/collective remove defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword  --hostName=$dockerHost --autoAcceptCertificates
      
      else
          # Al menos, faltaba un parámetro necesario,
          # notificar al usuario la sintaxis correcta
          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. Configure el archivo server.xml para utilizar con el Dockerfile; por ejemplo:
      <server description="Default Server">
         <featureManager>
            <feature>webProfile-6.0</feature>
         </featureManager>
      
         <httpEndpoint id="defaultHttpEndpoint"
                       httpPort="${memberHttpPort}"
                       httpsPort="${memberHttpsPort}" />
      
      </server>
    3. Asegúrese de que el archivo server.xml del controlador colectivo tiene sentencias que definen el nombre de usuario y la contraseña y las variables de despliegue del controlador; por ejemplo:
         <collectiveController user="admin"
      password="adminpwd" />
      ... 
         <deployVariable name="memberHttpPort" value="9090" increment="1"/>
         <deployVariable name="memberHttpsPort" value="9453"
      increment="1"/>

      Las variables de despliegue deben establecer valores que permiten a cada miembro tener un número de puerto exclusivo en los hosts de destino. Consulte DeployVariable (deployVariable).

    4. Ejecute el mandato de construcción Docker para crear la imagen.
      1. Copie el Dockerfile, los scripts joinMember y removeMember y el archivo server.xml nombrado en el Dockerfile en un equipo con Docker instalado. Coloque los archivos en el mismo directorio.
      2. Abra una ventana de mandatos en el directorio que contiene los archivos.
      3. Ejecute el mandato Docker para crear la imagen:
        docker
        build -t nombre_imagen .
      4. Verifique la creación de la imagen. El mandato siguiente devuelve el nombre de la imagen cuando la creación se ha realizado correctamente.
        imágenes de docker 
    5. Opcional: Publique la imagen de Docker en un hub de Docker.
      1. Inicie sesión en el host utilizando, por ejemplo, Telnet o SSH.
      2. Inicie sesión en el registro de Docker.
      3. Cargue la imagen de Docker en el registro ejecutando un mandato como:
        docker push
        nombre_imagen
  2. Registre el host Docker de destino con el controlador colectivo.

    El registro de un host permite al controlador colectivo extraer la imagen de Docker del registro para dicho host, así como también acceder a archivos, mandatos y otros recursos en el host. Utilice el mandato registerHost para registrar el host de destino. Consulte el archivo server.xml del controlador para encontrar los valores para los parámetros --host, --port, --user y --password. Para no utilizar un archivo de claves privado SSH como, por ejemplo, para hosts de destino en sistemas operativos Linux o Windows, incluya un usuario y una contraseña de inicio de sesión del sistema operativo estableciendo los parámetros --rpcUser y --rpcUserPassword. El usuario especificado por --rpcUser debe tener derechos de sistema operativo sobre la ubicación de despliegue de destino.

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

    Si un host ya está registrado, puede utilizar el mandato updateHost para restablecer la información de registro. Para obtener más información, consulte Registro de sistemas principales con un colectivo de Liberty.

  3. Si la imagen de Docker que se va a desplegar está almacenada en un registro, en lugar de disponible localmente en el host de Docker donde realizará el despliegue, puede configurar el controlador colectivo para acceder al registro. Consulte Configuración de un registro Docker para ser utilizado por un controlador colectivo.
  4. Revise las reglas de despliegue disponibles.
    1. Invoque una API REST que devuelva las reglas de despliegue disponibles.
      GET
      https://host_controlador:puerto_controlador/ibm/api/collective/v1/deployment/rule 

      La invocación devuelve las reglas de despliegue en la estructura JSON; por ejemplo:

      {"rules":
      [
        {"id":"Liberty Docker Rule","description":"Regla de despliegue
      para contenedores Liberty." ,"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":"Nombre
      del contenedor Liberty Docker.","defaultValue":"${imageName}_container"},
         {"name":"imageName","type":"String","description":"Nombre de la
      imagen de Liberty Docker."},
         {"name":"clusterName","type":"String","description":"Nombre del
      clúster del contenedor Liberty Docker.","defaultValue":"${imageName}_cluster"}
      ]}
    2. Si es necesario, cree sus propias reglas de despliegue añadiendo DeployRules a la configuración de controlador. Consulte Regla de despliegue (deployRule).
  5. Despliegue la imagen de Docker.

    La regla de despliegue contiene variables que puede utilizar para especificar un valor de entrada para la operación como, por ejemplo, la imagen de Docker para utilizar y el nombre del contenedor para crear. El cuerpo de retorno contiene una señal que puede utilizar para solicitar el estado y los resultados.

    POST
    https://host_controlador:puerto_controlador/ibm/api/collective/v1/deployment/deploy
    
    {
       "rule": "Regla de Liberty Docker",
       "hosts": [ "myHostName" ],
       "variables": [
          { "name":"imageName", "value":"myImageName" },
          { "name":"containerName", "value":"myContainerName" },
          { "name":"clusterName", "value":"myClusterName" },
          { "name":"keystorePassword", "value":"thePassword" }
       ]
    }

    Por ejemplo, la señal de retorno podría ser {"id":3}, que puede utilizar para obtener el estado y los resultados.

Qué hacer a continuación

Solicite y revise el estado y los resultados del despliegue.

  • Obtenga una lista de señales para operaciones de despliegue solicitadas.
    GET
    https://host_controlador:puerto_controlador/ibm/api/collective/v1/deployment/deploy
  • Obtenga un estado abreviado de las operaciones de despliegue. Utilice la señal del paso 4 para {token}. De esta forma para una señal de retorno {"id":3} del paso 4, utilice 3 for {token}.
    GET
    https://host_controlador:puerto_controlador/ibm/api/collective/v1/deployment/{token}/status 
    Durante el despliegue, la API devuelve IN_PROGRESS:
    {"status":{"host_destino":"IN_PROGRESS"}}
    Tras el despliegue, la API devuelve FINISHED:
    {"status":{"host_destino":"FINISHED"}}
  • Obtenga los resultados completos de una operación de despliegue. Utilice la señal del paso 4 para {token}. De esta forma para una señal de retorno {"id":3} del paso 4, utilice 3 for {token}.
    GET
    https://host_controlador:puerto_controlador/ibm/api/collective/v1/deployment/{token}/results
    Una vez completado el despliegue, los resultados contienen información sobre la operación. El ejemplo siguiente muestra resultados para FINISHED:
    {"results":[{"nombre_host":"host_destino","status":"FINISHED","result":0}]}
Anule el despliegue de un contenedor Docker. No tendrá que especificar una regla de despliegue. La regla utilizada para el despliegue se ha almacenado durante el despliegue. Puede utilizar la regla para la anulación del despliegue. La variable userDir debe ser Docker.
  • Anule el despliegue de un contenedor.
    POST
    https://host_controlador:puerto_controlador/ibm/api/collective/v1/deployment/undeploy
    {     
       "host": "myHostName",
       "userDir":"Docker",
       "serverName":"myContainerName"
    }
  • Obtenga una lista de señales para operaciones de anulación de despliegue.
    GET
    https://host_controlador:puerto_controlador/ibm/api/collective/v1/deployment/undeploy
    Para obtener el estado y los resultados, siga pasos similares a despliegues.

Icono que indica el tipo de tema Tema de tarea



Icono de indicación de fecha y hora Última actualización: Friday, 16 September 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-dist&topic=twlp_deployservice_docker
Nombre de archivo:twlp_deployservice_docker.html