K8SPXC-735 Documented new ProxySQL scheduler options and behavior #272
+276
−213
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…operator and configuration files. Added details on enabling the scheduler, its impact on load balancing, and configuration examples for better clarity.
modified: docs/operator.md
modified: docs/proxysql-conf.md
nastena1606
requested review from
egegunes,
eleo007,
gkech,
hors,
jvpasinatto,
nmarukovich,
pooknull and
valmiranogueira
as code owners
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the new ProxySQL scheduler feature introduced in Operator version 1.19.0. The scheduler provides better read/write splitting and load balancing across Percona XtraDB Cluster nodes.
Key Changes:
- Documents the
pxc_scheduler_handlerintegration and its benefits for load balancing - Adds configuration examples and behavioral details for the ProxySQL scheduler
- Includes new Custom Resource options for scheduler configuration
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/proxysql-conf.md | Added ProxySQL scheduler section with enablement instructions, behavior documentation, and general content improvements for clarity |
| docs/operator.md | Added documentation for seven new scheduler-related Custom Resource options (enabled, writerIsAlsoReader, checkTimeoutMilliseconds, etc.) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
it-percona
temporarily deployed
to
K8SPXC-735-Doc-ProxySQL-scheduler - percona-mysql-operator-pxc PR #272
Render
Destroyed
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
egegunes
requested changes
Nov 28, 2025
docs/proxysql-conf.md
Outdated
|
|
||
| You can enable ProxySQL only when you create a cluster. For a running cluster you can enable only HAProxy. Also note, if you have already enabled HAProxy, the switch from it to ProxySQL is not | ||
| possible. | ||
| You can enable ProxySQL only during cluster creation. For existing clusters, you can enable only HAProxy. If HAProxy is already enabled, you cannot switch to ProxySQL later. |
Contributor
There was a problem hiding this comment.
i think we can remove this warning now, right @gkech ?
docs/proxysql-conf.md
Outdated
| You may want to configure the ProxySQL service as a [headless Service :octicons-link-external-16:](https://kubernetes.io/docs/concepts/services-networking/service/#headless-services). For example, if you have applications that need direct DNS access to individual ProxySQL pods, such as when running in a multi-tenant setup or when handling advanced networking scenarios. | ||
|
|
||
| This annotation works only at service creation time and can't be added later. | ||
| To enable a headless ProxySQL service, add the `percona.com/headless-service: true` [annotation](annotations.md) in the Custom Resource metadata section of the `deploy/cr.yaml` file. Note that this annotation takes effect only at service creation time, so you need to set it when first creating the cluster. |
Contributor
There was a problem hiding this comment.
this is wrong. this annotation needs to be added into either proxysql.expose.annotations, haproxy.exposePrimary.annotations or haproxy.exposeReplicas.annotations.
nastena1606
force-pushed
the
K8SPXC-735-Doc-ProxySQL-scheduler
branch
from
deeb1df to
84ccf9e
Compare
egegunes
reviewed
Dec 1, 2025
docs/haproxy-conf.md
Outdated
Comment on lines
24
to
25
| Switching from ProxySQL to HAProxy will cause Percona XtraDB Cluster Pods | ||
| restart. Switching from HAProxy to ProxySQL is not possible, and if you need | ||
| ProxySQL, this should be configured at cluster creation time. | ||
| restart. |
Contributor
There was a problem hiding this comment.
@gkech is this true? i mean does switching proxies require PXC pods to restart?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added details on enabling the scheduler, its impact on load balancing, and configuration examples for better clarity.
modified: docs/operator.md
modified: docs/proxysql-conf.md