Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions src/content/en/installation/backup-and-recovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This data is divided into three logical databases with the following roles.
* querypie
* Stores access control targets and policy information. This database is referred to as the QueryPie Meta DB. Most of the data required to operate ACP, including user accounts, target assets, secrets for accessing those systems, and access control policies, is stored in this database.
* querypie_snapshot
* Temporarily stores records generated when users run SQL queries on target systems or perform activities after accessing those systems. The records remain while the connection session is active and are transferred to querypie_log when the session ends.
* Temporarily stores records generated when users run SQL queries on target systems or perform activities after accessing those systems. The records remain while the connection session is active and are transferred to querypie_log when the session ends. The DDL for this database must be restored, but the data itself does not need to be restored, and any data restored from a backup is ignored.
* querypie_log
* Stores audit records, including records of users accessing assets such as databases and servers and records of user activities.

Expand All @@ -45,21 +45,21 @@ For details about the environment variables, see [Container Environment Variable

Retain the complete container configuration for the production environment, including the following information.

* Database and Redis connection information
* KEY_ENCRYPTION_KEY
* Container environment variables - Database and Redis connection information
* Container environment variables - `KEY_ENCRYPTION_KEY`
* TLS certificates and private keys
* External system connection information
* Certificates and configuration files mounted in the containers
* QueryPie container image version
* QueryPie container image version and the image itself

In particular, retain the exact value of `KEY_ENCRYPTION_KEY` used at the time of backup.
If this value is lost or restored with a different value, secrets encrypted in the database, such as connection passwords and SSH keys, cannot be used.

Because environment variables and certificates may contain passwords and private keys, store them in an encrypted repository and restrict access to them.

You can change AGENT_SECRET and REDIS_PASSWORD during the recovery process.
Among the container environment variables, you can change `AGENT_SECRET` and `REDIS_PASSWORD` during the recovery process.

If you use files such as a custom JDBC driver, TLS certificates, or DAC_SKIP_SQL_COMMAND_RULE_FILE (`skip_command_config.json`), back up and restore them as well.
If you use files such as a custom JDBC driver, TLS certificates, or `DAC_SKIP_SQL_COMMAND_RULE_FILE` (`skip_command_config.json`), back up and restore them as well.

#### Information Stored in the Secret Store

Expand Down Expand Up @@ -121,6 +121,7 @@ mysqldump \
--password \
--single-transaction \
--hex-blob \
--routines \
--databases querypie querypie_snapshot querypie_log \
> "querypie-backup-$(date +%Y%m%d-%H%M%S).sql"
```
Expand All @@ -131,6 +132,10 @@ Do not enter the password directly on the command line because it may be exposed
The `--single-transaction` option creates a consistent point-in-time backup of tables that support transactions.
We recommend avoiding schema changes while the backup is running.

The `--routines` option includes stored procedures used by some earlier QueryPie versions in the backup.
QueryPie does not create MySQL Events in its default configuration, so do not use `--events`.
Add `--events` only if your organization has created separate Events.

The backup account must have the permissions required to read the three databases and dump their schemas.
Check the command's exit status and the size of the generated file, and treat the SQL file as sensitive because it contains secrets and audit logs.

Expand Down
17 changes: 11 additions & 6 deletions src/content/ja/installation/backup-and-recovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ QueryPie ACP は、ユーザーアカウント、アクセス対象の Database
* querypie
* アクセス制御の対象とポリシー情報を保存します。このデータベースは QueryPie Meta DB と呼ばれます。ユーザーアカウント、アクセス対象の資産、対象システムへのアクセスに必要な秘密情報、アクセス制御ポリシーなど、ACP の運用に必要なデータの大部分がこのデータベースに保存されます。
* querypie_snapshot
* ユーザーが対象システムに接続して SQL Query を実行した記録や、システムにアクセスして行った操作の記録を一時的に保存します。接続セッションが有効な間に使用され、セッションが終了すると querypie_log に移行されます。
* ユーザーが対象システムに接続して SQL Query を実行した記録や、システムにアクセスして行った操作の記録を一時的に保存します。接続セッションが有効な間に使用され、セッションが終了すると querypie_log に移行されます。このデータベースは DDL を復元する必要がありますが、データ自体を復元する必要はなく、バックアップから復元されたデータは無視されます。
* querypie_log
* 監査記録を保存します。ユーザーが Database や Server などの資産にアクセスした記録と、ユーザーの操作履歴が記録されます。

Expand All @@ -45,21 +45,21 @@ QueryPie ACP コンテナを正常にリカバリするには、コンテナの

次の情報を含む、実際の運用環境のコンテナ設定全体を保管します。

* データベースと Redis の接続情報
* KEY_ENCRYPTION_KEY
* コンテナ環境変数 - データベースと Redis の接続情報
* コンテナ環境変数 - `KEY_ENCRYPTION_KEY`
* TLS 証明書と Private Key
* 外部システムの接続情報
* コンテナにマウントした証明書と設定ファイル
* QueryPie コンテナイメージのバージョン
* QueryPie コンテナイメージのバージョンとイメージ本体

特に、`KEY_ENCRYPTION_KEY` はバックアップ時の値をそのまま保管する必要があります。
この値が失われたり、異なる値でリカバリされたりすると、データベースに暗号化して保存された Connection パスワードや SSH Key などの秘密情報を使用できません。

環境変数と証明書にはパスワードや Private Key が含まれる場合があるため、暗号化された保存先に保管し、アクセス権限を制限してください。

AGENT_SECRET と REDIS_PASSWORD は、リカバリ中に変更できます。
コンテナ環境変数のうち、`AGENT_SECRET` と `REDIS_PASSWORD` はリカバリ中に変更できます。

Custom JDBC Driver、TLS 証明書、DAC_SKIP_SQL_COMMAND_RULE_FILE(`skip_command_config.json`)などのファイルを使用している場合は、これらもバックアップしてリカバリする必要があります。
Custom JDBC Driver、TLS 証明書、`DAC_SKIP_SQL_COMMAND_RULE_FILE`(`skip_command_config.json`)などのファイルを使用している場合は、これらもバックアップしてリカバリする必要があります。

#### Secret Store に保存される情報

Expand Down Expand Up @@ -121,6 +121,7 @@ mysqldump \
--password \
--single-transaction \
--hex-blob \
--routines \
--databases querypie querypie_snapshot querypie_log \
> "querypie-backup-$(date +%Y%m%d-%H%M%S).sql"
```
Expand All @@ -131,6 +132,10 @@ mysqldump \
`--single-transaction` は、トランザクションをサポートするテーブルを一貫した時点でバックアップするために使用します。
バックアップ中はスキーマ変更を実行しないことを推奨します。

`--routines` は、一部の旧バージョンの QueryPie で使用する stored procedure をバックアップに含めるために指定します。
QueryPie のデフォルト構成では MySQL Event を作成しないため、`--events` は使用しません。
お客様が別途 Event を作成している場合にのみ、`--events` を追加してください。

バックアップアカウントには、3 つのデータベースを参照し、スキーマをダンプするために必要な権限が必要です。
コマンドの終了ステータスと生成されたファイルのサイズを確認し、秘密情報と監査ログを含む SQL ファイルは機密情報として安全に保管してください。

Expand Down
17 changes: 11 additions & 6 deletions src/content/ko/installation/backup-and-recovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ QueryPie ACP 는 MySQL Database 에 이용자 계정, 접근 대상 Database 나
* querypie
* 접근제어 대상과 정책 정보를 저장합니다. QueryPie Meta DB 라고 지칭합니다. 이용자 계정, 접근 대상이 되는 자산, 해당 시스템에 접근하기 위한 비밀정보, 접근제어 정책 등 ACP 를 운영하는데 필요한 대부분의 데이터는 이 데이터베이스에 저장됩니다.
* querypie_snapshot
* 이용자가 대상 시스템에 접속하여 SQL Query 를 실행하거나 시스템에 접근하여 활동하는 기록을 일시적으로 보관합니다. 접속 세션이 살아있는 동안 사용되며, 접속 세션이 종료되면 querypie_log 로 이관됩니다.
* 이용자가 대상 시스템에 접속하여 SQL Query 를 실행하거나 시스템에 접근하여 활동하는 기록을 일시적으로 보관합니다. 접속 세션이 살아있는 동안 사용되며, 접속 세션이 종료되면 querypie_log 로 이관됩니다. 이 데이터베이스는 DDL 은 복원되어야 하지만, 데이터 자체는 복원하지 않아도 무방하며, 백업 후 복구된 데이터는 무시됩니다.
* querypie_log
* 감사기록을 저장합니다. 이용자가 Database, Server 등 자산에 접속한 기록, 이용자의 활동 내역이 기록됩니다.

Expand All @@ -45,21 +45,21 @@ QueryPie ACP 컨테이너를 정상적으로 복구하려면 컨테이너 실행

다음 정보를 포함하여 실제 운영 환경의 컨테이너 설정 전체를 보관합니다.

* 데이터베이스와 Redis 연결 정보
* KEY_ENCRYPTION_KEY
* 컨테이너 환경변수 - 데이터베이스와 Redis 연결 정보
* 컨테이너 환경변수 - `KEY_ENCRYPTION_KEY`
* TLS 인증서와 Private Key
* 외부 시스템 연결 정보
* 컨테이너에 마운트한 인증서와 설정 파일
* QueryPie 컨테이너 이미지 버전
* QueryPie 컨테이너 이미지 버전과 이미지 자체

특히 `KEY_ENCRYPTION_KEY`는 백업 당시의 값을 그대로 보관해야 합니다.
이 값이 유실되거나 다른 값으로 복원되면 데이터베이스에 암호화되어 저장된 Connection 비밀번호, SSH Key 등의 비밀 정보를 사용할 수 없습니다.

환경 변수와 인증서에는 비밀번호와 Private Key가 포함될 수 있으므로 암호화된 저장소에 보관하고 접근 권한을 제한해야 합니다.

AGENT_SECRET, REDIS_PASSWORD 는 복구 과정에서 변경할 수 있는 값입니다.
컨테이너 환경변수 가운데, `AGENT_SECRET`, `REDIS_PASSWORD` 는 복구 과정에서 변경할 수 있는 값입니다.

Custom JDBC Driver, TLS 인증서, DAC_SKIP_SQL_COMMAND_RULE_FILE (`skip_command_config.json`) 등 파일을 사용하는 경우, 이를 백업하고 복구하여야 합니다.
Custom JDBC Driver, TLS 인증서, `DAC_SKIP_SQL_COMMAND_RULE_FILE` (`skip_command_config.json`) 등 파일을 사용하는 경우, 이를 백업하고 복구하여야 합니다.

#### Secret Store 에 보관되는 정보

Expand Down Expand Up @@ -121,6 +121,7 @@ mysqldump \
--password \
--single-transaction \
--hex-blob \
--routines \
--databases querypie querypie_snapshot querypie_log \
> "querypie-backup-$(date +%Y%m%d-%H%M%S).sql"
```
Expand All @@ -131,6 +132,10 @@ mysqldump \
`--single-transaction`은 트랜잭션을 지원하는 테이블을 일관된 시점으로 백업하는 데 사용합니다.
백업 중에는 스키마 변경 작업을 수행하지 않는 것을 권장합니다.

`--routines`는 일부 이전 QueryPie 버전에서 사용하는 stored procedure를 포함하여 백업하기 위해 지정합니다.
QueryPie 기본 구성에서는 MySQL Event를 생성하지 않으므로 `--events`는 사용하지 않습니다.
고객이 별도의 Event를 생성한 경우에만 `--events`를 추가하십시오.

백업 계정에는 세 데이터베이스를 조회하고 스키마를 덤프하는 데 필요한 권한이 있어야 합니다.
명령의 종료 상태와 생성된 파일의 크기를 확인하고, 생성된 SQL 파일은 비밀 정보와 감사 로그가 포함된 중요 자료로 취급하여 안전하게 보관하십시오.

Expand Down
Loading