How to configure Pgpool-II to be used with Jira?

This document is about the advantages of the Pgpool-II proxy software and provides a guideline on how to set up Pgpool-II in Jira.

はじめる前に

Pgpool-II は、Postgres をベースにした高可用性 (HA) データベースソ リューションです。Pgpool-II のような高可用性データベースへの移行をお勧めする理由をご紹介します。

1. No single point of failure (SPoF). Pgpool-II addresses the challenges typical of PostgreSQL databases that expose a Single-Point-of-Failure resulting in business impact due to service downtimes.
2. 接続プーリング。Pgpool-II は接続プーリングを提供しているため、複数のクライアント アプリがデータベース接続プールを共有できます。これにより、クライアント リクエストごとに新しい接続を確立するオーバーヘッドが大幅に軽減され、結果的にパフォーマンスが向上し、リソース消費量を削減できます。
3. 負荷分散。Pgpool-II には、クライアント リクエストを複数の PostgreSQL サーバー全体に分散するロード バランサーが組み込まれています。これにより、ワークロードが均等に分散され、利用可能なデータベース サーバー全体で最適なリソース使用が保証されます。
4. 高可用性。Pgpool-II は、自動フェイルオーバーやオンライン復旧などの機能を実装することで、可用性の高い構成をサポートします。プライマリ PostgreSQL サーバーに障害が発生したことを検出し、スタンバイ サーバーを自動的にプライマリ サーバーに昇格させることができるため、ダウンタイムが最小限に抑えられ、データベースの可用性を確実に維持できます。

Pgpool-II の詳細については、公式ドキュメントをご覧ください。

Prerequisites

• ご利用の PostgreSQL のバージョンがサポート対象であることをご確認ください。詳細は「サポート対象プラットフォーム」をご参照ください。
• If you're migrating Jira to another server, export your data to create a backup. You'll be able to transfer the data from the old database to the new database. Learn more about migrating data between databases in Switching databases.
• セットアップ ウィザードを実行中の場合を除き、開始する前に Jira をシャットダウンします。

Pgpool-II 環境を実行/設定する

このドキュメントでは、VMware が提供する Bitnami の Docker イメージを使用して説明します。Pgpool の公式ドキュメントによると、この方法には いくつかのメリットがあります。

• Bitnami は上流のソースの変更を綿密に追跡し、当社の自動システムを使用してこのイメージの新バージョンを速やかに公開します。
• Bitnami イメージがあれば、最新のバグ修正と機能を早急に利用できます。

セットアップ

まず、Postgres ノードをセットアップする必要があります。これらのノードは相互にアクセスできる必要があります。同じプライベート サブネットの一部にすることも、インターネットに公開することもできます。ただし、インターネットへの公開はお勧めしません。

1. 別のマシンにプライマリ PostgreSQL ノードを作成します。

   docker run --detach --rm --name pg-0 \
     -p 5432:5432 \
     --network my-network \
     --env REPMGR_PARTNER_NODES={PG-0-IP},{PG-1-IP} \
     --env REPMGR_NODE_NAME=pg-0 \
     --env REPMGR_NODE_NETWORK_NAME={PG-0-IP} \
     --env REPMGR_PRIMARY_HOST={PG-0-IP} \
     --env REPMGR_PASSWORD=repmgrpass \
     --env POSTGRESQL_POSTGRES_PASSWORD=adminpassword \
     --env POSTGRESQL_USERNAME=customuser \
     --env POSTGRESQL_PASSWORD=custompassword \
     --env POSTGRESQL_DATABASE=customdatabase \
     --env BITNAMI_DEBUG=true \
     bitnami/postgresql-repmgr:latest

   
   The message [NOTICE] starting monitoring of node "pg-0" (ID: 1000) confirms the successful creation of the primary node.

2. 別のマシンにスタンバイ ノードを作成します。

   docker run --detach --rm --name pg-1 \
     -p 5432:5432 \
     --network my-network \
     --env REPMGR_PARTNER_NODES={PG-0-IP},{PG-1-IP} \
     --env REPMGR_NODE_NAME=pg-1 \
     --env REPMGR_NODE_NETWORK_NAME={PG-1-IP} \
     --env REPMGR_PRIMARY_HOST={PG-0-IP} \
     --env REPMGR_PASSWORD=repmgrpass \
     --env POSTGRESQL_POSTGRES_PASSWORD=adminpassword \
     --env POSTGRESQL_USERNAME=customuser \
     --env POSTGRESQL_PASSWORD=custompassword \
     --env POSTGRESQL_DATABASE=customdatabase \
     --env BITNAMI_DEBUG=true \
     bitnami/postgresql-repmgr:latest

   1. Replace {PG-0-IP},{PG-1-IP} in the code sample with comma-separated IP addresses that can be used to access pg-0 and pg-1 nodes. For example, 15.237.94.251,35.181.56.169.
   2. 相互接続を確立するために、スタンバイ ノードは起動後すぐにプライマリ ノードへのアクセスを試みます。

3. その他のノードを参照する Pgpool バランサー ミドルウェア ノードを作成します。

   docker run --detach --name pgpool --network my-network \
     -p 5432:5432 \
     --env PGPOOL_BACKEND_NODES=0:{PG-0-HOST},1:{PG-1-HOST} \
     --env PGPOOL_SR_CHECK_USER=postgres \
     --env PGPOOL_SR_CHECK_PASSWORD=adminpassword \
     --env PGPOOL_ENABLE_LDAP=no \
     --env PGPOOL_USERNAME=customuser \
     --env PGPOOL_PASSWORD=custompassword \
     --env PGPOOL_POSTGRES_USERNAME=postgres \
     --env PGPOOL_POSTGRES_PASSWORD=adminpassword \
     --env PGPOOL_ADMIN_USERNAME=admin \
     --env PGPOOL_ADMIN_PASSWORD=adminpassword \
     --env PGPOOL_AUTO_FAILBACK=yes \
     --env PGPOOL_BACKEND_APPLICATION_NAMES=pg-0,pg-1 \
     bitnami/pgpool:latest

   1. Replace {PG-0-HOST},{PG-1-HOST} in the code sample with the host addresses of the pg-0 and pg-1 nodes, including ports. For example, 15.237.94.251:5432. 
      
      
      Learn more about the configuration of the Bitnami containers
      

4. To confirm the successful deployment, access the table repmgr.nodes through the Pgpool access point by using the following SQL query:
   

   SELECT t.*
   FROM repmgr.nodes t

   出力には、各ノードの状態に関する情報がすべて表示されているはずです。
   
   

お使いのバージョンの PostgreSQL 用にデータベースやデータベースを作成する

お使いのバージョンの PostgreSQL のユーザーおよびデータベース作成に関する情報については、PostgreSQL の公式ドキュメントをご覧ください。

1. Jira が接続するためのデータベース ユーザー (ログイン ロール) を作成します (例: jiradbuser)。
   このデータベース ユーザー名は、後続の手順で Jira とデータベースの接続を設定するために使用されるため、覚えておく必要があります。

2. Create a database for Jira to store issues with Unicode collation (for example, jiradb).
   Remember this database name as it'll be used to configure Jira's connection to this database in the following steps.

   CREATE DATABASE jiradb WITH ENCODING 'UNICODE' LC_COLLATE 'C' LC_CTYPE 'C' TEMPLATE template0;

   または、コマンド ラインで次を実行します。

   $ createdb -E UNICODE -l C -T template0 jiradb

3. ユーザーがデータベースに接続し、データベース中でテーブルを作成、書き込みできる権限を持っていることを確認します。
   

   GRANT ALL PRIVILEGES ON DATABASE <Database Name> TO <Role Name>

4. 権限が正常に付与されたことを検証するには、データベースに接続して \z コマンドを実行します。

Learn more about how to connect Jira to Pgpool-II