projectcalico.org_bgpconfigurations.yaml

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.18.0
  name: bgpconfigurations.projectcalico.org
spec:
  group: projectcalico.org
  names:
    kind: BGPConfiguration
    listKind: BGPConfigurationList
    plural: bgpconfigurations
    shortNames:
      - bgpconfig
      - bgpconfigs
    singular: bgpconfiguration
  preserveUnknownFields: false
  scope: Cluster
  versions:
    - name: v3
      schema:
        openAPIV3Schema:
          properties:
            apiVersion:
              description: |-
                APIVersion defines the versioned schema of this representation of an object.
                Servers should convert recognized schemas to the latest internal value, and
                may reject unrecognized values.
                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
              type: string
            kind:
              description: |-
                Kind is a string value representing the REST resource this object represents.
                Servers may infer this from the endpoint the client submits requests to.
                Cannot be updated.
                In CamelCase.
                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
              type: string
            metadata:
              type: object
            spec:
              description: BGPConfigurationSpec contains the values of the BGP configuration.
              properties:
                asNumber:
                  description:
                    "ASNumber is the default AS number used by a node. [Default:
                    64512]"
                  format: int32
                  type: integer
                bindMode:
                  description: |-
                    BindMode indicates whether to listen for BGP connections on all addresses (None)
                    or only on the node's canonical IP address Node.Spec.BGP.IPvXAddress (NodeIP).
                    Default behaviour is to listen for BGP connections on all addresses.
                  enum:
                    - None
                    - NodeIP
                  type: string
                communities:
                  description:
                    Communities is a list of BGP community values and their
                    arbitrary names for tagging routes.
                  items:
                    description:
                      Community contains standard or large community value
                      and its name.
                    properties:
                      name:
                        description: Name given to community value.
                        maxLength: 253
                        type: string
                      value:
                        description: |-
                          Value must be of format `aa:nn` or `aa:nn:mm`.
                          For standard community use `aa:nn` format, where `aa` and `nn` are 16 bit number.
                          For large community use `aa:nn:mm` format, where `aa`, `nn` and `mm` are 32 bit number.
                          Where, `aa` is an AS Number, `nn` and `mm` are per-AS identifier.
                        maxLength: 40
                        pattern: ^(\d+):(\d+)$|^(\d+):(\d+):(\d+)$
                        type: string
                    type: object
                    x-kubernetes-map-type: atomic
                  maxItems: 500
                  type: array
                  x-kubernetes-list-type: set
                extensions:
                  additionalProperties:
                    type: string
                  description:
                    Extensions is a mapping of keys to values that can be
                    used in custom BGP templates
                  type: object
                ignoredInterfaces:
                  description:
                    IgnoredInterfaces indicates the network interfaces that
                    needs to be excluded when reading device routes.
                  items:
                    type: string
                  type: array
                  x-kubernetes-list-type: set
                ipv4NormalRoutePriority:
                  description: |-
                    IPv4NormalRoutePriority is the normal route priority (metric) that Felix uses for IPv4
                    workload routes. This must match the value configured in FelixConfiguration. BIRD uses
                    this to identify elevated-priority routes during live migration and to override local
                    workload routes with higher-priority BGP-learned routes. [Default: 1024]
                  maximum: 2147483646
                  minimum: 1
                  type: integer
                ipv6NormalRoutePriority:
                  description: |-
                    IPv6NormalRoutePriority is the normal route priority (metric) that Felix uses for IPv6
                    workload routes. This must match the value configured in FelixConfiguration. BIRD uses
                    this to identify elevated-priority routes during live migration and to override local
                    workload routes with higher-priority BGP-learned routes. [Default: 1024]
                  maximum: 2147483646
                  minimum: 1
                  type: integer
                listenPort:
                  description:
                    ListenPort is the port where BGP protocol should listen.
                    Defaults to 179
                  maximum: 65535
                  minimum: 1
                  type: integer
                localWorkloadPeeringIPV4:
                  description: |-
                    The virtual IPv4 address of the node with which its local workload is expected to peer.
                    It is recommended to use a link-local address.
                  type: string
                localWorkloadPeeringIPV6:
                  description: |-
                    The virtual IPv6 address of the node with which its local workload is expected to peer.
                    It is recommended to use a link-local address.
                  type: string
                logSeverityScreen:
                  default: Info
                  description:
                    "LogSeverityScreen is the log severity above which logs
                    are sent to the stdout. [Default: Info]"
                  pattern: ^(?i)(Trace|Debug|Info|Warning|Error|Fatal)?$
                  type: string
                nodeMeshMaxRestartTime:
                  description: |-
                    Time to allow for software restart for node-to-mesh peerings.  When specified, this is configured
                    as the graceful restart timeout.  When not specified, the BIRD default of 120s is used.
                    This field can only be set on the default BGPConfiguration instance and requires that NodeMesh is enabled
                  type: string
                nodeMeshPassword:
                  description: |-
                    Optional BGP password for full node-to-mesh peerings.
                    This field can only be set on the default BGPConfiguration instance and requires that NodeMesh is enabled
                  properties:
                    secretKeyRef:
                      description: Selects a key of a secret in the node pod's namespace.
                      properties:
                        key:
                          description:
                            The key of the secret to select from.  Must be
                            a valid secret key.
                          type: string
                        name:
                          default: ""
                          description: |-
                            Name of the referent.
                            This field is effectively required, but due to backwards compatibility is
                            allowed to be empty. Instances of this type with an empty value here are
                            almost certainly wrong.
                            More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                          type: string
                        optional:
                          description:
                            Specify whether the Secret or its key must be
                            defined
                          type: boolean
                      required:
                        - key
                      type: object
                      x-kubernetes-map-type: atomic
                  type: object
                nodeToNodeMeshEnabled:
                  description:
                    "NodeToNodeMeshEnabled sets whether full node to node
                    BGP mesh is enabled. [Default: true]"
                  type: boolean
                prefixAdvertisements:
                  description:
                    PrefixAdvertisements contains per-prefix advertisement
                    configuration.
                  items:
                    description:
                      PrefixAdvertisement configures advertisement properties
                      for the specified CIDR.
                    properties:
                      cidr:
                        description: CIDR for which properties should be advertised.
                        format: cidr
                        type: string
                      communities:
                        description: |-
                          Communities can be list of either community names already defined in `Specs.Communities` or community value of format `aa:nn` or `aa:nn:mm`.
                          For standard community use `aa:nn` format, where `aa` and `nn` are 16 bit number.
                          For large community use `aa:nn:mm` format, where `aa`, `nn` and `mm` are 32 bit number.
                          Where,`aa` is an AS Number, `nn` and `mm` are per-AS identifier.
                        items:
                          type: string
                        maxItems: 50
                        type: array
                        x-kubernetes-list-type: atomic
                    type: object
                    x-kubernetes-map-type: atomic
                  maxItems: 500
                  type: array
                  x-kubernetes-list-type: set
                programClusterRoutes:
                  description: |-
                    ProgramClusterRoutes controls how a cluster node gets a route to a workload on another node,
                    when that workload's IP comes from an IP Pool with vxlanMode: Never. When ProgramClusterRoutes is Enabled,
                    confd and BIRD program that route. When ProgramClusterRoutes is Disabled, it is expected that Felix will program that route.
                    Felix always programs such routes for IP Pools with vxlanMode: Always or vxlanMode: CrossSubnet. [Default: Enabled]
                  enum:
                    - Enabled
                    - Disabled
                  type: string
                serviceClusterIPs:
                  description: |-
                    ServiceClusterIPs are the CIDR blocks from which service cluster IPs are allocated.
                    If specified, Calico will advertise these blocks, as well as any cluster IPs within them.
                  items:
                    description:
                      ServiceClusterIPBlock represents a single allowed ClusterIP
                      CIDR block.
                    properties:
                      cidr:
                        format: cidr
                        type: string
                    type: object
                    x-kubernetes-map-type: atomic
                  type: array
                  x-kubernetes-list-type: set
                serviceExternalIPs:
                  description: |-
                    ServiceExternalIPs are the CIDR blocks for Kubernetes Service External IPs.
                    Kubernetes Service ExternalIPs will only be advertised if they are within one of these blocks.
                  items:
                    description:
                      ServiceExternalIPBlock represents a single allowed
                      External IP CIDR block.
                    properties:
                      cidr:
                        format: cidr
                        type: string
                    type: object
                    x-kubernetes-map-type: atomic
                  type: array
                  x-kubernetes-list-type: set
                serviceLoadBalancerAggregation:
                  default: Enabled
                  description: |-
                    ServiceLoadBalancerAggregation controls how LoadBalancer service IPs are advertised.
                    When set to "Disabled", individual /32 routes are advertised for each service instead of
                    the full CIDR range. This is useful for anycast failover mechanisms where failed service
                    routes need to be withdrawn. [Default: Enabled]
                  enum:
                    - Enabled
                    - Disabled
                  type: string
                serviceLoadBalancerIPs:
                  description: |-
                    ServiceLoadBalancerIPs are the CIDR blocks for Kubernetes Service LoadBalancer IPs.
                    Kubernetes Service status.LoadBalancer.Ingress IPs will only be advertised if they are within one of these blocks.
                  items:
                    description:
                      ServiceLoadBalancerIPBlock represents a single allowed
                      LoadBalancer IP CIDR block.
                    properties:
                      cidr:
                        format: cidr
                        type: string
                    type: object
                    x-kubernetes-map-type: atomic
                  type: array
                  x-kubernetes-list-type: set
              type: object
              x-kubernetes-validations:
                - message:
                    nodeMeshPassword cannot be set when nodeToNodeMeshEnabled is
                    false
                  reason: FieldValueForbidden
                  rule:
                    "!has(self.nodeMeshPassword) || !has(self.nodeToNodeMeshEnabled)
                    || self.nodeToNodeMeshEnabled == true"
                - message:
                    nodeMeshMaxRestartTime cannot be set when nodeToNodeMeshEnabled
                    is false
                  reason: FieldValueForbidden
                  rule:
                    "!has(self.nodeMeshMaxRestartTime) || !has(self.nodeToNodeMeshEnabled)
                    || self.nodeToNodeMeshEnabled == true"
                - message: communities are defined but not used in prefixAdvertisements
                  reason: FieldValueInvalid
                  rule:
                    "!has(self.communities) || size(self.communities) == 0 || (has(self.prefixAdvertisements)
                    && size(self.prefixAdvertisements) > 0)"
          required:
            - metadata
            - spec
          type: object
      served: true
      storage: true