
使用部署 REST API 來部署 Liberty Docker 儲存器
您可以使用 DeployService REST API,將 Docker 儲存器中的 Liberty 伺服器部署成群體的成員。
開始之前
決定要在其中安裝 Docker 映像檔的目標主機。將 Docker 安裝在目標主機上。每一個目標主機都需要 RXA 或 SSH。請參閱設定 Liberty 群體作業的 RXA。
觀看:WASdev 文章中的利用「WebSphere Liberty 群體」來管理內部部署的 Polyglot 環境視訊,會補充說明這個主題中的程序。
程序
- 建立 Docker 映像檔。
- 使用 Dockerfile 來建立一個 Liberty 映像檔。
下列 Dockerfile 範例可建立 Liberty Network Deployment 映像檔。Docker Hub 上提供的映像檔無法存取 Network Deployment 特性,例如 scalingMember-1.0。請使用這個檔案來建立 Liberty Network Deployment 映像檔。您可以使用最後一行,將要使用的應用程式複製到 Docker 映像檔。
# # 用來建立 Liberty Network Deployment 映像檔的 Dockerfile # # 此 Dockerfile 假設: # - 啟用 Script (joinMember, removeMember) 的群體將放在 # Docker 儲存器中的 /opt/ibm/docker 內 # - WebSphere Liberty 會安裝在 /opt/ibm/wlp # - WebSphere Liberty 伺服器會是 "defaultServer" # (例如 /opt/ibm/wlp/usr/servers/defaultServer) # - Docker 儲存器使用 --net=host 來執行,因此不會有任何埠明確 # 匯出至這個檔案 FROM websphere-liberty # # 使用儲存器自動啟動 Liberty 伺服器 # ENTRYPOINT ["/opt/ibm/wlp/bin/server", "run", "defaultServer"] # # # # 新增啟用 Script 的群體 # ADD joinMember /opt/ibm/docker/ RUN chmod +x /opt/ibm/docker/joinMember ADD removeMember /opt/ibm/docker/ RUN chmod +x /opt/ibm/docker/removeMember # # 更新作業系統 # RUN apt-get update # # 新增其他必要的特性 # RUN installUtility install --acceptLicense scalingMember-1.0 clusterMember-1.0 collectiveMember-1.0 ADD server.xml /opt/ibm/wlp/usr/servers/defaultServer/ # # 插入您的應用程式檔案名稱。此陳述式會複製應用程式 # 到 Docker 映像檔。 # ADD application_file /opt/ibm/wlp/usr/servers/defaultServer/dropins/註: Docker 映像檔具有 joinMember Script,用來將 Docker 儲存器中的成員伺服器,加入到群體控制器:
Docker 映像檔還具有 removeMember Script,用來將 Docker 儲存器中的成員伺服器從群體移除:#!/bin/bash # # 用來將 Liberty Docker 儲存器加入到群體控制器的 Script。 # # 必要:<containerName> - 位置參數,是這個 Docker 儲存器 # 的名稱 # --host - 群體控制器主機名稱 # --port - 群體控制器 https 埠 # --user - 具有管理權的群體控制器使用者 # --password - 具有管理權的群體控制器使用者密碼 # --keystorePassword - 用於成員金鑰儲存庫 # --dockerHost - 此儲存器所在之 Docker 主機的主機名稱 # # Optional: --clusterName - 成員配置的叢集名稱。 # 若有指定,也會新增叢集與調整作業 # 成員特性。 # # 設定起始值 containerName=$1 # 剖析指令行 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 # 驗證必要的參數 if [[ -z "$containerName" ]]; then echo "Error: no containerName specified, validation suspended" failure="true" fi # 如果沒有指定 containerName,bash 會使用 # 第一個 "--" 參數作為 containerName if [[ $containerName == --* ]]; then echo "Error: no containerName specified, validation suspended" failure="true" fi # 當位置參數 containerName 失敗時, # 會暫停產生驗證報告 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 fifi if [[ $failure == false ]]; then # 為 Liberty Docker 成員建立 env.properties 檔 echo containerName=$containerName > /opt/ibm/docker/env.properties echo containerHost=$dockerHost >> /opt/ibm/docker/env.properties # 呼叫群體公用程式 /opt/ibm/wlp/bin/collective join defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword --hostName=$dockerHost --createConfigFile --keystorePassword=$memberKeystorePassword --autoAcceptCertificates --genDeployVariables # 建置其他的配置 dropin Snippet 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 # 將配置 Snippet 移至適當位置以供耗用 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 fielse # 遺漏至少一個必要參數, # 將正確語法通知使用者 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#!/bin/bash # 用來將 Liberty Docker 儲存器從群體控制器移除的 Script。 # # 必要:<containerName> - 位置參數,# 是這個 Docker 儲存器的名稱 # --host - 群體控制器主機名稱 # --port - 群體控制器 https 埠 # --user - 具有管理權的群體控制器使用者 # --password - 具有管理權的群體控制器使用者密碼 # --dockerHost - 此儲存器所在之 Docker 主機的主機名稱 # # # 設定起始值 containerName=$1 # 剖析指令行 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 # 驗證必要的參數 if [[ -z "$containerName" ]]; then echo "Error: no containerName specified, validation suspended" failure="true" fi # 如果沒有指定 containerName,bash 會使用 # 第一個 "--" 參數作為 containerName if [[ $containerName == --* ]]; then echo "Error: no containerName specified, validation suspended" failure="true" fi # 當位置參數 containerName 失敗時, # 會暫停產生驗證報告 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 fifi # 呼叫群體公用程式 if [[ $failure == false ]]; then /opt/ibm/wlp/bin/collective remove defaultServer --host=$controllerHost --port=$controllerPort --user=$controllerUser --password=$controllerPassword --hostName=$dockerHost --autoAcceptCertificates else # 遺漏至少一個必要參數, # 將正確語法通知使用者 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 - 配置 server.xml 檔,以便與 Dockerfile 搭配使用;例如:
<server description="Default Server"> <featureManager> <feature>webProfile-6.0</feature> </featureManager> <httpEndpoint id="defaultHttpEndpoint" httpPort="${memberHttpPort}" httpsPort="${memberHttpsPort}" /> </server> - 確定群體控制器 server.xml 檔具有陳述式,來定義控制器使用者名稱與密碼以及部署變數;例如:
<collectiveController user="admin" password="adminpwd" /> ... <deployVariable name="memberHttpPort" value="9090" increment="1"/> <deployVariable name="memberHttpsPort" value="9453" increment="1"/>部署變數所設定的值,必須可讓每一個成員在目標主機上具有唯一的埠號。請參閱DeployVariable (deployVariable)。
- 執行 Docker build 指令,來建立映像檔。
- 將 Dockerfile、joinMember 和 removeMember Script,以及 Dockerfile 中指名的 server.xml 檔,複製到已安裝 Docker 的電腦中。將檔案放在相同目錄中。
- 在保留檔案的目錄中開啟指令視窗。
- 執行 Docker 指令,以建立映像檔:
docker build -t image_name。 - 驗證映像檔已建立。下列指令會在建立成功時傳回映像檔名稱。
docker images
- 選擇性的: 將 Docker 映像檔公佈在 Docker Hub 上。
- 使用 Telnet 或 SSH 等登入主機。
- 登入 Docker 登錄。
- 執行指令將 Docker 映像檔上傳至登錄,例如:
docker push image_name
- 使用 Dockerfile 來建立一個 Liberty 映像檔。
- 向群體控制器登錄目標 Docker 主機。
透過登錄主機,可讓群體控制器將登錄中的 Docker 映像檔取出到該主機,以及存取主機上的檔案、指令和其他資源。請利用 registerHost 指令,來登錄目標主機。查看控制器的 server.xml 檔,尋找 --host、--port、--user 和 --password 參數的值。如果不想使用 SSH 私密金鑰檔,例如針對 Linux 或 Windows 作業系統上的目標主機,請設定 --rpcUser 和 --rpcUserPassword 參數,以包含作業系統的登入使用者和密碼。--rpcUser 指定的使用者對於目標部署位置必須具備作業系統權限。
wlp/bin/collective registerHost targetHost --host=controllerHost --port=controllerHTTPSPort --user=controllerAdmin --password=controllerAdminPassword --rpcUser=osUser --rpcUserPassword=osUserPassword如果主機已登錄,您可以使用 updateHost 指令來重設登錄資訊。如需相關資訊,請參閱向 Liberty 群體登錄主機。
- 如果要部署的 Docker 映像檔儲存在登錄中,而非儲存在您要部署的 Docker 主機中以供本端使用,您可以將群體控制器配置成存取登錄。請參閱配置 Docker 登錄以供群體控制器使用。
- 檢閱可用的部署規則。
- 呼叫 REST API,以傳回可用的部署規則。
GET https://controller_host:controller_port/ibm/api/collective/v1/deployment/rule這項呼叫會以 JSON 結構傳回部署規則;例如:
{"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"} ]} - 必要的話,請將 DeployRules 新增至控制器配置,來建立您自己的部署規則。請參閱部署規則 (deployRule)。
- 呼叫 REST API,以傳回可用的部署規則。
- 部署 Docker 映像檔。
部署規則含有一些變數,可用來指定作業的輸入值,例如,要使用的 Docker 映像檔,以及要建立的儲存器名稱。回覆內文含有記號,可用來要求狀態和結果。
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" } ] }例如,回覆記號可能是 {"id":3},可用來取得狀態和結果。
下一步
要求和檢閱部署狀態和結果。
- 取得所要求之部署作業的記號清單。
GET https://controller_host:controller_port/ibm/api/collective/v1/deployment/deploy - 取得部署作業的簡短狀態。將步驟 4 中的記號用於
{token}。因此,以步驟 4 中的 {"id":3} 回覆記號來說,請將 3 用於
{token}。
在部署期間,API 會傳回 IN_PROGRESS:GET https://controller_host:controller_port/ibm/api/collective/v1/deployment/{token}/status
在部署之後,API 會傳回 FINISHED:{"status":{"target_host":"IN_PROGRESS"}}{"status":{"target_host":"FINISHED"}} - 取得部署作業的完整結果。將步驟 4 中的記號用於
{token}。因此,以步驟 4 中的 {"id":3} 回覆記號來說,請將 3 用於
{token}。
在部署完成之後,結果會包含該作業的相關資訊。下列範例顯示 FINISHED 的結果:GET https://controller_host:controller_port/ibm/api/collective/v1/deployment/{token}/results{"results":[{"host_name":"target_host","status":"FINISHED","result":0}]}
- 取消部署儲存器。
POST https://controller_host:controller_port/ibm/api/collective/v1/deployment/undeploy { "host": "myHostName", "userDir":"Docker", "serverName":"myContainerName" } - 取得取消部署作業的記號清單。
如果要取得狀態和結果,請遵循類似於部署的步驟。GET https://controller_host:controller_port/ibm/api/collective/v1/deployment/undeploy
作業主題
前次更新: 2016 年 6 月 3 日http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-dist&topic=twlp_deployservice_docker
檔名:twlp_deployservice_docker.html
