Documentation ¶
Index ¶
- Constants
- func OwnerLabels(contour *Contour) map[string]string
- func OwningSelector(contour *Contour) *metav1.LabelSelector
- type AWSLoadBalancerParameters
- type AWSLoadBalancerType
- type AzureLoadBalancerParameters
- type Config
- type ContainerPort
- type Contour
- func (c *Contour) ComponentLabels() map[string]string
- func (c *Contour) ContourCertsSecretName() string
- func (c *Contour) ContourConfigurationName() string
- func (c *Contour) ContourDeploymentName() string
- func (c *Contour) ContourNodeSelectorExists() bool
- func (c *Contour) ContourRBACNames() RBACNames
- func (c *Contour) ContourServiceName() string
- func (c *Contour) ContourTolerationsExist() bool
- func (c *Contour) EnvoyCertsSecretName() string
- func (c *Contour) EnvoyDataPlaneName() string
- func (c *Contour) EnvoyNodeSelectorExists() bool
- func (c *Contour) EnvoyRBACNames() RBACNames
- func (c *Contour) EnvoyServiceName() string
- func (c *Contour) EnvoyTolerationsExist() bool
- func (c *Contour) LeaderElectionLeaseName() string
- type ContourNodePlacement
- type ContourSpec
- type EnvoyNetworkPublishing
- type EnvoyNodePlacement
- type GCPLoadBalancerParameters
- type LoadBalancerProviderType
- type LoadBalancerScope
- type LoadBalancerStrategy
- type NamespaceSpec
- type NetworkPublishing
- type NetworkPublishingType
- type NodePlacement
- type NodePort
- type ProviderLoadBalancerParameters
- type RBACNames
- type ServicePort
- type WorkloadType
Constants ¶
const ( // A Kubernetes DaemonSet. WorkloadTypeDaemonSet = contourv1alpha1.WorkloadTypeDaemonSet // A Kubernetes Deployment. WorkloadTypeDeployment = contourv1alpha1.WorkloadTypeDeployment )
const ( // ContourAvailableConditionType indicates that the contour is running // and available. ContourAvailableConditionType = "Available" )
const ( // OwningGatewayNameLabel is the owner reference label used for a Contour // created by the gateway provisioner. The value should be the name of the Gateway. OwningGatewayNameLabel = "projectcontour.io/owning-gateway-name" )
Variables ¶
This section is empty.
Functions ¶
func OwnerLabels ¶
OwnerLabels returns owner labels for the provided contour.
func OwningSelector ¶
func OwningSelector(contour *Contour) *metav1.LabelSelector
OwningSelector returns a label selector using "projectcontour.io/owning-gateway-name".
Types ¶
type AWSLoadBalancerParameters ¶
type AWSLoadBalancerParameters struct { // Type is the type of AWS load balancer to manage. // // Valid values are: // // * "Classic": A Classic load balancer makes routing decisions at either the // transport layer (TCP/SSL) or the application layer (HTTP/HTTPS). See // the following for additional details: // // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb // // * "NLB": A Network load balancer makes routing decisions at the transport // layer (TCP/SSL). See the following for additional details: // // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb // // If unset, defaults to "Classic". // // +kubebuilder:default=Classic Type AWSLoadBalancerType `json:"type,omitempty"` // AllocationIDs is a list of Allocation IDs of Elastic IP addresses that are // to be assigned to the Network Load Balancer. Works only with type NLB. // If you are using Amazon EKS 1.16 or later, you can assign Elastic IP addresses // to Network Load Balancer with AllocationIDs. The number of Allocation IDs // must match the number of subnets used for the load balancer. // // Example: "eipalloc-<xxxxxxxxxxxxxxxxx>" // // See: https://docs.aws.amazon.com/eks/latest/userguide/load-balancing.html // // +optional AllocationIDs []string `json:"allocationIds,omitempty"` }
AWSLoadBalancerParameters provides configuration settings that are specific to AWS load balancers.
type AWSLoadBalancerType ¶
type AWSLoadBalancerType string
AWSLoadBalancerType is the type of AWS load balancer to manage. +kubebuilder:validation:Enum=Classic;NLB
const ( AWSClassicLoadBalancer AWSLoadBalancerType = "Classic" AWSNetworkLoadBalancer AWSLoadBalancerType = "NLB" )
type AzureLoadBalancerParameters ¶
type AzureLoadBalancerParameters struct { // Address is the desired load balancer IP address. If scope is "Internal", address // must reside in same virtual network as AKS and must not already be assigned // to a resource. If address does not reside in same subnet as AKS, the subnet // parameter is also required. // // Address must already exist (e.g. `az network public-ip create`). // // See: // https://docs.microsoft.com/en-us/azure/aks/static-ip#create-a-service-using-the-static-ip-address // https://docs.microsoft.com/en-us/azure/aks/internal-lb#specify-an-ip-address // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 // +optional Address *string `json:"address,omitempty"` // ResourceGroup is the resource group name where the "address" resides. Relevant // only if scope is "External". // // Omit if desired IP is created in same resource group as AKS cluster. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=90 // +optional ResourceGroup *string `json:"resourceGroup,omitempty"` // Subnet is the subnet name where the "address" resides. Relevant only // if scope is "Internal" and desired IP does not reside in same subnet as AKS. // // Omit if desired IP is in same subnet as AKS cluster. // // See: https://docs.microsoft.com/en-us/azure/aks/internal-lb#specify-an-ip-address // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=80 // +optional Subnet *string `json:"subnet,omitempty"` }
type Config ¶
type Config struct { Name string Namespace string Replicas int32 NetworkType NetworkPublishingType NodePorts []NodePort GatewayControllerName *string EnableExternalNameService *bool }
Config is the configuration of a Contour.
type ContainerPort ¶
type ContainerPort struct { // Name is an IANA_SVC_NAME within the pod. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 Name string `json:"name"` // PortNumber is the network port number to expose on the envoy pod. // The number must be greater than 0 and less than 65536. // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 PortNumber int32 `json:"portNumber"` }
ContainerPort is the schema to specify a network port for a container. A container port gives the system additional information about network connections a container uses, but is primarily informational.
type Contour ¶
type Contour struct { metav1.ObjectMeta `json:"metadata,omitempty"` // Spec defines the desired state of Contour. Spec ContourSpec `json:"spec,omitempty"` }
Contour is the representation of an instance of Contour + Envoy.
func New ¶
New makes a Contour object using the provided ns/name for the object's namespace/name, pubType for the network publishing type of Envoy, and Envoy container ports 8080/8443.
func (*Contour) ComponentLabels ¶ added in v1.22.0
ComponentLabels returns labels for a Contour component.
func (*Contour) ContourCertsSecretName ¶
ContourCertsSecretName returns the name of the Contour xDS TLS certs Secret resource.
func (*Contour) ContourConfigurationName ¶
ContourConfigurationName returns the name of the ContourConfiguration resource.
func (*Contour) ContourDeploymentName ¶
ContourDeploymentName returns the name of the Contour Deployment resource.
func (*Contour) ContourNodeSelectorExists ¶
ContourNodeSelectorExists returns true if a nodeSelector is specified for Contour.
func (*Contour) ContourRBACNames ¶
ContourRBACNames returns the names of the RBAC resources for the Contour deployment.
func (*Contour) ContourServiceName ¶
ContourServiceName returns the name of the Contour Service resource.
func (*Contour) ContourTolerationsExist ¶
ContourTolerationsExist returns true if tolerations are set for Contour.
func (*Contour) EnvoyCertsSecretName ¶
EnvoyCertsSecretName returns the name of the Envoy xDS TLS certs Secret resource.
func (*Contour) EnvoyDataPlaneName ¶
EnvoyDataPlaneName returns the name of the Envoy data plane (DaemonSet or Deployment) resource.
func (*Contour) EnvoyNodeSelectorExists ¶
EnvoyNodeSelectorExists returns true if a nodeSelector is specified for Envoy.
func (*Contour) EnvoyRBACNames ¶
EnvoyRBACNames returns the names of the RBAC resources for the Envoy daemonset.
func (*Contour) EnvoyServiceName ¶
EnvoyServiceName returns the name of the Envoy Service resource.
func (*Contour) EnvoyTolerationsExist ¶
EnvoyTolerationsExist returns true if tolerations are set for Envoy.
func (*Contour) LeaderElectionLeaseName ¶
LeaderElectionLeaseName returns the name of the Contour leader election Lease resource.
type ContourNodePlacement ¶
type ContourNodePlacement struct { // NodeSelector is the simplest recommended form of node selection constraint // and specifies a map of key-value pairs. For the Contour pod to be eligible // to run on a node, the node must have each of the indicated key-value pairs // as labels (it can have additional labels as well). // // If unset, the Contour pod(s) will be scheduled to any available node. // // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // Tolerations work with taints to ensure that Envoy pods are not scheduled // onto inappropriate nodes. One or more taints are applied to a node; this // marks that the node should not accept any pods that do not tolerate the // taints. // // The default is an empty list. // // See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ // for additional details. // // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` }
ContourNodePlacement describes node scheduling configuration for Contour pods. If nodeSelector and tolerations are specified, the scheduler will use both to determine where to place the Contour pod(s).
type ContourSpec ¶
type ContourSpec struct { // ContourReplicas is the desired number of Contour replicas. If unset, // defaults to 2. ContourReplicas int32 // EnvoyReplicas is the desired number of Envoy replicas. If WorkloadType // is not "Deployment", this field is ignored. Otherwise, if unset, // defaults to 2. EnvoyReplicas int32 // NetworkPublishing defines the schema for publishing Contour to a network. // // See each field for additional details. // // +kubebuilder:default={envoy: {type: LoadBalancerService, containerPorts: {{name: http, portNumber: 8080}, {name: https, portNumber: 8443}}}} NetworkPublishing NetworkPublishing `json:"networkPublishing,omitempty"` // GatewayControllerName is used to determine which GatewayClass // Contour reconciles. The string takes the form of // "projectcontour.io/<namespace>/contour". If unset, Contour will not // reconcile Gateway API resources. // // +kubebuilder:validation:MaxLength=253 // +optional GatewayControllerName *string `json:"gatewayControllerName,omitempty"` // IngressClassName is the name of the IngressClass used by Contour. If unset, // Contour will process all ingress objects without an ingress class annotation // or ingress objects with an annotation matching ingress-class=contour. When // specified, Contour will only process ingress objects that match the provided // class. // // For additional IngressClass details, refer to: // https://projectcontour.io/docs/main/config/annotations/#ingress-class // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 // +optional IngressClassName *string `json:"ingressClassName,omitempty"` // NodePlacement enables scheduling of Contour and Envoy pods onto specific nodes. // // See each field for additional details. // // +optional NodePlacement *NodePlacement `json:"nodePlacement,omitempty"` // EnableExternalNameService enables ExternalName Services. // ExternalName Services are disabled by default due to CVE-2021-XXXXX // You can re-enable them by setting this setting to "true". // This is not recommended without understanding the security implications. // Please see the advisory at https://github.com/projectcontour/contour/security/advisories/GHSA-5ph6-qq5x-7jwc for the details. // // +optional EnableExternalNameService *bool `json:"enableExternalNameService,omitempty"` // RuntimeSettings is any user-defined ContourConfigurationSpec to use when provisioning. RuntimeSettings *contourv1alpha1.ContourConfigurationSpec // EnvoyWorkloadType is the way to deploy Envoy, either "DaemonSet" or "Deployment". EnvoyWorkloadType WorkloadType }
ContourSpec defines the desired state of Contour.
type EnvoyNetworkPublishing ¶
type EnvoyNetworkPublishing struct { // Type is the type of publishing strategy to use. Valid values are: // // * LoadBalancerService // // In this configuration, network endpoints for Envoy use container networking. // A Kubernetes LoadBalancer Service is created to publish Envoy network // endpoints. The Service uses port 80 to publish Envoy's HTTP network endpoint // and port 443 to publish Envoy's HTTPS network endpoint. // // See: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer // // * NodePortService // // Publishes Envoy network endpoints using a Kubernetes NodePort Service. // // In this configuration, Envoy network endpoints use container networking. A Kubernetes // NodePort Service is created to publish the network endpoints. // // See: https://kubernetes.io/docs/concepts/services-networking/service/#nodeport // // * ClusterIPService // // Publishes Envoy network endpoints using a Kubernetes ClusterIP Service. // // In this configuration, Envoy network endpoints use container networking. A Kubernetes // ClusterIP Service is created to publish the network endpoints. // // See: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types Type NetworkPublishingType // LoadBalancer holds parameters for the load balancer. Present only if type is // LoadBalancerService. // // If unspecified, defaults to an external Classic AWS ELB. // // +kubebuilder:default={scope: External, providerParameters: {type: AWS}} LoadBalancer LoadBalancerStrategy `json:"loadBalancer,omitempty"` // ServicePorts is a list of ports to expose on the Envoy service. // TODO(sk) ServicePorts, NodePorts and ContainerPorts should collapse // into a single struct. ServicePorts []ServicePort // NodePorts is a list of network ports to expose on each node's IP at a static // port number using a NodePort Service. Present only if type is NodePortService. // A ClusterIP Service, which the NodePort Service routes to, is automatically // created. You'll be able to contact the NodePort Service, from outside the // cluster, by requesting <NodeIP>:<NodePort>. // // If type is NodePortService and nodePorts is unspecified, two nodeports will be // created, one named "http" and the other named "https", with port numbers auto // assigned by Kubernetes API server. For additional information on the NodePort // Service, see: // // https://kubernetes.io/docs/concepts/services-networking/service/#nodeport // // Names and port numbers must be unique in the list. Two ports must be specified, // one named "http" for Envoy's insecure service and one named "https" for Envoy's // secure service. // // +kubebuilder:validation:MinItems=2 // +kubebuilder:validation:MaxItems=2 // +optional NodePorts []NodePort `json:"nodePorts,omitempty"` // ContainerPorts is a list of container ports to expose from the Envoy container(s). // Exposing a port here gives the system additional information about the network // connections the Envoy container uses, but is primarily informational. Not specifying // a port here DOES NOT prevent that port from being exposed by Envoy. Any port which is // listening on the default "0.0.0.0" address inside the Envoy container will be accessible // from the network. Names and port numbers must be unique in the list container ports. Two // ports must be specified, one named "http" for Envoy's insecure service and one named // "https" for Envoy's secure service. // // TODO [danehans]: Update minItems to 1, requiring only https when the following issue // is fixed: https://github.com/projectcontour/contour/issues/2577. // // TODO [danehans]: Increase maxItems when https://github.com/projectcontour/contour/pull/3263 // is implemented. // // +kubebuilder:validation:MinItems=2 // +kubebuilder:validation:MaxItems=2 // +kubebuilder:default={{name: http, portNumber: 8080}, {name: https, portNumber: 8443}} ContainerPorts []ContainerPort `json:"containerPorts,omitempty"` // ServiceAnnotations is a set of annotations to add to the provisioned Envoy service. ServiceAnnotations map[string]string }
EnvoyNetworkPublishing defines the schema to publish Envoy to a network. +union
type EnvoyNodePlacement ¶
type EnvoyNodePlacement struct { // NodeSelector is the simplest recommended form of node selection constraint // and specifies a map of key-value pairs. For the Envoy pod to be eligible to // run on a node, the node must have each of the indicated key-value pairs as // labels (it can have additional labels as well). // // If unset, the Envoy pod(s) will be scheduled to any available node. // // +optional NodeSelector map[string]string `json:"nodeSelector,omitempty"` // Tolerations work with taints to ensure that Envoy pods are not scheduled // onto inappropriate nodes. One or more taints are applied to a node; this // marks that the node should not accept any pods that do not tolerate the taints. // // The default is an empty list. // // See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ // for additional details. // // +optional Tolerations []corev1.Toleration `json:"tolerations,omitempty"` }
EnvoyNodePlacement describes node scheduling configuration for Envoy pods. If nodeSelector and tolerations are specified, the scheduler will use both to determine where to place the Envoy pod(s).
type GCPLoadBalancerParameters ¶
type GCPLoadBalancerParameters struct { // Address is the desired load balancer IP address. If scope is "Internal", the address // must reside in same subnet as the GKE cluster or "subnet" has to be provided. // // See: // https://cloud.google.com/kubernetes-engine/docs/tutorials/configuring-domain-name-static-ip#use_a_service // https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#lb_subnet // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 // +optional Address *string `json:"address,omitempty"` // Subnet is the subnet name where the "address" resides. Relevant only // if scope is "Internal" and desired IP does not reside in same subnet as GKE // cluster. // // Omit if desired IP is in same subnet as GKE cluster. // // See: https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#lb_subnet // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=63 // +optional Subnet *string `json:"subnet,omitempty"` }
type LoadBalancerProviderType ¶
type LoadBalancerProviderType string
LoadBalancerProviderType is the underlying infrastructure provider for the load balancer. Allowed values are "AWS", "Azure", and "GCP".
+kubebuilder:validation:Enum=AWS;Azure;GCP
const ( AWSLoadBalancerProvider LoadBalancerProviderType = "AWS" AzureLoadBalancerProvider LoadBalancerProviderType = "Azure" GCPLoadBalancerProvider LoadBalancerProviderType = "GCP" )
type LoadBalancerScope ¶
type LoadBalancerScope string
LoadBalancerScope is the scope at which a load balancer is exposed. +kubebuilder:validation:Enum=Internal;External
var ( // InternalLoadBalancer is a load balancer that is exposed only on the // cluster's private network. InternalLoadBalancer LoadBalancerScope = "Internal" // ExternalLoadBalancer is a load balancer that is exposed on the // cluster's public network (which is typically on the Internet). ExternalLoadBalancer LoadBalancerScope = "External" )
type LoadBalancerStrategy ¶
type LoadBalancerStrategy struct { // Scope indicates the scope at which the load balancer is exposed. // Possible values are "External" and "Internal". // // +kubebuilder:default=External Scope LoadBalancerScope `json:"scope,omitempty"` // ProviderParameters contains load balancer information specific to // the underlying infrastructure provider. // // +kubebuilder:default={type: "AWS"} ProviderParameters ProviderLoadBalancerParameters `json:"providerParameters,omitempty"` // LoadBalancerIP is the IP (or hostname) to request // for the LoadBalancer service. LoadBalancerIP string }
LoadBalancerStrategy holds parameters for a load balancer.
type NamespaceSpec ¶
type NamespaceSpec struct { // Name is the name of the namespace to run Contour and dependent // resources. If unset, defaults to "projectcontour". // // +kubebuilder:default=projectcontour Name string `json:"name,omitempty"` // RemoveOnDeletion will remove the namespace when the Contour is // deleted. If set to True, deletion will not occur if any of the // following conditions exist: // // 1. The Contour namespace is "default", "kube-system" or the // contour-operator's namespace. // // 2. Another Contour exists in the namespace. // // 3. The namespace does not contain the Contour owning label. // // +kubebuilder:default=false RemoveOnDeletion bool `json:"removeOnDeletion,omitempty"` }
NamespaceSpec defines the schema of a Contour namespace.
type NetworkPublishing ¶
type NetworkPublishing struct { // Envoy provides the schema for publishing the network endpoints of Envoy. // // If unset, defaults to: // type: LoadBalancerService // containerPorts: // - name: http // portNumber: 8080 // - name: https // portNumber: 8443 // // +kubebuilder:default={type: LoadBalancerService, loadBalancer: {scope: External, providerParameters: {type: AWS}}, containerPorts: {{name: http, portNumber: 8080}, {name: https, portNumber: 8443}}} Envoy EnvoyNetworkPublishing `json:"envoy,omitempty"` }
NetworkPublishing defines the schema for publishing Contour to a network.
type NetworkPublishingType ¶
type NetworkPublishingType = contourv1alpha1.NetworkPublishingType
const ( // LoadBalancerServicePublishingType publishes a network endpoint using a Kubernetes // LoadBalancer Service. LoadBalancerServicePublishingType NetworkPublishingType = contourv1alpha1.LoadBalancerServicePublishingType // NodePortServicePublishingType publishes a network endpoint using a Kubernetes // NodePort Service. NodePortServicePublishingType NetworkPublishingType = contourv1alpha1.NodePortServicePublishingType // ClusterIPServicePublishingType publishes a network endpoint using a Kubernetes // ClusterIP Service. ClusterIPServicePublishingType NetworkPublishingType = contourv1alpha1.ClusterIPServicePublishingType )
type NodePlacement ¶
type NodePlacement struct { // Contour describes node scheduling configuration of Contour pods. // // +optional Contour *ContourNodePlacement `json:"contour,omitempty"` // Envoy describes node scheduling configuration of Envoy pods. // // +optional Envoy *EnvoyNodePlacement `json:"envoy,omitempty"` }
NodePlacement describes node scheduling configuration of Contour and Envoy pods.
type NodePort ¶
type NodePort struct { // Name is an IANA_SVC_NAME within the NodePort Service. // // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:MaxLength=253 Name string `json:"name"` // PortNumber is the network port number to expose for the NodePort Service. // If unspecified, a port number will be assigned from the the cluster's // nodeport service range, i.e. --service-node-port-range flag // (default: 30000-32767). // // If specified, the number must: // // 1. Not be used by another NodePort Service. // 2. Be within the cluster's nodeport service range, i.e. --service-node-port-range // flag (default: 30000-32767). // 3. Be a valid network port number, i.e. greater than 0 and less than 65536. // // +optional // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 PortNumber *int32 `json:"portNumber,omitempty"` }
NodePort is the schema to specify a network port for a NodePort Service.
func MakeNodePorts ¶
MakeNodePorts returns a nodeport slice using the ports key as the nodeport name and the ports value as the nodeport number.
type ProviderLoadBalancerParameters ¶
type ProviderLoadBalancerParameters struct { // Type is the underlying infrastructure provider for the load balancer. // Allowed values are "AWS", "Azure", and "GCP". // // +unionDiscriminator // +kubebuilder:default=AWS Type LoadBalancerProviderType `json:"type,omitempty"` // AWS provides configuration settings that are specific to AWS // load balancers. // // If empty, defaults will be applied. See specific aws fields for // details about their defaults. // // +optional AWS *AWSLoadBalancerParameters `json:"aws,omitempty"` // Azure provides configuration settings that are specific to Azure // load balancers. // // If empty, defaults will be applied. See specific azure fields for // details about their defaults. // // +optional Azure *AzureLoadBalancerParameters `json:"azure,omitempty"` // GCP provides configuration settings that are specific to GCP // load balancers. // // If empty, defaults will be applied. See specific gcp fields for // details about their defaults. // // +optional GCP *GCPLoadBalancerParameters `json:"gcp,omitempty"` }
ProviderLoadBalancerParameters holds desired load balancer information specific to the underlying infrastructure provider.
+union
type RBACNames ¶
type RBACNames struct { ServiceAccount string ClusterRole string ClusterRoleBinding string Role string RoleBinding string }
RBACNames holds a set of names of related RBAC resources.
type ServicePort ¶
type WorkloadType ¶
type WorkloadType = contourv1alpha1.WorkloadType
WorkloadType is the type of Kubernetes workload to use for a component.