Add document for Service of type LoadBalancer #3322
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #3322 +/- ##
===========================================
- Coverage 60.95% 41.83% -19.12%
===========================================
Files 266 201 -65
Lines 26508 24142 -2366
===========================================
- Hits 16159 10101 -6058
- Misses 8597 12991 +4394
+ Partials 1752 1050 -702
Flags with carried forward coverage won't be shown. Click here to find out more.
|
jianjuns
requested review from
antoninbas,
tnqn,
jianjuns,
xliuxu and
hongliangl
jianjuns
added
the
kind/documentation
antoninbas
reviewed
Feb 17, 2022
There was a problem hiding this comment.
We should add a link to this document to https://github.com/antrea-io/antrea/blob/main/docs/feature-gates.md#serviceexternalip, like we did for other features.
xliuxu
reviewed
Feb 18, 2022
hongliangl
reviewed
Feb 18, 2022
hty690
force-pushed
the
service_lb_doc
branch
2 times, most recently
from
2693a7f to
d3f2990
Compare
xliuxu
reviewed
Feb 18, 2022
hty690
force-pushed
the
service_lb_doc
branch
2 times, most recently
from
0e51287 to
a238e46
Compare
|
Thanks for the review. I have addressed most of the comments. Please take another look. |
tnqn
reviewed
Feb 18, 2022
| Node network. The simplest way to achieve this is to reserve a range of IPs | ||
| from the Node network subnet, and define Service ExternalIPPools with the | ||
| reserved IPs, when the Nodes are connected to a layer 2 subnet. Or, another | ||
| possible way might be to manually configure Node network routing (e.g. by |
There was a problem hiding this comment.
I feel that way is not very convenient, even theoretically work. So, "might be" should be good.
hty690
force-pushed
the
service_lb_doc
branch
4 times, most recently
from
0c0e740 to
aa6fbb4
Compare
antoninbas
previously approved these changes
Feb 22, 2022
docs/service-loadbalancer.md
Outdated
| configures the cloud load balancers for the Services. However, the load | ||
| balancer support is not available on all platforms, or in some cases, it is | ||
| complex or has extra cost to deploy external load balancers. This document | ||
| describes two options of supporting Services of type LoadBalancer with Antrea, |
There was a problem hiding this comment.
s/of supporting/for supporting
docs/service-loadbalancer.md
Outdated
| #### Create an ExternalIPPool custom resource | ||
|
|
||
| Service external IPs are allocated from an ExternalIPPool, which defines a pool | ||
| of external IPs and the set of nodes to which the external IPs can be assigned. |
There was a problem hiding this comment.
s/nodes/Nodes for consistency
docs/service-loadbalancer.md
Outdated
Comment on lines
106
to
108
| For Antrea to manage the externalIP for a Service of type LoadBalancer, the | ||
| Service should be created with the `service.antrea.io/external-ip-pool` | ||
| annotation. For example: |
There was a problem hiding this comment.
does it work if the Service is created first without the annotation and then updated to include the correct annotation?
if yes, maybe rephrase to: ..., the Service should be annotated with service.antrea.io/external-ip-pool.
docs/service-loadbalancer.md
Outdated
|
|
||
| The BGP mode of MetalLB requires more configuration parameters to establish BGP | ||
| peering to the router. The example below configures MetalLB using AS number | ||
| 64500 to peer router 10.0.0.1 with AS number 64501: |
There was a problem hiding this comment.
should it be "to peer with router"?
There was a problem hiding this comment.
how about "connected to peer router"?
There was a problem hiding this comment.
Maybe: "connect to peer router"
hty690
force-pushed
the
service_lb_doc
branch
from
aa6fbb4 to
a45860d
Compare
jianjuns
reviewed
Feb 23, 2022
hty690
force-pushed
the
service_lb_doc
branch
from
a45860d to
8f91781
Compare
jianjuns
reviewed
Feb 24, 2022
docs/service-loadbalancer.md
Outdated
| - [Create a Service of type LoadBalancer](#create-a-service-of-type-loadbalancer) | ||
| - [Validate Service external IP](#validate-service-external-ip) | ||
| - [Limitations](#limitations) | ||
| - [Using MetalLB with Antrea](#using-metalb-with-antrea) |
There was a problem hiding this comment.
Missed a 'l' in "metallb" in "using-metalb-with-antrea"
hty690
force-pushed
the
service_lb_doc
branch
from
8f91781 to
75f1fa1
Compare
jianjuns
reviewed
Feb 24, 2022
hty690
force-pushed
the
service_lb_doc
branch
from
75f1fa1 to
4e0e6c4
Compare
Signed-off-by: Tianyi Huang <hty690@126.com>
hty690
force-pushed
the
service_lb_doc
branch
from
4e0e6c4 to
070fcef
Compare
jianjuns
approved these changes
Feb 24, 2022
|
/skip-all |
bangqipropel
pushed a commit
to bangqipropel/antrea
that referenced
this pull request
Mar 2, 2022
Signed-off-by: Tianyi Huang <hty690@126.com>
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.
Signed-off-by: Tianyi Huang hty690@126.com
Closes #2020