mongodb のレプリカセットのデプロイ調査
4時前に寝て6時半に起きた。1時過ぎまで作業して、帰って少しゲームして、うまく眠れなくてだらだらしていた。
mongodb のレプリカセットの調査⌗
以前 mongodb でトランザクションを使うときにレプリカセットが必要 なことがわかった。他機能の開発途中だったので一旦後回しにしていたものを回収している。状況によってはメンバーに委譲してもよかったんだけど、私が遊撃で出張ってみることにした。実際に調べてみてコンテナの運用も考慮するとけっこう難しいことがわかってきた。
mongosh からは Replication Methods を使ってレプリカセットの操作ができる。これはユーティリティのようなもので mongodb としての低レベルのコマンド操作は Replication Commands になる。mongo-go-driver はレプリカセット向けのユーティリティを提供していないため、Replication Commands を RunCommand() の低レベル API を使って自分で実装しないといけない。
例えば、レプリカセットの初期化をするときは次のように replSetInitiate
というコマンドを適切なパラメーターで呼び出す。あまりドキュメントで丁寧に説明されていないので試行錯誤でエラーメッセージをみながら実装することになる。とくにはまるのが mongod のサーバーは --replSet myrs
のようにレプリカセットを指定して起動させるものの、初期化コマンドを実行するときはまだレプリカセットを設定していないため、レプリカセットを指定せず、且つ direct
パラメーターをセットしないと mongod サーバーに接続できない。この微妙な設定を把握するのにはまった。これが正しい手順かどうかもわからないが、ググったりしているとフォーラムでそういったコメントが散見されたりする。おそらく mongosh の Replication Methods を使うと、クライアントからサーバー接続は裏方でよしなにやってくれるのでそっちの方が簡単ではある。
func (r *ReplicaSet) Initiate(ctx context.Context, config bson.M) error {
client, err := r.connectDirect(ctx)
if err != nil {
return fmt.Errorf("failed to connect with direct: %w", err)
}
defer client.Disconnect(ctx)
var result bson.M
cmd := bson.D{{Key: "replSetInitiate", Value: config}}
if err := client.Database(r.db).RunCommand(ctx, cmd).Decode(&result); err != nil {
return fmt.Errorf("failed to run replSetInitiate(): %w", err)
}
log.PrettyPrint("completed to initiate", result)
return nil
}
func (r *ReplicaSet) connectDirect(ctx context.Context) (*mongo.Client, error) {
opts := options.Client().
SetAuth(options.Credential{
Username: r.config.User,
Password: r.config.Passwd.String(),
}).
SetHosts(r.config.Hosts).
SetDirect(true) // must be true
return mongo.Connect(ctx, opts)
}
func InitSingleReplicaSet(
ctx context.Context, cfg *config.MongoDB,
) error {
rs := NewReplicaSet(cfg)
initConfig := bson.M{
"_id": cfg.ReplicaSet,
"members": []bson.M{
{"_id": 0, "host": "localhost:27017"},
},
}
return rs.Initiate(ctx, initConfig)
}
さらに mongod サーバーを起動するときに --replSet
と --keyFile
(認証が必要な場合のみ?) という2つのパラメーターを指定する必要がある。--replSet
はレプリカセットの識別子を指定する。そして --keyFile
は共通鍵を指定する。この共通鍵を生成するには次のようにする。
$ openssl rand -base64 756 > my-mongo-keyfile
$ chown mongodb:mongodb my-mongo-keyfile
$ chmod 400 my-mongo-keyfile
普通のサーバーインスタンスならすぐできることだが、コンテナの運用において面倒なのが owner とパーミッションを設定しないといけないところ。mongo のコンテナは mongodb ユーザーで起動するため、root でマウントされたファイルシステムには書き込みできなかったりして keyFile の配置をどう扱えばよいのかが難しい。docker hub の mongo の issues でもどうやって設定したらいいの?って議論が発散している。mongo 本体が公式のスクリプトや仕組みを提供していれば済む話しだけど、どうもそうではないみたい。だから泥臭い方法で自分でなんとかしないといけないようにみえる。
- Creating a mongo image set with –replSet #246
- Cannot configure replica sets with entrypoint-initdb #339
dockertest でもレプリカセットの設定について次の issue として登録されている。mongo のコンテナを使ったテストの場合、dockertest のレイヤーが挟まるのでさらにわかりにくくなっている。テストを動かすためにどういった設定が必要かは把握できたのでなにかよい方法を考えてコントリビュートしたい。