...
| Table of Contents | ||
|---|---|---|
|
概要
YellowfinをノートPC、クラウド、サーバー、どの環境で実行するにしても、導入プロセスは同じです。Yellowfinを初めて起動する場合は、ご利用の環境に合わせていくつかの設定を行う必要があります。YellowfinをノートPC、クラウド、サーバーのどの環境で実行するにしても、導入プロセスは同じです。Yellowfinを初めて起動する場合は、ご利用の環境に合わせていくつかの設定を行う必要があります。
...
初回導入の手順
...
これら各手順の詳細については、本ページの以下の項目でそれぞれ紹介しています。
- Yellowfin
...
このイメージは、Docker コンテナの外部にデータを保持せず、コンテナが破棄されるとすべてのコンテンツが失われます。これを念頭に置いて、次の事例を推奨します。
事例
このイメージは、次の事例での使用に最適です。
- 短期でのPOCおよびデモ
- Sandbox環境でのYellowfin機能のテスト
このイメージを次の事例で使用するのは避けましょう。
- 本番環境 (コンテナが破棄されるとすべてのコンテンツが失われます)
- クラスタ環境 (このイメージはこの機能をサポートしていません)
Yellowfin オールインワンイメージ構成オプション
Yellowfin オールインワンイメージには、構成に使用できる次の環境変数があります。
...
Yellowfin アプリケーション限定イメージ
Yellowfin アプリケーション限定 イメージには、Yellowfin アプリケーションのみが含まれています。そのため、既存のリポジトリデータベースに接続する必要があります。
このイメージを使用して、単一インスタンス、個別インスタンス、またはYellowfin クラスタ環境に導入することができます。このイメージは、データが外部Yellowfin リポジトリに保持されることで、コンテナが破棄されてもYellowfin データが保持されるため、本番環境および非本番環境の両方に適しています。
事例
このイメージは、次の事例での使用に最適です。
- データの永続性が重要なYellowfinの長期的に使用するインスタンス
- Yellowfin クラスタ環境への導入
Yellowfin アプリケーション限定イメージ構成オプション
Yellowfin アプリケーション限定イメージには、構成に使用できる次の環境変数があります。
...
リポジトリデータベースへのアクセスに必要なデータベースユーザーを指定します (必須)。
...
データベースパスワードを暗号化するかどうかを指定します (true/false)。
...
コネクションプールサイズ、JDBC_MAX_COUNT
...
リポジトリデータベースのコネクションプールの最大サイズを指定します (デフォルトは25)。
...
プロキシスキーム、PROXY_SCHEME
...
外部プロキシスキーム (http/https)です。
...
外部プロキシホストまたはIP アドレスです。
...
外部クラスタアドレス、CLUSTER_ADDRESS
...
クラスタメッセージ用の外部クラスタアドレスです。通常はDocker HostのホストまたはIPアドレス、またはDocker SwarmおよびKubernetesの場合は、コンテナのDNS名になります。
...
内部クラスタネットワークアダプター、CLUSTER_INTERFACE
...
追加ライブラリURL、LIBRARY_ZIP
...
Yellowfin イメージのダウンロードおよび構築
Yellowfinは、様々な形式でダウンロードできます。
Yellowfinの主要なインストーラーアプリケーションは、Yellowfin ポータルから取得できます。
Yellowfin Dockerイメージは、Docker Hubから取得できます。
(独自のDocker イメージを構築できる) Yellowfinのアセットは、GitHubから取得できます。
Yellowfinをアクティベートするにはライセンスが必要です。ライセンスをお持ちでない場合は、評価ライセンスまたはフルライセンスを提供できます。ライセンスの取得をご希望の場合は、Yellowfin 担当者までお問い合わせください。
Yellowfin GitHub
GitHubのYellowfinリポジトリでは、ダウンロード可能なDockerfileとして、YellowfinのDocker イメージが2つ提供されているほか、これらのページでは導入ファイルの例のコピーも提供されています。
Docker イメージを構築するには、次の手順に従います (My_Docker_Registryを、独自のDokcer レジストリ名に置き換えてください)。次の手順では、例として最新のビルドを使用しています。
- ダウンロードしたYellowfin Dockerfileを、システム内の適切なディレクトリに移動します。
- https://support.yellowfin.co.jp/hc/ja/sections/115003324168 からYellowfin jar ファイルをダウンロードします。
- ターミナルを起動し、Yellowfin DockerfileおよびYellowfin jar ファイルが含まれるフォルダーに移動します。
- ターミナルコマンドを使用して、DockerfileからDocker イメージを構築します。
docker build -t yellowfin-app-only - ターミナルコマンドを使用して、イメージにバージョンのタグを付けます。
docker tag yellowfin-app-only:latest My_Docker_Registry/yellowfin-app-only:latest - イメージをDocker レジストリにプッシュします。
docker push My_Docker_Registry/yellowfin-app-only:latest
Yellowfin Docker Hub
構築済みのDocker イメージを直接取得したい場合は、Yellowfin Docker Hubアカウントが、Yellowfin アプリケーション限定イメージリポジトリおよびYellowfin オールインワンイメージリポジトリの両方をホストします。いずれもYellowfinの公式リリースビルドに合わせたバージョンになっています。
暫定ビルドが表示される場合がありますが、これらはテストされていない特定のパートナー向けの例外ビルドであるため使用しないでください。
イメージを取得するには、次の表に示すコマンドと接尾辞の組み合わせを使用してください。
...
latest
x.x.x (例: Yellowfin 9.5.1の場合は9.5.1、またYellowfin 9.6の場合は9.6.0)
...
latest (使用には注意が必要です。詳細は以下をご確認ください。)
x.x.x (例: Yellowfin 9.5.1の場合は9.5.1、またYellowfin 9.6の場合は9.6.0)
例えば、最新のYellowfin オールインワンDocker イメージを取得する場合:
docker pull yellowfinbi/yellowfin-all-in-one:latest
または、特定のバージョンのYellowfin アプリケーション限定Docker イメージを取得する場合:
docker pull yellowfinbi/yellowfin-app-only:9.5.1
| Tip |
|---|
特定のバージョンのYellowfinを使用するには、取得する前にイメージリポジトリの「Tags」項目内で検索します。 |
| Note |
|---|
アプリケーション限定イメージを取得するときは、起動時に誤って更新が実行されないように、 「latest (最新)」 ではなく特定のバージョン番号を使用することを強く推奨します。 |
導入例
コンテナ化された導入の形式ごとに記述した手順は、すべての主要なクラウドプロバイダーおよびオンプレミス環境で機能します。
Yellowfinでは、以下のサービスを使用して、Amazon Web Services上でこれらの手順を作成し、テストしました。
- DockerおよびDocker Swarm環境向けEC2インスタンス
- Kubernetes環境向けAWS EKS
- Docker レジストリとしてのAWS ECR (すべての環境向けYellowfin Docker イメージを保存するために使用しました)
...
- アプリケーションサーバの起動 (これはデータベースを自動的に起動します)
- デフォルトの管理者認証情報を使用したログイン (およびパスワードの変更)
- レポート外部アクセス時BaseURLの設定
導入後の手順
データの詳細な掘り下げを始める前に、Yellowfinについてさらに詳しく学ぶことを強く推奨します。以下の手順には、wiki内の他のページおよび項目へのリンクが含まれています。各リンクには、Yellowfinを推測なしに設定するのに役立つ貴重な情報が記載されています。
- ログファイルおよびそのコンテンツについて
- Yellowfinのディレクトリ構成について
- 新規ユーザーの初回ログインについて
- Yellowfinの管理者機能について
...
初回導入の手順詳細
Yellowfin アプリケーションサーバの起動
Yellowfinにログインする前に、Yellowfin アプリケーションサーバを起動しなくてはいけません。
YellowfinをDockerのようなコンテナ環境で実行する場合は、コンテナ環境へのインストール項目で起動プロセスを確認してください (ご利用の環境に合わせて詳細をご確認ください)。
(AWS向けYellowfinなど) クラウドマーケットプレイスから直接Yellowfinを実行する場合は、クラウド環境へのインストール項目で起動プロセスを確認してください (ご利用の環境に合わせて詳細をご確認ください)。
Windows、Mac OS X、Linuxを使用して、サーバやローカルマシン上でYellowfinを実行する場合は、次の手順に従います。
- 新規Yellowfin ディレクトリを探します。これは、インストールプロセスの最後にインストール完了画面に表示されるか、インストールパス＞appserver フォルダー＞bin フォルダーから見つけることができます。
- Windowsの場合は、startup.bak ファイルをダブルクリックします。
- Mac OS XまたはLinuxの場合は、Startup (terminal).command ファイルをダブルクリックします (バックグラウンドで起動する場合は、代わりにStartup (background).commandを使用します)。
ターミナルウィンドウが開き、Yellowfin アプリケーションが起動されます。初回起動の場合は完了まで60-90秒程度、2回目以降は30-60秒程度かかります (サーバ起動プロセスの最後に時間が表示されます)。
| Info |
|---|
同じディレクトリ内にある別のファイルを使用することで、Yellowfin アプリケーションサーバを停止できます。shutdown.bat ファイル (Windowsの場合)、またはShutdown.command ファイル (Mac/Linuxの場合) をダブルクリックして、シャットダウンを実行します。 |
Windows - Yellowfin サービスの開始
Windowsでは、Yellowfinをサービスとして起動する追加オプションがあります。Yellowfin ソフトウェアインストールプロセス中に、この機能をインストールするかどうかを求められます。インストールをした場合は、次の手順に従ってサービスを開始します。インストールをしていない場合は、インストール後にこのツールを有効にする方法についてこちらの記事を参照し、次の手順に従います。
- Windows + Rキーを使用して、ファイル名を指定して実行ダイアログボックスを開きます。
- services.mscと入力し、エンターキーを押下します。
- 一覧からYellowfin サービスを探し、右クリックをしてポップアップメニューを表示します。
- 開始 (Start) メニューオプションをクリックします。
- コンピューターの起動に合わせてYellowfinを自動的に開始したい場合は、Yellowfin サービスをダブルクリックし、Yellowfin プロパティダイアログボックスを開きます。
- 開始タイプ (Startup Type) ドロップダウンで自動 (Automatic)を選択し、OKボタンをクリックします。
- Yellowfin サービスを停止するには、これを右クリックし、停止 (Stop) を選択します。
...
Yellowfinへのログイン
Yellowfin アプリケーションサーバを起動したら、ウェブブラウザを使用してYellowfin クライアントログインページに移動します。Yellowfinは、次のブラウザをサポートしています。
- Chrome
- Firefox 2+
- Microsoft Edge
- Opera 8+
- Safari 2+
Microsoftは、同社のブラウザであるInternet Explorer 11のサポートを段階的に廃止する予定であることに注意してください。その結果、Yellowfin ソフトウェアはIE 11上での実行のサポートを終了しており、IE 11の使用継続を選択した場合、Yellowfinのすべての機能が使用可能であることを保証することはできません。
Yellowfinをローカルマシンにインストールした場合は、同じ端末からYellowfin クライアントにアクセスをしてください。
Yellowfinを共有サーバにインストールした場合、同じ端末または対象の共有サーバにアクセスできる端末からYellowfin クライアントにアクセスすることができます。
- Yellowfinでサポートしているブラウザを開きます。
- インストールプロセスで提供したサーバホストおよびポート詳細に一致するURLを入力します (例えば、ローカルインストールの場合はlocalhost:8080、共有サーバへのインストールの場合はserver-name.yourcompany.comなど)
Yellowfinのログイン画面が表示され、ユーザー名およびパスワードの入力を促されます。
- 以下の示すデフォルトのログイン詳細を入力し、ログインボタンを押下します。
- ユーザー名: admin@yellowfin.com.au
- パスワード: test
- 表示される指示に従いパスワードをよりセキュアなものに変更します。
...
レポート外部アクセス時BaseURLの設定
レポート外部アクセス時BaseURLを設定することで、電子メールリンクやYellowfinへのJS APIアクセスを有効化します。
- 画面左側のメニューで管理＞システム構成をクリックします。
- 画面上部からシステムボタンをクリックします。
- 一般設定をクリックし、レポート外部アクセス時BaseURL項目を展開します。
- localhostの記載を、Yellowfin インスタンスにアクセスする際に使用する外部URL (IPアドレスまたはドメイン名) に変更します。
- 画面右上の保存ボタンをクリックして、変更内容を保存します。
| Info |
|---|
特定のクラスタ化インストール (Yellowfin 9.3を使用している場合のみ) でこの項目を設定する場合、追加の考慮事項があります。PDFブロードキャストの実行で問題が発生した場合は、こちらのコミュニティの記事を参照してください。 |
これで、Yellowfinを実行できる最小構成での設定が完了しました。ロギングおよびその他有用な管理機能については、上記の導入後の手順項目の一覧を参照してください。