Skip to content

Commit 4960d90

Browse files
PS-9241 Convert tables from .html to .md format (#327)
modified: docs/audit-log-filter-compression-encryption.md modified: docs/audit-log-filter-naming.md modified: docs/audit-log-filter-new.md modified: docs/feature-comparison.md modified: docs/server-version-numbers.md
1 parent b4c47e9 commit 4960d90

File tree

5 files changed

+37
-315
lines changed

5 files changed

+37
-315
lines changed

docs/audit-log-filter-compression-encryption.md

Lines changed: 4 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -26,52 +26,10 @@ The AES uses the 256-bit key size.
2626

2727
The following audit log filter functions are used with encryption:
2828

29-
<!DOCTYPE html>
30-
<html>
31-
<head>
32-
<title>HTML Table Generator</title>
33-
<style>
34-
table {
35-
border:1px solid #b3adad;
36-
border-collapse:collapse;
37-
padding:5px;
38-
}
39-
table th {
40-
border:1px solid #b3adad;
41-
padding:5px;
42-
background: #f0f0f0;
43-
color: #313030;
44-
}
45-
table td {
46-
border:1px solid #b3adad;
47-
text-align:center;
48-
padding:5px;
49-
background: #ffffff;
50-
color: #313030;
51-
}
52-
</style>
53-
</head>
54-
<body>
55-
<table>
56-
<thead>
57-
<tr>
58-
<th>Function name</th>
59-
<th>Description</th>
60-
</tr>
61-
</thead>
62-
<tbody>
63-
<tr>
64-
<td>audit_log_encryption_password_set()</td>
65-
<td>Stores the password in the keyring. If encryption is enabled, the function also rotates the log file by renaming the current log file and creating a log file encrypted with the password.</td>
66-
</tr>
67-
<tr>
68-
<td>audit_log_encryption_password_get()</td>
69-
<td>Invoking this function without an argument returns the current encryption password. An argument that specifies the keyring ID of an archived password or current password returns that password by ID.</td>
70-
</tr>
71-
</tbody>
72-
</table>
73-
</body>
74-
</html>
29+
| Function name | Description |
30+
| --------------- | ------------------ |
31+
| audit_log_encryption_password_set() | Stores the password in the keyring. If encryption is enabled, the function also rotates the log file by renaming the current log file and creating a log file encrypted with the password. |
32+
| audit_log_encryption_password_get() | Invoking this function without an argument returns the current encryption password. An argument that specifies the keyring ID of an archived password or current password returns that password by ID. |
7533

7634
The `audit_log_filter_password_history_keep_days` variable is used with encryption. If the variable is not zero (0) , invoking `audit_log_encryption_password_set()` causes the expiration of archived audit log passwords.
7735

docs/audit-log-filter-naming.md

Lines changed: 6 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -21,60 +21,12 @@ You can combine compression and encryption, which adds both suffixes to the `aud
2121

2222
The following table displays the possible ways a file can be named:
2323

24-
<!DOCTYPE html>
25-
<html>
26-
<head>
27-
<title>HTML Table Generator</title>
28-
<style>
29-
table {
30-
border:1px solid #b3adad;
31-
border-collapse:collapse;
32-
padding:5px;
33-
}
34-
table th {
35-
border:1px solid #b3adad;
36-
padding:5px;
37-
background: #f0f0f0;
38-
color: #313030;
39-
}
40-
table td {
41-
border:1px solid #b3adad;
42-
text-align:center;
43-
padding:5px;
44-
background: #ffffff;
45-
color: #313030;
46-
}
47-
</style>
48-
</head>
49-
<body>
50-
<table>
51-
<thead>
52-
<tr>
53-
<th>Default name</th>
54-
<th>Enabled feature</th>
55-
</tr>
56-
</thead>
57-
<tbody>
58-
<tr>
59-
<td>audit.log&nbsp;</td>
60-
<td>No compression or encryption&nbsp;</td>
61-
</tr>
62-
<tr>
63-
<td>&nbsp;audit.log.gz</td>
64-
<td>Compression&nbsp;</td>
65-
</tr>
66-
<tr>
67-
<td>&nbsp;audit.log.pwd_id.enc</td>
68-
<td>&nbsp;Encryption</td>
69-
</tr>
70-
<tr>
71-
<td>audit.log.gz.pwd_id.enc&nbsp;</td>
72-
<td>Compression, encryption&nbsp;</td>
73-
</tr>
74-
</tbody>
75-
</table>
76-
</body>
77-
</html>
24+
| Default name | Enabled feature |
25+
| -------------------------- | ----------------------------- |
26+
| audit.log | No compression or encryption |
27+
| audit.log.gz | Compression |
28+
| audit.log.pwd_id.enc | Encryption |
29+
| audit.log.gz.pwd_id.enc | Compression, encryption |
7830

7931
### Encryption ID format
8032

docs/audit-log-filter-new.md

Lines changed: 27 additions & 172 deletions
Original file line numberDiff line numberDiff line change
@@ -82,178 +82,33 @@ The order of the attributes within an <AUDIT_RECORD> can vary. Certain attribute
8282

8383
The attributes in every element are the following:
8484

85+
| Attribute Name | Description |
86+
| -------------- | ----------- |
87+
| `<NAME>` | The action that generated the audit record. |
88+
| `<RECORD_ID>` | The `<RECORD_ID>` consists of a sequence number and a timestamp value. The sequence number is initialized when the plugin opens the audit log filter file. |
89+
| `<TIMESTAMP>` | Displays the date and time when the audit event happened. |
8590

86-
<!DOCTYPE html>
87-
<html>
88-
<head>
89-
<title>HTML Table Generator</title>
90-
<style>
91-
table {
92-
width:150%;
93-
height:100%;
94-
border:1px solid #b3adad;
95-
border-collapse:collapse;
96-
padding:1px;
97-
}
98-
table th {
99-
border:1px solid #b3adad;
100-
padding:1px;
101-
background: #f0f0f0;
102-
color: #313030;
103-
}
104-
table td {
105-
border:1px solid #b3adad;
106-
text-align:left;
107-
padding:1px;
108-
background: #ffffff;
109-
color: #313030;
110-
}
111-
</style>
112-
</head>
113-
<body>
114-
<table>
115-
<thead>
116-
<tr>
117-
<th>Attribute Name</th>
118-
<th>Description</th>
119-
</tr>
120-
</thead>
121-
<tbody>
122-
<tr>
123-
<td>&nbsp;&lt;NAME&gt;</td>
124-
<td>The action that generated the audit record.</td>
125-
</tr>
126-
<tr>
127-
<td>&nbsp;&lt;RECORD_ID&gt;</td>
128-
<td>The &lt;RECORD_ID&gt; consists of a sequence number and a timestamp value. The sequence number is initialized when the plugin opens the audit log filter file.</td>
129-
</tr>
130-
<tr>
131-
<td>&nbsp;&lt;TIMESTAMP&gt;</td>
132-
<td>Displays the date and time when the audit event happened.</td>
133-
</tr>
134-
</tbody>
135-
</table>
136-
</body>
137-
</html>
13891
The optional attributes are the following:
13992

140-
<!DOCTYPE html>
141-
<html>
142-
<head>
143-
<title>HTML Table Generator</title>
144-
<style>
145-
table {
146-
width:150%;
147-
height:100%;
148-
border:1px solid #b3adad;
149-
border-collapse:collapse;
150-
padding:1px;
151-
}
152-
table th {
153-
border:1px solid #b3adad;
154-
padding:1px;
155-
background: #f0f0f0;
156-
color: #313030;
157-
}
158-
table td {
159-
border:1px solid #b3adad;
160-
text-align:left;
161-
padding:1px;
162-
background: #ffffff;
163-
color: #313030;
164-
}
165-
</style>
166-
</head>
167-
<body>
168-
<table>
169-
<thead>
170-
<tr>
171-
<th>Attribute Name</th>
172-
<th>Description</th>
173-
</tr>
174-
</thead>
175-
<tbody>
176-
<tr>
177-
<td>&nbsp;&lt;COMMAND_CLASS&gt;</td>
178-
<td>Contains the type of performed action.&nbsp;</td>
179-
</tr>
180-
<tr>
181-
<td>&nbsp;&lt;CONNECTION_ID&gt;</td>
182-
<td>Contains the client connection identifier.</td>
183-
</tr>
184-
<tr>
185-
<td>&nbsp;&lt;CONNECTION_ATTRIBUTES&gt;</td>
186-
<td>Contains the client connection attributes. Each attribute has a &lt;NAME&gt; and &lt;VALUE&gt; pair.</td>
187-
</tr>
188-
<tr>
189-
<td>&nbsp;&lt;CONNECTION_TYPE&gt;</td>
190-
<td>Contains the type of connection security.&nbsp;<br></td>
191-
</tr>
192-
<tr>
193-
<td>&nbsp;&lt;DB&gt;</td>
194-
<td>Contains the database name.</td>
195-
</tr>
196-
<tr>
197-
<td>&nbsp;&lt;HOST&gt;</td>
198-
<td>Contains the client's hostname.</td>
199-
</tr>
200-
<tr>
201-
<td>&nbsp;&lt;IP&gt;</td>
202-
<td>Contains the client's IP address.</td>
203-
</tr>
204-
<tr>
205-
<td>&nbsp;&lt;MYSQL_VERSION&gt;</td>
206-
<td>Contains the MySQL server version.</td>
207-
</tr>
208-
<tr>
209-
<td>&nbsp;&lt;OS_LOGIN&gt;</td>
210-
<td>Contains the user name used during an external authentication, for example, if the user is authenticated through an LDAP plugin. If the authentication plugin does not set a value or the user is authenticated using MySQL authentication, this value is empty.</td>
211-
</tr>
212-
<tr>
213-
<td>&nbsp;&lt;OS_VERSION&gt;</td>
214-
<td>Contains the server's operating system.</td>
215-
</tr>
216-
<tr>
217-
<td>&nbsp;&lt;PRIV_USER&gt;</td>
218-
<td>Contains the user name used by the server when checking privileges. This name may be different than &lt;USER&gt;.</td>
219-
</tr>
220-
<tr>
221-
<td>&nbsp;&lt;PROXY_USER&gt;</td>
222-
<td>Contains the proxy user. If a proxy is not used, the value is empty.</td>
223-
</tr>
224-
<tr>
225-
<td>&nbsp;&lt;SERVER_ID&gt;</td>
226-
<td>Contains the server ID.</td>
227-
</tr>
228-
<tr>
229-
<td>&nbsp;&lt;SQLTEXT&gt;</td>
230-
<td>Contains the text of the SQL statement.</td>
231-
</tr>
232-
<tr>
233-
<td>&nbsp;&lt;STARTUP_OPTIONS&gt;</td>
234-
<td>Contains the startup options. These options may be provided by the command line or files.</td>
235-
</tr>
236-
<tr>
237-
<td>&nbsp;&lt;STATUS&gt;</td>
238-
<td>Contains the status of a command. A 0 (zero) is a success. A nonzero value is an error.</td>
239-
</tr>
240-
<tr>
241-
<td>&nbsp;&lt;STATUS_CODE&gt;</td>
242-
<td>Contains the status of a command, which either succeeds (0) or an error occurred (1).</td>
243-
</tr>
244-
<tr>
245-
<td>&nbsp;&lt;TABLE&gt;</td>
246-
<td>Contains the table name.</td>
247-
</tr>
248-
<tr>
249-
<td>&nbsp;&lt;USER&gt;</td>
250-
<td>Contains the user name from the client. This name may be different than &lt;PRIV_USER&gt;.</td>
251-
</tr>
252-
<tr>
253-
<td>&nbsp;&lt;VERSION&gt;</td>
254-
<td>Contains the audit log filter format.</td>
255-
</tr>
256-
</tbody>
257-
</table>
258-
</body>
259-
</html>
93+
| Attribute Name | Description |
94+
| ----------------------- | ------------- |
95+
| `<COMMAND_CLASS>` | Contains the type of performed action. |
96+
| `<CONNECTION_ID>` | Contains the client connection identifier. |
97+
| `<CONNECTION_ATTRIBUTES>`| Contains the client connection attributes. Each attribute has a `<NAME>` and `<VALUE>` pair. |
98+
| `<CONNECTION_TYPE>` | Contains the type of connection security. |
99+
| `<DB>` | Contains the database name. |
100+
| `<HOST>` | Contains the client's hostname. |
101+
| `<IP>` | Contains the client's IP address. |
102+
| `<MYSQL_VERSION>` | Contains the MySQL server version. |
103+
| `<OS_LOGIN>` | Contains the user name used during an external authentication, for example, if the user is authenticated through an LDAP plugin. If the authentication plugin does not set a value or the user is authenticated using MySQL authentication, this value is empty. |
104+
| `<OS_VERSION>` | Contains the server's operating system. |
105+
| `<PRIV_USER>` | Contains the user name used by the server when checking privileges. This name may be different than `<USER>`. |
106+
| `<PROXY_USER>` | Contains the proxy user. If a proxy is not used, the value is empty. |
107+
| `<SERVER_ID>` | Contains the server ID. |
108+
| `<SQLTEXT>` | Contains the text of the SQL statement. |
109+
| `<STARTUP_OPTIONS>` | Contains the startup options. These options may be provided by the command line or files. |
110+
| `<STATUS>` | Contains the status of a command. A 0 (zero) is a success. A nonzero value is an error. |
111+
| `<STATUS_CODE>` | Contains the status of a command, which either succeeds (0) or an error occurred (1). |
112+
| `<TABLE>` | Contains the table name. |
113+
| `<USER>` | Contains the user name from the client. This name may be different than `<PRIV_USER>`. |
114+
| `<VERSION>` | Contains the audit log filter format. |

docs/feature-comparison.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,6 @@
77
We provide these benefits by significantly enhancing *Percona Server for MySQL* as
88
compared to the standard *MySQL* database server:
99

10-
<style>
11-
table {
12-
table-layout: fixed;
13-
width: 100%';
14-
border-collapse: collapse
15-
border: 3px solid blue
16-
}
17-
18-
thead th:nth-child(1) {
19-
width: 30%;
20-
text-align: left;
21-
vertical-align: top;
22-
}
23-
thead th:nth-child(2) {
24-
width: 25%;
25-
text-align: center;
26-
vertical-align: top;
27-
}
28-
thead th:nth-child(3) {
29-
width: 25%;
30-
text-align: center;
31-
vertical-align: top;
32-
}
33-
th,
34-
td {padding: 20px;}
35-
</style>
36-
37-
3810
| Features | Percona Server for MySQL 8.0.30 | MySQL 8.0.30 |
3911
|---|---|---|
4012
| Open Source | Yes | Yes |

docs/server-version-numbers.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,6 @@
22

33
A version number identifies the product release. The product contains the latest Generally Available (GA) features at the time of that release.
44

5-
<style>
6-
table {
7-
border-collapse: collapse;
8-
width=100%;
9-
}
10-
table td {
11-
border: 2px solid black;
12-
padding: 8px;
13-
text-align: center;
14-
}
15-
tr:nth-child(even){
16-
background-color:#f5f5f5
17-
}
18-
</style>
19-
205
| 8.0.29| -21. | 2 |
216
|---|---|---|
227
| Base version | Minor build version | Custom build |

0 commit comments

Comments
 (0)