1. Docker Compose¶

1.1. 目的¶

本書では、Exastro IT Automation を利用する際に必要となる、Exastro Platform および Exastro IT Automation を Docker もしくは Podman 上に導入する手順について説明します。

1.2. 特徴¶

最も簡単に Exastro IT Automation の利用を開始するための導入方法となります。

高い可用性やサービスレベルを必要とする場合には、Kubernetes 版の利用を推奨します。

1.3. 前提条件¶

デプロイ環境

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

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

リソース種別

要求リソース

CPU

2 Cores (3.0 GHz, x86_64)

Memory

4GB

Storage (Container image size)

40GB

表 1.6 ハードウェア要件(推奨構成)¶

リソース種別

要求リソース

CPU

4 Cores (3.0 GHz, x86_64)

Memory

16GB

Storage (Container image size)

120GB

警告

最小構成における要求リソースは Exastro IT Automation のコア機能に対する値です。GitLab や Ansible Automation Platform などの外部システムをデプロイする場合は、その分のリソースが別途必要となります。

データベースおよびファイルの永続化のために、別途ストレージ領域を用意する必要があります。

Storage サイズは、ユーザーの利用状況によるためあくまで目安となります。必要に応じて容量を確保してください。

表 1.5 ハードウェア要件(最小構成)¶
リソース種別	要求リソース
CPU	2 Cores (3.0 GHz, x86_64)
Memory	4GB
Storage (Container image size)	40GB

表 1.6 ハードウェア要件(推奨構成)¶
リソース種別	要求リソース
CPU	4 Cores (3.0 GHz, x86_64)
Memory	16GB
Storage (Container image size)	120GB

通信要件

表 1.7 通信要件¶
用途	説明	通信元	通信先	デフォルト
Exastro サービス用	Exastro サービスとの接続に利用	クライアント	Exastro システム	30080/tcp
Exastro システム管理用	Exastro システム管理機能に利用	クライアント	Exastro システム	30081/tcp
GitLab サービス用(オプション)	AAP連携時の GitLab サービス接続に利用	Ansible Automation Platform	Exastro システム	40080/tcp
GitLab サービス用(オプション)	GitLab サービス監視用	Exastro システム	Exastro システム	40080/tcp
資材取得	GitHub、コンテナイメージ、導入パッケージなど	Exastro システム	インターネット	443/tcp

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

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

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

種別

バージョン

Red Hat Enterprise Linux

バージョン 8

AlmaLinux

バージョン 8

Ubuntu

バージョン 22.04

表 1.8 オペレーティングシステム¶
種別	バージョン
Red Hat Enterprise Linux	バージョン 8
AlmaLinux	バージョン 8
Ubuntu	バージョン 22.04

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

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

表 1.9 コンテナプラットフォーム¶
ソフトウェア	バージョン
Podman Engine ※Podman 利用時	バージョン 4.4
Docker Compose ※Podman 利用時	バージョン 2.20
Docker Engine ※Docker 利用時	バージョン 24

アプリケーション

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

警告

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

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

1.4. 事前準備¶

サービス公開用の URL を準備しておく必要があります。

表 1.10 例1) IPアドレスによるサービス公開¶
サービス	URL
Exastro サービス	http://172.16.0.1:30080
Exastro 管理用サービス	http://172.16.0.1:30081
GitLab サービス	http://172.16.0.1:40080

表 1.11 例2) ドメインによるサービス公開¶
サービス	URL
Exastro サービス	http://ita.example.com:30080
Exastro 管理用サービス	http://ita.example.com:30081
GitLab サービス	http://ita.example.com:40080

表 1.12 例3) LoadBalancer を経由したサービス公開¶
サービス	URL
Exastro サービス	https://ita.example.com
Exastro 管理用サービス	https://ita-mng.example.com
GitLab サービス	https://gitlab.example.com

Tip

HTTPSを利用する場合には、 LoadBalancer または、リバースプロキシを利用する必要があります。

LoadBalancer または、リバースプロキシを利用する場合は、別途準備をする必要があります。

1.5. インストール (自動)¶

最も簡単なインストール方法はインストールスクリプトを利用するインストールです。
1回のコマンド実行と対話型による設定が可能です。
以下、ユーザーはtest_user、ホームディレクトリは/home/test_userで実行した例です。

リスト 1.1 インストールコマンド¶

sh <(curl -sf https://ita.exastro.org/setup) install

上記のコマンドを実行すると、システムが要件を満たしていることを確認し、Exastro の起動に必要なコンテナ環境の構築を始めます。

必要なパッケージなどのインストールが完了すると下記のように対話形式で設定値を投入することが可能です。

リスト 1.2 パスワード自動生成の確認¶

# Exastro システムが利用する MariaDB のパスワードや、システム管理者のパスワード自動生成するか？
Generate all password and token automatically.? (y/n) [default: y]:

リスト 1.3 Exastro サービスのURL¶

Service URL? [default: http://127.0.0.1:30080]: http://ita.example.com:30080

リスト 1.4 Exastro 管理用サービスのURL¶

Management URL? [default: http://127.0.0.1:30081]: http://ita.example.com:30081

リスト 1.5 GitLab コンテナデプロイ要否の確認¶

Deploy GitLab container? (y/n) [default: n]:

リスト 1.6 設定ファイルの生成の確認¶

System parametes are bellow.

System administrator password:    ********
Database password:                ********
Service URL:                      http://ita.example.com:30080
Manegement URL:                   http://ita.example.com:30081
Docker GID:                       1000
Docker Socket path:               /run/user/1000/podman/podman.sock
GitLab deployment:                false

Generate .env file by above settings? (y/n) [default: n]: y

y もしくは yes と入力すると、GitHub から Exastro システムの起動に必要な、Docker Compose ファイルのダウンロードやファイアウォールの設定投入が開始されます。

リスト 1.7 Exastro コンテナデプロイ実施の確認¶

Deploy Exastro containers now? (y/n) [default: n]: y

詳細な設定を編集する場合は、 n もしくは no と入力し、以降の処理をスキップします。
そのまま Exastro システムのコンテナ群を起動する場合は、 y もしくは yes と入力します。
Exastro システムのデプロイには数分～数十分程度の時間が掛かります。(通信環境やサーバースペックによって状況は異なります。)

リスト 1.8 Exastro コンテナデプロイ実行中¶

Please wait for a little while. It will take 10 minutes or later..........

Exastro システムのデプロイが完了すると、サービス接続情報が出力されます。

リスト 1.9 サービス接続情報の出力¶

System manager page:
  URL:                http://ita.example.com:30081/
  Login user:         admin
  Initial password:   ******************

Organization page:
  URL:                http://ita.example.com:30080/{{ Organization ID }}/platform


GitLab service is has completely started!

Run creation organization command:
   bash /home/test_user/exastro-docker-compose/create-organization.sh


! ! ! ! ! ! ! ! ! ! ! ! ! ! !
! ! !   C A U T I O N   ! ! !
! ! ! ! ! ! ! ! ! ! ! ! ! ! !

Be sure to reboot the you host operating system to ensure proper system operation.

Reboot now? (y/n) [default: y]: y

必要に応じて出力された接続情報を保存し、y もしくは yes と入力し再起動を実施します。

注釈

生成された各種パラメータは、~/exastro-docker-compose/.env に保存されています。

1.6. オーガナイゼーションの作成¶

再起動後に再度ログインをしたら、オーガナイゼーションの作成を行います。

オーガナイゼーションの詳細については、 Organization (オーガナイゼーション) を参照してください。

リスト 1.10 Organization の作成¶

bash /home/test_user/exastro-docker-compose/create-organization.sh

対話型スクリプトが実行されるので、必要な情報を登録してください。

リスト 1.11 Organization の作成結果¶

{
  "data": null,
  "message": "SUCCESS",
  "result": "000-00000",
  "ts": "2023-09-07T14:37:17.832Z"
}

Organization page:
  URL:                http://ita.example.com:30080/your-org/platform/
  User:               admin
  Password:           *********

SUCCESS と表示されたら成功ですが、失敗した場合は --retry オプションを追加し、5分程度時間を空けてから再登録してください。

Tip

GitLab 連携時に、GitLab が完全に立ち上がっていない状態では、オーガナイゼーションの作成はできません。

リスト 1.12 Organization の再作成¶

bash /home/test_user/exastro-docker-compose/create-organization.sh --retry

1.7. ワークスペースの作成¶

作成したオーガナイゼーションにログインをしたら、ワークスペースを作成する必要があります。

ワークスペースの作成については、Workspace (ワークスペース) を参照してください。

1.8. Let's Try!!¶

Exastro IT Automation のトレーニングのために、クイックスタートを実施することを推奨します。

クイックスタートを実施することで、Exastro IT Automation の使い方や、パラメータシートの設計方針についての理解の手助けになるでしょう。

1.9. アップグレード¶

Exastro システムのアップグレード方法について紹介します。

1.9.1. アップグレードの準備¶

警告

アップグレード実施前に、バックアップを取得しておくことを推奨します。

バックアップ対象は ~/exastro-docker-compose/.volumes です。

リポジトリの更新¶

exastro-docker-composeリポジトリを更新します。

リスト 1.13 コマンド¶

# exastro-docker-composeリポジトリの確認
cd ~/exastro-docker-compose
git pull

デフォルト設定値の更新の確認¶

デフォルト値の更新を確認します。

インストール時に作成した設定ファイル ~/exastro-docker-compose/.env とアップグレード後の設定ファイルを比較します。

リスト 1.14 コマンド¶

cd ~/exastro-docker-compose

# OSがAlmaLinuxまたはUbuntuの場合
diff .env .env.docker.sample
# OSがRed Hat Enterprise Linuxの場合
diff .env .env.podman.sample

設定値の更新¶

デフォルト設定値の比較結果から、項目の追加などにより設定値の追加が必要な場合は更新をしてください。

設定値の更新が不要であればこの手順はスキップしてください。

1.9.2. アップグレード¶

アップグレード実施¶

アップグレードを実施します。

リスト 1.15 コマンド¶

sh <(curl -sf https://ita.exastro.org/setup) install

1.10. アンインストール¶

Exastro システムのアンインストール方法について紹介します。

1.10.1. アンインストールの準備¶

警告

アンインストール実施前に、バックアップを取得しておくことを推奨します。

バックアップ対象は ~/exastro-docker-compose/.volumes です。

1.10.2. アンインストール¶

アンインストール実施¶

アンインストールを実施します。

↑ Page Top