エコシステムの管理

Things Cloud プラットフォームは、アプリケーションとマイクロサービスを区別します。

  • アプリケーション:テナントに登録されているか、テナントが所有するすべての Web アプリケーション

  • マイクロサービス:Things Cloud 上に追加機能を開発するために使用されるサーバー側アプリケーション

どちらも、ナビゲータの エコシステム メニューからアクセスできます。

さらに、エンタープライズテナント(親テナント) では デフォルトのサブスクリプション を構成できます。つまり、作成時にすべての新しいテナント、またはプラットフォームのアップグレード時にすべての既存のテナントにデフォルトで登録されるアプリケーションのリストを指定できます。詳細については デフォルトのサブスクリプション を参照してください。

必要条件

ロールとアクセス権限:

  • アプリケーションとマイクロサービスを表示する:「アプリケーション管理」権限タイプの読み取り権限
  • アプリケーションとマイクロサービスを管理する(作成、更新、コピー、削除):「アプリケーション管理」権限タイプの管理者権限

テナントの作成時には、上記の権限のサンプル構成として使用できるデフォルトのロールが利用可能です。

  • テナントマネージャー:アプリケーション、テナントオプション、ビジネスルールなどのテナント全体の構成を管理する

アプリケーションを完全に管理するには、機能ごとに、さまざまな権限レベルを持つ追加の権限タイプが必要になる場合があることに注意してください。
例:

アプリケーションの管理

アプリケーションには2種類の可用性があります。

  • 登録済み :プラットフォーム(デフォルトアプリケーションとして)またはサービス プロバイダーによって提供される、テナントに登録されたアプリケーション
  • カスタム :テナントが所有するアプリケーション。独自のアプリケーションとしてさまざまな方法で、カスタムアプリケーションを追加することができます。

アプリケーションは、トップバーのアプリケーション スイッチャーから利用できます。

アプリケーションスイッチャー

アプリケーションの表示

ナビゲータのエコシステムメニューでアプリケーションをクリックして、アカウント内のすべてのアプリケーションのリストまたはグリッドを表示します。

すべてのアプリケーション

アプリケーションタブでは、テナントで使用できるすべてのアプリケーションを確認できます。

アプリケーションは、名前または利用可能範囲によってフィルタリングできます。

アプリケーションの編集

アプリケーションをクリックするか、エントリの右側にあるメニューアイコン から編集をクリックします。

プロパティタブでは、アプリケーションのタイプに応じて複数のフィールドを変更できます(アプリケーションのプロパティ参照)。

重要
システムアプリケーション名は絶対に変更しないでください(「デバイス管理」「コックピット」など)。変更するとテナントの初期化に失敗します。

アプリケーションの削除

エントリの右側にあるメニューアイコン から削除をクリックします。アプリケーションの詳細のプロパティタブから直接アプリケーションを削除することもできます。

登録済みアプリケーションを上書きするアプリケーションを削除すると、現在登録済みアプリケーションはすべてのユーザーが使用できるようになります。さらに、ユーザーは登録済みアプリケーションの今後のアップグレードからもメリットを得ることができます。

登録済みアプリケーションを削除することはできません。これは、登録済みアプリケーションの所有者のみが実行できます。

機能

機能とは、明示的なアーティファクト(マイクロサービスや Web アプリケーションなど)によって表わせられない組み込みのアプリケーションです。

機能 タブには、テナントで登録されているすべての機能のリストが表示されます。エンタープライズテナント(親テナント)では、以下の機能がデフォルトで利用可能です。

UIでの名称 機能 APIでの識別 可用性
Feature-branding テナントの外観を自分の好みに合わせてカスタマイズする feature-branding エンタープライズテナント(親テナント)
Feature-user-hierarchy 同じデータベースを共有する独立した組織エンティティを Things Cloud に反映する feature-user-hierarchy エンタープライズテナント(親テナント)
備考
ここにリストされているすべてのアプリケーションは、タイプが「Feature」です。

テナントの個々のサブスクリプションによって、他の機能が表示される場合があります。

登録済みアプリケーション

Things Cloud は、さまざまな目的に合わせて、さまざまなアプリケーションを提供します。インストールやオプションのサービスに応じて、利用可能なアプリケーションの選択肢がテナントに表示されます。

備考
アプリケーション タブでは、登録されたアプリケーションは「登録済み」とラベルが付きます。登録されたアプリケーションは、ユーザーが追加、変更、または削除することはできませんが、テナント管理者のみが行うことができます。

以下に、標準テナント(サブテナント) または エンタープライズテナント(親テナント) でデフォルトで使用可能なすべてのアプリケーションを示します。さらに、多数のオプションのアプリケーションがテナントに登録されている場合があります。

デフォルトの登録済みアプリケーション

UIでの名称 機能 APIでの識別 テクニカルタイプ 可用性
管理 アカウント管理者はユーザー、ロール、テナント、アプリケーションを管理できます administration Webアプリケーション 標準テナント(サブテナント), エンタープライズテナント(親テナント)
コックピット ビジネスの観点からIoTのアセットとデータを管理および監視します cockpit Webアプリケーション 標準テナント(サブテナント), エンタープライズテナント(親テナント)
デバイス管理 デバイスを管理および監視し、デバイスのリモートでの制御とトラブルシューティング devicemanagement Webアプリケーション 標準テナント(サブテナント), エンタープライズテナント(親テナント)
ストリーミング分析 分析ビルダーモデルと EPLアプリの管理と編集(有効な場合) Streaming Analytics Webアプリケーション 標準テナント(サブテナント)(分析ビルダーの限定バージョン)、 エンタープライズテナント(親テナント)(フルバージョン)

カスタムアプリケーション

カスタムアプリケーションは、次のような働きを行うことができます。

  • Web ベース の UI アプリケーション。スタンドアロンアプリケーションとしてデプロイしたもの、またはコックピット ダッシュボードのウィジェットのような特定アプリケーションへデプロイしたプラグイン
  • 他の場所で実行されているアプリケーションへのリンク
  • 登録済みアプリケーションの複製(カスタマイズするため)
備考
アプリケーション タブでは、カスタムアプリケーションに「カスタム」というラベルが付きます。

アプリケーションタブの右上にあるアプリケーションを追加をクリックして、カスタムアプリケーションを追加します。

次に表示されるダイアログボックスで、以下のいずれかの方法を選択します。

Webアプリケーションのアップロード

  1. アプリケーションタブの右上にあるアプリケーションを追加をクリックします。
  2. Webアプリケーションをアップロードを選択します。
  3. 次のダイアログボックスで、zipファイルをドロップするか、ファイルシステムでファイルを参照します。

zipファイルがプラットフォームに正常にアップロードされると、アプリケーションが作成されます。

重要
zipファイルのルートディレクトリに index.htmlcumulocity.json が含まれている必要があります。含まれていない場合、アプリケーションは動作しません。
  1. アプリケーションタブの右上にあるアプリケーションを追加をクリックします。
  2. 外部アプリケーションを選択します。
  3. 次のダイアログボックスで、アプリケーション名を入力します。名前は、アプリケーションのタイトルとして表示されます。
  4. このアプリケーションを識別するアプリケーションキーを入力します。
  5. アプリケーションにアクセスできる外部 URL を入力します。
  6. アプリケーションを追加をクリックしてアプリケーションを作成します。

フィールドの詳細については、後述のアプリケーションのプロパティも参照してください。

ブループリントからアプリケーションのインストール

  1. アプリケーションタブの右上にあるアプリケーションを追加をクリックします。
  2. 利用可能な拡張パッケージからインストールを選択します。
  3. 目的のパッケージを選択します。
  4. 表示されるダイアログボックスで、アプリケーション名を入力します。名前は、アプリケーションのタイトルとして表示されます。
  5. このアプリケーションを識別するアプリケーションキーを入力します。
  6. アプリケーションにアクセスできるパスを入力します。
  7. インストールをクリックしてアプリケーションを作成します。

フィールドの詳細については、後述のアプリケーションのプロパティも参照してください。

アプリケーションの複製

アプリケーションの複製は、登録済みアプリケーションを必要に応じてカスタマイズする場合に便利です。登録済みアプリケーションを複製すると、元のアプリケーションへのリンクを含む独自のアプリケーションとしてコピーが作成されます。

  1. アプリケーションタブの右上にあるアプリケーションを追加をクリックします。

  2. 次のダイアログボックスで、既存のアプリケーションを複製を選択します。

  3. ドロップダウン リストから目的のアプリケーション (例:「コックピット」) を選択します。

  4. 次のウィンドウで、アプリケーション名、アプリケーションを識別するためのアプリケーションキー、およびアプリケーションを呼び出すための URL の一部としてのパスを入力します。最後に、利用可能なアイコンの中から新しいアプリケーションのアイコンを選択します。デフォルトでは、元のアプリケーションの値が数値で拡張されて提供されます。パスを元の登録済みアプリケーションのパスに設定すると、独自のアプリケーションが登録済みアプリケーションを無効にします。

    備考
    プラットフォームは、名前 フィールドでプレフィクス「feature-」の使用を制限しています。アプリケーション名にこのプレフィクスを使用してアプリケーションを作成することはできません。これは、複製アプリケーション機能が使用されている場合の既存のアプリケーションにも当てはまります。
  5. 最後に、複製をクリックしてアプリケーションを作成します。

備考
アプリケーションがテナントに登録されている場合、追加のトグル 登録されたアプリケーションを却下 があります。このトグルをオンにすると、名前、キー、およびパスの値が元のアプリケーションから継承され、複製されたアプリケーションが登録されたアプリケーションを無効にします。値を変更するには、これをオフにします。

アプリケーションを複製

フィールドの詳細については、以下のアプリケーションのプロパティも参照してください。

アプリケーションのプロパティ

アプリケーションの詳細を表示するには、アプリケーションをクリックして プロパティ タブを開きます。

Application properties

プロパティ タブでは、各アプリケーションにアプリケーションのタイプ(HOSTED または EXTERNAL)に応じて、次の情報が表示されます。

フィールド 説明 ホスト(Webアプリケーション) 外部
ID アプリケーションを識別する一意のID 自動的に提供 自動的に提供
名前 アプリケーション名。トップバーとアプリケーションスイッチャーに、アプリケーションのタイトルとして表示されます 自動的に作成 ユーザーが指定
アプリケーションキー アプリケーションを識別し、サブスクライブを可能にします。 自動的に作成 ユーザーが指定
タイプ アプリケーションタイプ ホスト 外部
パス アプリケーションを呼び出すURLの一部 自動的に作成 ユーザーが指定。例えば、アプリケーションのパスとして「hello」を使用する場合、アプリケーションのURLは「/apps/hello」になります
アイコンの選択 アプリケーションのアイコンを選択できる、さまざまなアイコンを提供します。 自動的に作成 ユーザーが指定
備考
アイコン選択はカスタムアプリケーションにのみ利用可能です。

拡張機能

拡張機能

拡張パッケージは、プラグインとブループリントの組み合わせで、1 つのファイルにまとめてプラットフォームにデプロイできます。そのため、さまざまなアプリケーション間で UI 機能の共有と再利用が向上し、コーディングの知識がなくてもアプリケーションに UI 機能を追加できます。

拡張パッケージには、2種類のコンテンツが含まれます。

  • プラグインを使用すると、アプリケーションを再構築することなく、既存のアプリケーションを拡張できます。
  • ブループリントは、プラットフォームでホストできる複数の UI 機能の組み合わせであり、新しいアプリケーションを最初から作成するために使用できます。

プラグインを他のアプリケーションに追加している間、ブループリント アプリケーションをデプロイする必要があります。これにより、ソリューション全体を足場にしたり、既存のソリューションを拡張したりすることができます。 マイクロフロントエンド テクノロジにより、これは再構築しなくても実行時に発生する可能性があります。

パッケージは、拡張ページにあります。

パッケージビュー

パッケージは、名前、作成者のタイプ、利用可能範囲、内容のタイプでフィルタリングできます。

新しい拡張パッケージを追加するには、右上の拡張パッケージの追加をクリックします。

パッケージをクリックすると、説明や画像、package.jsonから取得したメタ情報を含む拡張パッケージの概要など、パッケージの詳細が表示されます。

さらに、右側で選択したパッケージ内の利用可能なプラグインをすべて表示することができます。プラグインをインストールするには、プラグインのインストール をクリックし、目的のアプリケーションを選択します。

パッケージの概要

バージョン タブには、現在のパッケージに関連する過去にアップロードされたすべてのバイナリが表示されます。このタブに表示されるバイナリは、各パッケージバージョン エントリの横にあるコンテキスト メニューからダウンロードできます。

バージョンビュー

異なるバージョンを選択またはアップロードできます。バージョンはパッケージの状態を示します。これらは、特定のパッケージが古く、更新する必要があるかどうかを確認するために使用できます。バージョンをクリックすると、パッケージの内容、アプリケーション、プラグインなどの追加情報が表示されます。タグを使用すると、バージョンに意味のある名前を付けることができます。「latest」タグは、タグが指定されていない場合に選択されるデフォルトのバージョンを示すために使用されます。特定のタグなしでバージョンがアップロードされると、「latest」タグはデフォルトで最新バージョンに設定されます。

別のバージョンに切り替えるには、対象のバージョンのコンテキスト メニューを開き、最新として設定をクリックします。バージョンを削除するには、削除をクリックします。

プラグイン

アプリケーションの プラグイン タブに切り替えて、アプリケーションにインストールされているすべてのプラグインを表示します。

プラグイングリッド

プラグイン タブでは、プラグインを追加および削除できます。さらに、アプリケーションにプラグインをインストールできます。

アーカイブのアップロード

カスタム アプリケーションの場合、zip ファイルまたは mon ファイルをアップロードすることにより、作成された複数のファイルのバージョンを Things Cloud に保存することができます。各バージョンはアーカイブと呼ばれます。異なるバージョンを同時にアップロードし、これらのバージョンを切り替えることができます。

アーカイブのアップロード方法

  1. それぞれのアプリケーションをクリックして、アプリケーションのプロパティを開きます。
  2. アクティビティログ セクションの下部にあるプラスボタンをクリックして、ファイルシステム内のアーカイブを参照するか、アーカイブ ファイルをドロップします。
  3. アップロード をクリックして、アーカイブを Things Cloud アカウントにアップロードします。
アプリケーションのアーカイブ

アップロードされると、最新でアップロードされたバージョンが自動的にアクティブなバージョンとなります。これは、アカウントのユーザーに現在提供されているアプリケーションのバージョンとなります。このバージョンは削除できません。

備考
アプリケーションの所有者のみが、このアクションを実行できるため、登録済みアプリケーションではアーカイブ機能を使用できません。

アプリケーションを旧バージョンへ復元

ユーザーは、アーカイブからアプリケーションを旧バージョンへ復元することができます。

  1. それぞれのアプリケーションをクリックして、アプリケーションのプロパティを開きます。
  2. アクティビティログ セクションで、メニューアイコン をクリックして、目的のバージョンのコンテキストメニューを開き、アクティブに設定 を選択して有効なバージョンにします。

単一のアプリケーションを再アクティブ化

ホストされたアプリケーションが正しくデプロイされていない場合、ユーザーは再アクティブ化できます。

  1. それぞれのアプリケーションをクリックして、アプリケーションのプロパティを開きます。
  2. アクティビティログ セクションで、メニューアイコン をクリックして、目的のバージョンのコンテキストメニューを開き、アーカイブを再アクティブ化 を選択します。

選択したアプリケーションは、アプリケーション ディレクトリからそれぞれのファイルを削除し、Webアプリケーション パッケージを再度解凍することで再アクティブ化されます。

マイクロサービスの管理

ナビゲータの エコシステム メニューで マイクロサービス をクリックして、アカウントに登録されているすべてのマイクロサービスのリストまたはグリッドを表示します。

マイクロサービスのリスト

マイクロサービスは名前と利用可能範囲でフィルタリングできます。

マイクロサービスは特定タイプのアプリケーションであり、Things Cloud 上にさらなる機能を開発するために使用されるサーバー側アプリケーションです。webアプリケーションと同様に、マイクロサービスはプラットフォームまたはサービスプロバイダーによってテナントに登録されるか、カスタムアプリケーションとして所有できます。詳細については、カスタムマイクロサービスを参照してください。

登録済みマイクロサービス

Things Cloud は、さまざまな目的に合わせて、さまざまなマイクロサービスアプリケーションを提供します。インストールおよびオプションのサービスに応じて、利用可能なアプリケーションの選択肢がテナントに表示されます。

以下に、標準テナント(サブテナント) および エンタープライズテナント(親テナント) にデフォルトで登録されているすべてのマイクロサービスのリストを示します。さらに、多数のオプションのマイクロサービスがテナントに登録されている場合があります。

デフォルトの登録済みマイクロサービス

UIでの名称 機能 APIでの識別 可用性
Apama-ctrl-* ストリーミング分析マイクロサービス(分析ビルダー、EPLアプリ、スマートルールのランタイムを含む)。機能とリソースは、使用されるマイクロサービスのバリアントによって異なります apama-ctrl-* 標準テナント(サブテナント)、エンタープライズテナント(親テナント)
Device-simulator IoTデバイスのあらゆる側面をシミュレートします device-simulator 標準テナント(サブテナント)、エンタープライズテナント(親テナント)
Report agent コックピットアプリケーション内からデータのエクスポートをスケジュールします report agent 標準テナント(サブテナント)、エンタープライズテナント(親テナント)
Smartrule スマートルールエンジンを使用し、リアルタイムデータに基づいてアクションを実行するスマートルールを作成します。Apama-ctrlマイクロサービスのバリアントが必要です smartrule 標準テナント(サブテナント)、エンタープライズテナント(親テナント)
Sslmanagement SSL証明書を使用して独自のカスタムドメイン名を有効にします sslmanagement エンタープライズテナント(親テナント)
備考
ここにリストされているすべてのアプリケーションは、タイプが「Microservice」です。

カスタムマイクロサービス

マイクロサービスをカスタムアプリケーションとして追加

  1. 右上の マイクロサービスを追加 をクリックします。
  2. 次のダイアログボックスで、ZIPファイルをドロップするか、ファイルシステムでファイルを参照します。アップロードするファイルのサイズ制限は500MBであることに注意してください。
  3. ZIPファイルが正常にアップロードされると、マイクロサービスアプリケーションが作成されます。
重要
ZIPファイルには、アプリケーションマニフェストとマイクロサービスのDockerイメージが含まれている必要があります。マイクロサービスパッケージの準備とデプロイについては、一般的な側面を参照してください。マニフェストファイルでマイクロサービス名を指定できます。ファイルに名前が指定されていない場合、プラットフォームは認識されたバージョンサフィックスを削除して、ZIPファイル名から名前を取得します。いずれの場合も、結果として得られる名前の長さは23文字を超えてはなりません。

マイクロサービスのプロパティ

マイクロサービスの詳細を表示するには、マイクロサービスをクリックして プロパティ タブを開きます。

マイクロサービスのプロパティ

プロパティ タブでは、各マイクロサービスに次の情報が表示されます。

フィールド 説明 コメント
ID マイクロサービスを識別する一意のID 自動的に提供
名前 アプリケーション名。トップバーにマイクロサービスアプリケーションのタイトルとして表示されます マイクロサービスのマニフェストファイルで指定されていない限り、ZIPファイル名から自動的に推測されます(認識されたバージョン番号は削除されます)
アプリケーションキー マイクロサービスアプリケーションを識別し、サブスクリプションのために利用できるようにします ZIPファイル名に基づいて自動的に作成
タイプ アプリケーションタイプ Microservice
パス アプリケーションを呼び出すURLの一部 /service/<microservice-name>として自動的に作成

次に、マイクロサービスのバージョン、分離レベル、課金モードに関する情報も記載されています。これらのパラメータの詳細については、マイクロサービスの使用状況を参照してください。

マイクロサービスのサブスクリプション

プロパティ タブの右上には、マイクロサービスをサブスクライブまたはサブスクライブ解除するためのトグルがあります。

サブスクリプションの変更は、カスタムマイクロサービス、つまり所有するマイクロサービスにのみ可能です。

マイクロサービスのアクセス権限

アクセス権限 タブでは、各マイクロサービスに必要なアクセス権限と、提供されているロールを表示できます。

マイクロサービスの監視

Things Cloudがホストするマイクロサービスは、2つの方法で監視できます。

ステータス情報

マイクロサービスのステータスは、目的のマイクロサービスアプリケーションのステータスタブより確認することができます。

Microservice status

ステータスを表示するには、アプリケーション管理の読み取りロールとインベントリの読み取りロールの権限が必要です。

ステータスタブには、次の情報が表示されます。

  • インスタンス:現在のテナントにおけるアクティブ、異常、予期(期待通り)のマイクロサービスのインスタンス数
  • サブスクリプション:マイクロサービスが登録されたすべてのサブテナントのアクティブ、異常、予期(期待通り)なマイクロサービスのインスタンス数
  • アラーム:アプリケーションのリアルタイムで提供されるアラーム
  • イベント:アプリケーションのリアルタイムで提供されるイベント
  • スマートルール:適用可能なスマートルールのリスト

アラームとイベント

ステータスタブに表示されるほとんどのアラームとイベントは、マイクロサービスで何が起こっているかを厳密に技術的に説明したものです。

利用者向けのアラームタイプは2つあります。

  • c8y_Application_Down :マイクロサービスインスタンスを利用できない場合に作成されるクリティカルアラーム
  • c8y_Application_Unhealthy :少なくとも1つのマイクロサービスインスタンスが正常に動作しているが、すべてが完全に動作しているわけではない場合に作成されるメジャーアラーム

上記のアラームは、マイクロサービス所有者のテナントに対してのみ作成されます。また、状況が正常に戻る、つまりすべてのマイクロサービスインスタンスが正常に動作している状態に戻ると、自動的にクリアされます。

これらのアラームはスマートルール作成にも利用できます。さまざまなタイプのスマートルールの作成についての詳細については、スマートルールを参照してください。

例えば、マイクロサービスがダウンしたときにメールを送信する場合は、「アラーム時に電子メールを送信」というスマートルールを作成します。

次のタイプのアラームの場合: セクションで、アラームタイプとして c8y_Application_Down を使用します。対象アセットとして、例えば「echo-agent-server」など、監視するマイクロサービスを選択します。

ログファイル

Things Cloudは閲覧ログを表示して、テナントに所有されたマイクロサービスのステータスに関する、より詳細な情報を提供します。

ログを表示するには、目的のマイクロサービスのログタブを開きます。

ページ上部で、ログを表示するマイクロサービスのインスタンスを選択できます。

備考
マイクロサービスが2つのインスタンスへと規模を変更した場合、インスタンスを切り替えることができますが、両方のインスタンスからのログを同時に表示することはできません。

インスタンスのドロップダウンの横にあるカレンダーから日付を選択し、時間を入力すれば、ログエントリが表示される時間の範囲を選択できます。

備考
ここで入力する時間は、タイムゾーンの違いによりサーバー時刻と異なる場合があります。

右上には、次の追加機能があります。

  • ダウンロード :指定した時間範囲のログデータをダウンロードします。
  • 暗色テーマ :暗色テーマのオン/オフを切り替えます。
  • 自動更新 :自動更新機能を有効にします。有効にすると、表示されたログデータは10秒ごとに自動的に更新されます。

最初に、ログタブにマイクロサービスインスタンスの最新のログが表示されます。

右下には、ナビゲーションボタンがあります。

  • 最初 :マイクロサービスの再起動後に、マイクロサービスで利用可能な最も古いログエントリに直接移動します(ログの最大容量:35MB)。
  • :時間範囲を10分単位で拡大します。
  • 次へ :時間範囲を10分単位で縮小します。
  • 最後 :利用可能な最新のログエントリに直接移動します。

選択した時間範囲に利用可能なログがなかった場合、それに応じてメッセージが表示されます。

Microservice log
備考

以前に実行されていたインスタンスのログ、または 35MBを超える以前にローテーションされたログを表示することはできません。しかし、インスタンス内ではDockerコンテナが実行されており、(インスタンス全体ではなく)そのDockerコンテナのみが再起動した場合は、現在実行中のDockerコンテナと最近終了したDockerコンテナのログが表示されます。

ログは常に stdoutstderr の両方を使用してDockerコンテナから読み込まれ、ログ生成元によって区別/フィルタリングすることはできません。