Slide 1

Slide 1 text

Cloud Foundry Cli Plugin Introduction to Cli Plugin

Slide 2

Slide 2 text

About me Takeshi Morikawa 業務: Cloud Foundry関連 CF関連チェック範囲(業務外も含む) ◎ 少し前 ○ ccngとdeaまわり ◎ 最近 ○ rootfs(lucid64やcflinuxfs2) ○ cli plugin(本日の内容)

Slide 3

Slide 3 text

Movie & Music & Game About me Takeshi Morikawa

Slide 4

Slide 4 text

◎ Cli Pluginとは ◎ pluginの入手と削除 ◎ pluginの入手その他の方法 ◎ pluginを作るための知識 本日の内容

Slide 5

Slide 5 text

cli pluginとは

Slide 6

Slide 6 text

cli plugin??? ◎ 基本的な特長 ○ cfコマンド(cli)のサブコマンドのように扱える ◉ 例:cf hoge APP_NAME ○ go版のcfコマンド v6.7以降?から使用可能

Slide 7

Slide 7 text

cli plugin??? ◎ 基本的な特長 ○ cli自体と同じようにGolangで実装 ○ RPCでやりとり

Slide 8

Slide 8 text

Install plugin 『cf install-plugin』からgoのクロスコンパイルで 生成されたbinファイルを指定 $ cf install-plugin hoge githubのリリース等からバイナリを持ってきた場合 go get等でバイナリを持ってきた場合 $ export GOPATH=$HOME/tmp_gopath $ go get $ cf install-plugin $GOPATH/bin/hoge

Slide 9

Slide 9 text

Uninstall plugin 『cf plugins』でPlugin nameを確認し 『cf uninstall-plugin』する $ cf plugins Listing Installed Plugins... OK Plugin name Version Command name Command Help hoge 1.0.0 hoge cf hoge plugin $ cf uninstall-plugin hoge Uninstalling plugin hoge... OK Plugin name tree successfully uninstalled plugin nameがhogeの場合

Slide 10

Slide 10 text

plugin入手 その他の方法

Slide 11

Slide 11 text

community pluginを使う

Slide 12

Slide 12 text

community pluginを使う その1 communityのplugin用urlをcfコマンドに登録する $ cf add-plugin-repo community OK added as 'community' $ cf list-plugin-repos OK Repo Name Url community

Slide 13

Slide 13 text

community pluginを使う その2 communityのplugin一覧から入れたいpluginを探す $ cf repo-plugins community Getting plugins from all repositories ... Repository: community name version description CLI-Recorder 1.0.1 Records and playbacks CLI commands. Live Stats 1.0.0 Monitor CPU and Memory usage on an app via the browser. Console 1.0.0 Start a tmate session on an application container Diego-Beta 1.3.0 Enables Diego-specific commands and functionality etc…

Slide 14

Slide 14 text

community pluginを使う その3 communityの一覧経由でpluginを入れる $ cf install-plugin Console -r community Looking up 'Console' from repository 'community' 7974312 bytes downloaded... Installing plugin /tmp/cf-plugin-console... OK Plugin Console successfully installed. $ cf plugins Listing Installed Plugins... OK Plugin name Version Command name Command Help hoge 1.0.0 hoge cf hoge plugin Console N/A console Start a live console 入れたいplugin名がConsoleの場合 ※ -rで取得元のnameを入れる

Slide 15

Slide 15 text

community plugin ざっくり紹介

Slide 16

Slide 16 text

Community plugin一覧 その1 (2015/5/6調べ) Version Description CLI-Recorder v1.0.1 Records and playbacks CLI commands. Live Stats v1.0.0 Monitor CPU and Memory usage on an app via the browser. Console v1.0.0 Start a tmate session on an application container

Slide 17

Slide 17 text

Live Stats localhost:8080でHTTPserverを立ち上げ 内部的にはstats相当を叩く(cf app APP_NAME)

Slide 18

Slide 18 text

Console cloudfoundry-tmate-buildpackやcf-sshと同じように tmate経由でコンテナにアクセスするplugin $ cf console cf-api-checker > Finding app guid for cf-api-checker ... 62de88da-8947-46fc-9877- 52319c0a0bfb > Updating app to connect to tmate. > Updating app start command to 'curl -s https://raw.githubusercontent. com/danhigham/cf-console/master/ > /tmp/ && bash /tmp/ && sleep 3600'. > Changing instance count to 2. > Checking app log datestamps.

Slide 19

Slide 19 text

Community plugin一覧 その2 (2015/5/6調べ) Version Description Diego-Beta v1.3.0 Enables Diego-specific commands and functionality Open v1.10 Open app url in browser autopilot v0.0.1 zero downtime deploy plugin for cf applications

Slide 20

Slide 20 text

autopilot appの旧バージョンmanifestと新バージョンmanifestを指定し ダウンタイムゼロでアプリを新バージョンに移行するplugin $ cf zero-downtime-push application-to-replace \ -f path/to/new_manifest.yml \ -p path/to/new/path pluginの配布元READMEの説明による動作原理 1. 旧バージョンのアプリ名を -venerableにリネーム この時アプリのroutesは変更しない 2. 新バージョンのアプリを でpush この時のroutesは旧バージョンと一緒になるのでロードバランシングされる 3. 旧バージョン側のroutesとアプリそのものを削除し移行完了

Slide 21

Slide 21 text

Community plugin一覧 その3 (2015/5/6調べ) Version Description Brooklyn v0.1.1 Interact with Service Broker for Apache Brooklyn kinaba-me-logs v0.3.0 Launches the Kibana UI (from kibana-me- logs) for an application. Buildpack Usage v1.0.0 Buildpack Usage CF App Stack Changer v1.0.0 Allows admins to list and update applications with outdated lucid64 stacks.

Slide 22

Slide 22 text

cf-plugin-kinaba-me-logs (kibana-me-logs) Docker/Logstash Service Brokerを使って applicationのlogをkibana経由で確認する用のplugin pluginの配布元READMEの説明による動作原理 1. を内部的には利用 2. cf-kinaba-me-logs 3. 本来のkibana-me-logs単体の使い方 a. logをkibana UIで確認したいアプリに対して cf bind-service APP_NAM b. kibana-me-logs自体をpush&bind-serviceするとbindしたその他のアプリが見える

Slide 23

Slide 23 text

Buildpack Usage 特定のspaceやorgが利用しているbuildpackを確認するplugin $ cf buildpack-usage 13 buildpacks found across 110 app deployments Buildpacks Used ---------------- Node.js PHP Ruby

Slide 24

Slide 24 text

CF App Stack Changer lucid64のstacksをcflinuxfs2に移行する為のplugin ◎ lucid64のアプリの確認 ◎ stacks変更+restartが行える $ cf stack-list Getting all apps with lucid64 stack... OK Total 14 found ... name guid state hogehoge 09d03ad3-24ee-44a1-8969-4abb3268aab6 STARTED $ cf stack-change APP_NAME

Slide 25

Slide 25 text

Community plugin一覧 その4 (2015/5/6調べ) Version Description Targets v1.0.0 Easily manage multiple CF targets Test User v0.0.1 Create a user and assign all possible permissions, organisation and space are created if they do not already exist as well. If no organisation or space name are specified then the default value of 'development' is used cf-download v1.0.0 Plugin for downloading your application contents after staging.

Slide 26

Slide 26 text

Targets CF_HOMEを利用して複数環境のtarget情報を管理するplugin $ cf api $ cf login $ cf save-target bluemix $ cf api --skip-ssl-validation $ cf login $ cf save-target bosh-lite $ cf set-target dev $ cf targets bluemix bosh-lite (current)

Slide 27

Slide 27 text

cf-download cf files APP_NAME app/hogehoge.logのように内部的にfiles相当のAPI経由で staging後のアプリ上にあるファイルを取得するplugin $ cf download dora Files completed: 1755 / $ ls ~/dora-download/ app logs staging_info.yml tmp

Slide 28

Slide 28 text

cli pluginを作るための知識

Slide 29

Slide 29 text

実装する上で参考になるコード解説 1 最初pluginを作る上で参考になるのは github/cloudfoundry/cliの中にあるplugin_examples/call_cli_cmdがオススメ import ( "fmt" "" ) import部分でをimportする main部分でplugin.Startでstructをnewさせる func main() { plugin.Start(new(CliCmd)) }

Slide 30

Slide 30 text

実装する上で参考になるコード解説 2 func (c *CliCmd) GetMetadata() plugin.PluginMetadata { return plugin.PluginMetadata{ Name: "CliCmd", Version: plugin.VersionType{ Major: 1, Minor: 1, Build: 0, }, Commands: []plugin.Command{ { Name: "cli-command", HelpText: "Command to call cli command. It passes all arguments through to the command", UsageDetails: plugin.Usage{ Usage: "cli-command\n cf cli-command CORE- COMMAND", }, }, }, } } GetMetadata()を定義しpluginの名前(uninstall時に利用するもの)や コマンド名、およびバージョン定義を行う

Slide 31

Slide 31 text

実装する上で参考になるコード解説 3 func (c *CliCmd) Run(cliConnection plugin.CliConnection, args []string) { output, err := cliConnection.CliCommand(args[1:]...) if err != nil { fmt.Println("PLUGIN ERROR: Error from CliCommand: ", err) } fmt.Println("") fmt.Println("---------- Command output from the plugin ----------") for index, val := range output { fmt.Println("#", index, " value: ", val) } fmt.Println("---------- FIN -----------") } Run()部分で実際に処理を行う ※以下は実際のソースのコメントアウト部分を除いたもの cliConnection.CliCommand部分でpluginに渡ってきた引数を cliにそのまま渡す

Slide 32

Slide 32 text

実装する上で参考になるコード解説 4 $ cf cli-command apps Getting apps in org testOrg / space testSpace as admin... OK name requested state instances memory disk urls aaa started ?/1 256M 1G go started 1/1 256M 1G dora started 1/1 256M 1G ---------- Command output from the plugin ---------- # 0 value: Getting apps in org testOrg / space testSpace as admin... # 1 value: OK # 2 value: # 3 value: name requested state instances memory disk urls # 4 value: aaa started ?/1 256M 1G # 5 value: go started 1/1 256M 1G # 6 value: dora started 1/1 256M 1G ---------- FIN ----------- cli-command pluginに値を渡した時の挙動

Slide 33

Slide 33 text

CliConnectionのinterface(旧) v6.10.0の場合は基本的な以下の2つが用意されていた(最新はv6.11.2) ● CliCommand ○ plugin_examplesで使われている ○ plugin内部でコマンド発行した結果も標準出力に出す ● CliCommanWithoutTerminalOutput ○ plugin内部でコマンドを発行し、発行コマンド自体の標準出力 は表示はしない  ⇒ 通常はこちらを使う

Slide 34

Slide 34 text

CliConnectionのinterface(新) v6.11.2の場合はpluginを作る際によく使われる値を取得するための interfaceが追加された type CliConnection interface { CliCommandWithoutTerminalOutput(args ...string) ([]string, error) CliCommand(args ...string) ([]string, error) GetCurrentOrg() (plugin_models.Organization, error) GetCurrentSpace() (plugin_models.Space, error) Username() (string, error) UserGuid() (string, error) UserEmail() (string, error) IsLoggedIn() (bool, error) IsSSLDisabled() (bool, error) HasOrganization() (bool, error) HasSpace() (bool, error) ApiEndpoint() (string, error) ApiVersion() (string, error) HasAPIEndpoint() (bool, error) LoggregatorEndpoint() (string, error) DopplerEndpoint() (string, error) AccessToken() (string, error) }

Slide 35

Slide 35 text

CliConnectionのinterface(次期) 更に良く使われる以下のような値が追加される? Example: apps = cliConnection.GetApps() println(apps[0].Name) println(apps[0].Guid) - GetApps() - GetApp() - GetOrgs() - GetOrg() - GetSpaces() - GetSpace() - GetUsers() - GetUser() - GetServices() - GetService()

Slide 36

Slide 36 text


Slide 37

Slide 37 text

plugin化の メリット cliに独自拡張していた場合に Upstream追従が大変だが 独立管理が可能になる ニッチな用途のコマンドが 作りやすい

Slide 38

Slide 38 text

plugin化の デメリット cliのバージョンと独立するので CCNGのAPI versionとの 紐付けが重要

Slide 39

Slide 39 text

その他参考情報 pluginリリースの参考になる情報!starred/vcap- dev/RDk9xbmp3gc

Slide 40

Slide 40 text

Credits Special thanks to all the people who made and released these awesome resources for free: ◎ Presentation template by SlidesCarnival ◎ Photographs by Unsplash & Death to the Stock Photo (license)