Skip to content

Latest commit

 

History

History
219 lines (170 loc) · 8.32 KB

README.md

File metadata and controls

219 lines (170 loc) · 8.32 KB
Raw

Policy Machinery

Machinery for implementing Gateway API policies and policy controllers.

Features

  • Types for modeling topologies of targetable network resources and corresponding attached policies
  • Examples of policy types defined with their own custom merge strategies (JSON patch, Kuadrant Defaults & Overrides)
  • Helpers for building and testing Gateway API-specific topologies of network resources and policies
  • Special package for implementing custom controllers of Gateway API resources, policies and related runtime objects
  • 2 patterns for reconciliation: state-of-the-world and incremental events
  • Reconciliation workflows (for handling dependencies and concurrent tasks) and subscriptions
  • Full example of custom controller leveraging a Gateway API topology with 4 kinds of policies

Usage

❶ Import the package:

go get github.com/kuadrant/policy-machinery

❷ Implement the Policy interface:

package mypolicy

import (
  "github.com/kuadrant/policy-machinery/machinery"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  gwapiv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
)

var _ machinery.Policy = &MyPolicy{}

type MyPolicy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec MyPolicySpec `json:"spec"`
}

type MyPolicySpec struct {
  TargetRef gwapiv1alpha2.LocalPolicyTargetReference
}

func (p *MyPolicy) GetLocator() string {
	return machinery.LocatorFromObject(p)
}

func (p *MyPolicy) GetTargetRefs() []machinery.PolicyTargetReference {
	return []machinery.PolicyTargetReference{
		machinery.LocalPolicyTargetReference{
			LocalPolicyTargetReference: p.Spec.TargetRef,
			PolicyNamespace: p.Namespace,
		},
	}
}

func (p *MyPolicy) GetMergeStrategy() machinery.MergeStrategy {
	return machinery.DefaultMergeStrategy // replace with your merge strategy
}

func (p *MyPolicy) Merge(policy machinery.Policy) machinery.Policy {
	source := policy.(*MyPolicy)
	return source.GetMergeStrategy()(source, p)
}

func (p *MyPolicy) DeepCopy() *MyPolicy {
	spec := p.Spec.DeepCopy()
	return &MyPolicy{
		TypeMeta:   p.TypeMeta,
		ObjectMeta: p.ObjectMeta,
		Spec:       *spec,
	}
}

❸ Build a topology of targetable network resources:

import (
  "fmt"

  "github.com/kuadrant/policy-machinery/machinery"
  "github.com/samber/lo"
)

// ...

topology := machinery.NewTopology(
  machinery.WithTargetables(gateways...),
  machinery.WithTargetables(httpRoutes...),
  machinery.WithTargetables(services...),
  machinery.WithLinks(
    machinery.LinkGatewayToHTTPRouteFunc(gateways),
    machinery.LinkHTTPRouteToServiceFunc(httpRoutes, false),
  ),
  machinery.WithPolicies(policies...),
)

// Print the topology in Graphviz DOT language
fmt.Println(topology.ToDot())

// Calculate the effective policy for any path between 2 targetables in the topology
paths := topology.Paths(gateways[0], services[0])

for _, path := range paths {
  // Gather all policies in the path sorted from the least specific to the most specific
  policies := lo.FlatMap(path, func(targetable machinery.Targetable, _ int) []machinery.Policy {
    return targetable.Policies()
  })

  // Map reduces the policies from most specific to least specific, merging them into one effective policy for each path
  var emptyPolicy machinery.Policy = &MyPolicy{}
  effectivePolicy := lo.ReduceRight(policies, func(effectivePolicy machinery.Policy, policy machinery.Policy, _ int) machinery.Policy {
    return effectivePolicy.Merge(policy)
  }, emptyPolicy)
}

Topology of Gateway API resources

Alternatively to the generic machinery.NewTopology(…), use machinery.NewGatewayAPITopology(…) to build a topology of Gateway API resources. The links between network objects (GatewayClasses, Gateways, HTTPRoutes, etc) will be inferred automatically.

topology := machinery.NewGatewayAPITopology(
  machinery.WithGateways(gateways...),
  machinery.WithHTTPRoutes(httpRoutes...),
  machinery.WithServices(services...),
  machinery.WithPolicies(policies...),
)

You can use the topology options ExpandGatewayListeners(), ExpandHTTPRouteRules(), and ExpandServicePorts() to automatically expand Gateways, HTTPRoutes and Services. The inner sections of these resources (listeners, route rules, service ports, respectively) will be added as targetables to the topology. The links between objects are then automatically adjusted accordingly.

Custom controllers for topologies of Gateway API resources

The controller package defines a simplified controller abstraction based on the k8s.io/apimachinery and sigs.k8s.io/controller-runtime, that builds an in-memory representation of your topology of Gateway API, policy and generic linked resources, from events watched from the cluster.

Example:

import (
  "context"
  "sync"

  "k8s.io/apimachinery/pkg/runtime/schema"
  "k8s.io/client-go/dynamic"
  "k8s.io/client-go/tools/clientcmd"
  ctrlruntime "sigs.k8s.io/controller-runtime"

  gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
  "./mypolicy"

  "github.com/kuadrant/policy-machinery/controller"
	"github.com/kuadrant/policy-machinery/machinery"
)

func main() {
	// create a logger
	logger := controller.CreateAndSetLogger()

	// load kubeconfig
	kubeconfig := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(clientcmd.NewDefaultClientConfigLoadingRules(), &clientcmd.ConfigOverrides{})
	config, err := kubeconfig.ClientConfig()
	if err != nil {
		log.Fatalf("Error loading kubeconfig: %v", err)
	}

	// create a client
	client, err := dynamic.NewForConfig(config)
	if err != nil {
		log.Fatalf("Error creating client: %v", err)
	}

	// create a controller with a built-in gateway api topology
	controller := controller.NewController(
		controller.WithLogger(logger),
		controller.WithClient(client),
		controller.WithRunnable("gateway", controller.Watch(*gwapiv1.Gateway{}, gwapiv1.SchemeGroupVersion.WithResource("gateways"), metav1.NamespaceAll)),
		controller.WithRunnable("httproute", controller.Watch(*gwapiv1.HTTPRoute{}, gwapiv1.SchemeGroupVersion.WithResource("httproutes"), metav1.NamespaceAll)),
		controller.WithRunnable("mypolicy", controller.Watch(*mypolicy.MyPolicy{}, mypolicy.SchemeGroupVersion.WithResource("mypolicies"), metav1.NamespaceAll)),
		controller.WithPolicyKinds(schema.GroupKind{Group: mypolicy.SchemeGroupVersion.Group, Kind: "MyPolicy"}),
		controller.WithReconcile(reconcile),
	)

	if err := controller.Start(ctrlruntime.SetupSignalHandler()); err != nil {
		logger.Error(err, "error starting controller")
		os.Exit(1)
	}
}

func reconcile(ctx context.Context, events []ResourceEvent, topology *machinery.Topology, err error, state *sync.Map) error {
  // TODO: implement your reconciliation business logic here
}

State-of-the-world kind of watchers will coallesce events into a compact single reconciliation call (default). Alternatively, use incremental informers for more granular reconciliation calls at every event.

Check out as well the options for defining watchers with predicates (labels, field selectors, etc).

For more advanced and optimized reconciliation, consider workflows (for handling dependencies and concurrent tasks) and subscriptions (for macthing on specific event types).

Example

Check out the full Kuadrant example of using the machinery and controller packages to implement a full custom controller that watches for Gateway API resources, as well as policy resources of 4 kinds (DNSPolicy, TLSPolicy, AuthPolicy and RateLimitPolicy.)

Each event the controller subscribes to generates a call to a reconcile function that saves a graphical representation of the updated Gateway API topology to a file in the fle system, and computes all applicable effective policies for all 4 kinds of policies.