harumaki.net

インフラ屋の覚書や、ラーメン食べある記とか。

backup DB infra MySQL 運用

[MySQL] ZRM(Zmanda Recovery Manager) Mysql-zrm.conf パラメータ一覧をまとめてみた

投稿日:2013年9月30日

ZRMを試すにあたって指定するmysql-zrm.confのパラメータを調べてみたので、そのまとめを。
オプションの一覧と説明の元ソースは、コマンド”mysql-zrm-backup”のマニュアル。

▼参考:お世話になっております!

https://wiki.zmanda.com/index.php/Configuration_Files
https://wiki.zmanda.com/index.php/Mysql-zrm.conf
https://wiki.zmanda.com/index.php/Sample_mysql-zrm.conf

▼設定に関する覚書

https://wiki.zmanda.com/index.php/Configuration_Files より。

  • ZRM for MySQL configuration files are located under /etc/mysql-zrm directory.
  • All backup parameters applicable for all backup sets are specified in a global configuration file – /etc/mysql-zrm/mysql-zrm.conf.
  • Parameters that are specific to a backup set are specified in /etc/mysql-zrm//mysql-zrm.conf.
  • All parameters in the ZRM for MySQL configuration file are optional and ZRM for MySQL will use the MySQL client file (my.cnf) parameters if needed.
  • Backup set specific parameters will override the parameters specified in the global configuration file.
  • In addition, parameters can be specified on the command line and these will override that given in the configuration files.
  • All lines starting with # are treated as comments.
  • Since the MySQL user and password in plain-text has to be provided in the configuration files, care should be taken to protect the configuration file from unauthorized access.

ざっと訳してみたところでは:

  • ZRM for MySQL のコンフィグは/etc/mysql-zrm ディレクトリ以下に配置しましょう。
  • すべてのバックアップに関する”グローバルコンフィグ”は/etc/mysql-zrm/mysql-zrm.conf に記載してください。
  • バックアップは”バックアップセット”という単位として、個別に/etc/mysql-zrm//mysql-zrm.confを作成して実行することができます。
  • ZRM for MySQLの設定はオプションであり、my.cnfに記述可能です。
  • バックアップセットの設定は、グローバルセットの設定値を上書きします。
  • コマンドラインにて指定した設定値は設定ファイルを上書きします。
  • “#”で始まる行はコメントとして扱われます。
  • MySQLのユーザーとパスワードはプレーンテキスト(平文)でコンフィグに記述する必要があり、それゆえ、設定ファイルの保護に注意しましょう。

意訳としてはこんな感じになるかな?

▼パラメータごとの指定値

こちらはhttps://wiki.zmanda.com/index.php/Mysql-zrm.confおよびhttps://wiki.zmanda.com/index.php/Mysql-zrm-backupからの意訳を。

[マニュアル]
Backup parameters – comment, backup-level, backup-mode,
lvm-snapshot, destination, retention-policy, replication, com-
press, compress-plugin, encrypt, encrypt-plugin, decrypt-optionDatabase parameters – all-databases, databases, tables, databaseMySQL server parameters – user, password, host, port, socket,
ssl-options, mysql-binpath, mysql-binlogpath, tmpdirZRM parameters – verbose, mailto, html-report-directory,
html-reports, webserver-url, rss-header-locationZRM plugin parameters – copy-plugin, pre-backup-plugin,
pre-backup-plugin-options, post-backup-plugin, post-backup-plu-
gin-options, pre-scheduler-plugin, passfile, ssh-user,
remote-mysql-binpath, socket-remote-port

1)Backup parameters

バックアップの動作に関する設定値。

comment コメント
backup-level バックアップレベル、フルバックアップか差分バックアップかの指定
0でフルバックアップ、1で差分バックアップ。
backup-mode バックアップモードの指定、論理バックアップか物理バックアップの指定。
デフォルトは”raw(物理バックアップ)”
lvm-snapshot LVMによるスナップショット作成時のサイズ指定。
backup-mode=rawの場合のみ有効。
デフォルトの指定サイズは10M。
サイズの指定はK(キロバイト)、M(メガバイト)、G(ギガバイト)、T(テラバイト)まで指定可能。
destination バックアップ完了時の出力先ディレクトリの指定。
デフォルトは”/var/lib/mysql-zrm”。
retention-policy バックアップ保持期間の指定。デフォルトは無期限に設定されている。
設定値はD(day)、W(Week)、M(month)、Y(year)で期間を指定可能。
replication レプリケーション環境において、スレーブDBからバックアップを実行する場合は”1″を指定する。
デフォルトではコメントアウト。
compress 作成されたバックアップファイルの圧縮の指定。圧縮する場合は”1″を指定する。
デフォルトでは圧縮無し。
実行時の圧縮にはデフォルトでgzipを使用するが、後述の”compress-plugin”にて
gzip以外のコマンド、圧縮方式を指定可能。
compress-plugin compress有効時に、gzip以外の圧縮方式を指定する場合に、他の圧縮コマンドをフルパスで指定する。
“/usr/bin/gzip”、”/usr/local/bin/7z”など。
encrypt バックアップ実行時に暗号化の有無。有効にする場合はコメントアウトと同時に”1″を指定する。
後述の”encrypt-plugin”、”decrypt-option”も同時に指定すること。
encrypt-plugin encryptオプション有効時に使用するプラグインの指定。”encrypt=1″の場合は必ず有効にする。
デフォルトでは”/usr/share/mysql-zrm/plugins/encrypt.pl”が指定されている。
decrypt-option encryptオプション実行時の複合化オプション。
デフォルトの設定値は”-d”。

[追加]version 3.0にて追加されていたパラメータ

backup-type バックアップ実行時の高速実行オプション。
“regular”または”quick”の指定が可能。

2)Database parameters

バックアップの対象とするデータベーススキーマ、テーブルの指定
バックアップセットとして編集するとよい。

all-databases すべてのデータベースを指定。”all-databases=1″で全データベースを対象とする。
databases バックアップ対象のデータベーススキーマを指定。
あいだに半角スペースを入れて複数指定が可能。
例:”databases=schema1 schema2 schema3″
ただし上述の”all-databases”にて1がセットされている場合は無視される。
tables バックアップ対象のテーブルの指定。
こちらも”databases”と同様、あいだに半角スペースを入れて複数指定が可能。
指定がない場合は”databases”にて指定したスキーマの全テーブルが対象となる。
同時に、テーブルを指定する際、対象スキーマを下記の”database”にて指定する。
database “tables”と対応するデータベーススキーマの指定。
使用例:
tables=tableA tableB tableC
database=”schemaZ
→データベーススキーマ”schemaZ”のうち、テーブル”tableA”、”tableB”、”tableC”を
バックアップ対象とする。

3)MySQL server parameters

おもにバックアップ対象のMySQLデータベースに関する設定。
対象のMySQLサーバが決まっているなら、グローバルコンフィグとして設定し
サーバが複数あるならバックアップセットとして編集するとよい。

user バックアップ実行時に使用するmysqlユーザー
password バックアップ実行時に使用するmysqlユーザーのパスワード
host バックアップ対象ホスト
port バックアップ対象サーバのmysql TCPポートの指定
socket バックアップ対象サーバのmysql ソケットの指定
ssl-options バックアップ対象サーバへのmysql SSL接続オプション
mysql-binpath バックアップ対象サーバのmysql バイナリログの指定。オプション。
mysql-binlogpath バックアップ対象サーバのmysql バイナリログの指定。オプション。
tmpdir

[追加]version 3.0にて追加されていたパラメータ

routines mysqldumpにおいて”–routines”オプションを追加することと同義。
設定値”1″にて有効化される。
single-transaction mysqldumpにおいて”–single-transaction”の無効化と同義。
設定値”0″にて無効化される。
default-character-set mysql、mysqldumpにて指定されたcharsetとは別にdefault-character-setを指定可能。オプション。

4)ZRM parameters

ZRMのジョブに関する設定値。
ここもグローバルオプションとして統一しておくと良さそう。

verbose ZRMのログを詳細モードで出力する。
設定値は0(通常モード)、または1(詳細モード)。
mailto ZRMコマンド実行時のメール送信先
html-reports htmlで出力するレポートの種類を指定。
html-report-directory ZRMのhtmlレポート出力先の指定。
webserver-url htmlレポート出力先をURLで指定。
下記の”rss-header-location”オプションと連動するので、同時に設定すること。
rss-header-location RSSヘッダーファイルの場所を指定する。
このオプションを使用する場合は、”webserver-url”を設定すること。
指定したディレクトリ以下に”RSS.header”ファイルが出力される。

[追加]version 3.0にて追加されていたパラメータ

mail-policy メール通知ポリシー、通知する内容をレベルによって指定。
“always(すべて送信)”, “never” or “only-on-error”の3パターンから指定する。

5)ZRM plugin parameters

ZRMで用意されている、さまざまなプラグインに関する設定値。
原則として、バックアップセット毎に指定する設定が多い様子。

copy-plugin リモートのMySQLデータベースサーバーへアクセスする際に使用するプラグイン。
デフォルトではソケットを利用したcopy-pluginスクリプト、
ssh接続を用いたcopy-pluginスクリプトの2種類が用意されている様子。
バックアップセットのコンフィグでのみ指定可能
(グローバルコンフィグでは指定不可)。
デフォルトでは下記のソケットでのコピー実行用:socket-copy.pl
ssh接続でのコピー実行用 :ssh-copy.pl
上記のほか、windows用のコピープラグイン”windows-copy.pl”もある様子。
pre-backup-plugin バックアップ実行前にバックアップセット毎に呼び出すプラグインを指定。
pre-backup-plugin-options 上記の”pre-backup-plugin”で指定したプラグインを実行する際に指定するオプション、引数。
したがってこのパラメータは”pre-backup-plugin”とセットで有効にする。
post-backup-plugin こちらはバックアップ実行後にバックアップセット毎に呼び出すプラグインを指定。
post-backup-plugin-options 上記の”post-backup-plugin”で指定したプラグインを実行する際に指定するオプション、引数。
したがってこのパラメータは”post-backup-plugin”とセットで有効にする。
pre-scheduler-plugin バックアップ実行に際して条件、スケジュールをプラグインに設定して読み込む。
こちらもバックアップセットに指定する。
passfile “Backup Palameters”において”encrypt=1″で有効にした際に
パスフレーズ記載ファイルを用意して引数に指定する。
ssh-user sshを用いたプラグインを使用する際の接続ユーザーを指定。
パスワードの指定は無いので公開鍵認証での使用が
前提になると思われる。
remote-mysql-binpath copy-pluginでのリモートアクセス時に指定する、
リモートホスト(バックアップ対象)のmysqlのコマンドへのパスを指定する。
ex: remote-mysql-binpath=”/usr/bin”
socket-remote-port socket-copy.pl実行時に使用する、リモートホストのポート番号の指定。

[追加]version 3.0にて追加されていたパラメータ

windows-backup-port Windows環境において、Windowsリモートホストへアクセスする際のポート指定。バックアップ用。
“copy-plugin”パラメータにおいて、プラグインwindows-copy.plを使用した際に
セットで設定する。
windows-restore-port  Windows環境において、Windowsリモートホストへアクセスする際のポート指定。こちらはリストア用。
“copy-plugin”パラメータにおいて、プラグインwindows-copy.plを使用した際にセットで設定する。

-backup, DB, infra, MySQL, 運用
-,

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA


関連記事

no image

haproxyを試す 3.SSLリバースプロキシを設定してみる

HAProxyにてSSLリバースプロキシを設定してみるテスト。 設定環境はAWS EC2にてRightImageのCentOS6を使用しました。 HTTP/80については設定済みとなっている前提でメモ …

no image

VPNサーバ構築検証(PPTP)

会社のWindowsVPNが不調になったので、原因を調べつつLinuxでの構築を試してみる。 サーバーはRedHat Enterprise 4系。 構築要件 † WindowsPCからの …

no image

クラスタリング/heartbeat

クラスタリング/heartbeat 参考サイト 構成ファイルとバージョン 作業ログ 1)ダウンロードとインストール libnet heartbeat heartbeat-ldirectord 2)構成 …

no image

VMware Management Interface インストール

▼VMware Management Interface インストール 2006/09/20 VMware server console のほか、ブラウザからステータス情報の表示や 設定、ゲスト の起 …

no image

[パッケージ管理]porgのインストール

テスト環境にpacoを入れておこうと、久々に本家サイトへアクセスしたら "This project is no longer active."とのこと。あらら・・・ つづけて、&q …