アプリケーションのビルド

1. Developer パースペクティブで、Project ページに移動します。
2. Project メニューからプロジェクトを選択します。
3. Project Access タブを選択します。

4. Add access をクリックして、パーミッションの新規の行をデフォルトのパーミッションに追加します。

   図2.2 プロジェクトパーミッション

   
5. ユーザー名を入力し、Select a role ドロップダウンリストをクリックし、適切なロールを選択します。
6. Save をクリックして新規パーミッションを追加します。

手順

1. Administrator パースペクティブで、Administration → Cluster settings に移動します。
2. Configuration タブをクリックします。
3. Configuration resource リストから、Console operator.openshift.io を選択します。
4. YAML タブに移動し、YAML コードを表示し、編集します。

5. spec の YAML コードで、プロジェクトアクセスに使用可能なクラスターロールのリストをカスタマイズします。次の例では、デフォルトの admin、edit、および view ロールを指定します。

   apiVersion: operator.openshift.io/v1
   kind: Console
   metadata:
     name: cluster
   # ...
   spec:
     customization:
       projectAccess:
         availableClusterRoles:
         - admin
         - edit
         - view

6. Save をクリックして、Console 設定リソースへの変更を保存します。

検証

1. Developer パースペクティブで、Project ページに移動します。
2. Project メニューからプロジェクトを選択します。
3. Project access タブを選択します。
4. Role 列のメニューをクリックし、使用可能なロールが Console リソース設定に適用した設定と一致することを確認します。

手順

1. Developer パースペクティブで、+Add ページに移動します。
2. Project メニューからプロジェクトを選択します。
3. +Add ページで項目をクリックし、ワークフローに従います。

手順

1. cluster-admin 権限を持つユーザーとしてログインしている。

2. デフォルトのプロジェクトテンプレートを生成します。

   $ oc adm create-bootstrap-project-template -o yaml > template.yaml

3. オブジェクトを追加するか、既存オブジェクトを変更することにより、テキストエディターで生成される template.yaml ファイルを変更します。

4. プロジェクトテンプレートは、openshift-config namespace に作成される必要があります。変更したテンプレートを読み込みます。

   $ oc create -f template.yaml -n openshift-config

5. Web コンソールまたは CLI を使用し、プロジェクト設定リソースを編集します。

   • Web コンソールの使用

     1. Administration → Cluster Settings ページに移動します。
     2. Configuration をクリックし、すべての設定リソースを表示します。
     3. Project のエントリーを見つけ、Edit YAML をクリックします。

   • CLI の使用

     1. project.config.openshift.io/cluster リソースを編集します。

        $ oc edit project.config.openshift.io/cluster

6. spec セクションを、projectRequestTemplate および name パラメーターを組み込むように更新し、アップロードされたプロジェクトテンプレートの名前を設定します。デフォルト名は project-request です。

   カスタムプロジェクトテンプレートを含むプロジェクト設定リソース

   apiVersion: config.openshift.io/v1
   kind: Project
   metadata:
   # ...
   spec:
     projectRequestTemplate:
       name: <template_name>
   # ...

7. 変更を保存した後、変更が正常に適用されたことを確認するために、新しいプロジェクトを作成します。

手順

1. cluster-admin 権限を持つユーザーとしてログインします。

2. 以下のコマンドを実行して、self-provisioners クラスターロールバインディングの使用を確認します。

   $ oc describe clusterrolebinding.rbac self-provisioners

   出力例

   Name:		self-provisioners
   Labels:		<none>
   Annotations:	rbac.authorization.kubernetes.io/autoupdate=true
   Role:
     Kind:	ClusterRole
     Name:	self-provisioner
   Subjects:
     Kind	Name				Namespace
     ----	----				---------
     Group	system:authenticated:oauth

   self-provisioners セクションのサブジェクトを確認します。

3. self-provisioner クラスターロールをグループ system:authenticated:oauth から削除します。

   • self-provisioners クラスターロールバインディングが self-provisioner ロールのみを system:authenticated:oauth グループにバインドする場合、以下のコマンドを実行します。

     $ oc patch clusterrolebinding.rbac self-provisioners -p '{"subjects": null}'

   • self-provisioners クラスターロールバインディングが self-provisioner ロールを system:authenticated:oauth グループ以外のユーザー、グループまたはサービスアカウントにバインドする場合、以下のコマンドを実行します。

     $ oc adm policy \
         remove-cluster-role-from-group self-provisioner \
         system:authenticated:oauth

4. ロールへの自動更新を防ぐには、self-provisioners クラスターロールバインディングを編集します。自動更新により、クラスターロールがデフォルトの状態にリセットされます。

   • CLI を使用してロールバインディングを更新するには、以下を実行します。

     1. 以下のコマンドを実行します。

        $ oc edit clusterrolebinding.rbac self-provisioners

     2. 表示されるロールバインディングで、以下の例のように rbac.authorization.kubernetes.io/autoupdate パラメーター値を false に設定します。

        apiVersion: authorization.openshift.io/v1
        kind: ClusterRoleBinding
        metadata:
          annotations:
            rbac.authorization.kubernetes.io/autoupdate: "false"
        # ...

   • 単一コマンドを使用してロールバインディングを更新するには、以下を実行します。

     $ oc patch clusterrolebinding.rbac self-provisioners -p '{ "metadata": { "annotations": { "rbac.authorization.kubernetes.io/autoupdate": "false" } } }'

5. 認証されたユーザーとしてログインし、プロジェクトのセルフプロビジョニングを実行できないことを確認します。

   $ oc new-project test

   出力例

   Error from server (Forbidden): You may not request a new project via this API.

   組織に固有のより有用な説明を提供できるようこのプロジェクト要求メッセージをカスタマイズすることを検討します。

手順

1. Web コンソールまたは CLI を使用し、プロジェクト設定リソースを編集します。

   • Web コンソールの使用

     1. Administration → Cluster Settings ページに移動します。
     2. Configuration をクリックし、すべての設定リソースを表示します。
     3. Project のエントリーを見つけ、Edit YAML をクリックします。

   • CLI の使用

     1. cluster-admin 権限を持つユーザーとしてログインします。

     2. project.config.openshift.io/cluster リソースを編集します。

        $ oc edit project.config.openshift.io/cluster

2. spec セクションを、projectRequestMessage パラメーターを含むように更新し、値をカスタムメッセージに設定します。

   カスタムプロジェクト要求メッセージを含むプロジェクト設定リソース

   apiVersion: config.openshift.io/v1
   kind: Project
   metadata:
   # ...
   spec:
     projectRequestMessage: <message_string>
   # ...

   以下に例を示します。

   apiVersion: config.openshift.io/v1
   kind: Project
   metadata:
   # ...
   spec:
     projectRequestMessage: To request a project, contact your system administrator at projectname@example.com.
   # ...

3. 変更を保存した後に、プロジェクトをセルフプロビジョニングできない開発者またはサービスアカウントとして新規プロジェクトの作成を試行し、変更が正常に適用されていることを確認します。

手順

1. +Add ビューで、Samples タイルをクリックして Samples ページを表示します。
2. Samples ページで、利用可能なサンプルアプリケーションの 1 つを選択し、Create Sample Application フォームを表示します。

3. Create Sample Application Form:

   • Name フィールドには、デフォルトでデプロイメント名が表示されます。この名前は必要に応じて変更することができます。
   • Builder Image Version では、ビルダーイメージがデフォルトで選択されます。Builder Image Version ドロップダウンリストを使用してイメージバージョンを変更できます。
   • Git リポジトリー URL のサンプルは、デフォルトで追加されます。
4. Create をクリックしてサンプルアプリケーションを作成します。サンプルアプリケーションのビルドステータスが Topology ビューに表示されます。サンプルアプリケーションの作成後、デプロイメントがアプリケーションに追加されていることを確認できます。

手順

1. +Add ビューで、Getting Started resources → Build with guided documentation → View all quick starts リンクをクリックして、Quick Starts ページを表示します。
2. Quick Starts ページで、使用するクイックスタートのタイルをクリックします。
3. Start をクリックして、クイックスタートを開始します。
4. 表示される手順を実行します。

手順

1. +Add ビューで、Git Repository タイルの From Git をクリックし、Import from git フォームを表示します。
2. Git セクションで、アプリケーションの作成に使用するコードベースの Git リポジトリー URL を入力します。たとえば、このサンプル nodejs アプリケーションの URL https://github.com/sclorg/nodejs-ex を入力します。その後、URL は検証されます。

3. オプション: Show Advanced Git Options をクリックし、以下のような詳細を追加できます。

   • Git Reference: アプリケーションのビルドに使用する特定のブランチ、タグ、またはコミットのコードを参照します。
   • Context Dir: アプリケーションのビルドに使用するアプリケーションのソースコードのサブディレクトリーを指定します。
   • Source Secret: プライベートリポジトリーからソースコードをプルするための認証情報で Secret Name を作成します。

4. オプション: Devfile、Dockerfile、Builder Image、または Serverless Function が Git リポジトリーからインポートして、デプロイをさらにカスタマイズできます。

   • Git リポジトリーに Devfile、Dockerfile、Builder Image、または func.yaml が含まれている場合、それらは自動的に検出され、それぞれのパスフィールドに入力されます。
   • Devfile、Dockerfile、または Builder Image が同じリポジトリーで検出された場合、デフォルトで Devfile が選択されます。
   • Git リポジトリーで func.yaml が検出された場合、Import Strategy は Serverless Function に変更されます。
   • または、Git リポジトリー URL を使用して +Add ビューでサーバー Create Serverless function をクリックして、サーバーレス関数を作成することもできます。
   • ファイルのインポートタイプを編集して、別のストラテジーを選択し、Edit import strategy オプションをクリックします。
   • 複数の Devfiles、Dockerfiles、または Builder Images が検出された場合、特定のインスタンスをインポートするには、コンテキストディレクトリーからの相対パスをそれぞれ指定します。

5. Git URL の検証後に、推奨されるビルダーイメージが選択されて星マークが付けられます。ビルダーイメージが自動検出されていない場合は、ビルダーイメージを選択します。https://github.com/sclorg/nodejs-ex Git URL の場合、Node.js ビルダーイメージがデフォルトで選択されます。

   1. オプション:Builder Image Version ドロップダウンリストを使用してバージョンを指定します。
   2. オプション:Edit import strategy を使用して、別のストラテジーを選択します。
   3. オプション:Node.js ビルダーイメージの場合、Run command フィールドを使用して、アプリケーションを実行するためにコマンドを上書きします。

6. General セクションで、以下を実行します。

   1. Application フィールドに、アプリケーションを分類するために一意の名前 (myapp など) を入力します。アプリケーション名が namespace で一意であることを確認します。

   2. Name フィールドで、既存のアプリケーションが存在しない場合に、このアプリケーション用に作成されたリソースが Git リポジトリー URL をベースとして自動的に設定されることを確認します。既存のアプリケーションがある場合には、既存のアプリケーション内でそのコンポーネントをデプロイしたり、新しいアプリケーションを作成したり、またはコンポーネントをいずれにも割り当てない状態にしたりすることができます。

      注記

      リソース名は namespace で一意である必要があります。エラーが出る場合はリソース名を変更します。

7. Resources セクションで、以下を選択します。

   • Deployment: 単純な Kubernetes スタイルのアプリケーションを作成します。
   • Deployment Config: OpenShift Container Platform スタイルのアプリケーションを作成します。

   • Serverless Deployment: Knative サービスを作成します。

     注記

     アプリケーションをインポートするためのデフォルトのリソース設定を設定するには、User Preferences → Applications → Resource type フィールドに移動します。Serverless Deployment オプションは、OpenShift Serverless Operator がクラスターにインストールされている場合にのみ、Import from Git フォームに表示されます。Resources セクションは、サーバーレス関数の作成時には利用できません。詳細は、OpenShift Serverless のドキュメントを参照してください。

8. Pipelines セクションで、Add Pipeline を選択してから Show Pipeline Visualization をクリックし、アプリケーションのパイプラインを表示します。デフォルトのパイプラインが選択されますが、アプリケーションで利用可能なパイプラインの一覧から必要なパイプラインを選択できます。

   注記

   次の基準が満たされている場合、Add pipeline チェックボックスがオンになり、Configure PAC がデフォルトで選択されます。

   • パイプラインオペレーターがインストールされています
   • pipelines-as-code が有効になっています
   • .tekton ディレクトリーが Git リポジトリーで検出される

9. Webhook をリポジトリーに追加します。Configure PAC がオンになっており、GitHub アプリがセットアップされている場合は、Use GitHub App と Setup a webhook オプションが表示されます。GitHub アプリケーションがセットアップされていない場合は、Setup a webhook オプションのみが表示されます。

   1. Settings → Webhooks に移動し、Add webhook をクリックします。
   2. Payload URL を Pipelines as Code コントローラーのパブリック URL に設定します。
   3. コンテンツタイプを application/json として選択します。
   4. Webhook シークレットを追加し、別の場所に書き留めます。openssl がローカルマシンにインストールされた状態で、ランダムなシークレットを生成します。
   5. Let me select individual events をクリックし、Commit comments、Issue comments、Pull request、および Pushes のイベントを選択します。
   6. Add webhook をクリックします。

10. オプション: Advanced Options セクションでは、Target port および Create a route to the application がデフォルトで選択されるため、公開されている URL を使用してアプリケーションにアクセスできます。

    アプリケーションがデフォルトのパブリックポート 80 でデータを公開しない場合は、チェックボックスの選択を解除し、公開する必要のあるターゲットポート番号を設定します。

11. オプション: 以下の高度なオプションを使用してアプリケーションをさらにカスタマイズできます。

    Routing

    Routing のリンクをクリックして、以下のアクションを実行できます。

    • ルートのホスト名をカスタマイズします。
    • ルーターが監視するパスを指定します。
    • ドロップダウンリストから、トラフィックのターゲットポートを選択します。

    • Secure Route チェックボックスを選択してルートを保護します。必要な TLS 終端タイプを選択し、各ドロップダウンリストから非セキュアなトラフィックに関するポリシーを設定します。

      注記

      サーバーレスアプリケーションの場合、Knative サービスが上記のすべてのルーティングオプションを管理します。ただし、必要に応じて、トラフィックのターゲットポートをカスタマイズできます。ターゲットポートが指定されていない場合、デフォルトポートの 8080 が使用されます。

    ドメインマッピング

    Serverless Deployment を作成する場合、作成時に Knative サービスにカスタムドメインマッピングを追加できます。

    • Advanced options セクションで、Show advanced Routing options をクリックします。

      • サービスにマッピングするドメインマッピング CR がすでに存在する場合は、Domain mapping のドロップダウンメニューから選択できます。
      • 新規ドメインマッピング CR を作成する場合は、ドメイン名をボックスに入力し、Create オプションを選択します。たとえば、example.com と入力すると、Create オプションは Create "example.com" になります。

    ヘルスチェック

    Health Checks リンクをクリックして、Readiness、Liveness、および Startup プローブをアプリケーションに追加します。すべてのプローブに事前に設定されたデフォルトデータが実装され、必要に応じてデフォルトデータでプローブを追加したり、必要に応じてこれをカスタマイズしたりできます。

    ヘルスプローブをカスタマイズするには、以下を実行します。

    • Add Readiness Probe をクリックし、必要に応じてコンテナーが要求を処理する準備ができているかどうかを確認するためにパラメーターを変更し、チェックマークを選択してプローブを追加します。
    • Add Liveness Probe をクリックし、必要に応じてコンテナーが実行中かどうかを確認するためにパラメーターを変更し、チェックマークを選択してプローブを追加します。

    • Add Startup Probe をクリックし、必要に応じてコンテナー内のアプリケーションが起動しているかどうかを確認するためにパラメーターを変更し、チェックマークを選択してプローブを追加します。

      それぞれのプローブについて、ドロップダウンリストから要求タイプ (HTTP GET、Container Command、TCP Socket) を指定できます。選択した要求タイプに応じてフォームが変更されます。次に、プローブの成功および失敗のしきい値、コンテナーの起動後の最初のプローブ実行までの秒数、プローブの頻度、タイムアウト値など、他のパラメーターのデフォルト値を変更できます。

    ビルド設定およびデプロイメント

    Build Configuration および Deployment リンクをクリックして、それぞれの設定オプションを表示します。オプションの一部はデフォルトで選択されています。必要なトリガーおよび環境変数を追加して、オプションをさらにカスタマイズできます。

    サーバーレスアプリケーションの場合、Deployment オプションは表示されません。これは、Knative 設定リソースが DeploymentConfig リソースの代わりにデプロイメントの必要な状態を維持するためです。

    スケーリング

    Scaling リンクをクリックして、最初にデプロイするアプリケーションの Pod 数またはインスタンス数を定義します。

    サーバーレスデプロイメントを作成する場合、以下の設定を行うこともできます。

    • Min Pods は、Knative サービスである時点で実行する必要がある Pod 数の下限を決定します。これは、minScale 設定としても知られています。
    • Max Pods は、Knative サービスである時点で実行できる Pod 数の上限を決定します。これは、maxScale 設定としても知られています。
    • Concurrency target は、ある時点でアプリケーションの各インスタンスに対して必要な同時リクエストの数を決定します。
    • Concurrency limit は、ある時点でアプリケーションの各インスタンスに対して許容される同時リクエストの数の制限を決定します。
    • Concurrency utilization は、Knative が追加のトラフィックを処理するために追加の Pod をスケールアップする際に満たす必要のある同時リクエストの制限のパーセンテージを決定します。
    • Autoscale window は、Autoscaler がパニックモードではない場合に、スケーリングの決定を行う際のインプットを提供するためにメトリクスの平均値を計算する期間を定義します。この期間中にリクエストが受信されなかった場合、サービスはゼロにスケーリングされます。Autoscale window のデフォルト期間は 60s です。これは stable window としても知られています。

    リソースの制限

    Resource Limit リンクをクリックして、コンテナーが実行時に保証または使用が許可されている CPU および メモリー リソースの量を設定します。

    ラベル

    Labels リンクをクリックして、カスタムラベルをアプリケーションに追加します。

12. Create をクリックしてアプリケーションを作成し、成功の通知が表示されます。Topology ビューでアプリケーションのビルドステータスを確認できます。

手順

1. +Add ビューで、Container images をクリックして、Deploy Images ページを表示します。

2. Image セクションで以下を行います。

   1. Image name from external registry を選択してパブリックレジストリーまたはプライベートレジストリーからイメージをデプロイメントするか、Image stream tag from internal registry を選択して内部レジストリーからイメージをデプロイメントします。
   2. Runtime icon タブでイメージのアイコンを選択します。

3. General セクションで、以下を実行します。

   1. Application name フィールドに、アプリケーションを分類するための一意の名前を入力します。
   2. Name フィールドに、このコンポーネント用に作成されたリソースを識別するための一意の名前を入力します。

4. Resource type セクションで、生成するリソースタイプを選択します。

   1. Deployment を選択して、Pod および ReplicaSet オブジェクトの宣言的更新を有効にします。
   2. DeploymentConfig を選択して、Pod オブジェクトのテンプレートを定義し、新しいイメージと設定ソースのデプロイを管理します。
   3. アイドル時にゼロへのスケーリングを有効にするには、Serverless Deployment を選択します。
5. Create をクリックします。Topology ビューでアプリケーションのビルドステータスを確認できます。

手順

1. Topology ビューで、任意の場所を右クリックして Add to Project メニューを表示します。
2. Add to Project メニューにカーソルを置いてメニューオプションを表示し、Upload JAR file オプションを選択して Upload JAR file フォームを確認します。または、JAR ファイルを Topology ビューにドラッグできます。
3. JAR file フィールドで、ローカルマシンで必要な JAR ファイルを参照し、これをアップロードします。または、JAR ファイルをフィールドにドラッグできます。互換性のないタイプのファイルが Topology ビューにドラッグされると、トーストアラートが右側に表示されます。互換性のないファイルタイプがアップロードフォームのフィールドにドロップされると、フィールドエラーが表示されます。
4. デフォルトで、ランタイムアイコンとビルダーイメージが選択されています。ビルダーイメージが自動検出されていない場合は、ビルダーイメージを選択します。必要に応じて、Builder Image Version のドロップダウンリストを使用してバージョンを変更できます。
5. オプション: Application Name フィールドに、リソースのラベル付けに使用する一意のアプリケーション名を入力します。
6. Name フィールドに、関連付けられたリソースに名前を付けるために一意のコンポーネント名を入力します。
7. オプション: Resource type ドロップダウンリストを使用して、リソースタイプを変更します。
8. Advanced options メニューで Create a Route to the Application をクリックし、デプロイされたアプリケーションのパブリック URL を設定します。
9. Create をクリックしてアプリケーションをデプロイします。JAR ファイルがアップロードされたことを通知するトースト通知が表示されます。トースト通知には、ビルドログを表示するリンクも含まれます。

手順

1. Developer Perspective → +Add → Developer Catalog → All Services に移動します。Developer Catalog で利用可能なすべてのサービスの一覧が表示されます。
2. Type で、Devfiles をクリックして、特定の言語またはフレームワークをサポートする devfiles を参照します。あるいは、キーワードフィルターを使用して、名前、タグ、または説明を使用して特定の devfile を検索できます。
3. アプリケーションの作成に使用する devfile をクリックします。devfile タイルに、devfile の名前、説明、プロバイダー、ドキュメントなど、devfile の詳細が表示されます。
4. Create をクリックしてアプリケーションを作成し、Topology ビューでアプリケーションを表示します。

手順

1. Developer パースペクティブで、+Add に移動して、Developer Catalog タイルから All Services をクリックし、Developer Catalog で利用可能なすべてのサービスを表示します。
2. All Services で、サービスの種類またはプロジェクトに追加する必要のあるコンポーネントを選択します。この例では、Databases を選択してすべてのデータベースサービスを一覧表示し、MariaDB をクリックしてサービスの詳細を表示します。

3. Instantiate Template をクリックして、MariaDB サービスの詳細情報を含む自動的に設定されたテンプレートを表示し、Create をクリックして Topology ビューで MariaDB サービスを作成し、これを表示します。

   図3.1 トポロジーの MariaDB

   

手順

1. この手順を実行するために OpenShift Container Platform Web コンソールで新規プロジェクトを作成します。この例では、my-etcd というプロジェクトを使用します。

2. Operators → Installed Operators ページに移動します。クラスター管理者によってクラスターにインストールされ、使用可能にされた Operator がクラスターサービスバージョン (CSV) のリストとしてここに表示されます。CSV は Operator によって提供されるソフトウェアを起動し、管理するために使用されます。

   ヒント

   以下を使用して、CLI でこのリストを取得できます。

   $ oc get csv

3. Installed Operators ページで、etcd Operator をクリックして詳細情報および選択可能なアクションを表示します。

   Provided APIs に表示されているように、この Operator は 3 つの新規リソースタイプを利用可能にします。これには、etcd クラスター (EtcdCluster リソース) のタイプが含まれます。これらのオブジェクトは、Deployment または ReplicaSet などの組み込み済みのネイティブ Kubernetes オブジェクトと同様に機能しますが、これらには etcd を管理するための固有のロジックが含まれます。

4. 新規 etcd クラスターを作成します。

   1. etcd Cluster API ボックスで、Create instance をクリックします。
   2. 次のページでは、EtcdCluster オブジェクト (クラスターのサイズなど) のテンプレートを起動する最小条件を変更できます。ここでは Create をクリックして確定します。これにより、Operator がトリガーされ、Pod、サービス、および新規 etcd クラスターの他のコンポーネントが起動します。

5. example etcd クラスター、Resources タブの順にクリックし、Operator が自動的に作成および設定した多数のリソースが含まれていることを確認します。

   Kubernetes サービスが作成され、プロジェクトの他の Pod からデータベースにアクセスできることを確認します。

6. 所定プロジェクトで edit ロールを持つすべてのユーザーは、クラウドサービスのようにセルフサービス方式でプロジェクトにすでに作成されている Operator によって管理されるアプリケーションのインスタンス (この例では etcd クラスター) を作成し、管理し、削除することができます。この機能を持つ追加のユーザーを有効にする必要がある場合、プロジェクト管理者は以下のコマンドを使用してこのロールを追加できます。

   $ oc policy add-role-to-user edit <user> -n <target_project>

手順

1. Web コンソールの Administrator パースペクティブで、Operators → OperatorHub に移動します。
2. Filter by keywordボックスを使用して、カタログで Service Binding Operator を検索します。Service Binding Operator タイルをクリックします。
3. Service Binding Operator ページで Operator についての簡単な説明を参照してください。Install をクリックします。

4. Install Operator ページで以下を行います。

   1. Installation Mode で All namespaces on the cluster (default) を選択します。このモードは、デフォルトの openshift-operators namespace に Operator をインストールします。これにより、Operator はクラスター内のすべての namespace を監視し、これらの namespace に対して利用可能になります。
   2. Approval Strategy で Automatic を選択します。これにより、Operator への今後のアップグレードは Operator Lifecycle Manager (OLM) によって自動的に処理されます。Manual 承認ストラテジーを選択すると、OLM は更新要求を作成します。クラスター管理者は、Operator を新規バージョンに更新できるように OLM 更新要求を手動で承認する必要があります。

   3. Update Channel を選択します。

      • デフォルトでは、stable チャネルでは、サービスバインディング Operator の安定した最新版のリリースをインストールできます。

5. Install をクリックします。

   注記

   Operator は openshift-operators namespace に自動的にインストールされます。

6. Installed operator - ready for use ペインで、View Operator をクリックします。Operator が Installed Operators ページに一覧表示されます。
7. Status が Succeeded に設定されており、サービスバインディング Operator のインストールが正常に行われたことを確認します。

手順

1. シェルで以下のコマンドを実行して、my-petclinic namespace に PostgresCluster CR を作成します。

   $ oc apply -n my-petclinic -f - << EOD
   ---
   apiVersion: postgres-operator.crunchydata.com/v1beta1
   kind: PostgresCluster
   metadata:
     name: hippo
   spec:
     image: registry.developers.crunchydata.com/crunchydata/crunchy-postgres:ubi8-14.4-0
     postgresVersion: 14
     instances:
       - name: instance1
         dataVolumeClaimSpec:
           accessModes:
           - "ReadWriteOnce"
           resources:
             requests:
               storage: 1Gi
     backups:
       pgbackrest:
         image: registry.developers.crunchydata.com/crunchydata/crunchy-pgbackrest:ubi8-2.38-0
         repos:
         - name: repo1
           volume:
             volumeClaimSpec:
               accessModes:
               - "ReadWriteOnce"
               resources:
                 requests:
                   storage: 1Gi
   EOD

   この PostgresCluster CR に追加されたアノテーションは、サービスバインディング接続を有効にし、Operator の調整をトリガーします。

   この出力では、データベースインスタンスが作成されていることを検証します。

   出力例

   postgrescluster.postgres-operator.crunchydata.com/hippo created

2. データベースインスタンスを作成したら、my-petclinic namespace のすべての Pod が実行されていることを確認します。

   $ oc get pods -n my-petclinic

   出力 (表示に数分かかる) で、データベースが作成され設定されていることを検証できます。

   出力例

   NAME                                     READY    STATUS      RESTARTS   AGE
   hippo-backup-9rxm-88rzq                   0/1     Completed   0          2m2s
   hippo-instance1-6psd-0                    4/4     Running     0          3m28s
   hippo-repo-host-0                         2/2     Running     0          3m28s

   データベースを設定したら、サンプルアプリケーションをデプロイしてデータベースサービスに接続できます。

手順

1. シェルで以下のコマンドを実行して、spring-petclinic アプリケーションを PostgresCluster カスタムリソース (CR) でデプロイします。

   $ oc apply -n my-petclinic -f - << EOD
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: spring-petclinic
     labels:
       app: spring-petclinic
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: spring-petclinic
     template:
       metadata:
         labels:
           app: spring-petclinic
       spec:
         containers:
           - name: app
             image: quay.io/service-binding/spring-petclinic:latest
             imagePullPolicy: Always
             env:
             - name: SPRING_PROFILES_ACTIVE
               value: postgres
             ports:
             - name: http
               containerPort: 8080
   ---
   apiVersion: v1
   kind: Service
   metadata:
     labels:
       app: spring-petclinic
     name: spring-petclinic
   spec:
     type: NodePort
     ports:
       - port: 80
         protocol: TCP
         targetPort: 8080
     selector:
       app: spring-petclinic
   EOD

   この出力では、Spring PetClinic サンプルアプリケーションが作成され、デプロイされていることを確認します。

   出力例

   deployment.apps/spring-petclinic created
   service/spring-petclinic created

   注記

   Web コンソールの Developer パースペクティブでコンテナーイメージ を使用してアプリケーションをデプロイする場合は、Advanced options の Deployment セクションで以下の環境変数を入力する必要があります。

   • Name: SPRING_PROFILES_ACTIVE
   • Value: postgres

2. 以下のコマンドを実行して、アプリケーションがまだデータベースサービスに接続されていないことを確認します。

   $ oc get pods -n my-petclinic

   出力にCrashLoopBackOff ステータスが表示されるまで、数分かかります。

   出力例

   NAME                                READY   STATUS             RESTARTS      AGE
   spring-petclinic-5b4c7999d4-wzdtz   0/1     CrashLoopBackOff   4 (13s ago)   2m25s

   この段階では、Pod は起動に失敗します。アプリケーションとの対話を試みると、エラーが返されます。

3. サービスを公開して、アプリケーションのルートを作成します。

   $ oc expose service spring-petclinic -n my-petclinic

   出力は、spring-petclinic サービスが公開され、Spring PetClinic サンプルアプリケーションのルートが作成されたことを確認します。

   出力例

   route.route.openshift.io/spring-petclinic exposed

手順

1. ServiceBinding CR を作成し、バインディングデータにパッチを適用します。

   $ oc apply -n my-petclinic -f - << EOD
   ---
   apiVersion: binding.operators.coreos.com/v1alpha1
   kind: ServiceBinding
   metadata:
     name: spring-petclinic-pgcluster
   spec:
     services: 1
       - group: postgres-operator.crunchydata.com
         version: v1beta1
         kind: PostgresCluster 2
         name: hippo
     application: 3
       name: spring-petclinic
       group: apps
       version: v1
       resource: deployments
   EOD

   1

   サービスリソースのリストを指定します。

   2

   データベースの CR。

   3

   Deployment または PodSpec が組み込まれた同様のリソースを参照するサンプルアプリケーション。

   この出力では、バインディングデータをサンプルアプリケーションにプロジェクションする ServiceBinding CR が作成されていることを確認します。

   出力例

   servicebinding.binding.operators.coreos.com/spring-petclinic created

2. サービスバインディングのリクエストが正常に完了したことを確認します。

   $ oc get servicebindings -n my-petclinic

   出力例

   NAME                         READY   REASON              AGE
   spring-petclinic-pgcluster   True    ApplicationsBound   7s

   デフォルトでは、データベースサービスのバインディングデータからの値は、サンプルアプリケーションを実行するワークロードコンテナーにファイルとしてプロジェクションされます。たとえば、Secret リソースからの値はすべて bindings/spring-petclinic-pgcluster ディレクトリーに反映されます。

   注記

   オプションとして、ディレクトリーの内容を出力して、アプリケーションのファイルに反映されたバインディングデータが含まれることを確認することもできます。

   $ for i in username password host port type; do oc exec -it deploy/spring-petclinic -n my-petclinic -- /bin/bash -c 'cd /tmp; find /bindings/*/'$i' -exec echo -n {}:" " \; -exec cat {} \;'; echo; done

   出力例: シークレットリソースからのすべての値

   /bindings/spring-petclinic-pgcluster/username: <username>
   /bindings/spring-petclinic-pgcluster/password: <password>
   /bindings/spring-petclinic-pgcluster/host: hippo-primary.my-petclinic.svc
   /bindings/spring-petclinic-pgcluster/port: 5432
   /bindings/spring-petclinic-pgcluster/type: postgresql

3. アプリケーションポートからポート転送を設定し、ローカル環境からサンプルアプリケーションにアクセスします。

   $ oc port-forward --address 0.0.0.0 svc/spring-petclinic 8080:80 -n my-petclinic

   出力例

   Forwarding from 0.0.0.0:8080 -> 8080
   Handling connection for 8080

4. http://localhost:8080/petclinic にアクセスします。

   localhost:8080 で Spring PetClinic サンプルアプリケーションにリモートでアクセスできるようになり、アプリケーションがデータベースサービスに接続されていることを確認できます。

手順

1. my-petclinic namespace に Dev4Devs PostgreSQL Operator をデプロイするには、シェルで以下のコマンドを実行します。

検証

1. Operator のインストール後に、openshift-operators namespace の Operator サブスクリプションを一覧表示します。

   $ oc get subs -n openshift-operators

   出力例

   NAME                               PACKAGE                            SOURCE                  CHANNEL
   postgresql-operator-dev4devs-com   postgresql-operator-dev4devs-com   ibm-multiarch-catalog   alpha
   rh-service-binding-operator        rh-service-binding-operator        redhat-operators        stable

手順

1. シェルで以下のコマンドを実行して、my-petclinic namespace に Database CR を作成します。

   $ oc apply -f - << EOD
   apiVersion: postgresql.dev4devs.com/v1alpha1
   kind: Database
   metadata:
     name: sampledatabase
     namespace: my-petclinic
     annotations:
       host: sampledatabase
       type: postgresql
       port: "5432"
       service.binding/database: 'path={.spec.databaseName}'
       service.binding/port: 'path={.metadata.annotations.port}'
       service.binding/password: 'path={.spec.databasePassword}'
       service.binding/username: 'path={.spec.databaseUser}'
       service.binding/type: 'path={.metadata.annotations.type}'
       service.binding/host: 'path={.metadata.annotations.host}'
   spec:
     databaseCpu: 30m
     databaseCpuLimit: 60m
     databaseMemoryLimit: 512Mi
     databaseMemoryRequest: 128Mi
     databaseName: "sampledb"
     databaseNameKeyEnvVar: POSTGRESQL_DATABASE
     databasePassword: "samplepwd"
     databasePasswordKeyEnvVar: POSTGRESQL_PASSWORD
     databaseStorageRequest: 1Gi
     databaseUser: "sampleuser"
     databaseUserKeyEnvVar: POSTGRESQL_USER
     image: registry.redhat.io/rhel8/postgresql-13:latest
     databaseStorageClassName: nfs-storage-provisioner
     size: 1
   EOD

   この Database CR に追加されたアノテーションは、サービスバインディング接続を有効にし、Operator の調整をトリガーします。

   この出力では、データベースインスタンスが作成されていることを検証します。

   出力例

   database.postgresql.dev4devs.com/sampledatabase created

2. データベースインスタンスを作成したら、my-petclinic namespace のすべての Pod が実行されていることを確認します。

   $ oc get pods -n my-petclinic

   出力 (表示に数分かかる) で、データベースが作成され設定されていることを検証できます。

   出力例

   NAME                                     READY    STATUS      RESTARTS   AGE
   sampledatabase-cbc655488-74kss            0/1     Running        0       32s

手順

1. シェルで以下のコマンドを実行して、spring-petclinic アプリケーションを PostgresCluster カスタムリソース (CR) でデプロイします。

   $ oc apply -n my-petclinic -f - << EOD
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: spring-petclinic
     labels:
       app: spring-petclinic
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: spring-petclinic
     template:
       metadata:
         labels:
           app: spring-petclinic
       spec:
         containers:
           - name: app
             image: quay.io/service-binding/spring-petclinic:latest
             imagePullPolicy: Always
             env:
             - name: SPRING_PROFILES_ACTIVE
               value: postgres
             - name: org.springframework.cloud.bindings.boot.enable
               value: "true"
             ports:
             - name: http
               containerPort: 8080
   ---
   apiVersion: v1
   kind: Service
   metadata:
     labels:
       app: spring-petclinic
     name: spring-petclinic
   spec:
     type: NodePort
     ports:
       - port: 80
         protocol: TCP
         targetPort: 8080
     selector:
       app: spring-petclinic
   EOD

   この出力では、Spring PetClinic サンプルアプリケーションが作成され、デプロイされていることを確認します。

   出力例

   deployment.apps/spring-petclinic created
   service/spring-petclinic created

   注記

   Web コンソールの Developer パースペクティブでコンテナーイメージ を使用してアプリケーションをデプロイする場合は、Advanced options の Deployment セクションで以下の環境変数を入力する必要があります。

   • Name: SPRING_PROFILES_ACTIVE
   • Value: postgres

2. 以下のコマンドを実行して、アプリケーションがまだデータベースサービスに接続されていないことを確認します。

   $ oc get pods -n my-petclinic

   CrashLoopBackOff ステータスが表示されるまで数分かかります。

   出力例

   NAME                                READY   STATUS             RESTARTS      AGE
   spring-petclinic-5b4c7999d4-wzdtz   0/1     CrashLoopBackOff   4 (13s ago)   2m25s

   この段階では、Pod は起動に失敗します。アプリケーションとの対話を試みると、エラーが返されます。

手順

1. ServiceBinding CR を作成し、バインディングデータにパッチを適用します。

   $ oc apply -n my-petclinic -f - << EOD
   ---
   apiVersion: binding.operators.coreos.com/v1alpha1
   kind: ServiceBinding
   metadata:
       name: spring-petclinic-pgcluster
   spec:
     services: 1
       - group: postgresql.dev4devs.com
         kind: Database 2
         name: sampledatabase
         version: v1alpha1
     application: 3
       name: spring-petclinic
       group: apps
       version: v1
       resource: deployments
   EOD

   1

   サービスリソースのリストを指定します。

   2

   データベースの CR。

   3

   Deployment または PodSpec が組み込まれた同様のリソースを参照するサンプルアプリケーション。

   この出力では、バインディングデータをサンプルアプリケーションにプロジェクションする ServiceBinding CR が作成されていることを確認します。

   出力例

   servicebinding.binding.operators.coreos.com/spring-petclinic created

2. サービスバインディングのリクエストが正常に完了したことを確認します。

   $ oc get servicebindings -n my-petclinic

   出力例

   NAME                          READY   REASON              AGE
   spring-petclinic-postgresql   True    ApplicationsBound   47m

   デフォルトでは、データベースサービスのバインディングデータからの値は、サンプルアプリケーションを実行するワークロードコンテナーにファイルとしてプロジェクションされます。たとえば、Secret リソースからの値はすべて bindings/spring-petclinic-pgcluster ディレクトリーに反映されます。

3. これが作成されたら、トポロジーに移動し、接続を視覚的に確認できます。

   図6.1 spring-petclinic のサンプルデータベースへの接続

   

4. アプリケーションポートからポート転送を設定し、ローカル環境からサンプルアプリケーションにアクセスします。

   $ oc port-forward --address 0.0.0.0 svc/spring-petclinic 8080:80 -n my-petclinic

   出力例

   Forwarding from 0.0.0.0:8080 -> 8080
   Handling connection for 8080

5. http://localhost:8080 にアクセスします。

   localhost:8080 で Spring PetClinic サンプルアプリケーションにリモートでアクセスできるようになり、アプリケーションがデータベースサービスに接続されていることを確認できます。

1. ファイルとして (デフォルト)。
2. 環境変数として。(ServiceBinding リソースから .spec.bindAsFiles パラメーターを設定した後)。

手順

1. ファイルとしてバインディングデータをプロジェクションするには、既存の SERVICE_BINDING_ROOT 環境変数がワークロードが実行されるコンテナーで存在することを確認して、宛先フォルダーを決定します。
2. バインドデータを環境変数としてプロジェクションするには、カスタムリソース (CR) の ServiceBinding リソースから、 .spec.bindAsFiles パラメーターの値を false に設定します。

手順

1. Developer パースペクティブで、関連するプロジェクト (my-petclinic など) に切り替えます。

2. Spring PetClinic サンプルアプリケーションにカーソルを合わせ、ノード上の矢印を確認します。

   図6.2 ビジュアルコネクター

   
3. 矢印をクリックして hippo-pgbouncer デプロイメントに向かってドラッグし、Spring PetClinic サンプルアプリケーションを接続します。
4. spring-petclinic デプロイメントをクリックし、Overview パネルを表示します。Details タブで Annotations セクションの編集アイコンをクリックして、Key = app.openshift.io/connects-to と Value = [{"apiVersion":"apps/v1","kind":"Deployment","name":"hippo-pgbouncer"}] アノテーションがデプロイメントに追加されていることを確認します。

5. オプション: これらの手順を繰り返して、作成した他のアプリケーションとコンポーネントの間に視覚的な接続を確立できます。

   図6.3 複数アプリケーションへの接続

   

手順

1. Developer パースペクティブで、関連するプロジェクト (my-petclinic など) に切り替えます。
2. Topology ビューで、Spring PetClinic サンプルアプリケーションにカーソルを合わせてノードの矢印を確認します。
3. 矢印を Postgres クラスターの hippo データベースアイコンにドラッグアンドドロップして、Spring PetClinic サンプルアプリケーションとのバインディング接続を作成します。

4. サービスバインドの作成 ダイアログで、サービスバインドのデフォルトの名前をそのまま使用するか、別の名前を追加して、作成 をクリックします。

   図6.4 Service Binding ダイアログ

   
5. オプション: Topology ビューを使用してバインド接続を作成するのが難しい場合は、+Add → YAML → Import YAML に移動します。

6. オプション: YAML エディターで、ServiceBinding リソースを追加します。

   apiVersion: binding.operators.coreos.com/v1alpha1
   kind: ServiceBinding
   metadata:
       name: spring-petclinic-pgcluster
       namespace: my-petclinic
   spec:
       services:
       - group: postgres-operator.crunchydata.com
         version: v1beta1
         kind: PostgresCluster
         name: hippo
       application:
         name: spring-petclinic
         group: apps
         version: v1
         resource: deployments

   サービスバインディングリクエストが作成され、ServiceBinding リソースを通じてバインディング接続が作成されます。データベースサービス接続要求が成功すると、アプリケーションが再デプロイされ、接続が確立されます。

   図6.5 バインディングコネクター

   
   ヒント

   矢印をドラッグしてコンテキストメニューを使用し、Operator がサポートするサービスへのバインディング接続を追加して作成できます。

   図6.6 バインディング接続を作成するためのコンテキストメニュー

   
7. ナビゲーションメニューで、トポロジー をクリックします。トポロジービューの spring-petclinic 展開には、その Web ページを表示するための 開く URL リンクが含まれています。
8. URL を開く リンクをクリックします。

手順

1. サービスのバインドが成功したら、バインドコネクターをクリックします。サイドパネルが表示され、Details タブの下に Connected ステータスが表示されます。

   必要に応じて、次のページで Developer パースペクティブから Connected ステータスを表示できます。

   • ServiceBindings ページ。
   • ServiceBinding details ページ。さらに、ページタイトルには Connected バッジが表示されます。

2. サービスバインディングに失敗した場合、バインディングコネクターの接続の中央に赤い矢印と赤い十字が表示されます。このコネクターをクリックすると、サイドパネルの Details タブに Error ステータスが表示されます。必要に応じて、Error ステータスをクリックして、根本的な問題に関する特定の情報を表示します。

   次のページで、Developer パースペクティブから Error ステータスとツールチップを表示することもできます。

   • ServiceBindings ページ。
   • ServiceBinding details ページ。さらに、ページタイトルには Error バッジが表示されます。

1. Helm バイナリーをダウンロードし、これをパスに追加します。

   • Linux (x86_64, amd64)

     # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-linux-amd64 -o /usr/local/bin/helm

   • IBM Z® および IBM® LinuxONE (s390x) 上の Linux

     # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-linux-s390x -o /usr/local/bin/helm

   • IBM Power® 上の Linux (ppc64le)

     # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-linux-ppc64le -o /usr/local/bin/helm

2. バイナリーファイルを実行可能にします。

   # chmod +x /usr/local/bin/helm

3. インストールされたバージョンを確認します。

   $ helm version

   出力例

   version.BuildInfo{Version:"v3.0", GitCommit:"b31719aab7963acf4887a1c1e6d5e53378e34d93", GitTreeState:"clean", GoVersion:"go1.13.4"}

1. 最新の .exe ファイル をダウンロードし、希望のディレクトリーに配置します。
2. Start を右クリックし、Control Panel をクリックします。
3. System and Security を選択してから System をクリックします。
4. 左側のメニューから、Advanced systems settings を選択し、下部にある Environment Variables をクリックします。
5. Variable セクションから Path を選択し、Edit をクリックします。
6. New をクリックして、.exe ファイルのあるフォルダーへのパスをフィールドに入力するか、Browse をクリックし、ディレクトリーを選択して OK をクリックします。

1. 最新の .exe ファイル をダウンロードし、希望のディレクトリーに配置します。
2. Search クリックして、env または environment を入力します。
3. Edit environment variables for your account を選択します。
4. Variable セクションから Path を選択し、Edit をクリックします。
5. New をクリックし、exe ファイルのあるディレクトリーへのパスをフィールドに入力するか、Browse をクリックし、ディレクトリーを選択して OK をクリックします。

1. Helm バイナリーをダウンロードし、これをパスに追加します。

   # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-darwin-amd64 -o /usr/local/bin/helm

2. バイナリーファイルを実行可能にします。

   # chmod +x /usr/local/bin/helm

3. インストールされたバージョンを確認します。

   $ helm version

   出力例

   version.BuildInfo{Version:"v3.0", GitCommit:"b31719aab7963acf4887a1c1e6d5e53378e34d93", GitTreeState:"clean", GoVersion:"go1.13.4"}

手順

1. 新規プロジェクトを作成します。

   $ oc new-project vault

2. Helm チャートのリポジトリーをローカルの Helm クライアントに追加します。

   $ helm repo add openshift-helm-charts https://charts.openshift.io/

   出力例

   "openshift-helm-charts" has been added to your repositories

3. リポジトリーを更新します。

   $ helm repo update

4. サンプルの HashiCorp Vault をインストールします。

   $ helm install example-vault openshift-helm-charts/hashicorp-vault

   出力例

   NAME: example-vault
   LAST DEPLOYED: Fri Mar 11 12:02:12 2022
   NAMESPACE: vault
   STATUS: deployed
   REVISION: 1
   NOTES:
   Thank you for installing HashiCorp Vault!

5. チャートが正常にインストールされたことを確認します。

   $ helm list

   出力例

   NAME         	NAMESPACE	REVISION	UPDATED                                	STATUS  	CHART       	APP VERSION
   example-vault	vault    	1       	2022-03-11 12:02:12.296226673 +0530 IST	deployed	vault-0.19.0	1.9.2

1. Developer パースペクティブで、+Add ビューに移動し、プロジェクトを選択します。次に、Helm Chart オプションをクリックし、Developer Catalog にすべての Helm チャートを表示します。
2. チャートを選択し、チャートの説明、README、チャートに関するその他の詳細を確認します。

3. Create をクリックします。

   図7.1 Developer カタログの Helm チャート

   

4. Create Helm Release ページで:

   1. リリースの固有の名前を Release Name フィールドに入力します。
   2. Chart Version ドロップダウンリストから必要なチャートのバージョンを選択します。

   3. Form View または YAML View を使用して Helm チャートを設定します。

      注記

      利用可能な場合は、YAML View と Form View 間で切り替えることができます。ビューの切り替え時に、データは永続化されます。

   4. Create をクリックして Helm リリースを作成します。Web コンソールは、Topology ビューに新しいリリースを表示します。

      Helm チャートにリリースノートがある場合は、Web コンソールに表示されます。

      Helm チャートがワークロードを作成する場合、Web コンソールはそれらを Topology または Helm リリース詳細 ページに表示します。ワークロードは、DaemonSet、CronJob、Pod、Deployment、および DeploymentConfig です。

   5. Helm Releases ページで、新しく作成された Helm リリースを表示します。

手順

1. 新規プロジェクトを作成します。

   $ oc new-project nodejs-ex-k

2. OpenShift Container Platform オブジェクトが含まれる Node.js チャートのサンプルをダウンロードします。

   $ git clone https://github.com/redhat-developer/redhat-helm-charts

3. サンプルチャートを含むディレクトリーに移動します。

   $ cd redhat-helm-charts/alpha/nodejs-ex-k/

4. Chart.yaml ファイルを編集し、チャートの説明を追加します。

   apiVersion: v2 1
   name: nodejs-ex-k 2
   description: A Helm chart for OpenShift 3
   icon: https://static.redhat.com/libs/redhat/brand-assets/latest/corp/logo.svg 4
   version: 0.2.1 5

   1

   チャート API バージョン。これは、Helm 3 以上を必要とする Helm チャートの場合は v2 である必要があります。

   2

   チャートの名前。

   3

   チャートの説明。

   4

   アイコンとして使用するイメージへの URL。

   5

   Semantic Versioning (SemVer) 2.0.0 仕様に準拠したチャートのバージョン。

5. チャートが適切にフォーマットされていることを確認します。

   $ helm lint

   出力例

   [INFO] Chart.yaml: icon is recommended
   
   1 chart(s) linted, 0 chart(s) failed

6. 直前のディレクトリーレベルに移動します。

   $ cd ..

7. チャートをインストールします。

   $ helm install nodejs-chart nodejs-ex-k

8. チャートが正常にインストールされたことを確認します。

   $ helm list

   出力例

   NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
   nodejs-chart nodejs-ex-k 1 2019-12-05 15:06:51.379134163 -0500 EST deployed nodejs-0.1.0  1.16.0

手順

1. 新規の Helm Chart リポジトリーを追加するには、Helm Chart Repository カスタムリソース (CR) をクラスターに追加する必要があります。

   Helm チャートリポジトリー CR のサンプル

   apiVersion: helm.openshift.io/v1beta1
   kind: HelmChartRepository
   metadata:
     name: <name>
   spec:
    # optional name that might be used by console
    # name: <chart-display-name>
     connectionConfig:
       url: <helm-chart-repository-url>

   たとえば、Azure サンプルチャートリポジトリーを追加するには、以下を実行します。

   $ cat <<EOF | oc apply -f -
   apiVersion: helm.openshift.io/v1beta1
   kind: HelmChartRepository
   metadata:
     name: azure-sample-repo
   spec:
     name: azure-sample-repo
     connectionConfig:
       url: https://raw.githubusercontent.com/Azure-Samples/helm-charts/master/docs
   EOF

2. Web コンソールで Developer Catalog に移動し、チャートリポジトリーの Helm チャートが表示されることを確認します。

   たとえば、Chart リポジトリー フィルターを使用して、リポジトリーから Helm チャートを検索します。

   図7.2 チャートリポジトリーのフィルター

   
   注記

   クラスター管理者がすべてのチャートリポジトリーを削除する場合は、+Add ビュー、Developer Catalog、および左側のナビゲーションパネルで Helm オプションを表示できません。

手順

1. 新規の namespace スコープの Helm Chart Repository を追加するには、Helm Chart Repository カスタムリソース (CR) を namespace に追加する必要があります。

   namespace スコープの Helm Chart Repository CR のサンプル

   apiVersion: helm.openshift.io/v1beta1
   kind: ProjectHelmChartRepository
   metadata:
     name: <name>
   spec:
     url: https://my.chart-repo.org/stable
   
     # optional name that might be used by console
     name: <chart-repo-display-name>
   
     # optional and only needed for UI purposes
     description: <My private chart repo>
   
     # required: chart repository URL
     connectionConfig:
       url: <helm-chart-repository-url>

   たとえば、my-namespace namespace スコープの Azure サンプルチャートリポジトリーを追加するには、以下を実行します。

   $ cat <<EOF | oc apply --namespace my-namespace -f -
   apiVersion: helm.openshift.io/v1beta1
   kind: ProjectHelmChartRepository
   metadata:
     name: azure-sample-repo
   spec:
     name: azure-sample-repo
     connectionConfig:
       url: https://raw.githubusercontent.com/Azure-Samples/helm-charts/master/docs
   EOF

   この出力から、namespace スコープの Helm Chart Repository CR が作成されていることが分かります。

   出力例

   projecthelmchartrepository.helm.openshift.io/azure-sample-repo created

2. Web コンソールで Developer Catalog に移動し、チャートリポジトリーの Helm チャートが my-namespace namespace に表示されることを確認します。

   たとえば、Chart リポジトリー フィルターを使用して、リポジトリーから Helm チャートを検索します。

   図7.3 namespace のチャートリポジトリーフィルター

   

   あるいは、以下のコマンドを実行します。

   $ oc get projecthelmchartrepositories --namespace my-namespace

   出力例

   NAME                     AGE
   azure-sample-repo        1m

   注記

   クラスター管理者または適切な RBAC パーミッションを持つ通常ユーザーが特定の namespace のすべてのチャートリポジトリーを削除すると、その特定の namespace の +Add ビュー、Developer Catalog、および左側のナビゲーションパネルで Helm オプションを表示することはできません。

1. openshift-config namespace で、PEM でエンコードされた形式のカスタム CA 証明書で ConfigMap を作成し、これを設定マップ内の ca-bundle.crt キーに保存します。

   $ oc create configmap helm-ca-cert \
   --from-file=ca-bundle.crt=/path/to/certs/ca.crt \
   -n openshift-config

2. openshift-config namespace で、クライアント TLS 設定を追加するために Secret オブジェクトを作成します。

   $ oc create secret tls helm-tls-configs \
   --cert=/path/to/certs/client.crt \
   --key=/path/to/certs/client.key \
   -n openshift-config

   クライアント証明書とキーは PEM でエンコードされた形式であり、それぞれ tls.crt および tls.key キーに保存される必要があります。

3. 以下のように Helm リポジトリーを追加します。

   $ cat <<EOF | oc apply -f -
   apiVersion: helm.openshift.io/v1beta1
   kind: HelmChartRepository
   metadata:
     name: <helm-repository>
   spec:
     name: <helm-repository>
     connectionConfig:
       url: <URL for the Helm repository>
       tlsConfig:
           name: helm-tls-configs
       ca:
   	name: helm-ca-cert
   EOF

   ConfigMap および Secret は、tlsConfig および ca フィールドを使用して HelmChartRepository CR で使用されます。これらの証明書は、Helm リポジトリー URL への接続に使用されます。

4. デフォルトでは、認証されたユーザーはすべて設定済みのチャートにアクセスできます。ただし、証明書が必要なチャートリポジトリーの場合は、以下のように openshift-config namespace で helm-ca-cert 設定マップおよび helm-tls-configs シークレットへの読み取りアクセスを提供する必要があります。

   $ cat <<EOF | kubectl apply -f -
   apiVersion: rbac.authorization.k8s.io/v1
   kind: Role
   metadata:
     namespace: openshift-config
     name: helm-chartrepos-tls-conf-viewer
   rules:
   - apiGroups: [""]
     resources: ["configmaps"]
     resourceNames: ["helm-ca-cert"]
     verbs: ["get"]
   - apiGroups: [""]
     resources: ["secrets"]
     resourceNames: ["helm-tls-configs"]
     verbs: ["get"]
   ---
   kind: RoleBinding
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     namespace: openshift-config
     name: helm-chartrepos-tls-conf-viewer
   subjects:
     - kind: Group
       apiGroup: rbac.authorization.k8s.io
       name: 'system:authenticated'
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: Role
     name: helm-chartrepos-tls-conf-viewer
   EOF

手順

1. Developer パースペクティブで、+Add ビューに移動し、プロジェクトを選択します。
2. Developer Catalog タイルから、Helm Chart オプションを選択して Developer Catalog ですべての Helm チャートを表示します。

3. Helm チャートのリストの左側にあるフィルターを使用して、必要なチャートをフィルターします。

   • Chart Repositories フィルターを使用して、Red Hat Certification Charts または OpenShift Helm Charts が提供したチャートをフィルターします。
   • Source フィルターを使用して、Partners、Community または Red Hat から提供されるチャートをフィルターします。認定チャートはアイコン ( ) で表示されます。

手順

1. Topology ビューで Helm リリースを選択し、サイドパネルを表示します。
2. Actions → Upgrade Helm Release をクリックします。
3. Upgrade Helm Release ページで、アップグレード先とする Chart Version を選択してから Upgrade をクリックし、別の Helm リリースを作成します。Helm Releases ページには 2 つのリビジョンが表示されます。

1. Developer パースペクティブで Helm ビューに移動し、namespace の Helm Releases を表示します。
2. リスト表示されているリソースに隣接する Options メニュー をクリックし、Rollback を選択します。
3. Rollback Helm Release ページで、ロールバックする Revision を選択し、Rollback をクリックします。
4. Helm Releases ページで、チャートをクリックし、リリースの詳細およびリソースを表示します。

5. Revision History タブに移動し、チャートのすべてのリビジョンを表示します。

   図7.4 Helm リビジョン履歴

   
6. 必要な場合は、さらに特定のリビジョンに隣接する Options メニュー を使用して、ロールバックするリビジョンを選択します。

手順

1. Topology ビューで Helm リリースを右クリックし、Delete Helm Release を選択します。
2. 確認プロンプトで、グラフの名前を入力し、Delete をクリックします。

1. ReplicationController 定義の要素。
2. 新規デプロイメントの自動作成のトリガー。
3. デプロイメント間の移行ストラテジー。
4. ライフサイクルフック。