Dataiku DSSでChart系のPlugin作ってるのだけど、ちょっとでもデバッグ楽にしたかったのでVSCodeと連携させてみた覚書き。
有償ライセンスがいる話です。
-
参考サイト
-
環境
- Windows
- Dataiku DSS ver 8.0.2
VSCodeにDataiku DSS Extentionをインストール。
参考サイト参照
Dataiku DSS側との接続。
Configファイルの設定をしていきます。まず、設定にあたって必要な、Personal API Keyの発行からやっていきます。
Personal API Keyの発行
鍵の発行については、このあたり参照。たぶん、ここで有償ライセンスが必要。
https://doc.dataiku.com/dss/latest/publicapi/keys.html
Dataiku DSS上のマイページみたいなところにいく。
画面右上の自分のアカウントの最初の一文字が表示されている丸をクリックした後、自分の名前クリックでいける。正式名称はUser centerの模様。
API keysタブをクリック。セキュリティの都合上、いくつかマスキングしている画像で失礼します。
右上の[+ NEW API KEY]をクリックすると、personal API keysが発行される。
Secretのところのい記載されている文字列が、設定ファイル（次で説明）のapi_keyにあたる。（画面は省略）
Configファイルの作成
VSCodeのターミナルで以下をやってconfig.jsonをつくる。VSCodeの正式な使い方がいまだによくわからないのでなんでもターミナルで済まそうとしてしまう。
C:\Users\ユーザー名\.dataikuを作るという話です。
mkdir ~/.dataiku
cd ~/.dataiku
config.jsonファイルを作成し、以下の要領で、urlとapi_keyを記入。
designInstanceとかは任意の文字列でOK。defaultinstanceとかpluginDevelopInstanceとか。
今回は、SSL証明書のチェックがはいるサーバだったのでno_check_certificateで回避している。関係ない場合はこの一行はいらない。
最終行のdefault_instanceに記載されているものが、デフォルトで接続するインスタンスになる。
{
"dss_instance": {
"designInstance": {
"url": "https://www.mydesigninstance.com:11500",
"api_key": "your-design-API-key-secret",
"no_check_certificate":true
},
"productionInstance": {
"url": "https://www.myproductioninstance.com:12500",
"api_key": "your-production-API-key-secret"
}
},
"default_instance": "designInstance"
}
- url : Dataiku instanceのURL。末尾に/をつけてはいけない。
- api_key. The secret for personal API key。先ほど作成した鍵をここに記載。
これで再読み込みすると、Dataiku DSSのサイドパネルにプロジェクトやプラグインの一覧が表示される。
おまけ
config.jsonのdefault_instanceの設定内容は、Ctr+Shift+Pで設定もできる模様。
dataikuと打ち込むと、いろいろ一覧でてくるので、Setup your DSS instance URLや、Ssetup your API Keyなどを設定することが可能。
VSCode的にはこういうやり方が一般的？なのです？