diff --git a/_resourcepdf/overrides/main.html b/_resourcepdf/overrides/main.html index 2f242f18..e9759a79 100644 --- a/_resourcepdf/overrides/main.html +++ b/_resourcepdf/overrides/main.html @@ -64,12 +64,6 @@
diff --git a/docs/_static/percona-logomark-one-color-dark.png b/docs/_static/percona-logomark-one-color-dark.png new file mode 100644 index 00000000..28fbf02e Binary files /dev/null and b/docs/_static/percona-logomark-one-color-dark.png differ diff --git a/docs/apt.md b/docs/apt.md index 8a2114c8..a3fe7196 100644 --- a/docs/apt.md +++ b/docs/apt.md @@ -77,7 +77,7 @@ The following steps install from the APT repository. 6. Enable the `release` repository for *Percona XtraDB Cluster*: ```shell - sudo percona-release setup pxc-84-lts + sudo percona-release setup {{pkg}} ``` diff --git a/docs/compile.md b/docs/compile.md index c2a60f4d..5e443435 100644 --- a/docs/compile.md +++ b/docs/compile.md @@ -83,7 +83,7 @@ Compile Percona XtraDB Cluster from source: The snippets target `Linux-x86_64`. On ARM64, rewrite filenames for your chip (`aarch64`, `arm64`, …); never reuse paths that disagree with your download. - Stage everything under `pxc-build/pxc_extra`, then rename to match the `mv` targets in the snippet. Map `glibc2.xx`, `{{vers}}.x`, and `8.4.x` to the strings in your real filenames (for example `{{release}}` and `8.4.0-3`). Aim each `tar` and `mv` at the top-level folder that unpack creates. + Stage everything under `pxc-build/pxc_extra`, then rename to match the `mv` targets in the snippet. Map `glibc2.xx`, `{{vers}}.x`, and `8.4.x` to the strings in your real filenames (for example `{{release}}` and `8.4.2-2`). Aim each `tar` and `mv` at the top-level folder that unpack creates. ```shell mkdir -p ./pxc-build/pxc_extra diff --git a/docs/css/kapa.css b/docs/css/kapa.css new file mode 100644 index 00000000..d2964b52 --- /dev/null +++ b/docs/css/kapa.css @@ -0,0 +1,64 @@ +button#ask-percona-ai { + display: inline-flex; + align-items: center; + justify-content: center; + + gap: 0.45rem; + + /* Match MkDocs Material search field */ + height: 1.8rem; + padding: 0 0.9rem; + margin-left: 0.5rem; + + border: none; + border-radius: 0.1rem; + + background: #AB4213; + color: #E7C8BB; + + box-shadow: var(--md-shadow-z1); + + cursor: pointer; + + font-family: inherit; + font-size: 0.8rem; + font-weight: 400; + line-height: 1; + + white-space: nowrap; + + transition: + background-color 0.25s ease, + box-shadow 0.25s ease; +} + +button#ask-percona-ai:hover { + background: #EB6F3B; +} + +button#ask-percona-ai:focus-visible { + outline: none; + box-shadow: + 0 0 0 0.1rem rgba(235, 111, 59, 0.35), + var(--md-shadow-z2); +} + +button#ask-percona-ai .percona-star, +button#ask-percona-ai .percona-text { + color: inherit; +} + +button#ask-percona-ai .percona-star { + font-size: 0.85rem; + line-height: 1; +} + +@media screen and (max-width: 768px) { + button#ask-percona-ai { + padding: 0 0.75rem; + } + + button#ask-percona-ai .percona-text { + display: none; + } +} \ No newline at end of file diff --git a/docs/download-instructions.md b/docs/download-instructions.md index 7e6e2397..29d3b7eb 100644 --- a/docs/download-instructions.md +++ b/docs/download-instructions.md @@ -18,7 +18,7 @@ In `Package Download Options`, select a specific package and click `Download`. T ## Download to another computer -In `Package Download Options`, select a specific package and right-click on the `DOWNLOAD`, and in the drop-down menu, choose `Copy Link Address` +In `Package Download Options`, select a specific package and right-click on the `Download`, and in the drop-down menu, choose `Copy Link Address` Paste the link in your terminal to download the selected package. diff --git a/docs/install-index.md b/docs/install-index.md index 4e517545..cc7d51cc 100644 --- a/docs/install-index.md +++ b/docs/install-index.md @@ -32,17 +32,4 @@ If you want to build Percona XtraDB Cluster from source, see [Compiling and Inst If you want to run Percona XtraDB Cluster using Docker, see [Run in a Docker container](docker.md). - - -## Product version numbering - -The version number in PXC releases contains the following components: - -* The version of Percona Server for MySQL that the given PXC release is based on - -* The sequence number which represents the PXC built. - -For example, version number *8.0.18-9.3* means that this is the third PXC -build based on Percona Server for MySQL 8.0.18-9. - [Telemetry data]: telemetry.md diff --git a/docs/js/kapa.js b/docs/js/kapa.js new file mode 100644 index 00000000..595a186a --- /dev/null +++ b/docs/js/kapa.js @@ -0,0 +1,98 @@ +(function () { + function createAIButton() { + if (document.getElementById("ask-percona-ai")) { + return; + } + + const search = document.querySelector(".md-search"); + + if (!search || !search.parentNode) { + return; + } + + const button = document.createElement("button"); + + button.id = "ask-percona-ai"; + button.type = "button"; + + button.innerHTML = ` + ✨ + Ask Percona AI + `; + + // Place button AFTER search component + search.parentNode.insertBefore(button, search.nextSibling); + } + + function loadKapa() { + // Prevent duplicate loading + if (document.getElementById("kapa-widget-script")) { + return; + } + + const script = document.createElement("script"); + + script.id = "kapa-widget-script"; + + script.src = "https://widget.kapa.ai/kapa-widget.bundle.js"; + + script.async = true; + + // REQUIRED CONFIG + script.setAttribute( + "data-website-id", + "0e0d55cf-6370-4a6d-a987-96670a7fe935" + ); + + script.setAttribute( + "data-modal-override-open-selector", + "#ask-percona-ai" + ); + + script.setAttribute( + "data-button-hide", + "true" + ); + + script.setAttribute( + "data-project-name", + "Percona" + ); + + script.setAttribute( + "data-modal-title", + "Percona AI Assistant" + ); + + script.setAttribute( + "font-size", + "0.875rem" + ); + + // MODAL CONTENT + script.setAttribute( + "data-modal-disclaimer", + "The **Percona AI Assistant** helps you find simple, clear answers to your Percona questions using [official documentation](https://docs.percona.com/), resolved [forum posts](https://forums.percona.com/) and [blog posts](https://www.percona.com/blog/). Note, do not enter personal or confidential information. Before using Percona AI assistant, read the [Legal Notice](https://docs.percona.com/percona-server/9.7/legal-notice.html)." + ); + + script.setAttribute( + "data-modal-example-questions", + "How do I get started quickly with Percona Server?, How do I install Percona Server?, How do I upgrade Percona Server?, How should I use the Audit Log Filter plugin?" + ); + + script.setAttribute( + "data-project-logo", + "https://docs.percona.com/percona-server/9.7/_static/percona-logomark-one-color-dark.png" + ); + + document.head.appendChild(script); + } + + createAIButton(); + loadKapa(); + + document.addEventListener("navigation.instant", () => { + createAIButton(); + loadKapa(); + }); +})(); \ No newline at end of file diff --git a/docs/legal-notice.md b/docs/legal-notice.md new file mode 100644 index 00000000..624be3ff --- /dev/null +++ b/docs/legal-notice.md @@ -0,0 +1,3 @@ +# Legal Notice + +You are interacting with an AI-powered chatbot that provides automated responses for general information about our IT services and software. Responses may be inaccurate or incomplete and do not constitute professional or contractual advice. Do not submit personal data, confidential information, credentials, or other sensitive information through this chat. Conversations may be logged and processed to improve our services in accordance with our [Privacy Policy](https://www.percona.com/privacy-policy#h.c033wws8ytgb) and applicable laws, including the GDPR. If you require assistance, please contact a [human representative](https://www.percona.com/about/contact). \ No newline at end of file diff --git a/docs/singlebox.md b/docs/singlebox.md index da91a6e0..850d4792 100644 --- a/docs/singlebox.md +++ b/docs/singlebox.md @@ -1,7 +1,5 @@ # How to set up a three-node cluster on a single box - - This tutorial describes how to set up a 3-node cluster on a single physical box. @@ -10,7 +8,7 @@ For the purposes of this tutorial, assume the following: * The local IP address is `192.168.2.21`. * Percona XtraDB Cluster is extracted from binary tarball into -`/usr/local/Percona-XtraDB-Cluster-8.4.x86_64` +`/usr/local/Percona-XtraDB-Cluster-{{vers}}.x86_64` To set up the cluster: @@ -23,11 +21,11 @@ To set up the cluster: port = 4000 socket=/tmp/mysql.4000.sock datadir=/data/bench/d1 - basedir=/usr/local/Percona-XtraDB-Cluster-8.4.x86_64 + basedir=/usr/local/Percona-XtraDB-Cluster-{{vers}}.x86_64 user=mysql log_error=error.log wsrep_cluster_address='gcomm://192.168.2.21:5030,192.168.2.21:6030' - wsrep_provider=/usr/local/Percona-XtraDB-Cluster-8.4.x86_64/lib/libgalera_smm.so + wsrep_provider=/usr/local/Percona-XtraDB-Cluster-{{vers}}.x86_64/lib/libgalera_smm.so wsrep_sst_receive_address=192.168.2.21:4020 wsrep_node_incoming_address=192.168.2.21 wsrep_cluster_name=trimethylxanthine @@ -44,11 +42,11 @@ To set up the cluster: port = 5000 socket=/tmp/mysql.5000.sock datadir=/data/bench/d2 - basedir=/usr/local/Percona-XtraDB-Cluster-8.4.x86_64 + basedir=/usr/local/Percona-XtraDB-Cluster-{{vers}}.x86_64 user=mysql log_error=error.log wsrep_cluster_address='gcomm://192.168.2.21:4030,192.168.2.21:6030' - wsrep_provider=/usr/local/Percona-XtraDB-Cluster-8.4.x86_64/lib/libgalera_smm.so + wsrep_provider=/usr/local/Percona-XtraDB-Cluster-{{vers}}.x86_64/lib/libgalera_smm.so wsrep_sst_receive_address=192.168.2.21:5020 wsrep_node_incoming_address=192.168.2.21 wsrep_cluster_name=trimethylxanthine @@ -65,11 +63,11 @@ To set up the cluster: port = 6000 socket=/tmp/mysql.6000.sock datadir=/data/bench/d3 - basedir=/usr/local/Percona-XtraDB-Cluster-8.4.x86_64 + basedir=/usr/local/Percona-XtraDB-Cluster-{{vers}}.x86_64 user=mysql log_error=error.log wsrep_cluster_address='gcomm://192.168.2.21:4030,192.168.2.21:5030' - wsrep_provider=/usr/local/Percona-XtraDB-Cluster-8.4.x86_64/lib/libgalera_smm.so + wsrep_provider=/usr/local/Percona-XtraDB-Cluster-{{vers}}.x86_64/lib/libgalera_smm.so wsrep_sst_receive_address=192.168.2.21:6020 wsrep_node_incoming_address=192.168.2.21 wsrep_cluster_name=trimethylxanthine diff --git a/docs/upgrade-packages.md b/docs/upgrade-packages.md index 26b47ff1..c2a74dd1 100644 --- a/docs/upgrade-packages.md +++ b/docs/upgrade-packages.md @@ -21,10 +21,10 @@ Make a full backup (or dump if possible) of your database. Move the database con The following example downloads Percona Server for MySQL {{release}} packages for Debian 11.0: ```shell - wget https://downloads.percona.com/downloads/Percona-Server-innovative-release/Percona-Server-{{release}}/binary/debian/bullseye/x86_64/Percona-Server-{{release}}-r582ebeef-bullseye-x86_64-bundle.tar + wget https://downloads.percona.com/downloads/Percona-Server-{{vers}}/Percona-Server-{{release}}/binary/debian/bullseye/x86_64/Percona-Server-{{release}}-rd76e81f4-bullseye-x86_64-bundle.tar ``` - 4. Unpack the bundle to get the packages: `tar xvf Percona-Server-{{release}}-x86_64-bundle.tar`. + 4. Unpack the bundle to get the packages: `tar xvf Percona-Server-{{release}}-rd76e81f4-bullseye-x86_64-bundle.tar`. After you unpack the bundle, you should see the following packages: @@ -107,13 +107,13 @@ Make a full backup (or dump if possible) of your database. Move the database con 3. Download the packages of the desired series for your architecture from the [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads). The easiest way is to download the bundle which contains all the packages. The following example downloads Percona Server for MySQL {{release}} packages for CentOS 9: ```shell - wget https://downloads.percona.com/downloads/Percona-Server-innovative-release/Percona-Server-{{release}}/binary/redhat/9/x86_64/Percona-Server-{{release}}-r582ebeef-el9-x86_64-bundle.tar + wget https://downloads.percona.com/downloads/Percona-Server-{{vers}}/Percona-Server-{{release}}/binary/redhat/9/aarch64/Percona-Server-{{release}}-rd76e81f4-el9-aarch64-bundle.tar ``` 4. Unpack the bundle to get the packages ```shell - tar xvf Percona-Server-{{release}}-r582ebeef-el9-x86_64-bundle.tar + tar xvf Percona-Server-{{release}}-rd76e81f4-el9-aarch64-bundle.tar ``` After you unpack the bundle, you should see the following packages: `ls \*.rpm` diff --git a/docs/verify-replication.md b/docs/verify-replication.md index 6211bfb2..3e0a2ee7 100644 --- a/docs/verify-replication.md +++ b/docs/verify-replication.md @@ -86,5 +86,5 @@ and adding some records to the table on the first node. for efficient workload management across the cluster without any changes to the applications that generate queries. This is the recommended high-availability solution for Percona XtraDB Cluster. For more information, see [Load balancing with ProxySQL](load-balance-proxysql.md#load-balance-with-proxysql). -* [Percona Monitoring and Management :octicons-link-external-16:](https://www.percona.com/software/database-tools/percona-monitoring-and-management) is the best choice for managing and monitoring Percona XtraDB Cluster performance. +* [Percona Monitoring and Management :octicons-link-external-16:](https://www.percona.com/monitoring/) is the best choice for managing and monitoring Percona XtraDB Cluster performance. It provides visibility for the cluster and enables efficient troubleshooting. \ No newline at end of file diff --git a/docs/xtradb-cluster-version-numbers.md b/docs/xtradb-cluster-version-numbers.md index 43026cb4..0875cd13 100644 --- a/docs/xtradb-cluster-version-numbers.md +++ b/docs/xtradb-cluster-version-numbers.md @@ -1,19 +1,15 @@ # Understand version numbers - +A version number identifies the innovation product release. The product contains the latest features, improvements, and bug fixes at the time of that release. -A version number identifies the product release. The product contains the latest Generally Available (GA) features at the time of that release. +| 9.7.1 | -1 | +|---|---| +| Base version | Minor build version | -| 8.0.20| -11. | 2 | -|---|---|---| -| Base version | Minor build | Custom build | +Percona uses semantic version numbering, which follows the pattern of base version and build version. Percona assigns unique, non-negative integers in increasing order for each version release. The version number combines the base Percona Server for MySQL version number, the minor build version, and the custom build version, if needed. -Percona uses semantic version numbering, which follows the pattern of base version, minor build, and an optional custom build. Percona assigns unique, non-negative integers in increasing order for each minor build release. The version number combines the base Percona Server for MySQL version number, the minor build version, and the custom build version, if needed. +The version numbers for Percona XtraDB Cluster {{release}} define the following information: -The version numbers for Percona XtraDB Cluster 8.0.20-11.2 define the following information: +* Base version - the leftmost numbers indicate [MySQL {{vers}} :octicons-link-external-16:](https://dev.mysql.com/doc/relnotes/mysql/{{vers}}/en/) version used as a base. -* Base version - the leftmost set of numbers that indicate the Percona Server for MySQL version used as a base. An increase in the base version resets the minor build version and the custom build version to 0. - -* Minor build version - an internal number that increases with every Percona XtraDB Cluster release, and the custom build number is reset to 0. - -* Custom build version - an optional number assigned to custom builds used for bug fixes. The features don't change unless the fixes include those features. For example, Percona XtraDB Cluster 8.0.20-11.1, 8.0.20-11.2, and 8.0.20-11.3 are based on the same Percona Server for MySQL version and minor build version but are custom build versions. \ No newline at end of file +* Minor build version - an internal number that increases by one every time Percona XtraDB Cluster is released. \ No newline at end of file diff --git a/docs/yum.md b/docs/yum.md index 897a631d..3f97b89e 100644 --- a/docs/yum.md +++ b/docs/yum.md @@ -11,7 +11,7 @@ You can install Percona XtraDB Cluster with the following methods: * Use the official repository using YUM -* Download and manually install the Percona XtraDB Cluster packages from [Percona Software Downloads :octicons-link-external-16:](http://www.percona.com/downloads/Percona-XtraDB-Cluster-80/LATEST/). +* Download and manually install the Percona XtraDB Cluster packages from [Percona Software Downloads :octicons-link-external-16:](https://www.percona.com/downloads/). * Use the Percona Software repositories diff --git a/mkdocs-base.yml b/mkdocs-base.yml index ad9d86a6..fe5768e6 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -72,12 +72,14 @@ extra_css: - css/nocopy.css - css/mysql.css - css/rating.css + - css/kapa.css extra_javascript: - js/version-select.js - js/promptremover.js - js/consent.js - js/rating.js + - js/kapa.js markdown_extensions: attr_list: {} diff --git a/mkdocs-percona.yml b/mkdocs-percona.yml deleted file mode 100644 index 4ede0fa5..00000000 --- a/mkdocs-percona.yml +++ /dev/null @@ -1,22 +0,0 @@ -# MkDocs configuration for Percona website builds - -INHERIT: mkdocs-base.yml - -site_url: "https://docs.percona.com/percona-xtradb-cluster/9.7/index.html" - -plugins: - bootstrap-tables: {} - -theme: - name: material - custom_dir: _resource/theme - -extra_css: - - css/version-select.css - - css/toctree.css - - css/percona.css - - css/details.css - -extra: # Used in main.html template and can't be externalized - edit_page_text: ' Edit this page' - updated_text: ' Page updated' diff --git a/variables.yml b/variables.yml index 4d2bb757..181db115 100644 --- a/variables.yml +++ b/variables.yml @@ -1,6 +1,6 @@ # variables for HTML output -release: '9.7.0-0' +release: '9.7.1-1' version: '9.7' vers: '9.7' # we are going to use it instead of version pkg: 'pxc-97-lts'