Skip to content

Commit 8c1fd5d

Browse files
authored
Merge pull request #358 from percona/PS-9325
PS-9325 Remove info about Keyring file plugin from PS 8.4 (8.4)
2 parents 2171ef4 + 1f377ba commit 8c1fd5d

File tree

4 files changed

+13
-44
lines changed

4 files changed

+13
-44
lines changed

docs/encrypt-logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Changing the encryption does not change existing redo log pages. Setting the opt
1212

1313
The metadata for the redo log encryption includes the tablespace encryption key and is stored the in redo log file header. Removing the encryption metadata disables the redo log encryption.
1414

15-
Without the keyring plugin or component or the encryption key, a normal restart is not possible. InnoDB scans the redo log pages during startup. If the encryption options are not available, InnoDB cannot scan these pages. A forced startup without the redo logs is possible.
15+
Without the keyring component or the encryption key, a normal restart is not possible. InnoDB scans the redo log pages during startup. If the encryption options are not available, InnoDB cannot scan these pages. A forced startup without the redo logs is possible.
1616

1717
## Option
1818

@@ -44,7 +44,7 @@ Changing the encryption does not change existing undo log pages. Setting the opt
4444

4545
The metadata for the redo log encryption includes the tablespace encryption key and is stored the in undo log file header.
4646

47-
The server requires the keyring plugin or keyring component used to encrypt log data until that data is truncated, even if the current option setting is `OFF`. When the undo tablespace is truncated, the encryption header is removed.
47+
The server requires the keyring component used to encrypt log data until that data is truncated, even if the current option setting is `OFF`. When the undo tablespace is truncated, the encryption header is removed.
4848

4949

5050
## `innodb_undo_log_encrypt`

docs/keyring-components-plugins-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Keyring components and plugins overview
1+
# Keyring components overview
22

3-
Percona Server supports a keyring that enables internal server components and plugins to store sensitive information securely for later retrieval.
3+
Percona Server supports a keyring that enables internal server components to store sensitive information securely for later retrieval.
44

55
!!! warning
66

7-
Enable only one keyring plugin or one keyring component at a time for each server instance. Enabling multiple keyring plugins or keyring components or mixing keyring plugins or keyring components is not supported and may result in data loss.
7+
Enable only one keyring component at a time for each server instance. Enabling multiple keyring components is not supported and may result in data loss.
88

9-
Percona Server supports the following keyring components and plugins:
9+
Percona Server supports the following keyring components:
1010

11-
[Use the keyring file component or plugin :material-arrow-right:](use-keyring-file.md){.md-button}
11+
[Use the keyring file component :material-arrow-right:](use-keyring-file.md){.md-button}
1212

1313
[Use the keyring vault component :material-arrow-right:](use-keyring-vault-component.md){.md-button}
1414

docs/use-keyring-file.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,10 @@
1-
# Use the keyring file component or keyring file plugin
1+
# Use the keyring file component
22

3-
## Use the keyring file plugin
4-
5-
Percona Server for MySQL supports the keyring_file plugin that stores the keyring data locally.
6-
7-
!!! warning
8-
9-
The `keyring_file` plugin should not be used for regulatory compliance.
10-
11-
To install the plugin, follow the [installing and uninstalling plugins] instructions.
12-
13-
### Load the keyring plugin
14-
15-
You should load the plugin at server startup with the `--early-plugin-load` option to enable keyrings.
16-
17-
We recommend that you load the plugin in the configuration file to facilitate recovery for encrypted tables. Also, the redo log encryption and the undo log encryption cannot be used without `--early-plugin-load`. The normal plugin load happens too late at startup.
18-
19-
To load the keyring_file plugin, run the following command:
20-
21-
```{.bash data-prompt="$"}
22-
$ mysqld --early-plugin-load="keyring_file=keyring_file.so"
23-
```
24-
25-
If a server starts with different plugins loaded early, the `--early-plugin-load` option should contain the plugin names in a double-quoted list with each plugin name separated by a semicolon. The use of double quotes ensures the semicolons do not create issues when the list is executed in a script.
3+
The `keyring_file` component is part of the component-based MySQL infrastructure which extends the server capabilities.
264

27-
## Use the keyring file component
5+
!!! important
286

29-
The `keyring_file` component is part of the component-based MySQL infrastructure which extends the server capabilities.
7+
Percona Server for MySQL {{vers}} does not support the `keyring_file` plugin.
308

319
See the MySQL documentation on the [component installation] and on the [keyring_file component usage] for more information.
3210

@@ -51,5 +29,4 @@ An example of `/lib/plugin/component_keyring_file.cnf`:
5129
```
5230

5331
[component installation]: https://dev.mysql.com/doc/refman/{{vers}}/en/keyring-component-installation.html
54-
[keyring_file component usage]: https://dev.mysql.com/doc/refman/{{vers}}/en/keyring-file-component.html
55-
[installing and uninstalling plugins]: https://dev.mysql.com/doc/refman/{{vers}}/en/plugin-loading.html
32+
[keyring_file component usage]: https://dev.mysql.com/doc/refman/{{vers}}/en/keyring-file-component.html

mkdocs-base.yml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -265,14 +265,6 @@ nav:
265265
- isolation-levels.md
266266
- transaction-mgmt.md
267267
- views.md
268-
269-
270-
271-
272-
273-
274-
275-
276268
- extended-show-grants.md
277269
- restrict-dynamic-log-locations.md
278270
- clone-plugin.md
@@ -299,7 +291,7 @@ nav:
299291
- encryption-functions.md
300292
- Data-at-rest-encryption:
301293
- data-at-rest-encryption.md
302-
- Keyring components and plugins:
294+
- Keyring components:
303295
- keyring-components-plugins-overview.md
304296
- use-keyring-file.md
305297
- use-keyring-vault-component.md

0 commit comments

Comments
 (0)