BPAユーザガイドサービスカタログNext Generation v5.1

• はじめに
• コンポーネント
• エンドツーエンドフロー
  • 開発者向けのサービス設計
  • 管理者用のカタログ項目、カテゴリ、タグの管理
  • 事業者向けサービスカタログを使用したエンドツーエンドのサービスプロビジョニング
• サービスカタログ項目のオンボーディング：管理者
• Next Generationサービスカタログの使用
  • カタログ・リストの表示
    • カタログ注文の作成
  • 注文リストの表示
    • 注文ステータスと詳細の追跡および確認
  • サービスの表示
• トラブルシューティング

はじめに

サービスカタログアプリケーションは、組織内でのサービスの管理と提供を合理化するために設計された包括的なプラットフォームです。新しいサービスのオンボーディング、注文、注文ステータスの確認、およびすべての有効な注文の全体像の把握が可能な統合インターフェイスを提供し、サービスライフサイクル管理の効率化を促進します。

主な機能は次のとおりです。

• ユニファイドサービスオンボーディングおよび発注：ユーザは一元化されたインターフェイスを使用して、新しいサービスのオンボーディングと発注を簡単に行えるため、プロセスが簡素化され、一貫性が確保されます
• 注文のステータスとマイルストーン：注文の進捗状況を詳細に追跡し、さまざまなマイルストーンの進捗状況に応じて注文のステータスを確認できます
• アクティブな注文の全体像：ユーザはすべてのアクティブな注文の包括的な概要にアクセスできるため、継続的なサービスの管理と監視が向上します。
• サービスの分類とタグ付け：サービスを分類してタグ付けできるため、編成と取得が容易になり、カタログ内のサービスの検索可能性と検出可能性が向上します
• お気に入りの検索：ユーザは、キーワードとタグを使用して特定のサービスを検索し、頻繁に使用するサービスをお気に入りとしてマークして、すばやくアクセスできます
• 管理管理：管理者ユーザは、カタログ項目、カテゴリ、およびタグを管理して、カタログを最新の状態に保ち、整理することができます
• サービスの設計とワークフロー：サービス設計者は、ワークフローに基づいてサービスを作成および設計し、各サービスが目的の成果と効率で提供されるようにします

このアプリケーションは、サービス管理プロセスの最適化を検討している組織にとって不可欠なツールであり、エンドユーザと管理者の両方にシームレスで使いやすいエクスペリエンスを提供します。

コンポーネント

サービスカタログアプリケーションは、連携してサービスを管理および提供するための堅牢で柔軟なプラットフォームを提供する次の主要コンポーネントで構成されています。

• ワークフローコンポーネントは、サービス提供プロセスのバックボーンです。サービスリクエストを満たすために必要なタスクとアクティビティのシーケンスを定義する特定のビジネス要件に合わせてワークフローをカスタマイズし、各サービスを効率的かつ一貫して提供できます。

ワークフロー機能には、タスクの自動割り当て、条件付きロジック、承認プロセス、通知などがあります。

• Form Builderは、ユーザがカスタムフォームを作成して、サービスリクエストの開始と処理に必要な情報を取得できるようにするツールです。これらのフォームは、特定のデータポイントを収集するようにカスタマイズでき、関連するすべての情報を事前に収集できます。

フォームビルダの機能には、ドラッグアンドドロップインターフェイス、カスタマイズ可能なフィールド、入力規則、およびユーザー入力に基づく動的なフィールドの表示が含まれます。

• ダイナミックUIコンポーネントのユーザインターフェイス(UI)コンポーネントは、応答性に優れたインタラクティブなインターフェイスを提供することでユーザエクスペリエンスを向上させます。ユーザの入力と選択に適応し、関連情報とオプションをリアルタイムで表示します。このコンポーネントにより、サービスカタログを操作する際のシームレスで直感的な操作が保証されます。

動的なUI機能には、リアルタイムの更新、フィールドとセクションの条件付き表示、および使いやすいナビゲーションが含まれます。

• カタログ項目は、サービスカタログ内で利用可能な個々のサービスまたは製品です。各カタログアイテムには、説明、ドメインの詳細、完了予定時刻、関連するワークフローやフォームなどの詳細情報が含まれます。カタログ項目はサービスカタログの構成要素であり、ユーザが利用できるさまざまなサービスを表します。

カタログアイテムの機能には、詳細な説明、分類、タグ付け、関連するワークフローとフォームが含まれます。

• サービスは、ユーザが要求して利用できる完全なパッケージを表します。ワークフロー、フォーム、カタログアイテムなど、必要なすべてのコンポーネントを含むエンドツーエンドのサービスをユーザに提供します。サービスは、特定の成果を実現するように設計されており、組織固有のニーズを満たすようにカスタマイズできます。

サービス機能には、包括的なサービス定義、関連するワークフローとフォーム、成果主導の設計が含まれます。

これらのコンポーネントを組み合わせることで、包括的で強力なサービスカタログアプリケーションが形成され、組織は幅広いサービスを効率的に管理および提供できるようになります。このアプリケーションは、使いやすいインターフェイス、カスタマイズ可能なワークフロー、および動的なフォームを提供し、効率的で効果的なサービス提供を保証します。

エンドツーエンドフロー

サービスカタログアプリケーションは、組織内のさまざまなペルソナ（開発者、管理者、オペレータなど）に対応する包括的なエンドツーエンドフローを提供します。 それぞれの担当者は、設計やオンボーディングからプロビジョニングや管理に至るまで、サービスライフサイクルにおいて特定の役割と責任を担います。エンドツーエンドのフローの詳細については、次の項で説明します。

開発者向けのサービス設計

開発者は、次のパラメータを使用してサービスを設計します。これらのパラメータは、目的とする成果を実現するためにワークフロー主導で使用されます。

• サービス要件の定義：
  • 新しいサービスのビジネスニーズと目的の特定
  • 関係者から要件を収集し、サービスがユーザの期待を満たすことを確認する
• ワークフローの作成：
  • ワークフローコンポーネントを使用して、サービスの提供に必要なタスクとアクティビティのシーケンスを定義します
  • 自動タスク割当、条件付きロジック、承認プロセスおよび通知の構成
  • ワークフローをテストして、目的どおりに機能することを確認する
• フォームの作成：
  • ユーザーから必要な情報を取り込むためのカスタムフォームを作成するには、フォームビルダを使用します
  • カスタマイズ可能なフィールドと検証ルールを追加する、ドラッグアンドドロップインターフェイスを使用したフォームの設計
  • ユーザ入力に基づいて動的なフィールド可視性を実装し、ユーザエクスペリエンスを向上させる
• 動的UIコンポーネントの統合：
  • 動的なUIコンポーネントを組み込んで、応答性に優れたインタラクティブなインターフェイスを作成
  • ユーザの操作に基づいて、フィールドとセクションのリアルタイム更新と条件付き表示を保証
• パッケージサービス：
  • ワークフロー、フォーム、および動的UIコンポーネントを統合サービスパッケージに統合
  • 説明、予想される成果、依存関係など、サービスの詳細を文書化します。

管理者用のカタログ項目、カテゴリ、タグの管理

管理者は、カタログ項目、カテゴリ、およびタグを管理して、カタログが整理され、最新の状態であることを確認できます。

• カタログ項目のオンボーディング：
  • 詳細な説明、ドメイン、コントローラ、推定所要時間、関連サービスなど、新しいカタログ項目をサービスカタログに追加
  • 各カタログ項目を、開発者が設計した関連ワークフローおよびフォームに関連付けます。
  • ユーザの理解と選択を促進するために必要なすべての情報を提供する
  • 2日目の操作（編集、削除、調整など）を定義し、ワークフローとユーザ入力コンポーネントをアタッチします。
• カテゴリとタグの定義：
  • カテゴリを作成および管理して、カタログ項目を論理的に整理する
  • カタログ項目にタグを割り当て、検索性と検出性を向上
  • カテゴリとタグを定期的にレビューおよび更新して、提供サービスの変更を反映する
• カタログ項目を発行しています：
  • 発行するカタログ項目を確認して承認する
  • ユーザーがカタログ項目を利用できるようにする前に、カタログ項目が正確に分類され、タグ付けされていることを確認します
• サービスカタログ項目へのきめ細かいアクセスの定義：
  • サービスカタログはロールベースアクセスコントロール(RBAC)をサポート（ロール、アクセスポリシー定義を含む）
  • サービスカタログ項目はリソースグループとして定義でき、管理者はサービスカタログ項目に設定されたリソースを利用してアクセスポリシーを定義できます
  • サービスカタログのアクセスポリシーとRBACの定義方法についての詳細は、『BPAユーザガイド』を参照してください
• ユーザグループの検出：
  • アクセスポリシーが定義されている場合は、ユーザグループ（ユーザがその一部）とアクセスポリシーユーザグループの共通部分を使用して保存します
  • アクセスポリシーが定義されていない場合は、ユーザグループとロールグループの共通部分を使用して保存します
• ユーザグループパラメータ：
  • ユーザグループが注文のパラメータである場合、そのユーザグループを使用して、注文に使用するサービスアカウントがユーザグループの一部であることを確認します 
  • ユーザーが管理者である場合は、パラメータをそのまま使用して、ユーザー・グループが存在することを確認します

事業者向けサービスカタログを使用したエンドツーエンドのサービスプロビジョニング

オペレータは、サービスカタログを利用してサービスを要求および管理し、効率的なサービス提供を実現します。

• サービスカタログへのアクセス：
  • サービスカタログアプリケーションにログインし、利用可能なサービスを参照します
  • 検索およびフィルタオプションを使用して、カテゴリとタグに基づいて特定のサービスを検索します
• サービスの要求：
  • カタログから目的のサービスを選択し、関連するフォームに入力して必要な情報を入力します
  • サービスリクエストを送信し、事前定義されたワークフローをトリガーします。
• 注文の進行状況の追跡：
  • 注文処理機能を使用して、サービスリクエストのステータスを監視します。
  • サービスリクエストのワークフローの段階に応じて、マイルストーンを表示し、通知を受け取る
• 有効な注文の管理：
  • すべてのアクティブな注文を包括的に表示し、継続的なサービスを管理および追跡
  • 関係者と連絡を取り、必要に応じて最新情報を提供
• サービスの履行：
  • ワークフローで定義されているタスクとアクティビティを完了して、サービスリクエストを処理します
  • 定義された成果とユーザの期待に従ってサービスが提供されることを確認する
• レビューとフィードバック：
  • サービスが提供されたら、プロセスを確認し、ユーザからのフィードバックを収集します
  • フィードバックに基づいて、改善が必要な領域を特定し、将来のサービス提供を強化する

このエンドツーエンドのフローに従うことで、サービスカタログアプリケーションは、サービスの設計、オンボーディング、およびプロビジョニングを効率的に行い、サービスのライフサイクルに関わるすべてのユーザのニーズを満たします。

サービスカタログ項目のオンボーディング：管理者

サービスカタログ項目をオンボードするには、次の手順を実行します。

1. Admin Settingsに移動します。

2. AdminページでService Catalogを選択します。Service Catalogページが表示されます。
3. Service Categoriesタブをクリックします。Add Service Categoryウィンドウが開きます。

4. フォームに詳細を入力し、Saveをクリックします。

1. Service Itemsタブをクリックします。Edit Service Itemウィンドウが開きます。

6. フォームに詳細を入力し、Saveをクリックします。

Next Generationサービスカタログの使用

Service Catalog Next Generation(NG)アプリケーションは、サービスのオンボーディング、注文、およびレビューを統合ビューで行います。このアプリケーションを使用すると、ユーザは、お気に入りのサービスを分類、タグ付け、検索、および追加できます。注文の進捗状況はマイルストーンとして表示でき、管理者はカタログ項目、カテゴリ、タグを管理できます。

サービスカタログアプリケーションでは、次の操作を実行できます。

• 使用可能なカタログ項目の一覧を表示します
• カタログ項目から注文を作成
• 検索とお気に入りのカタログ項目
• 注文の追跡
• サービスライフサイクルの追跡

カタログ・リストの表示

使用可能なカタログ・リストを表示するには、次の手順に従います。

1. BPA HomeページからService Catalog NG > Catalogの順に選択します。Catalogページが表示されます。

次のアクションを実行できます。

• View Active Ordersをクリックして、選択した品目の注文のチェックリストを表示します。
• 選択した品目のすべての注文を表示するには、その他オプションアイコンからすべての注文の表示をクリックします。
• 必要なカタログ項目を検索するには、サービスの最初の3文字をSearchフィールドに入力するか、All、Name、またはDescriptionで検索します。また、カテゴリまたはドメイン別にカタログ項目をフィルタすることもできます。
• Orderをクリックして注文を作成します。
• リスト/グリッドビューアイコンをクリックしてビューを変更します。
• Favoritesアイコンをクリックして、項目をお気に入りに追加します。
• Favoritesリンクをクリックして、お気に入りを表示します。

カタログ注文の作成

カタログ注文を作成するには、次の手順に従います。

1. Catalogページでカタログ項目を選択し、Orderをクリックします。Logging Serviceウィンドウが開きます。

2. Uploadアイコンをクリックして、入力ファイルをアップロードします。
3. 注文を送信するには、Order Nowをクリックします。

注文リストの表示

有効な注文を表示するには、次の手順に従います。

1. BPAのホームページから、Service Catalog NG > Ordersの順に選択します。

2. Filtersをクリックすると、Catalog Name、Status、Time、およびDomainで注文リストがフィルタリングされます。
3. 注意が必要なタスクリストを開くには、「タスク」列の「警告」アイコンを選択します。
4. マイルストーンを表示するには、「マイルストーン」列のリンクをクリックします。

注文ステータスと詳細の追跡および確認

注文ステータスと詳細を表示するには、次の手順に従います。

1. BPA HomeページからService Catalog NG > Ordersの順に選択します。

2. 注文ページでレコードをクリックすると、詳細ビューが開きます。

注文ページでは、次のアクションを実行できます。

• 注文を表示するには、注文ID列の任意のレコードをクリックします。
• 各マイルストーンに関連付けられている詳細、ステータス、および成果物を表示するには、「マイルストーン」タブをクリックします。
• マイルストーン成果物を開くには、「詳細を表示」をクリックします。
• 注文入力とサービスフォームの概要タブをクリックします。
• 注文に関連付けられているリソースリストのリソースタブをクリックします。
• レポートを生成してダウンロードするには、Generate Reportsをクリックします。

注：ユーザは、ロギングサービスページの右下隅にマイルストーンのインデックスを表示できます。

サービスの表示

アクティブなサービスを表示するには、BPA HomeページからService Catalog NG > Servicesの順に選択します。

サービスページでは、次のアクションを実行できます。

• Filtersオプションを使用してサービスをフィルタリングします。
• 任意のレコードをクリックして、選択したサービスの詳細(注文ID、作成済み、発注者、期間など)を表示します。
• Get Service Provisioningリンクをクリックすると、注文のマイルストーンが表示されます。
• 資産アイコンを使用して、選択したサービスに関連付けられている資産を表示します。

トラブルシューティング

BPA UIから注文を作成して監視することは簡単に思えますが、その裏には、注文またはサービスプロビジョニングプロセスに関連する複数のシステムがあります。問題が発生して注文が停滞した場合は、次の方法を使用して問題の根本原因をデバッグおよび特定できます。

ワークフロータスクとデバッグビューの使用

デバッグビューを使用して、プロセス変数とその現在の値を分析できます。この手順は、ワークフローで予測される特定の値を正しく受け取るかどうかを判断するために重要です。さらに、ワークフローインシデントのビューで、ワークフローの実行中に発生する可能性のある例外やインシデントを確認することが重要です。

ワークフローデバッグビューを開くには、次の手順に従います。

1. デバッグする必要がある注文行をクリックします。
2. 注文ビューで、ワークフローインスタンスリンクをクリックします。ワークフローが別のタブで開きます。
3. 対象のプロセス変数を検索します。

次のスクリーンショットは、ワークフローデバッグビューAPIへのアクセス方法を示しています。

camunda、camunda-external-tasks、およびservice-catalog-ms microservicesのログを確認しています。

マイクロサービスログを確認するには、次の手順を実行します。

1. マスターノードまたはワーカーノードにログインします(SSH)。
2. 対象のマイクロサービスの導入名またはポッド名を取得します。
3. kubetilユーティリティを使用してログを追跡します。

次のスクリーンショットは、マイクロサービスのログを確認する方法を示しています。