Skip to content

Commit 6651e26

Browse files
PS-9241 Convert tables from .html to .md format (#328)
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 7d3a6d2 commit 6651e26

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
@@ -24,52 +24,10 @@ The AES uses the 256-bit key size.
2424

2525
The following audit log filter functions are used with encryption:
2626

27-
<!DOCTYPE html>
28-
<html>
29-
<head>
30-
<title>HTML Table Generator</title>
31-
<style>
32-
table {
33-
border:1px solid #b3adad;
34-
border-collapse:collapse;
35-
padding:5px;
36-
}
37-
table th {
38-
border:1px solid #b3adad;
39-
padding:5px;
40-
background: #f0f0f0;
41-
color: #313030;
42-
}
43-
table td {
44-
border:1px solid #b3adad;
45-
text-align:center;
46-
padding:5px;
47-
background: #ffffff;
48-
color: #313030;
49-
}
50-
</style>
51-
</head>
52-
<body>
53-
<table>
54-
<thead>
55-
<tr>
56-
<th>Function name</th>
57-
<th>Description</th>
58-
</tr>
59-
</thead>
60-
<tbody>
61-
<tr>
62-
<td>audit_log_encryption_password_set()</td>
63-
<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>
64-
</tr>
65-
<tr>
66-
<td>audit_log_encryption_password_get()</td>
67-
<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>
68-
</tr>
69-
</tbody>
70-
</table>
71-
</body>
72-
</html>
27+
| Function name | Description |
28+
| ----------------- | -------------------- |
29+
| 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. |
30+
| 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. |
7331

7432
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.
7533

docs/audit-log-filter-naming.md

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

2020
The following table displays the possible ways a file can be named:
2121

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

7729
### Encryption ID format
7830

docs/audit-log-filter-new.md

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

8181
The attributes in every element are the following:
8282

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

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

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

11-
<style>
12-
table {
13-
table-layout: fixed;
14-
width: 100%';
15-
border-collapse: collapse
16-
border: 3px solid blue
17-
}
18-
19-
thead th:nth-child(1) {
20-
width: 30%;
21-
text-align: left;
22-
vertical-align: top;
23-
}
24-
thead th:nth-child(2) {
25-
width: 25%;
26-
text-align: center;
27-
vertical-align: top;
28-
}
29-
thead th:nth-child(3) {
30-
width: 25%;
31-
text-align: center;
32-
vertical-align: top;
33-
}
34-
th,
35-
td {padding: 20px;}
36-
</style>
37-
38-
3911
| Features | Percona Server for MySQL {{vers}} | MySQL {{vers}} |
4012
|---|---|---|
4113
| 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 innovtion product release. The product contains the latest features, improvements, and bug fixes 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.1.0 | -1 |
216
|---|---|---|
227
| Base version | Minor build version |

0 commit comments

Comments
 (0)