CLI使用 · shipyard中文文檔

這篇文檔描述怎樣使用Shipyard CLI（command line interface）來工作。 ## 查看幫助 ~~~ shipyard cli> shipyard help NAME: shipyard - manage a shipyard cluster USAGE: shipyard [global options] command [command options] [arguments...] VERSION: 2.0.3 COMMANDS: login login to a shipyard cluster change-password update your password accounts show accounts add-account add account delete-account delete account containers list containers inspect inspect container run run a container stop stop a container restart restart a container scale scale a container logs show container logs destroy destroy a container engines list engines add-engine add shipyard engine remove-engine removes an engine inspect-engine inspect an engine service-keys list service keys add-service-key adds a service key remove-service-key removes a service key extensions show extensions add-extension add extension remove-extension remove an extension webhook-keys list webhook keys add-webhook-key adds a webhook key remove-webhook-key removes a webhook key info show cluster info events show cluster events help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --help, -h show help --generate-bash-completion --version, -v print the version ~~~ ## 登錄登錄Shipyard集群。將會保存授權信息到`~/.shipyardrc`。 ~~~ shipyard cli> shipyard login URL: http://localhost:8080 Username: admin Password: ********** ~~~ ## 修改密碼只要登錄了系統，你就可以使用?`change-password`來修改賬戶的密碼。 ~~~ shipyard cli> shipyard change-password Password: ********** Confirm: ********** ~~~ ## 賬戶列表列出所有Shipyard賬戶 ~~~ shipyard cli> shipyard accounts Username Role admin admin demo user ~~~ ## 增加賬戶使用命令?`add-account`。 ### 可選項 * `--username,-u`:賬戶名稱 * `--password,-p`:賬戶密碼 * `--role,-r`:賬戶角色（admin/user） ~~~ shipyard cli> shipyard add-account -u demo -p demo123 -r user ~~~ ## 刪除賬戶使用命令`delete-account`。 ~~~ shipyard cli> shipyard delete-account demo ~~~ ## 查看容器列表查看集群所有容器列表使用?`containers`。 ~~~ shipyard cli> shipyard containers ID Name Host Ports 7b55a8eb9f57 redis:2.8.11 local tcp/49167:6379 3e532b000891 ehazlett/go-demo:latest local tcp/49155:8080 ~~~ ## 查看容器詳情 ~~~ shipyard cli> shipyard inspect 3e53 { "id": "3e532b000891e90e93ca3781031e7c1ddb76d8378dfdfd3a34f", "image": { "name": "ehazlett/go-demo:latest", "cpus": 0.08, "memory": 256, "environment": { "GOPATH": "/gopath", "GOROOT": "/goroot" }, "hostname": "demo-1", "type": "service", "labels": [ "local" ], "restart_policy": {} }, "engine": { "id": "local", "addr": "http://10.1.2.3:2375", "cpus": 4, "memory": 8192, "labels": [ "dev", "local" ] }, "ports": [ { "proto": "tcp", "port": 49155, "container_port": 8080 } ] } ~~~ ## 發布容器使用命令?`run`。 ### 可選項 * `--name`:Docker鏡像名稱 * `--container-name`:容器名稱 * `--cpus`:可使用的cpus * `--memory`:可使用的內存單位MB * `--type`:容器類型（service，host，unique） * `--hostname`:容器主機名 * `--domain`:容器域名 * `--env`:設置容器環境變量 * `--link`:連接其他容器 * `--arg`:容器命令行參數 * `--vol`:容器掛載點（`/host/path:/container/path`或者`/container/path`） * `--label`:用來調度的標簽 * `--port`:容器暴露的端口（`/::`） * `--publish`:暴露所有端口 * `--pull`:啟動之前獲取最新鏡像 * `--count`:容器啟動數量 * `--restart`:重啟策略（失敗時，總是，失敗次數：5等等） ~~~ shipyard cli> shipyard run --name ehazlett/go-demo \ --cpus 0.1 \ --memory 32 \ --type service \ --hostname demo-test \ --domain local \ --link redis:db \ --port tcp/10.1.2.3:80:8080 \ --port tcp/::8000 \ --restart "on-failure:5" \ --env FOO=bar \ --label dev \ --pull started 407e39dc1ccc on local ~~~ ## 容器擴展將擴展容器到想要的數量。 ~~~ shipyard cli> shipyard scale --id 407e --count 10 scaled 407e39dc1ccc to 10 ~~~ ## 查看容器日志顯示容器的日志。 ~~~ shipyard cli> shipyard logs 407e39 listening on :8080 ~~~ ## 銷毀容器殺掉和刪除容器。 ~~~ shipyard cli> shipyard destroy 407e destroyed 407e39dc1ccc ~~~ ## 查看引擎列表顯示集群上的引擎列表。 ~~~ shipyard cli> shipyard engines ID Cpus Memory Host Labels local 4.00 8192.00 http://10.1.2.3:2375 dev,local ~~~ ## 增加引擎使用`add-engine`。 ### 可選項 * `--id`:引擎id * `--addr`:引擎地址（例如：[http://10.1.2.3:2375）](http://10.1.2.3:2375%EF%BC%89/) * `--cpus`:引擎cpus * `--memory`:引擎內存 * `--label`:調度使用的標簽 * `--ssl-cert`:（可選）ssl證書地址 * `--ssl-key`:（可選）ssl key * `--ca-cert`:（可選）ca證書地址 ~~~ shipyard cli> shipyard add-engine --id demo --add http://10.1.2.3:2375 --cpus 4.0 --memory 4096 --label local --label dev ~~~ ## 查看引擎詳情使用`inspect-engine`查看引擎詳情。 ~~~ shipyard cli> shipyard inspect-engine local { "engine": { "labels": [ "local", "dev" ], "memory": 2048, "cpus": 4, "addr": "http://172.16.1.50:2375", "id": "local" }, "id": "a08b8518-e963-4eb5-959a-566bd270cd28" } ~~~ ## 刪除引擎使用?`remove-engine`從集群中刪除引擎 ~~~ shipyard cli> shipyard remove-engine demo ~~~ ## 創建Service key 使用?`add-service-key`。 ## 可選項 * `--description,-d`:key的描述 ~~~ shipyard cli> shipyard add-service-key -d "test key" created key: Z2uwezQGoaIcfiRSQBRbktrzdbFRWKlVTEry ~~~ ## 查看Service key列表使用?`service-keys`查看集群的service key 列表 ~~~ shipyard cli> shipyard service-keys Key Description Z2uwezQGoaIcfiRSQBRbktrzdbFRWKlVTEry test key ~~~ ## 查看集群信息使用?`info`。 ~~~ shipyard cli> shipyard info Cpus: 4.00 Memory: 8192.00 MB Containers: 2 Images: 5 Engines: 1 Reserved Cpus: 4.00% (0.16) Reserved Memory: 3.52% (288.00 MB) ~~~ ## 查看事件列表使用`events`。 ~~~ shipyard cli> shipyard events Time Message Engine Type Tags Sep 09 06:58:13 2014 container:6c07 local start docker Sep 09 06:58:13 2014 container:6c07 local create docker ~~~