// Module included in the following assemblies:
//
// * networking/metallb/metallb-configure-community-alias.adoc

:_mod-docs-content-type: REFERENCE
[id="nw-metallb-community-cr_{context}"]
= About the community custom resource

[role="_abstract"]
To simplify BGP configuration, define named aliases for community values by using the community custom resource. You can reference these aliases when advertising `ipAddressPools` with the `BGPAdvertisement` resource.

The fields for the `community` custom resource are described in the following table.

[NOTE]
====
The `community` CRD applies only to BGPAdvertisement.
====

.MetalLB community custom resource
[cols="1,1,3a", options="header"]
|===

|Field
|Type
|Description

|`metadata.name`
|`string`
|Specifies the name for the `community`.

|`metadata.namespace`
|`string`
|Specifies the namespace for the `community`.
Specify the same namespace that the MetalLB Operator uses.

|`spec.communities`
|`string`
|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.

|===

.CommunityAlias
[cols="1,1,3a", options="header"]
|===

|Field
|Type
|Description

|`name`
|`string`
|The name of the alias for the `community`.

|`value`
|`string`
|The BGP `community` value corresponding to the given name.
|===