uesyn / gokcps Goto Github PK

View Code? Open in Web Editor NEW

This project forked from xanzy/go-cloudstack

2.0 2.0 1.0 3.04 MB

A KDDI Cloud Platform Service API client enabling Go programs to interact with KCPS in a simple and uniform way

License: Apache License 2.0

Go 100.00%

gokcps's Introduction

gokcps

This package is based on xanzy/go-cloudstack.

Description

A KDDI Cloud Platform Service API client enabling Go programs to interact with KCPS in a simple and uniform way.

Example

// API Clientを生成する
cli := gokcps.NewAsyncClient("api_endpoint", "api_key", "secret_key" , false) 

// APIを叩くためのパラメータを生成する.  
// gokcpsでKCPSのAPIを叩く場合は対称のAPIのパラメータオブジェクトを生成し、そのパラメータオブジェクトを実際にAPIを叩くメソッドの引数とする.
// パラメータオブジェクト生成するメソッドは全てNew***Paramsの命名規則を持つ.
// パラメータオブジェクト生成時にはAPIを叩くために必須のパラメータを引数として渡す必要がある(一部例外あり)
p := cli.VirtualMachine.NewDeployValueVirtualMachineParams(
	"service-offering-id", 
	"template-id", 
	"zone-id",
	"vmname",
)

// パラメータオブジェクトにはAPIで利用可能なその他のオプションをSet***メソッドで追加可能.
p.SetName("vmname2")

// 上記で生成したパラメータを引数にAPIを実行.
// 全てのAPI実行メソッドには一つ目の返り値にResponseオブジェクトと、二つ目の返り値に実行エラーが帰ってくる.(成功時にはnil)
r, err := cli.VirtualMachine.DeployValueVirtualMachine(p)
if err != nil {
	log.Fatalf("Error creating the new instance %s: %s", name, err)
}

fmt.Printf("UUID or the newly created machine: %s", r.ID)

ToDo

godoc
implementation of some convinient method.

Getting Help

If you have an issue: report it on the issue tracker

Author

uesyn

License

Apache License, Version 2.0

gokcps's People

Contributors

Stargazers

Watchers

Forkers

takahiro-impara

gokcps's Issues

terraform-provider-kcpsで必要なパラメータのセット

リファレンスに書かれていないコマンドのパラメータにも対応する #5で示したものの中で、特にterraform側で必要なパラメータをセットできるようにしてほしいです

createPortForwardingRule[openfirewall]
createTemplate[ispublic]
createLoadBalancerRule[openfirewall]

ListSnapshotPoliciesParamsにでvolumeidをセットできるようにする

KCPSのAPIコマンドlistSnapshotPoliciesはvolumeidが必須パラメータですhttps://iaas.cloud-platform.kddi.ne.jp/developer/listSnapshotPolicies/

gokcpsでは、NewListSnapshotPoliciesParamsが引数をとらず、setterはSetIdしか実装されていないため、ListSnapshotPoliciesParamsにvolumeidをセットする術がありません

NewListSnapshotPoliciesParams(volumeid string)

と定義し直し、volumeidをセットできるようにすべきです

構造体の型を使い回すようにする

たとえばSnapshotService.goで定義されているCreateSnapshotResponseなんですが

type CreateSnapshotResponse struct {
	JobID        string `json:"jobid,omitempty"`
	Account      string `json:"account,omitempty"`
	Created      string `json:"created,omitempty"`
	Domain       string `json:"domain,omitempty"`
	Domainid     string `json:"domainid,omitempty"`
	Id           string `json:"id,omitempty"`
	Intervaltype string `json:"intervaltype,omitempty"`
	Name         string `json:"name,omitempty"`
	Physicalsize int64  `json:"physicalsize,omitempty"`
	Project      string `json:"project,omitempty"`
	Projectid    string `json:"projectid,omitempty"`
	Revertable   bool   `json:"revertable,omitempty"`
	Snapshottype string `json:"snapshottype,omitempty"`
	State        string `json:"state,omitempty"`
	Tags         []struct {
		Account      string `json:"account,omitempty"`
		Customer     string `json:"customer,omitempty"`
		Domain       string `json:"domain,omitempty"`
		Domainid     string `json:"domainid,omitempty"`
		Key          string `json:"key,omitempty"`
		Project      string `json:"project,omitempty"`
		Projectid    string `json:"projectid,omitempty"`
		Resourceid   string `json:"resourceid,omitempty"`
		Resourcetype string `json:"resourcetype,omitempty"`
		Value        string `json:"value,omitempty"`
	} `json:"tags,omitempty"`
	Volumeid   string `json:"volumeid,omitempty"`
	Volumename string `json:"volumename,omitempty"`
	Volumetype string `json:"volumetype,omitempty"`
	Zoneid     string `json:"zoneid,omitempty"`
}

これはTagsService.goで定義されたTag型を用いて

type CreateSnapshotResponse struct {
	JobID        string `json:"jobid,omitempty"`
	Account      string `json:"account,omitempty"`
	Created      string `json:"created,omitempty"`
	Domain       string `json:"domain,omitempty"`
	Domainid     string `json:"domainid,omitempty"`
	Id           string `json:"id,omitempty"`
	Intervaltype string `json:"intervaltype,omitempty"`
	Name         string `json:"name,omitempty"`
	Physicalsize int64  `json:"physicalsize,omitempty"`
	Project      string `json:"project,omitempty"`
	Projectid    string `json:"projectid,omitempty"`
	Revertable   bool   `json:"revertable,omitempty"`
	Snapshottype string `json:"snapshottype,omitempty"`
	State        string `json:"state,omitempty"`
	Tags         []Tag `json:"tags,omitempty"`
	Volumeid   string `json:"volumeid,omitempty"`
	Volumename string `json:"volumename,omitempty"`
	Volumetype string `json:"volumetype,omitempty"`
	Zoneid     string `json:"zoneid,omitempty"`
}

このように書き換えることが可能かと思います。

現在あらゆる構造体中のTagsフィールドはTag型ではない（型が定義されていない）ので、たとえばCreateSnapshotResponseやDeployValueVirtualMachineResponseのTagsを引数にとるような関数が作れません。

Tags以外にもEgressrule、Securitygroup、Nic（Networknameのフィールドを持つものとそうでないものがある）なども型で定義して、それを使い回すとよいと思います

RegisterIsoで正しいレスポンスが取得できない

RegisterIso実行後ISOの登録が完了しているにも関わらず、返り値(RegisterIsoResponse型)が
&{ false false map[] false false false false false false 0 false [] }となっています。

ListLBStickinessPoliciesで正しいレスポンスが取得できない

ListLBStickinessPolicies実行後、スティッキー設定が存在するにも関わらず、返り値（ListLBStickinessPoliciesResponse型）のLBStickinessPoliciesがnilになってしまっています。

NewRegisterIsoParamsでostypeidにzoneidがセットされている

修正よろしくお願いします

ISOService.go (Lines 565-574)

func (s *ISOService) NewRegisterIsoParams(displaytext string, name string, url string, zoneid string, ostypeid string) *RegisterIsoParams {
	p := &RegisterIsoParams{}
	p.p = make(map[string]interface{})
	p.p["displaytext"] = displaytext
	p.p["name"] = name
	p.p["url"] = url
	p.p["zoneid"] = zoneid
	p.p["ostypeid"] = zoneid  #ここ
	return p
}

CreateSnapshotPolicyで&{false 0 0 }が返却される

CreateSnapshotPolicy実行後、定期スナップショットの設定に成功しているにも関わらず、返り値（CreateSnapshotPolicyResponse型）が&{false 0 0 }となっています。errの方はnilです。

createLBStickinessPolicyのparamに対応する

createLBStickinessPolicyコマンドのparamに対応できていません

createLBStickinessPolicyは複数のparamをセットできます。またparamはnameとvalueの組み合わせです。（https://iaas.cloud-platform.kddi.ne.jp/developer/createLBStickinessPolicy/）

下記は複数のparamをセットした場合のcreateLBStickinessPolicyの例です

./kick_api.sh command=createLBStickinessPolicy lbruleid=10c00c09-8e47-499b-85c8-f6eb29f46c8e methodname=AppCookie name=test param[0].value=bbb param[1].name=mode param[1].value=cccc param[2].name=length param[2].value=50 param[3].name=holdtime param[3].value=1000 param[4].name=request-learn param[4].value=true param[5].name=prefix param[5].value=true

現状のgokcpsで以下の2つの問題が確認できました

複数のparamをセットできない
- SetParam関数は引数の型はmap[string]stringで、1つのmapしか渡せない
- リスト化
URLにparamをセットする際、nameをkeyにしてしまっている
- ここは単純にパラメータの名前を変更すれば良い

リファレンスに書かれていないコマンドのパラメータにも対応する

KCPSのAPIコマンドのリファレンスに書いていないパラメータもセットできるようにしてほしいです。

以下に現在確認しているリファレンスに書かれていないパラメータ一覧を示します（パラメータを全て網羅するには仕様書でも読まないと厳しい）

コマンド	パラメータ	型	デフォルト値	内容
createPortForwardingRule	openfirewall	bool	true	ポートフォワードのルール作成時、自動でFirewallのルールを追加するかどうか。作成されるFirewallのルールはcidrが0.0.0.0/0、portの範囲はポートフォワードのルールのパブリックポートと同じ範囲になる。
registerTemplate	details[n].nicAdapter	string	nil	NICアダプタの設定（例: details[0].nicAdapter=E1000）
registerTemplate	details[n].keyboard	string	nil	keyboardの設定（例: details[0].keyboard=us）
createTemplate	ispublic	bool	false	テンプレートの公開設定
createSnapshot	quiescevm	bool	false	VMの休止
createVMSnapshot	snapshotmemory	bool	false	メモリを含めるか否か
createLoadBalancerRule	openfirewall	bool	true	ポートフォワードのルール作成時、自動でFirewallのルールを追加するかどうか

NewCreateTemplateParamsのパラメータsnapshotidを必須にしない

Templateの作成はスナップショットから作成する場合と、仮想サーバのROOTボリュームから作成する場合があります。https://iaas.cloud-platform.kddi.ne.jp/developer/createTemplate/

ボリュームから作成する場合はsnapshotidは不要になるので、NewCreateTemplateParamsの第一引数snapshotidは必須ではありません。