3. OASE Agent (Docker Compose)

3.1. 目的

本書では、Exastro IT AutomationにおいてOASEを利用する際に、外部との連携に必要となる、Exastro OASE Agentを導入する手順について説明します。

3.2. 特徴

OASEを利用するための絶対条件である、Exastro OASE Agentの導入方法となります。

Docker Compose を利用することで、Exastro OASE Agentを簡単に起動することが可能です。

Exastro OASE Agentの設定や運用については、エージェント概要 をご参照ください。

3.3. 前提条件

• Exastro IT Automationについて

  Exastro OASE Agentの運用には、Exastro OASE AgentとExastro IT Automationのバージョンが一致している必要があります。

• デプロイ環境

  動作確認が取れているコンテナ環境の最小要求リソースとバージョンは下記のとおりです。

  表 3.1 ハードウェア要件(最小構成)

  リソース種別	要求リソース
  CPU	2 Cores (3.0 GHz, x86_64)
  Memory	4GB
  Storage (Container image size)	10GB

• 動作確認済みオペレーティングシステム

  以下は、動作確認済のバージョンとなります。

  表 3.2 オペレーティングシステム

  種別	バージョン
  Red Hat Enterprise Linux	バージョン 8
  AlmaLinux	バージョン 8
  Ubuntu	バージョン 22.04

• 動作確認済みコンテナプラットフォーム

  手動でインストールする際には、下記のコンテナプラットフォームを準備してください。 以下は、動作確認済のバージョンとなります。

  表 3.3 コンテナプラットフォーム

  ソフトウェア	バージョン
  Podman Engine ※Podman 利用時	バージョン 4.4
  Docker Compose ※Podman 利用時	バージョン 2.20
  Docker Engine ※Docker 利用時	バージョン 24

• アプリケーション

  sudo コマンドが実行できる必要があります。

警告

Exastro OASE Agent のプロセスは一般ユーザ権限で起動する必要があります。(rootユーザーでのインストールはできません)

また、利用する一般ユーザは sudoer で、全操作権限を持っている必要があります。

3.4. インストール

3.4.1. 準備

はじめに、各種構成ファイルを取得します。docker-compose.ymlなどの起動に必要なファイル群を取得します。

git clone https://github.com/exastro-suite/exastro-docker-compose.git

以降は、exastro-docker-compose/ita-ag-oaseディレクトリで作業をします。

cd exastro-docker-compose/ita-ag-oase

環境変数の設定ファイル（.env）を、サンプルから作成します。

リスト 3.1 （Docker利用時）サンプルからコピー

cp .env.docker.sample .env

リスト 3.2 （Podman利用時）サンプルからコピー

cp .env.podman.sample .env

末尾のパラメータ一覧を参考に、起動に必要な情報を .env に登録します。

vi .env

3.4.2. 起動

docker もしくは docker-compose コマンドを使いコンテナを起動します。

リスト 3.3 docker コマンドを利用する場合(Docker環境)

docker compose up -d  --wait

リスト 3.4 docker-compose コマンドを利用する場合(Podman環境)

docker-compose up -d  --wait

3.5. パラメータ一覧

Exastro OASE Agentの仕様と一部のパラメータの関連については、OASE Agentの処理フローと.envの設定値 にて説明しています。

パラメータ	説明	変更	デフォルト値・選択可能な設定値
NETWORK_ID	OASE エージェント で利用する Docker ネットワークのID	可	20230101
LOGGING_MAX_SIZE	コンテナ毎のログファイルの1ファイルあたりのファイルサイズ	可	10m
LOGGING_MAX_FILE	コンテナ毎のログファイルの世代数	可	10
TZ	OASE エージェント システムで使用するタイムゾーン	可	Asia/Tokyo
DEFAULT_LANGUAGE	OASE エージェント システムで使用する規定の言語	可	ja
LANGUAGE	OASE エージェント システムで使用する言語	可	en
ITA_VERSION	OASE エージェント のバージョン	可	2.3.0
UID	OASE エージェント の実行ユーザ	不要	1000 (デフォルト): Docker 利用の場合 0: Podman 利用の場合
HOST_DOCKER_GID	ホスト上の Docker のグループID	不要	999: Docker 利用の場合 0: Podman 利用の場合
AGENT_NAME	起動する OASEエージェントの名前	可	ita-oase-agent-01
EXASTRO_URL	Exastro IT Automation の Service URL	可	http://localhost:30080
EXASTRO_ORGANIZATION_ID	Exastro IT Automation で作成した OrganizationID	必須	無し
EXASTRO_WORKSPACE_ID	Exastro IT Automation で作成した WorkspaceID	必須	無し
EXASTRO_USERNAME	Exastro IT Automation で作成した ユーザー名 ※ユーザーのロールが、OASE - イベント - イベント履歴メニューをメンテナンス可能である必要があります。	可	admin
EXASTRO_PASSWORD	Exastro IT Automation で作成した パスワード	可	Ch@ngeMe
EVENT_COLLECTION_SETTINGS_NAMES	Exastro IT Automation のOASE管理 エージェント で作成した イベント収集設定名	必須	無し※カンマ区切りで複数指定可能
ITERATION	OASE エージェント が設定を初期化するまでの、処理の繰り返し数	可	10（下限値: 10）
EXECUTE_INTERVAL	OASE エージェント のデータ収集処理の実行間隔	可	5（下限値: 3）
LOG_LEVEL	OASE エージェント のログレベル	可	INFO