OASE Agent on Docker Compose - Online

Introduction

This document aims to explain how to install the Exastro OASE Agent, which is used to link with external services when using OASE.

Features

This document contains information on how to install the Exastro OASE Agent, which is required in order to use Exastro OASE.

Users can easily boot the Exastro OASE Agent by using Docker Compose.

For more information regarding configuring and using the Exastro OASE Agent, see the Agent overview.

Pre-requisites

• Exastro IT Automation

  In order to operate the Exastro OASE Agent, both the Exastro OASE Agent and the Exastro IT Automation must be operating on the same version.

• Deploy environment

  The following describes confirmed compatible container environments as well as their resources and versions.

  表 35 Hardware requirements(Minimum)

  Resource type	Required resource
  CPU	2 Cores (3.0 GHz, x86_64)
  Memory	4GB
  Storage (Container image size)	10GB

• Confirmed compatible Operation systems

  The following describes confirmed compatible operation systems as well as their versions.

  表 36 Operating systems

  Type	Version
  Red Hat Enterprise Linux	Version 8
  AlmaLinux	Version 8
  Ubuntu	Version 22.04

• Confirmed compatible Operation systems and container platforms

  The following describes confirmed compatible operation systems as well as their versions.

  表 37 Container Platforms

  Software	Version
  Podman Engine ※When using Podman	Version 4.4
  Docker Compose ※When using Podman	Version 2.20
  Docker Engine ※When using Docker	Version 24

Application

The user must be able to run sudo commands.

警告

The Exastro OASE Agent process must be able to be run with normal user permissions (it is not possible to install with root user).

Any normal users must be sudoer and have complete permissions.

Install

Preparation

First, the user must fetch the different structure files. In this section, we will fetch the file groups required to boot the agent, such as docker-compose.yml.

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

The following steps will be done in the exastro-docker-compose/ita_ag_oase directory.

cd exastro-docker-compose/ita_ag_oase

Make a environment setting file（.env） from the sample.

リスト 172 Copied from sample （When using Docker）

cp .env.docker.sample .env

リスト 173 Copied from sample （When using Podman）

cp .env.podman.sample .env

Refer to the parameter list and register an .env file.

vi .env

Boot

Use either docker or docker-compose command to boot the container.

リスト 174 Using docker command(Docke environment)

docker compose up -d --wait

リスト 175 using docker-compose command(Podman environment)

docker-compose up -d --wait

Parameter list

For more information regarding Exastro OASE Agent and how some of the parameter works, see OASE Agent operation flow and ".env" setting Values.

Parameter	Description	Changeable	Default value/Selectable setting value
NETWORK_ID	Docker Network ID used by the OASE Agent	Yes	20230101
LOGGING_MAX_SIZE	Max file size for the container's log files.	Yes	10m
LOGGING_MAX_FILE	Maximum amount of generations for the container's log files.	Yes	10
TZ	The Time zone used by the OASGE Agent system.	Yes	Asia/Tokyo
DEFAULT_LANGUAGE	Default language used by the OASE Agent System.	Yes	ja
LANGUAGE	Language used by the OASE Agent System.	Yes	en
ITA_VERSION	OASE Agent version	Yes	2.3.0
UID	OASE Agent execution user	Not required	1000 (Default): Using Docker 0: When using Podman
HOST_DOCKER_GID	Docker group ID on the host	Not required	999: Using Docker 0: When using Podman
AGENT_NAME	Name of the OASE Agent	Yes	ita-oase-agent-01
EXASTRO_URL	Exastro IT Automation's Service URL	Yes	http://localhost:30080
EXASTRO_ORGANIZATION_ID	OrganizationID created in Exastro IT Automation	Required	None
EXASTRO_WORKSPACE_ID	WorkspaceID created in Exastro IT Automation	Required	None
EXASTRO_REFRESH_TOKEN	Refresh token fetched from the Exastro System management page※ ※The user's role must have edit permission for the OASE - Event - Event history menu.	Yes	None
EXASTRO_USERNAME	Username created in Exastro IT Automation ※Refresh token fetched from the Exastro System management page. ※If not using EXASTRO_REFRESH_TOKEN（Not recommended）	Yes	admin
EXASTRO_PASSWORD	Password created in Exastro IT Automation. ※If not using EXASTRO_REFRESH_TOKEN（Not recommended）	Yes	Ch@ngeMe
EVENT_COLLECTION_SETTINGS_NAMES	The Event collection setting name created in Exastro IT Automation's OASE Management event collection.	Required	None ※Multiple can be specified by dividing with commas.
ITERATION	Number of process iterations before the OASE Agent settings resets.	Yes	10（Max: 120, Min: 10）
EXECUTE_INTERVAL	OASE Agent's data fetch process execution interval	Yes	5（Min: 3）
LOG_LEVEL	OASE Agent's log level	Yes	INFO

※For more information regarding fetching Refresh tokens, see Issue tokens.

Update

This section explains how to update the Exastro OASE Agent.

Update preparation

警告

We highly recommend taking a backup before updating the system.

Backup target is ~/exastro-docker-compose/ita_ag_oase/.volumes/.

Update repository

Update the exastro-docker-compose repository.

リスト 176 Command

# Confirm exastro-docker-compose repository
cd ~/exastro-docker-compose/ita_ag_oase
git pull

Check the updated default setting values.

Check the updated default values.

Compare the settings filed created when installing the system ~/exastro-docker-compose/.env and the settings file after the update.

リスト 177 Command

cd ~/exastro-docker-compose/ita_ag_oase

# If the OS is AlmaLinux or Ubuntu
diff .env .env.docker.sample
# If the OS is Red Hat Enterprise Linux
diff .env .env.podman.sample

Update setting values

Use the comparison results to check if there are any added items that needs setting values added to. If there are none or the user does not need to change any values, proceed to the next step.

Update

Update the system

Start the Update process.

リスト 178 Command

cd ~/exastro-docker-compose/ita_ag_oase

リスト 179 For using docker command(Docker environment)

docker compose up -d --wait

リスト 180 For using docker-compose command(Podman environment)

docker-compose up -d --wait

Uninstall

This sections explains how to uninstall the Exastro OASE agent

Uninstallment preparation

警告

We highly recommend taking a backup before uninstalling the system.

The backup target is ~/exastro-docker-compose/ita_ag_oase/.volumes/.

Uninstall

Start Uninstallment process

Start uninstalling

リスト 181 Command

cd ~/exastro-docker-compose/ita_ag_oase

リスト 182 For using docker command(Docker environment)

# For only deleting the Container
docker compose down

# For deleting the Container+ Container Image+ Volume
docker compose down --rmi all --volumes

リスト 183 For using docker-compose command(Podman environment)

# For only deleting the Container
docker-compose down

# For deleting the Container+ Container Image+ Volume
docker-compose down --rmi all --volumes

リスト 184 Command

# For deleting the data
rm -rf ~/exastro-docker-compose/ita_ag_oase/.volumes/storage/*