@@ -17,91 +17,177 @@ spec:
1717 - name : v1
1818 schema :
1919 openAPIV3Schema :
20+ description : BGPConfiguration contains the configuration for any BGP routing.
2021 properties :
2122 apiVersion :
23+ description : |-
24+ APIVersion defines the versioned schema of this representation of an object.
25+ Servers should convert recognized schemas to the latest internal value, and
26+ may reject unrecognized values.
27+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
2228 type : string
2329 kind :
30+ description : |-
31+ Kind is a string value representing the REST resource this object represents.
32+ Servers may infer this from the endpoint the client submits requests to.
33+ Cannot be updated.
34+ In CamelCase.
35+ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2436 type : string
2537 metadata :
2638 type : object
2739 spec :
40+ description : BGPConfigurationSpec contains the values of the BGP configuration.
2841 properties :
2942 asNumber :
43+ description : ' ASNumber is the default AS number used by a node. [Default:
44+ 64512]'
3045 format : int32
3146 type : integer
3247 bindMode :
48+ description : |-
49+ BindMode indicates whether to listen for BGP connections on all addresses (None)
50+ or only on the node's canonical IP address Node.Spec.BGP.IPvXAddress (NodeIP).
51+ Default behaviour is to listen for BGP connections on all addresses.
3352 type : string
3453 communities :
54+ description : Communities is a list of BGP community values and their
55+ arbitrary names for tagging routes.
3556 items :
57+ description : Community contains standard or large community value
58+ and its name.
3659 properties :
3760 name :
61+ description : Name given to community value.
3862 type : string
3963 value :
64+ description : |-
65+ Value must be of format `aa:nn` or `aa:nn:mm`.
66+ For standard community use `aa:nn` format, where `aa` and `nn` are 16 bit number.
67+ For large community use `aa:nn:mm` format, where `aa`, `nn` and `mm` are 32 bit number.
68+ Where, `aa` is an AS Number, `nn` and `mm` are per-AS identifier.
4069 pattern : ^(\d+):(\d+)$|^(\d+):(\d+):(\d+)$
4170 type : string
4271 type : object
4372 type : array
4473 ignoredInterfaces :
74+ description : IgnoredInterfaces indicates the network interfaces that
75+ needs to be excluded when reading device routes.
4576 items :
4677 type : string
4778 type : array
4879 listenPort :
80+ description : ListenPort is the port where BGP protocol should listen.
81+ Defaults to 179
4982 maximum : 65535
5083 minimum : 1
5184 type : integer
5285 localWorkloadPeeringIPV4 :
86+ description : |-
87+ The virtual IPv4 address of the node with which its local workload is expected to peer.
88+ It is recommended to use a link-local address.
5389 type : string
5490 localWorkloadPeeringIPV6 :
91+ description : |-
92+ The virtual IPv6 address of the node with which its local workload is expected to peer.
93+ It is recommended to use a link-local address.
5594 type : string
5695 logSeverityScreen :
96+ description : ' LogSeverityScreen is the log severity above which logs
97+ are sent to the stdout. [Default: INFO]'
5798 type : string
5899 nodeMeshMaxRestartTime :
100+ description : |-
101+ Time to allow for software restart for node-to-mesh peerings. When specified, this is configured
102+ as the graceful restart timeout. When not specified, the BIRD default of 120s is used.
103+ This field can only be set on the default BGPConfiguration instance and requires that NodeMesh is enabled
59104 type : string
60105 nodeMeshPassword :
106+ description : |-
107+ Optional BGP password for full node-to-mesh peerings.
108+ This field can only be set on the default BGPConfiguration instance and requires that NodeMesh is enabled
61109 properties :
62110 secretKeyRef :
111+ description : Selects a key of a secret in the node pod's namespace.
63112 properties :
64113 key :
114+ description : The key of the secret to select from. Must be
115+ a valid secret key.
65116 type : string
66117 name :
67118 default : " "
119+ description : |-
120+ Name of the referent.
121+ This field is effectively required, but due to backwards compatibility is
122+ allowed to be empty. Instances of this type with an empty value here are
123+ almost certainly wrong.
124+ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
68125 type : string
69126 optional :
127+ description : Specify whether the Secret or its key must be
128+ defined
70129 type : boolean
71130 required :
72131 - key
73132 type : object
74133 x-kubernetes-map-type : atomic
75134 type : object
76135 nodeToNodeMeshEnabled :
136+ description : ' NodeToNodeMeshEnabled sets whether full node to node
137+ BGP mesh is enabled. [Default: true]'
77138 type : boolean
78139 prefixAdvertisements :
140+ description : PrefixAdvertisements contains per-prefix advertisement
141+ configuration.
79142 items :
143+ description : PrefixAdvertisement configures advertisement properties
144+ for the specified CIDR.
80145 properties :
81146 cidr :
147+ description : CIDR for which properties should be advertised.
82148 type : string
83149 communities :
150+ description : |-
151+ Communities can be list of either community names already defined in `Specs.Communities` or community value of format `aa:nn` or `aa:nn:mm`.
152+ For standard community use `aa:nn` format, where `aa` and `nn` are 16 bit number.
153+ For large community use `aa:nn:mm` format, where `aa`, `nn` and `mm` are 32 bit number.
154+ Where,`aa` is an AS Number, `nn` and `mm` are per-AS identifier.
84155 items :
85156 type : string
86157 type : array
87158 type : object
88159 type : array
89160 serviceClusterIPs :
161+ description : |-
162+ ServiceClusterIPs are the CIDR blocks from which service cluster IPs are allocated.
163+ If specified, Calico will advertise these blocks, as well as any cluster IPs within them.
90164 items :
165+ description : ServiceClusterIPBlock represents a single allowed ClusterIP
166+ CIDR block.
91167 properties :
92168 cidr :
93169 type : string
94170 type : object
95171 type : array
96172 serviceExternalIPs :
173+ description : |-
174+ ServiceExternalIPs are the CIDR blocks for Kubernetes Service External IPs.
175+ Kubernetes Service ExternalIPs will only be advertised if they are within one of these blocks.
97176 items :
177+ description : ServiceExternalIPBlock represents a single allowed
178+ External IP CIDR block.
98179 properties :
99180 cidr :
100181 type : string
101182 type : object
102183 type : array
103184 serviceLoadBalancerIPs :
185+ description : |-
186+ ServiceLoadBalancerIPs are the CIDR blocks for Kubernetes Service LoadBalancer IPs.
187+ Kubernetes Service status.LoadBalancer.Ingress IPs will only be advertised if they are within one of these blocks.
104188 items :
189+ description : ServiceLoadBalancerIPBlock represents a single allowed
190+ LoadBalancer IP CIDR block.
105191 properties :
106192 cidr :
107193 type : string
0 commit comments