第5章 CodeReady Studio での OpenShift の基本
CodeReady Studio には OpenShift Application Explorer ビューが含まれています。これにより、ユーザーエクスペリエンスが簡素化され、内部ループで簡単および迅速にフィードバックすることができ、デバックも容易および迅速に行うことができます。
OpenShift Application Explorer は、CodeReady Studio でデフォルトのビューとして設定されています。手動で開く必要がある場合は、「OpenShift Application Explorer ビューの設定」を参照してください。
5.1. OpenShift Application Explorer ビューの設定
CodeReady Studio で OpenShift Application Explorer を開く方法を説明します。
手順
- CodeReady Studio を起動します。
Window → Show View → Other とクリックします。
Show View ウインドウが表示されます。
- 検索フィールドに OpenShift と入力します。
- OpenShift Application Explorer を選択します。
Open をクリックします。
OpenShift Application Explorer ビューが表示されます。
5.2. OpenShift Application Explorer を使用した OpenShift クラスターへの接続
OpenShift Application Explorer を使用して CodeReady Studio で OpenShift クラスターにログインする方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を開きます。
Can't connect to cluster. Click to loging. をクリックします。
Login ウインドウが表示されます。
URL フィールドに OpenShift API URL を貼り付けます。
OpenShift API URL 経由でクラスターにアクセスする方法の詳細は、「Red Hat OpenShift - Accessing your Services」を参照してください。
- ユーザー名とパスワードまたはトークンを入力します。
- Finish をクリックします。
5.2.1. ブラウザーベースのトークンの取得
ユーザー名とパスワード、またはトークンを提供する代わりに、ブラウザーベースのトークンを取得して、OpenShift クラスターにログインすることができます。ログインの方法には「Paste Login Command」と「Retrieve Token」の 2 つがあります。
「Paste Login Command」の使用
URL フィールドに OpenShift API URL を貼り付けます。
OpenShift API URL 経由でクラスターにアクセスする方法の詳細は、「Red Hat OpenShift - Accessing your Services」を参照してください。
OpenShift Container Platform の Web UI にアクセスします。
- 右上隅のドロップダウンメニューをクリックします。
- Copy Login Command をクリックします。
- Display Token をクリックします。
- ログインコマンドをコピーします。
Sign in to OpenShift ウィンドウで Paste login command をクリックします。
Finish をクリックします。
注記OpenShift 3 では、ログインコマンドは自動的にクリップボードにコピーされます。
「Retrieve Token」の使用
URL フィールドに OpenShift API URL を貼り付けます。
OpenShift API URL 経由でクラスターにアクセスする方法の詳細は、「Red Hat OpenShift - Accessing your Services」を参照してください。
Retrieve token をクリックします。
- ユーザー名とパスワードを入力します。
- Log in をクリックします。
- Display Token をクリックします。
- Finish をクリックします。
プロジェクトが OpenShift Application Explorer ビューに表示されます。
5.3. OpenShift ツールを使用した Developer Sandbox の設定
ここでは、CodeReady Studio で Developer Sandbox にブートストラップを実行し、ログインする方法を説明します。
手順
- CodeReady Studio を起動します。
OpenShift Application Explorer を開きます。
- OpenShift コネクションを右クリックします。
Login をクリックします。
Sign in to OpenShift ウィンドウが表示されます。
- Red Hat Developer Sandbox をクリックします。
Red Hat アカウントのクレデンシャルを入力し、Log in をクリックします。
Developer Sandbox がブートストラップされました。
Login to Red Hat Developer Sandbox ウィンドウが表示されます。
- Next をクリックします。
- DevSandbox をクリックします。
- Red Hat アカウントのクレデンシャルを再度入力し、Log in をクリックします。
- Display Token をクリックします。
Finish をクリックします。
トークンが Sign in to OpenShift ウィンドウに表示されます。
Finish をクリックします。
これで Developer Sandbox にログインした状態となります。
Developer Sandbox が OpenShift Application Explorer ビューに表示されます。
5.4. devfile に基づくアプリケーションのビルド
devfile を基にしてアプリケーションをデプロイするには、ローカルのワークスペースに空のプロジェクトが必要です。さらに、OpenShift にも devfile コンポーネントを作成するための空のプロジェクトが必要です。コンポーネントの確立後、プロジェクトが更新され、OpenShift で作成されたローカルおよびリモートアーティファクトも更新されます。
5.4.1. 空のプロジェクトの作成
CodeReady Studio で空のプロジェクトを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- General → Project を選択します。
Next をクリックします。
New Project ウインドウが表示されます。
- プロジェクトに名前を付けます。
- プロジェクトの場所を選択します。
- Finish をクリックします。
新たに作成した空のプロジェクトが Project Explorer ビューに表示されます。
5.4.2. OpenShift Application Explorer を使用した空の OpenShift プロジェクトの作成
CodeReady Studio で OpenShift Application Explorer を使用して空のプロジェクトを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
OpenShift Application Explorer → New → Project の任意の場所をクリックします。
New project ウインドウが表示されます。
- プロジェクトに名前を付けます。
- OK をクリックします。
新たに作成したプロジェクトが OpenShift Application Explorer ビューに表示されます。
5.4.3. OpenShift Application Explorer を使用した devfile コンポーネントの作成
CodeReady Studio で OpenShift Application Explorer を使用して devfile コンポーネントを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
ターゲットの Project → New → Component を右クリックします。
Create component ウィンドウが表示されます。
- プロジェクトに名前を付けます。
- Browse をクリックして Eclipse Project を選択します。
-
Component type を
java-vertx
に設定します。 -
Project starter を
java-vertx
に設定します。 - アプリケーションに名前を付けます。
- Push after create チェックボックスを未選択にします。
- Finish をクリックします。
Console ビューが表示され、検証プロセスが表示されます。
新たに作成されたコンポーネントが、プロジェクト下の OpenShift Application Explorer ビューに表示されます。
5.4.4. OpenShift Application Explorer を使用した devfile レジストリー管理
CodeReady Studio で OpenShift Application Explorer を使用して devfile レジストリーを作成、削除、および編集する方法を説明します。
devfile レジストリーの追加
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
devfile レジストリーは、Devfile registries ノードに表示されます。
devfile レジストリーノードを拡張すると、そのレジストリーのすべての devfile が表示されます。
新規 devfile レジストリーを追加するには、Devfile registries を右クリックし、new をクリックします。
Create devfile registry ウインドウが表示されます。
- devfile レジストリーに名前を付けます。
- devfile URL を貼り付けます。
- Finish をクリックします。
新たに作成された devfile レジストリーが Devfile registries 下の OpenShift Application Explorer ビューに表示されます。
devfile レジストリーの削除
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
devfile レジストリーは、Devfile registries ノードに表示されます。
展開された devfile レジストリーノードには、そのレジストリーのすべての devfile が表示されます。
devfile レジストリーを削除するには、devfile レジストリーのノードを右クリックして、delete をクリックします。
devfile レジストリーが削除されます。
devfile レジストリーの編集
- devfile レジストリーを編集するには、YAML エディターを使用します。YAML エディターは構文の検証およびコンテンツ補助を提供します。
その他のリソース
devfile の詳細は、「Introduction to Devfile」を参照してください。
5.5. S2I ファイルを基にしたアプリケーションのビルド
S2I ファイルを基にしてアプリケーションをデプロイするには、ローカルのワークスペースに空のプロジェクトが必要です。さらに、OpenShift にもコンポーネントを作成するための空のプロジェクトが必要です。コンポーネントの確立後、プロジェクトが更新され、OpenShift で作成されたローカルおよびリモートアーティファクトも更新されます。
5.5.1. ランチャープロジェクトの作成
CodeReady Studio でランチャープロジェクトを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
Ctrl+N キーを押します。
Select a wizard ウインドウが表示されます。
- 検索フィールドに Launcher と入力します。
- Launcher project を選択します。
Next をクリックします。
New Launcher project ウインドウが表示されます。
-
Mission を
rest-http
に設定します。 -
Runtime を
vert.x community
に設定します。 - プロジェクトに名前を付けます。
- プロジェクトの場所を選択します。
Finish をクリックします。
依存関係の解決プロセスが完了するまで時間がかかることがあるため注意してください。
新た作成されたランチャープロジェクトが Project Explorer ビューに表示されます。
5.5.2. OpenShift Application Explorer での空の OpenShift プロジェクトの作成
CodeReady Studio で OpenShift Application Explorer を使用して空のプロジェクトを作成する方法を説明します。
手順
OpenShift Application Explorer → New → Project の任意の場所をクリックします。
New project ウインドウが表示されます。
- プロジェクトに名前を付けます。
- OK をクリックします。
新たに作成したプロジェクトが OpenShift Application Explorer ビューに表示されます。
5.5.3. OpenShift Application Explorer を使用した S2I コンポーネントの作成
CodeReady Studio で OpenShift Application Explorer を使用してコンポーネントを作成する方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
ターゲットの Project → New → Component を右クリックします。
Create component ウィンドウが表示されます。
- プロジェクトに名前を付けます。
- Browse をクリックして Eclipse Project を選択します。
-
S2I
の横にある矢印をクリックし、Component type をjava
に設定します。 -
Component version を
latest
に設定します。 - アプリケーションに名前を付けます。
- Push after create チェックボックスを未選択にします。
- Finish をクリックします。
Console ビューが表示され、検証プロセスが表示されます。
新たに作成されたコンポーネントが、プロジェクト下の OpenShift Application Explorer ビューに表示されます。
5.6. OpenShift Application Explorer を使用したクラスターへのコンポーネントのデプロイ
CodeReady Studio で OpenShift Application Explorer を使用して、クラスターにコンポーネントをデプロイする方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
- プロジェクトを展開します。
- アプリケーションを展開します。
component → Push を右クリックします。
Console ビューが表示され、ファイル同期化のプロセスが表示されます。
5.7. OpenShift Application Explorer を使用した外部アクセス URL の定義
CodeReady Studio で OpenShift Application Explorer を使用して外部アクセス URL を定義する方法を説明します。
手順
- CodeReady Studio を起動します。
- OpenShift Application Explorer を起動します。
- プロジェクトを展開します。
- アプリケーションを展開します。
component → New → URL を右クリックします。
Create URL ウインドウが表示されます。
- URL に名前を付けます。
- Port の値を 8080 に設定します。
Finish をクリックします。
Console ビューが表示され、URL 作成のプロセスが表示されます。
OpenShift Application Explorer で、component → Push を右クリックします。
Console ビューが表示され、ファイル同期化のプロセスが表示されます。
新たに作成された URL がコンポーネント下の OpenShift Application Explorer ビューに表示されます。
5.8. OpenShift Application Explorer を使用したクラスターでのアプリケーションのデバッグ
CodeReady Studio で OpenShift Application Explorer を使用して、クラスターでアプリケーションをデバッグする方法を説明します。
手順
- CodeReady Studio を起動します。
-
Project Explorer ビューで
MainVerticle.java
(devfiles) またはHttpApplication.java
(S2I) ファイルを見つけ、ダブルクリックして開きます。 左側がルーラーになっている列をクリックし、ブレークポイントを設定します。
- OpenShift Application Explorer を開きます。
- プロジェクトを展開します。
- アプリケーションを展開します。
component → Debug を右クリックします。
Console ビューが表示されます。
- OpenShift Application Explorer で、コンポーネントを展開します。
url → Open in Browser を右クリックします。
Confirm Perspective Switch ウインドウが表示されます。
Switch をクリックします。
Debug Perspective ウィンドウが表示され、デバッグプロセスが表示されます。