Skip to content

Commit b006464

Browse files
committed
Update DBLab version references from 4.0.1 to 4.0.3
Update all documentation files to reference the latest DBLab version 4.0.3 instead of the outdated 4.0.1. This includes: - Docker image tags - GitLab config example links - CLI version exports
1 parent f794d2c commit b006464

12 files changed

Lines changed: 31 additions & 31 deletions

docs/dblab-howtos/administration/ci-observer-postgres-log-masking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ keywords:
1414
## Configure masking for PostgreSQL log
1515
When Database Lab's CI Observer is used for automated testing of database migrations, it stores PostgreSQL log in DBLab Platform's centralized storage. You can optionally configure masking rules for sensitive data in the PostgreSQL log. Such rules will be continuously applied before sending any PostgreSQL log entries to the Platform's storage.
1616

17-
You can define masking rules in the form of regular expressions. To do it, open the DBLab Engine configuration file (usually, `~/.dblab/engine/configs/server.yml`; see config file examples [here](https://gitlab.com/postgres-ai/database-lab/-/tree/v4.0.1/engine/configs)) and define subsection `replacementRules` in the section `replacementRules`. A basic example:
17+
You can define masking rules in the form of regular expressions. To do it, open the DBLab Engine configuration file (usually, `~/.dblab/engine/configs/server.yml`; see config file examples [here](https://gitlab.com/postgres-ai/database-lab/-/tree/v4.0.3/engine/configs)) and define subsection `replacementRules` in the section `replacementRules`. A basic example:
1818
```yaml
1919
observer:
2020
replacementRules:

docs/dblab-howtos/administration/data/custom.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To set up it you need to use following jobs:
1616
- [physicalSnapshot](/docs/reference-guides/database-lab-engine-configuration-reference#job-physicalsnapshot)
1717

1818
### Options
19-
Copy the example configuration file [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`. For demo purposes we've used `pg_basebackup` tool, but you can use any tool suitable for the task. Check and update the following options:
19+
Copy the example configuration file [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`. For demo purposes we've used `pg_basebackup` tool, but you can use any tool suitable for the task. Check and update the following options:
2020
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
2121
- Set connection options in `physicalRestore:options:envs`, based on your tool
2222
- Set PostgreSQL commands in `physicalRestore:options:customTool`:
@@ -43,7 +43,7 @@ sudo docker run \
4343
--env DOCKER_API_VERSION=1.39 \
4444
--detach \
4545
--restart on-failure \
46-
postgresai/dblab-server:4.0.1
46+
postgresai/dblab-server:4.0.3
4747
```
4848

4949
:::info

docs/dblab-howtos/administration/data/dump.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In order to set up DBLab Engine to automatically get the data from database usin
1515
- [logicalSnapshot](/docs/reference-guides/database-lab-engine-configuration-reference#job-logicalsnapshot)
1616

1717
### Options
18-
Copy the contents of configuration example [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.logical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
18+
Copy the contents of configuration example [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.logical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
1919
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
2020
- Set connection options in `retrieval:spec:logicalDump:options:source:connection`:
2121
- `dbname`: database name to connect to
@@ -44,7 +44,7 @@ sudo docker run \
4444
--env DOCKER_API_VERSION=1.39 \
4545
--detach \
4646
--restart on-failure \
47-
postgresai/dblab-server:4.0.1
47+
postgresai/dblab-server:4.0.3
4848
```
4949

5050
You can use PGPASSWORD env to set the password.

docs/dblab-howtos/administration/data/pg_basebackup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In order to set up DBLab Engine to automatically get the data from database usin
1414
- [physicalSnapshot](/docs/reference-guides/database-lab-engine-configuration-reference#job-physicalsnapshot)
1515

1616
### Options
17-
Copy the contents of configuration example [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
17+
Copy the contents of configuration example [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
1818
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
1919
- Set connection options in `physicalRestore:options:envs`:
2020
- `PGUSER`: database user name
@@ -44,7 +44,7 @@ sudo docker run \
4444
--env DOCKER_API_VERSION=1.39 \
4545
--detach \
4646
--restart on-failure \
47-
postgresai/dblab-server:4.0.1
47+
postgresai/dblab-server:4.0.3
4848
```
4949

5050
:::info

docs/dblab-howtos/administration/data/pgbackrest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In order to configure DLE to automatically restore the database using the [pgBac
1616
- [physicalSnapshot](/docs/reference-guides/database-lab-engine-configuration-reference#job-physicalsnapshot)
1717

1818
### Options
19-
Copy the example configuration file [`config.example.physical_pgbackrest.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.physical_pgbackrest.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
19+
Copy the example configuration file [`config.example.physical_pgbackrest.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.physical_pgbackrest.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
2020
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
2121
- Set repository options in `physicalRestore:options:envs`:
2222
- pgBackRest allows using environment variables instead of command-line options (see [pgBackRest docs](https://pgbackrest.org/command.html#introduction)):
@@ -70,7 +70,7 @@ sudo docker run \
7070
--env DOCKER_API_VERSION=1.39 \
7171
--detach \
7272
--restart on-failure \
73-
postgresai/dblab-server:4.0.1
73+
postgresai/dblab-server:4.0.3
7474
```
7575

7676
:::info

docs/dblab-howtos/administration/data/rds.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ If you want to use **IAM database authentication**, read how to enable it [here]
2525
You need to know the **master password**. If you lost the password it can be reset. Read how to reset it [here](https://aws.amazon.com/premiumsupport/knowledge-center/reset-master-user-password-rds/).
2626
:::
2727

28-
Copy the contents of configuration example [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.logical_generic.yml) from the DBLab Engine repository to `~/.dblab/engine/configs/server.yml` and update the following options:
28+
Copy the contents of configuration example [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.logical_generic.yml) from the DBLab Engine repository to `~/.dblab/engine/configs/server.yml` and update the following options:
2929
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
3030
- Set connection options in `retrieval:spec:logicalDump:options:source:connection`:
3131
- `dbname`: database name to connect to
@@ -54,7 +54,7 @@ sudo docker run \
5454
--env DOCKER_API_VERSION=1.39 \
5555
--detach \
5656
--restart on-failure \
57-
postgresai/dblab-server:4.0.1
57+
postgresai/dblab-server:4.0.3
5858
```
5959

6060
:::info
@@ -80,7 +80,7 @@ Alternatively, you can add `AmazonRDSFullAccess`, `IAMFullAccess` policies to an
8080
:::
8181

8282
### Set up and run DBLab Engine
83-
Copy the contents of configuration example [`config.example.logical_rds_iam.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.logical_rds_iam.yml) from the DBLab Engine repository to `~/.dblab/engine/configs/server.yml` and update the following options:
83+
Copy the contents of configuration example [`config.example.logical_rds_iam.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.logical_rds_iam.yml) from the DBLab Engine repository to `~/.dblab/engine/configs/server.yml` and update the following options:
8484
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
8585
- Set connection options `retrieval:spec:logicalDump:options:source:connection`:
8686
- `dbname`: database name to connect to
@@ -120,7 +120,7 @@ sudo docker run \
120120
--env DOCKER_API_VERSION=1.39 \
121121
--detach \
122122
--restart on-failure \
123-
postgresai/dblab-server:4.0.1
123+
postgresai/dblab-server:4.0.3
124124
```
125125

126126
:::info

docs/dblab-howtos/administration/data/rsync.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In order to set up DBLab Engine to automatically get the data from database usin
1414
- [physicalSnapshot](/docs/reference-guides/database-lab-engine-configuration-reference#job-physicalsnapshot)
1515

1616
### Options
17-
Copy the example configuration file [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
17+
Copy the example configuration file [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml` and update the following options:
1818
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
1919
- Set connection options in `physicalRestore:options:envs`:
2020
- `PGUSER`: database user name
@@ -54,7 +54,7 @@ sudo docker run \
5454
--env DOCKER_API_VERSION=1.39 \
5555
--detach \
5656
--restart on-failure \
57-
postgresai/dblab-server:4.0.1
57+
postgresai/dblab-server:4.0.3
5858
```
5959

6060
:::info

docs/dblab-howtos/administration/data/wal-g.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In order to set up DBLab Engine to automatically get the data from database usin
1414
- [physicalSnapshot](/docs/reference-guides/database-lab-engine-configuration-reference#job-physicalsnapshot)
1515

1616
### Options
17-
Copy the example configuration file [`config.example.physical_walg.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.physical_walg.yml) from the DBLab Engine repository to `~/.dblab/engine/configs/server.yml` and update the following options:
17+
Copy the example configuration file [`config.example.physical_walg.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.physical_walg.yml) from the DBLab Engine repository to `~/.dblab/engine/configs/server.yml` and update the following options:
1818
- Set secure `server:verificationToken`, it will be used to authorize API requests to the Engine
1919
- Set connection options in `physicalRestore:options:envs`:
2020
- Use WAL-G environment variables to configure the job, see the [WAL-G configuration reference](https://github.com/wal-g/wal-g#configuration)
@@ -50,7 +50,7 @@ sudo docker run \
5050
--env DOCKER_API_VERSION=1.39 \
5151
--detach \
5252
--restart on-failure \
53-
postgresai/dblab-server:4.0.1
53+
postgresai/dblab-server:4.0.3
5454
```
5555

5656
:::info

docs/dblab-howtos/administration/engine-manage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All YAML features can be used, including anchors and aliases, to help you conven
1616

1717
For instance, you can define a binding with `&` and then refer to it using an alias denoted by `*`.
1818

19-
See config examples [here](https://gitlab.com/postgres-ai/database-lab/-/tree/v4.0.1/engine/configs)
19+
See config examples [here](https://gitlab.com/postgres-ai/database-lab/-/tree/v4.0.3/engine/configs)
2020
:::
2121

2222
After configuring DBLab Engine, run the following command:
@@ -37,7 +37,7 @@ sudo docker run \
3737
--volume /lib/modules:/lib/modules:ro \
3838
--volume /proc:/host_proc:ro \
3939
--env DOCKER_API_VERSION=1.41 \
40-
postgresai/dblab-server:4.0.1
40+
postgresai/dblab-server:4.0.3
4141
```
4242

4343
:::info
@@ -105,7 +105,7 @@ If you need to save the logs in a file:
105105
sudo docker logs dblab_server 2>&1 | gzip > dblab_server.log.gz
106106
```
107107
108-
If you want to see more details, enable debug mode setting option `debug` to `true` (see [example](https://gitlab.com/postgres-ai/database-lab/-/tree/v4.0.1/engine/configs)). Next, follow [the reconfiguration guidelines](#reconfigure-database-lab) to apply the change.
108+
If you want to see more details, enable debug mode setting option `debug` to `true` (see [example](https://gitlab.com/postgres-ai/database-lab/-/tree/v4.0.3/engine/configs)). Next, follow [the reconfiguration guidelines](#reconfigure-database-lab) to apply the change.
109109
110110
:::caution
111111
When debug mode is turned on, logs may contain sensitive data such as API secret keys for the backup system.

docs/dblab-howtos/administration/install-dle-manually.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -242,11 +242,11 @@ sudo docker stop dblab_pg_initdb
242242
sudo docker rm dblab_pg_initdb
243243
```
244244
245-
Now, we need to take care of DBLab Engine configuration. Copy the contents of configuration example [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.logical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`:
245+
Now, we need to take care of DBLab Engine configuration. Copy the contents of configuration example [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.logical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`:
246246
```bash
247247
mkdir -p ~/.dblab/engine/configs
248248
249-
curl -fsSL https://gitlab.com/postgres-ai/database-lab/-/raw/v4.0.1/engine/configs/config.example.logical_generic.yml \
249+
curl -fsSL https://gitlab.com/postgres-ai/database-lab/-/raw/v4.0.3/engine/configs/config.example.logical_generic.yml \
250250
--output ~/.dblab/engine/configs/server.yml
251251
```
252252
@@ -263,11 +263,11 @@ Open `~/.dblab/engine/configs/server.yml` and edit the following options:
263263
264264
If you want to try Database Lab for an existing database, you need to copy the data to PostgreSQL data directory on the Database Lab server, to the directory `/var/lib/dblab/dblab_pool/data`. This step is called "thick cloning". It only needs to be completed once. There are several options to physically copy the data directory. Here we will use the standard PostgreSQL tool, `pg_basebackup`. However, we are not going to use it directly (although, it is possible) – we will specify its options in the DBLab Engine configuration file.
265265
266-
First, copy the example configuration file [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`:
266+
First, copy the example configuration file [`config.example.physical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.physical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`:
267267
```bash
268268
mkdir -p ~/.dblab/engine/configs
269269
270-
curl -fsSL https://gitlab.com/postgres-ai/database-lab/-/raw/v4.0.1/engine/configs/config.example.physical_generic.yml \
270+
curl -fsSL https://gitlab.com/postgres-ai/database-lab/-/raw/v4.0.3/engine/configs/config.example.physical_generic.yml \
271271
--output ~/.dblab/engine/configs/server.yml
272272
```
273273
@@ -288,11 +288,11 @@ If you want to try Database Lab for an existing database, you need to copy the d
288288
289289
Here we will configure DBLab Engine to use a "logical" method of thick cloning, dump/restore.
290290
291-
First, copy the configuration example configuration file [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.1/engine/configs/config.example.logical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`:
291+
First, copy the configuration example configuration file [`config.example.logical_generic.yml`](https://gitlab.com/postgres-ai/database-lab/-/blob/v4.0.3/engine/configs/config.example.logical_generic.yml) from the Database Lab repository to `~/.dblab/engine/configs/server.yml`:
292292
```bash
293293
mkdir -p ~/.dblab/engine/configs
294294
295-
curl -fsSL https://gitlab.com/postgres-ai/database-lab/-/raw/v4.0.1/engine/configs/config.example.logical_generic.yml \
295+
curl -fsSL https://gitlab.com/postgres-ai/database-lab/-/raw/v4.0.3/engine/configs/config.example.logical_generic.yml \
296296
--output ~/.dblab/engine/configs/server.yml
297297
```
298298
@@ -340,7 +340,7 @@ sudo docker run \
340340
--env DOCKER_API_VERSION=1.39 \
341341
--detach \
342342
--restart on-failure \
343-
postgresai/dblab-server:4.0.1
343+
postgresai/dblab-server:4.0.3
344344
```
345345
346346
</TabItem>
@@ -363,7 +363,7 @@ sudo docker run \
363363
--env DOCKER_API_VERSION=1.39 \
364364
--detach \
365365
--restart on-failure \
366-
postgresai/dblab-server:4.0.1
366+
postgresai/dblab-server:4.0.3
367367
```
368368
369369
</TabItem>
@@ -386,7 +386,7 @@ sudo docker run \
386386
--env DOCKER_API_VERSION=1.39 \
387387
--detach \
388388
--restart on-failure \
389-
postgresai/dblab-server:4.0.1
389+
postgresai/dblab-server:4.0.3
390390
```
391391
392392
</TabItem>

0 commit comments

Comments
 (0)