feat: ApisixRoute v2alpha1

pkg/ingress/controller/apisix_upstream.go

@@ -46,7 +46,7 @@ func (c *Controller) newApisixUpstreamController() *apisixUpstreamController {
 		cache.ResourceEventHandlerFuncs{
 			AddFunc:    ctl.onAdd,
 			UpdateFunc: ctl.onUpdate,
-			DeleteFunc: ctl.OnDelete,
+			DeleteFunc: ctl.onDelete,
 		},
 	)
 	return ctl
@@ -56,7 +56,7 @@ func (c *apisixUpstreamController) run(ctx context.Context) {
 	log.Info("ApisixUpstream controller started")
 	defer log.Info("ApisixUpstream controller exited")
 	if ok := cache.WaitForCacheSync(ctx.Done(), c.controller.apisixUpstreamInformer.HasSynced, c.controller.svcInformer.HasSynced); !ok {
-		log.Errorf("cache sync failed")
+		log.Error("cache sync failed")
 		return
 	}
 	for i := 0; i < c.workers; i++ {
@@ -179,13 +179,13 @@ func (c *apisixUpstreamController) handleSyncErr(obj interface{}, err error) {
 		return
 	}
 	if c.workqueue.NumRequeues(obj) < _maxRetries {
-		log.Infow("sync endpoints failed, will retry",
+		log.Infow("sync ApisixUpstream failed, will retry",
 			zap.Any("object", obj),
 		)
 		c.workqueue.AddRateLimited(obj)
 	} else {
 		c.workqueue.Forget(obj)
-		log.Warnf("drop endpoints %+v out of the queue", obj)
+		log.Warnf("drop ApisixUpstream %+v out of the queue", obj)
 	}
 }
 
@@ -232,7 +232,7 @@ func (c *apisixUpstreamController) onUpdate(oldObj, newObj interface{}) {
 	})
 }
 
-func (c *apisixUpstreamController) OnDelete(obj interface{}) {
+func (c *apisixUpstreamController) onDelete(obj interface{}) {
 	au, ok := obj.(*configv1.ApisixUpstream)
 	if !ok {
 		tombstone, ok := obj.(cache.DeletedFinalStateUnknown)

pkg/ingress/controller/controller.go

@@ -69,19 +69,22 @@ type Controller struct {
 	crdInformerFactory externalversions.SharedInformerFactory
 
 	// common informers and listers
-	epInformer             cache.SharedIndexInformer
-	epLister               listerscorev1.EndpointsLister
-	svcInformer            cache.SharedIndexInformer
-	svcLister              listerscorev1.ServiceLister
-	ingressLister          kube.IngressLister
-	ingressInformer        cache.SharedIndexInformer
-	apisixUpstreamInformer cache.SharedIndexInformer
-	apisixUpstreamLister   listersv1.ApisixUpstreamLister
+	epInformer                  cache.SharedIndexInformer
+	epLister                    listerscorev1.EndpointsLister
+	svcInformer                 cache.SharedIndexInformer
+	svcLister                   listerscorev1.ServiceLister
+	ingressLister               kube.IngressLister
+	ingressInformer             cache.SharedIndexInformer
+	apisixUpstreamInformer      cache.SharedIndexInformer
+	apisixUpstreamLister        listersv1.ApisixUpstreamLister
+	apisixRouteV1Informer       cache.SharedIndexInformer
+	apisixRouteV2alpha1Informer cache.SharedIndexInformer
 
 	// resource conrollers
 	endpointsController      *endpointsController
 	ingressController        *ingressController
 	apisixUpstreamController *apisixUpstreamController
+	apisixRouteController    *apisixRouteController
 }
 
 // NewController creates an ingress apisix controller object.
@@ -159,6 +162,7 @@ func NewController(cfg *config.Config) (*Controller, error) {
 
 	c.endpointsController = c.newEndpointsController()
 	c.apisixUpstreamController = c.newApisixUpstreamController()
+	c.apisixRouteController = c.newApisixRouteController()
 	c.ingressController = c.newIngressController()
 
 	return c, nil
@@ -299,8 +303,6 @@ func (c *Controller) run(ctx context.Context) {
 		Stop:                      ctx.Done(),
 	}
 
-	// ApisixRoute
-	ac.ApisixRoute(c)
 	// ApisixTLS
 	ac.ApisixTLS(c)
 
@@ -338,17 +340,6 @@ type Api6Controller struct {
 	Stop                      <-chan struct{}
 }
 
-func (api6 *Api6Controller) ApisixRoute(controller *Controller) {
-	arc := BuildApisixRouteController(
-		api6.KubeClientSet,
-		api6.Api6ClientSet,
-		api6.SharedInformerFactory.Apisix().V1().ApisixRoutes(),
-		controller)
-	if err := arc.Run(api6.Stop); err != nil {
-		log.Errorf("failed to run ApisixRouteController: %s", err)
-	}
-}
-
 func (api6 *Api6Controller) ApisixTLS(controller *Controller) {
 	atc := BuildApisixTlsController(
 		api6.KubeClientSet,

pkg/kube/apisix/apis/config/v2alpha1/doc.go

@@ -0,0 +1,18 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// +k8s:deepcopy-gen=package
+
+// +groupName=apisix.apache.org
+package v2alpha1

pkg/kube/apisix/apis/config/v2alpha1/register.go

@@ -0,0 +1,50 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package v2alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+const (
+	_groupName = "apisix.apache.org"
+	_version   = "v2alpha1"
+)
+
+var (
+	SchemeGroupVersion = schema.GroupVersion{
+		Group:   _groupName,
+		Version: _version,
+	}
+	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
+	AddToScheme   = SchemeBuilder.AddToScheme
+)
+
+func Resource(resource string) schema.GroupResource {
+	return SchemeGroupVersion.WithResource(resource).GroupResource()
+}
+
+func addKnownTypes(scheme *runtime.Scheme) error {
+	scheme.AddKnownTypes(SchemeGroupVersion,
+		&ApisixRoute{},
+		&ApisixRouteList{},
+	)
+
+	// register the type in the scheme
+	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
+	return nil
+}

pkg/kube/apisix/apis/config/v2alpha1/types.go

@@ -0,0 +1,161 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package v2alpha1
+
+import (
+	"encoding/json"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/intstr"
+)
+
+// +genclient
+// +genclient:noStatus
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// ApisixRoute is used to define the route rules and upstreams for Apache APISIX.
+type ApisixRoute struct {
+	metav1.TypeMeta   `json:",inline" yaml:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
+	Spec              *ApisixRouteSpec `json:"spec,omitempty" yaml:"spec,omitempty"`
+}
+
+// ApisixRouteSpec is the spec definition for ApisixRouteSpec.
+type ApisixRouteSpec struct {
+	HTTP []*ApisixRouteHTTP `json:"http,omitempty"`
+}
+
+// ApisixRouteHTTP represents a single route in for HTTP traffic.
+type ApisixRouteHTTP struct {
+	// Route priority, when multiple routes contains
+	// same URI path (for path matching), route with
+	// higher priority will take effect.
+	Priority int                      `json:"priority,omitempty"`
+	Match    *ApisixRouteHTTPMatch    `json:"match,omitempty"`
+	Backend  *ApisixRouteHTTPBackend  `json:"backend"`
+	Plugins  []*ApisixRouteHTTPPlugin `json:"plugins,omitempty"`
+}
+
+// ApisixRouteHTTPMatch represents the match condition for hitting this route.
+type ApisixRouteHTTPMatch struct {
+	// URI path predicates, at least one path should be
+	// configured, path could be exact or prefix, for prefix path,
+	// append "*" after it, for instance, "/foo*".
+	Paths []string `json:"paths"`
+	// HTTP request method predicates.
+	Methods []string `json:"methods,omitempty"`
+	// HTTP Host predicates, host can be a wildcard domain or
+	// an exact domain. For wildcard domain, only one generic
+	// level is allowed, for instance, "*.foo.com" is valid but
+	// "*.*.foo.com" is not.
+	Hosts []string `json:"hosts,omitempty"`
+	// Remote address predicates, items can be valid IPv4 address
+	// or IPv6 address or CIDR.
+	RemoteAddrs []string `json:"remoteAddrs,omitempty"`
+	// NginxVars represents generic match predicates,
+	// it uses Nginx variable systems, so any predicate
+	// like headers, querystring and etc can be leveraged
+	// here to match the route.
+	// For instance, it can be:
+	// nginxVars:
+	//   - subject: "$remote_addr"
+	//     op: in
+	//     value:
+	//       - "127.0.0.1"
+	//       - "10.0.5.11"
+	NginxVars []ApisixRouteHTTPMatchNginxVar `json:"nginxVars,omitempty"`
+}
+
+// ApisixRouteHTTPMatchNginxVar represents a binary expression for the Nginx vars.
+type ApisixRouteHTTPMatchNginxVar struct {
+	// Subject is the expression subject, it can
+	// be any string composed by literals and nginx
+	// vars.
+	Subject string `json:"subject"`
+	// Op is the operator, can be:
+	// - "==": equal
+	// - "~=": not equal
+	// - ">": greater than
+	// - ">=": greater than or equal to
+	// - "<": less then
+	// - "<=": less then or equal to
+	// - "~~": regex match
+	// - "!~~": regex not match
+	// - "~*": case insensitive regex match
+	// - "!~*": case insensitive regex not match
+	// - "in": set match, Value should be a string array.
+	// - "not_in": set match, Value should be a string array.
+	// - "contain": subject contains the Value (inclusion relation).
+	// - "not_contain": subject doesn't contain the Value (inclusion relation).
+	Op string `json:"op"`
+	// Array is an array type object of the expression.
+	// It should be used when the Op is "in" or "not_in";
+	Array []string `json:"array"`
+	// Value is the normal type object for the expression,
+	// it should be used when the Op is not "in" and "not_in".
+	// Array and Value are exclusive so only of them can be set
+	// in the same time.
+	Value *string `json:"value"`
+}
+
+// ApisixRouteHTTPBackend represents a HTTP backend (a Kuberentes Service).
+type ApisixRouteHTTPBackend struct {
+	// The name (short) of the service, note cross namespace is forbidden,
+	// so be sure the ApisixRoute and Service are in the same namespace.
+	ServiceName string `json:"serviceName"`
+	// The service port, could be the name or the port number.
+	ServicePort intstr.IntOrString `json:"servicePort"`
+	// The resolve granularity, can be "endpoints" or "service",
+	// when set to "endpoints", the pod ips will be used; other
+	// wise, the service ClusterIP or ExternalIP will be used,
+	// default is endpoints.
+	ResolveGranularity string `json:"resolveGranularity"`
+}
+
+// ApisixRouteHTTPPlugin represents an APISIX plugin.
+type ApisixRouteHTTPPlugin struct {
+	// The plugin name.
+	Name string `json:"name"`
+	// Whether this plugin is in use, default is true.
+	Enable bool `json:"enable"`
+	// Plugin configuration.
+	// TODO we may use protobuf to define it.
+	Config ApisixRouteHTTPPluginConfig
+}
+
+// ApisixRouteHTTPPluginConfig is the configuration for
+// any plugins.
+type ApisixRouteHTTPPluginConfig map[string]interface{}
+
+func (p ApisixRouteHTTPPluginConfig) DeepCopyInto(out *ApisixRouteHTTPPluginConfig) {
+	b, _ := json.Marshal(&p)
+	_ = json.Unmarshal(b, out)
+}
+
+func (p *ApisixRouteHTTPPluginConfig) DeepCopy() *ApisixRouteHTTPPluginConfig {
+	if p == nil {
+		return nil
+	}
+	out := new(ApisixRouteHTTPPluginConfig)
+	p.DeepCopyInto(out)
+	return out
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+type ApisixRouteList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+	Items           []ApisixRoute `json:"items,omitempty"`
+}