コンテンツにスキップ

クイックスタート

DataFlux Func は、Python ベースのスクリプト開発、管理、実行プラットフォームです。

DataFlux Funcdata flux function と読み、システム内では DFF と略されることがあります。

インストールパッケージのダウンロードコマンド

Bash
1
bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

0. 読む前の注意

本書で扱うすべての shell コマンドは、root ユーザーではそのまま実行できますが、root 以外のユーザーでは sudo を付けて実行する必要があります。

本書では最も一般的な操作手順のみを提供します。詳細なインストールとデプロイについては、デプロイとメンテナンス / インストールとデプロイ / Standalone Deployment を参照してください。

1. システム要件

DataFlux Func を実行するホストまたはクラウドホストが以下の条件を満たすことを確認してください。

  • CPU コア数 >= 2
  • メモリ容量 >= 4GB
  • ディスク容量 >= 20GB
  • ネットワーク帯域幅 >= 10Mbps
  • オペレーティングシステムは Ubuntu 16.04 LTS / CentOS 7.2 以上のオリジナルシステム (macOS、Windows はサポートされていません)
  • 8088 ポートを開放する(本システムはデフォルトで 8088 ポートを使用するため、ファイアウォール、セキュリティグループなどの設定で 8088 のインバウンドアクセスが許可されていることを確認してください)

詳細なシステム要件

より詳細なシステム要件については、デプロイとメンテナンス / システム要件 を参照してください。

2. インストールとデプロイ

DataFlux Func は複数のインストールパッケージによるデプロイ方式をサポートしており、ユーザーは自分の実際の状況に応じて選択できます。

インストールパッケージをダウンロードしてデプロイ

単一ホストにデプロイするシナリオでは、インストールパッケージをダウンロードしてデプロイすることを推奨します。また、この方法はパブリックネットワークがない環境や制限された環境にも適しています。

Linux、macOS などのシステムでは、公式提供の shell コマンドを使用してインストールパッケージをダウンロードすることを推奨します。スクリプトは、現在の環境に応じて x86_64 または aarch64 アーキテクチャのバージョンを自動的に選択してダウンロードします。

Bash
1
bash -c "$(curl -fsSL docs.dataflux-func.com/download)"

手動でインストールパッケージをダウンロード

Windows では手動でインストールパッケージをダウンロードする必要があります。デプロイとメンテナンス / インストールとデプロイ / Standalone Deployment / 手動ダウンロード を参照してください。

ダウンロード完了後、インストールファイルがあるディレクトリの run-portable.sh を実行すると、自動的に設定され、最終的に DataFlux Func 全体が起動します。

Bash
1
sudo bash {インストールファイルのあるディレクトリ}/run-portable.sh

実行完了後、ブラウザで http://{サーバー IP アドレス/ドメイン}:{ポート} にアクセスして初期化操作画面を表示できます。

インストールスクリプトの設定パラメータ

インストールスクリプトの設定パラメータについては、デプロイとメンテナンス / インストールとデプロイ / Standalone Deployment / インストールオプション を参照してください。

Helm を使用した k8s へのインストール

ドキュメント デプロイとメンテナンス / インストールとデプロイ / Helm を参照してください。

3. システムの初期化

DataFlux Func をインストールした後、初めてシステムにアクセスすると初期化画面が表示されます。「保存してデータベースを初期化」ボタンをクリックすると、データベースを初期化できます。

しばらく待つと、初期化が完了し、自動的にログイン画面に移動します。

setup-page.png

4. サンプル関数の実行

初期インストール時の DataFlux Func には、簡単なコードサンプルが含まれています。

「編集」ボタンをクリックすると、編集モードに入り、コードを変更できます。

sample-code.png

編集モードでは、実行する関数を選択し、「実行」をクリックします。

関数の実行結果や print(...) の出力は、すべて下の出力欄に表示されます。

sample-code-result.png

5. 関数 API の作成

「管理 / 関数 API」に入ると、関数 API のリストが表示されます。

「新規作成」をクリックすると、@DFF.API(...) で装飾された関数の関数 API を作成できます。

func-api-list.png

create-func-api.png

6. 関数 API の呼び出し

「管理 / 関数 API」に入ると、関数 API のリストが表示されます。

「サンプル」をクリックすると、呼び出し方法の説明が表示されます。呼び出しパラメータを調整すると、具体的な呼び出し方法が自動的に生成されます。

func-api-list-2.png

func-api-example.png

表示された呼び出し方法に従ってアクセスすると、関数の戻り値(すなわち return 値)を取得できます。