サーバソフトウェア運用者向けガイド
Personiumのサーバソフトウェアを使ってPersonium Unitを構築する方や、Personiumサーバプログラムをビルド・デプロイ・設定する方、 Personiumを使用したPDSサービス環境を提供・運用したい方向けのドキュメントです。
構築・設定済のPersonium Unitに対して、Cellの作成・払出しや、払出したCellの管理等を実施する方は、Unit管理者向けガイドをご覧ください。
システム構成とセットアップツール
PersoniumのUnitは評価、開発、確認、運用等々の様々な目的に応じてサーバ台数を増やしてシステムを構成することが可能です。また、構成に応じたVM作成やミドルウェア導入等を行うセットアップツールを一部提供しています。本ページで提供するシステム構成とセットアップツールの組み合わせは以下の表の通りとなります。
| サーバ | サーバ構築 | Personiumセットアップ | Personiumバージョン | |
|---|---|---|---|---|
| 小規模環境 | ユーザ側でLinuxサーバを準備 | Ansible | 任意 デフォルトは最新 | |
| Linuxサーバ1台 | Vagrant | Ansible | デフォルトは最新 | |
| 中規模環境 | Linuxサーバ3台 | HeatTemplate | Ansible | 任意 デフォルトは最新 |
| ユーザ側でLinuxサーバを準備 | Ansible | 任意 デフォルトは最新 |
※1 サンプルアプリをインストールしたい場合は、こちらの手順をご確認ください。
Personiumにおける各サーバーの役割
PersoniumのUnitは以下の役割を持ったサーバーから構成されます。これらの役割は相互に接続された単独または複数のサーバーに割り当てることが可能です。
| 役割 | 必須 | 詳細 |
|---|---|---|
| Web | 必須 | リバースプロキシーサーバー。インターネットからのアクセスが可能なグローバルなIPアドレスを保有する必要があります。 |
| AP | 必須 | Personiumが動作するアプリケーションサーバーです。 |
| ES | 必須 | ElasticSearchが動作するサーバーです。 |
| MQ | 必須 | ActiveMQが動作するサーバーです。 |
| NFS | 必須 | ネットワークファイルシステム(NFS)が動作するサーバーです。 |
| Bastion | オプション | 踏み台サーバ。各サーバへのsshでのアクセスを中継させるためにのサーバです。 |
以下の図はPersoniumセットアップツールのAnsibleで想定するWeb層-AP層-DB層3台の場合の構成図です。
Unit構築時の注意点
Personium Unitはhttps://alice.personium.exampleやhttps://bob.personium.exampleといったデータ主体によって異なるサブドメインでのHTTPSアクセスを行うことを前提にしているため、以下が基本必要となります。
- WebサーバにアクセスするIPアドレスに対しての
*.personium.exampleといったワイルドカードドメイン名でのDNSレコード設定 *.personium.exampleといったワイルドカードドメイン名に対応したSSL証明書の取得と設定
上記を簡単に行うために、ローカルネットワーク上で構築するよりもパブリックIaaSとDNSサービスを使って構築することを推奨します。
詳細な手順は後述のPersonium Ansible Playbook上の実行手順の中で記載しています。
Unitの構築
Unit構築にはVagrant、Ansibleを利用することができます。またOpen Stack ベースのクラウド環境に構築する場合は Heat Template を使えば、ほぼ自動でUnit構築が可能です。もちろん、これら自動構築ツールを使わないで任意のクラウドや物理/仮想マシンを使ってUnit構築を行うこともできます。しかし、本ドキュメントでは現状その構築手順を用意していないため、Open StackのHeatを使ったサーバインフラ構築手順やAnsibleを使ったUnit自動構築手順を参考に構築を行ってください。
小規模環境(サーバ1台で動作するPersonium環境)を構築する
もしもあなたが、Personiumにより一層興味を持ち、アプリケーションの開発やテストを実施してみたいと思ったならば、1台のサーバからUnitが構成される、本構成をお勧めします。
サーバ1台手動構築 + Ansible(1-Server)
Ansible(1-Server)を利用してLinuxサーバ1台構成のUnitを構築するためのガイドを公開しています。
Vagrant (+ Ansible)
Vagrantを利用してローカル環境のVM上にUnitを構築するためのガイドを公開しています。Vagrant実行時にVM作成とともにAnsibleが実行されます
中規模環境(サーバ3台で動作するPersonium環境)を構築する
もしもあなたがPersoniumプロジェクトにご参加いただき、アプリケーションをリリースしようとするならば、3層構成の3台サーバからUnitが構成される、本構成をお勧めします。
Open Stack Heat(サーバ3台構築) + Ansible(3-Server)
HeatTemplateを利用して、OpenStackでPersonium 3ServerUnit用のネットワークおよびサーバ構成を自動構築するためのガイドを公開してしています。
Ansible(3-Server)を利用してLinuxサーバ3台構成のUnitを構築するためのガイドを公開しています。
サーバ3台手動構築 + Ansible(3-Server)
Ansible(3-Server)を利用してLinuxサーバ3台構成のUnitを構築するためのガイドを公開しています。
構築したUnitの環境情報
構築したUnitの主要なミドルウェアの環境情報を確認します。
構築完了後、Unitの管理方法を確認したい場合はこちらをご覧ください。
Pluginの導入
Ansible(1-Server)、Ansible(3-Server)の手順を利用して環境を構築した場合はこちらも併せてご覧ください。
Unitの設定
Unitの構成ができたら、Unitを正しく設定する必要があります。 自動構築Unitには基本的な設定はひととおりされていますが、完全ではありません。以下を参照し適切な設定を行ってください。
Unitの起動・停止
設定が終わったらUnitの起動です。以下の順序で各サーバの起動を行ってください。
| 起動順序 | 起動方法 |
|---|---|
| 1 | Memcached, ElasticSearch, ActiveMQ |
| 2 | Tomcat |
| 3 | Nginx |
停止については上記の逆順で実施ください。
Unitの運用
サーバのセキュリティ対応について
多くの場合PersoniumのUnitには個人のプライバシーに関わる情報が入りますし、そもそもインターネット上にサーバを立てる上でセキュリティ対策は必須です。初期構築されたままでUnitを放置せず、適切にセキュリティパッチを適用してください。Unitのセキュリティ対応について
構築した環境は場合によってはセキュリティホールとなりえる情報が設定が含まれています。そのため、デフォルトから変更したほうが良い設定について説明します。