Skip to content

Commit

Permalink
Merge branch 'innovation-release' into ps-9225
Browse files Browse the repository at this point in the history
  • Loading branch information
@patrickbirch
patrickbirch authored Jul 3, 2024
2 parents f4b9660 + 1d15392 commit 45af4d5
Show file tree
Hide file tree
Showing 37 changed files with 1,704 additions and 383 deletions.
2 changes: 1 addition & 1 deletion _resource/overrides/main.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
{% include "partials/nav.html" %}
<br>
<label class="md-nav__title" for="__drawer">
<a href="https://learn.percona.com/download-manual-percona-server-innovation-release" onclick="_gaq.push(['b._trackEvent', 'Percona Server', 'Download', 'Download Manual Percona Server']);" class="md-nav__link md-nav__link--active" style="font-size: .7rem;">
<a href="https://learn.percona.com/download-manual-percona-server-for-mysql-innovation-releases" onclick="_gaq.push(['b._trackEvent', 'Percona Server', 'Download', 'Download Manual Percona Server']);" class="md-nav__link md-nav__link--active" style="font-size: .7rem;">
Download PDF
</a>
</label>
Expand Down
15 changes: 0 additions & 15 deletions _resource/overrides/partials/copyright.html
View file

This file was deleted.

7 changes: 7 additions & 0 deletions docs/ai-docs.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# How we use artificial intelligence

The technical writer oversees the integration of AI-driven tools and platforms into the documentation workflow, ensuring that AI-generated text meets the standards for clarity, coherence, and accuracy. While AI assists in tasks such as content generation, language enhancement, and formatting optimization, the technical writer is responsible for validating and refining the output to ensure its suitability for the intended audience.

Throughout the documentation process, the technical writer reviews the quality and relevance of AI-generated content in detail and with critical judgment. By leveraging their expertise in language, communication, and subject matter knowledge, the technical writer collaborates with AI systems to refine and tailor the documentation to meet the specific needs and preferences of the audience.

While AI accelerates the documentation process and enhances productivity, the technical writer verifies the information's accuracy and maintains consistency in terminology, style, and tone. The technical writer ensures that the final document reflects the company's commitment to excellence.
50 changes: 4 additions & 46 deletions docs/audit-log-filter-compression-encryption.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,52 +24,10 @@ The AES uses the 256-bit key size.

The following audit log filter functions are used with encryption:

<!DOCTYPE html>
<html>
<head>
<title>HTML Table Generator</title>
<style>
table {
border:1px solid #b3adad;
border-collapse:collapse;
padding:5px;
}
table th {
border:1px solid #b3adad;
padding:5px;
background: #f0f0f0;
color: #313030;
}
table td {
border:1px solid #b3adad;
text-align:center;
padding:5px;
background: #ffffff;
color: #313030;
}
</style>
</head>
<body>
<table>
<thead>
<tr>
<th>Function name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>audit_log_encryption_password_set()</td>
<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>
</tr>
<tr>
<td>audit_log_encryption_password_get()</td>
<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>
</tr>
</tbody>
</table>
</body>
</html>
| Function name | Description |
| ----------------- | -------------------- |
| 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. |
| 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. |

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.

Expand Down
60 changes: 6 additions & 54 deletions docs/audit-log-filter-naming.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,60 +19,12 @@ You can combine compression and encryption, which adds both suffixes to the `aud

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

<!DOCTYPE html>
<html>
<head>
<title>HTML Table Generator</title>
<style>
table {
border:1px solid #b3adad;
border-collapse:collapse;
padding:5px;
}
table th {
border:1px solid #b3adad;
padding:5px;
background: #f0f0f0;
color: #313030;
}
table td {
border:1px solid #b3adad;
text-align:center;
padding:5px;
background: #ffffff;
color: #313030;
}
</style>
</head>
<body>
<table>
<thead>
<tr>
<th>Default name</th>
<th>Enabled feature</th>
</tr>
</thead>
<tbody>
<tr>
<td>audit.log&nbsp;</td>
<td>No compression or encryption&nbsp;</td>
</tr>
<tr>
<td>&nbsp;audit.log.gz</td>
<td>Compression&nbsp;</td>
</tr>
<tr>
<td>&nbsp;audit.log.pwd_id.enc</td>
<td>&nbsp;Encryption</td>
</tr>
<tr>
<td>audit.log.gz.pwd_id.enc&nbsp;</td>
<td>Compression, encryption&nbsp;</td>
</tr>
</tbody>
</table>
</body>
</html>
| Default name | Enabled feature |
| ----------------------- | ------------------------------ |
| audit.log | No compression or encryption |
| audit.log.gz | Compression |
| audit.log.pwd_id.enc | Encryption |
| audit.log.gz.pwd_id.enc | Compression, encryption |

### Encryption ID format

Expand Down
199 changes: 27 additions & 172 deletions docs/audit-log-filter-new.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,178 +80,33 @@ The order of the attributes within an <AUDIT_RECORD> can vary. Certain attribute

The attributes in every element are the following:

| Attribute Name | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `<NAME>` | The action that generated the audit record. |
| `<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. |
| `<TIMESTAMP>` | Displays the date and time when the audit event happened. |

<!DOCTYPE html>
<html>
<head>
<title>HTML Table Generator</title>
<style>
table {
width:150%;
height:100%;
border:1px solid #b3adad;
border-collapse:collapse;
padding:1px;
}
table th {
border:1px solid #b3adad;
padding:1px;
background: #f0f0f0;
color: #313030;
}
table td {
border:1px solid #b3adad;
text-align:left;
padding:1px;
background: #ffffff;
color: #313030;
}
</style>
</head>
<body>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>&nbsp;&lt;NAME&gt;</td>
<td>The action that generated the audit record.</td>
</tr>
<tr>
<td>&nbsp;&lt;RECORD_ID&gt;</td>
<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>
</tr>
<tr>
<td>&nbsp;&lt;TIMESTAMP&gt;</td>
<td>Displays the date and time when the audit event happened.</td>
</tr>
</tbody>
</table>
</body>
</html>
The optional attributes are the following:

<!DOCTYPE html>
<html>
<head>
<title>HTML Table Generator</title>
<style>
table {
width:150%;
height:100%;
border:1px solid #b3adad;
border-collapse:collapse;
padding:1px;
}
table th {
border:1px solid #b3adad;
padding:1px;
background: #f0f0f0;
color: #313030;
}
table td {
border:1px solid #b3adad;
text-align:left;
padding:1px;
background: #ffffff;
color: #313030;
}
</style>
</head>
<body>
<table>
<thead>
<tr>
<th>Attribute Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>&nbsp;&lt;COMMAND_CLASS&gt;</td>
<td>Contains the type of performed action.&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&lt;CONNECTION_ID&gt;</td>
<td>Contains the client connection identifier.</td>
</tr>
<tr>
<td>&nbsp;&lt;CONNECTION_ATTRIBUTES&gt;</td>
<td>Contains the client connection attributes. Each attribute has a &lt;NAME&gt; and &lt;VALUE&gt; pair.</td>
</tr>
<tr>
<td>&nbsp;&lt;CONNECTION_TYPE&gt;</td>
<td>Contains the type of connection security.&nbsp;<br></td>
</tr>
<tr>
<td>&nbsp;&lt;DB&gt;</td>
<td>Contains the database name.</td>
</tr>
<tr>
<td>&nbsp;&lt;HOST&gt;</td>
<td>Contains the client's hostname.</td>
</tr>
<tr>
<td>&nbsp;&lt;IP&gt;</td>
<td>Contains the client's IP address.</td>
</tr>
<tr>
<td>&nbsp;&lt;MYSQL_VERSION&gt;</td>
<td>Contains the MySQL server version.</td>
</tr>
<tr>
<td>&nbsp;&lt;OS_LOGIN&gt;</td>
<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>
</tr>
<tr>
<td>&nbsp;&lt;OS_VERSION&gt;</td>
<td>Contains the server's operating system.</td>
</tr>
<tr>
<td>&nbsp;&lt;PRIV_USER&gt;</td>
<td>Contains the user name used by the server when checking privileges. This name may be different than &lt;USER&gt;.</td>
</tr>
<tr>
<td>&nbsp;&lt;PROXY_USER&gt;</td>
<td>Contains the proxy user. If a proxy is not used, the value is empty.</td>
</tr>
<tr>
<td>&nbsp;&lt;SERVER_ID&gt;</td>
<td>Contains the server ID.</td>
</tr>
<tr>
<td>&nbsp;&lt;SQLTEXT&gt;</td>
<td>Contains the text of the SQL statement.</td>
</tr>
<tr>
<td>&nbsp;&lt;STARTUP_OPTIONS&gt;</td>
<td>Contains the startup options. These options may be provided by the command line or files.</td>
</tr>
<tr>
<td>&nbsp;&lt;STATUS&gt;</td>
<td>Contains the status of a command. A 0 (zero) is a success. A nonzero value is an error.</td>
</tr>
<tr>
<td>&nbsp;&lt;STATUS_CODE&gt;</td>
<td>Contains the status of a command, which either succeeds (0) or an error occurred (1).</td>
</tr>
<tr>
<td>&nbsp;&lt;TABLE&gt;</td>
<td>Contains the table name.</td>
</tr>
<tr>
<td>&nbsp;&lt;USER&gt;</td>
<td>Contains the user name from the client. This name may be different than &lt;PRIV_USER&gt;.</td>
</tr>
<tr>
<td>&nbsp;&lt;VERSION&gt;</td>
<td>Contains the audit log filter format.</td>
</tr>
</tbody>
</table>
</body>
</html>
| Attribute Name | Description |
| ----------------------- | ---------------------- |
| `<COMMAND_CLASS>` | Contains the type of performed action. |
| `<CONNECTION_ID>` | Contains the client connection identifier. |
| `<CONNECTION_ATTRIBUTES>`| Contains the client connection attributes. Each attribute has a `<NAME>` and `<VALUE>` pair. |
| `<CONNECTION_TYPE>` | Contains the type of connection security. |
| `<DB>` | Contains the database name. |
| `<HOST>` | Contains the client's hostname. |
| `<IP>` | Contains the client's IP address. |
| `<MYSQL_VERSION>` | Contains the MySQL server version. |
| `<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. |
| `<OS_VERSION>` | Contains the server's operating system. |
| `<PRIV_USER>` | Contains the user name used by the server when checking privileges. This name may be different than `<USER>`. |
| `<PROXY_USER>` | Contains the proxy user. If a proxy is not used, the value is empty. |
| `<SERVER_ID>` | Contains the server ID. |
| `<SQLTEXT>` | Contains the text of the SQL statement. |
| `<STARTUP_OPTIONS>` | Contains the startup options. These options may be provided by the command line or files. |
| `<STATUS>` | Contains the status of a command. A 0 (zero) is a success. A nonzero value is an error. |
| `<STATUS_CODE>` | Contains the status of a command, which either succeeds (0) or an error occurred (1). |
| `<TABLE>` | Contains the table name. |
| `<USER>` | Contains the user name from the client. This name may be different than `<PRIV_USER>`. |
| `<VERSION>` | Contains the audit log filter format. |
Loading

0 comments on commit 45af4d5

Please sign in to comment.