Skip to content

Commit bc24905

Browse files
authored
Merge pull request #56005 from kquinn1204/TELCODOCS-1179
TELCODOCS-1179 fixing BGP communities doc bugs
2 parents a8bc4a0 + 2462c31 commit bc24905

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

modules/nw-metallb-community-cr.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `community` custom resource is a collection of aliases for communities. User
1010

1111
[NOTE]
1212
====
13-
The `community` CRD applies only to BGPAdvertisement.
13+
The `community` CRD applies only to BGPAdvertisement.
1414
====
1515

1616

@@ -33,9 +33,7 @@ Specify the same namespace that the MetalLB Operator uses.
3333

3434
|`spec.communities`
3535
|`string`
36-
|Specifies a list of IP addresses for MetalLB to assign to services.
37-
You can specify multiple ranges in a single pool, they will all share the same settings.
38-
Specify each range in CIDR notation or as starting and ending IP addresses separated with a hyphen.
36+
|Specifies a list of BGP community aliases that can be used in BGPAdvertisements. A community alias consists of a pair of name (alias) and value (number:number). Link the BGPAdvertisement to a community alias by referring to the alias name in its `spec.communities` field.
3937

4038
|===
4139

modules/nw-metallb-configure-community-bgp-advertisement.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ spec:
4343
$ oc apply -f ipaddresspool.yaml
4444
----
4545

46-
. Create a community alias named `community1`.
46+
. Create a community alias named `community1`.
4747
+
4848
[source,yaml]
4949
----
@@ -55,10 +55,10 @@ metadata:
5555
spec:
5656
communities:
5757
- name: NO_ADVERTISE
58-
- value: '65535:65282'
58+
value: '65535:65282'
5959
----
6060

61-
. Create a BGP peer named `doc-example-bgp-peer`.
61+
. Create a BGP peer named `doc-example-bgp-peer`.
6262

6363
.. Create a file, such as `bgppeer.yaml`, with content like the following example:
6464
+
@@ -98,12 +98,14 @@ spec:
9898
aggregationLength: 32
9999
aggregationLengthV6: 128
100100
communities:
101-
- community1
101+
- NO_ADVERTISE <1>
102102
ipAddressPools:
103103
- doc-example-bgp-community
104104
peers:
105105
- doc-example-peer
106106
----
107+
+
108+
<1> Specify the `CommunityAlias.name` here and not the community custom resource (CR) name.
107109

108110
.. Apply the configuration:
109111
+

0 commit comments

Comments
 (0)