docs: Add missing dsrDispatch parameter to annotation-based DSR examples #40873
Conversation
|
Commits addf948, 6f43162 do not match "(?m)^Signed-off-by:". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
|
Thanks! Can you please rebase your branch on the current |
|
hi @qmonnet I have rebased the MR could you review it now!! |
There was a problem hiding this comment.
Thanks!
Can we reorganise it a little, please? You inserted the note right between the paragraph that introduces the example (ending with a colon), and the example itself. I note that you also have the new example helm command outside of the note: it should probably be inside of it? I'm thinking something like this:
... would look as follows:
.. parsed-literal::
helm... (example with geneve)
.. note::
When using annotation-based DSR mode (...) as in the previous example, you must explicitly... Valid options are... For example, for environments where Geneve... can be used instead:
.. parsed-literal:: # note the indent, to move it inside the note
helm ... (example with ipip)Or even without the second example. I think you already make it explicit what the valid options are, if we mention that IPIP can be used, we probably don't need the full snippet again, users should be able to replace geneve with ipip without difficulties.
|
hey @qmonnet i have reorganized the codeblocks PTAL! 🙇 |
|
@qmonnet i have squashed the commits! Thankyou for your review!! |
This updates the documentation for annotation-based DSR, clarifying the required dsrDispatch parameter and providing examples for different dispatch methods. Fixes: cilium#37659 Signed-off-by: Aryan Jain <aryan.jain.csbs22@ggits.net>
|
@qmonnet PTAL! |
|
/test |
|
@qmonnet thanks 🙏🙏, can you please suggest me some issue related to LFX project. |
|
@gitsofaryan there aren't any LFX related issues. The mentee is chosen only based on their application. |
|
Thanks @xmulligan 🙏, so is their any process or learning to how to make your application selected? |
|
@gitsofaryan write a great cover letter and don't use AI |
|
it is planned to backport to stable branch ? |
I've marked for backports. |
Fixes: #37659
cc : @xmulligan @pchaigno
Description
This pull request updates the documentation for configuring a kube-proxy-free environment with DSR (Direct Server Return) enabled in annotation mode. The changes clarify the required parameters and provide examples for different DSR dispatch methods.
Problem
Users following the annotation-based DSR documentation encounter validation errors because the required
dsrDispatchparameter is missing from examples. Whenbpf.lbModeAnnotation=trueis set without explicitly specifyingloadBalancer.dsrDispatch, Cilium fails to start with: Invalid value for --bpf-lb-dsr-dispatch: optSolution
bpf.lbModeAnnotation=true), theloadBalancer.dsrDispatchparameter must be explicitly definedloadBalancer.dsrDispatch=geneveparameteropt,ipip,geneve) work with annotation modeChanges Made
Documentation/network/kubernetes/kubeproxy-free.rstin the "Annotation-based DSR and SNAT Mode" section