broker

Documentation

Overview

Example (Full)

package main

import (
	"os"

	"knative.dev/reconciler-test/pkg/manifest"
)

func main() {
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":        "foo",
		"namespace":   "bar",
		"brokerClass": "a-broker-class",
		"delivery": map[string]interface{}{
			"retry":         "42",
			"backoffPolicy": "exponential",
			"backoffDelay":  "2007-03-01T13:00:00Z/P1Y2M10DT2H30M",
			"deadLetterSink": map[string]interface{}{
				"ref": map[string]string{
					"kind":       "deadkind",
					"name":       "deadname",
					"apiVersion": "deadapi",
				},
				"uri": "/extra/path",
			},
		},
	}

	files, err := manifest.ExecuteLocalYAML(images, cfg)
	if err != nil {
		panic(err)
	}

	manifest.OutputYAML(os.Stdout, files)
}

Output:

apiVersion: eventing.knative.dev/v1
kind: Broker
metadata:
  name: foo
  namespace: bar
  labels:
    eventing.knative.dev/broker.class: a-broker-class
spec:
  delivery:
    deadLetterSink:
      ref:
        kind: deadkind
        namespace: bar
        name: deadname
        apiVersion: deadapi
      uri: /extra/path
    retry: 42
    backoffPolicy: exponential
    backoffDelay: "2007-03-01T13:00:00Z/P1Y2M10DT2H30M"

Example (Min)

package main

import (
	"os"

	"knative.dev/reconciler-test/pkg/manifest"
)

func main() {
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":       "foo",
		"namespace":  "bar",
		"brokerName": "baz",
		"subscriber": map[string]interface{}{
			"ref": map[string]string{
				"kind":       "subkind",
				"namespace":  "subnamespace",
				"name":       "subname",
				"apiVersion": "subversion",
			},
		},
	}

	files, err := manifest.ExecuteLocalYAML(images, cfg)
	if err != nil {
		panic(err)
	}

	manifest.OutputYAML(os.Stdout, files)
}

Output:

apiVersion: eventing.knative.dev/v1
kind: Broker
metadata:
  name: foo
  namespace: bar
spec:

Index

• func Address(ctx context.Context, name string, interval, timeout time.Duration) (*apis.URL, error)
• func Gvr() schema.GroupVersionResource
• func Install(name string, opts ...CfgFn) feature.StepFn
• func IsAddressable(name string, interval, timeout time.Duration) feature.StepFn
• func IsReady(name string, interval, timeout time.Duration) feature.StepFn
• type CfgFn
  • func WithBrokerClass(class string) CfgFn
  • func WithDeadLetterSink(ref *duckv1.KReference, uri string) CfgFn
  • func WithRetry(count int32, backoffPolicy *eventingv1.BackoffPolicyType, backoffDelay *string) CfgFn

Examples

• Package (Full)
• Package (Min)
• WithBrokerClass
• WithDeadLetterSink
• WithRetry
• WithRetry (OnlyCount)

Functions

func Address

func Address(ctx context.Context, name string, interval, timeout time.Duration) (*apis.URL, error)

Address returns a broker's address.

func Gvr

func Gvr() schema.GroupVersionResource

func Install

func Install(name string, opts ...CfgFn) feature.StepFn

Install will create a Broker resource, augmented with the config fn options.

func IsAddressable

func IsAddressable(name string, interval, timeout time.Duration) feature.StepFn

IsAddressable tests to see if a Broker becomes addressable within the time given.

func IsReady

func IsReady(name string, interval, timeout time.Duration) feature.StepFn

IsReady tests to see if a Broker becomes ready within the time given.

Types

type CfgFn

type CfgFn func(map[string]interface{})

func WithBrokerClass

func WithBrokerClass(class string) CfgFn

WithBrokerClass adds the broker class config to a Broker spec.

Example

package main

import (
	"os"

	"knative.dev/eventing/test/rekt/resources/broker"
	"knative.dev/reconciler-test/pkg/manifest"
)

func main() {

	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":      "foo",
		"namespace": "bar",
	}
	broker.WithBrokerClass("a-broker-class")(cfg)

	files, err := manifest.ExecuteLocalYAML(images, cfg)
	if err != nil {
		panic(err)
	}

	manifest.OutputYAML(os.Stdout, files)
}

Output:

apiVersion: eventing.knative.dev/v1
kind: Broker
metadata:
  name: foo
  namespace: bar
  labels:
    eventing.knative.dev/broker.class: a-broker-class
spec:

func WithDeadLetterSink

func WithDeadLetterSink(ref *duckv1.KReference, uri string) CfgFn

WithDeadLetterSink adds the dead letter sink related config to a Broker spec.

Example

package main

import (
	"os"

	"knative.dev/eventing/test/rekt/resources/broker"

	v1 "knative.dev/pkg/apis/duck/v1"
	"knative.dev/reconciler-test/pkg/manifest"
)

func main() {
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":      "foo",
		"namespace": "bar",
	}
	broker.WithDeadLetterSink(&v1.KReference{
		Kind:       "deadkind",
		Name:       "deadname",
		APIVersion: "deadapi",
	}, "/extra/path")(cfg)

	files, err := manifest.ExecuteLocalYAML(images, cfg)
	if err != nil {
		panic(err)
	}

	manifest.OutputYAML(os.Stdout, files)
}

Output:

apiVersion: eventing.knative.dev/v1
kind: Broker
metadata:
  name: foo
  namespace: bar
spec:
  delivery:
    deadLetterSink:
      ref:
        kind: deadkind
        namespace: bar
        name: deadname
        apiVersion: deadapi
      uri: /extra/path

func WithRetry

func WithRetry(count int32, backoffPolicy *eventingv1.BackoffPolicyType, backoffDelay *string) CfgFn

WithRetry adds the retry related config to a Broker spec.

Example

package main

import (
	"os"

	eventingv1 "knative.dev/eventing/pkg/apis/duck/v1"
	"knative.dev/eventing/test/rekt/resources/broker"
	"knative.dev/pkg/ptr"
	"knative.dev/reconciler-test/pkg/manifest"
)

func main() {
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":      "foo",
		"namespace": "bar",
	}
	exp := eventingv1.BackoffPolicyExponential
	broker.WithRetry(42, &exp, ptr.String("2007-03-01T13:00:00Z/P1Y2M10DT2H30M"))(cfg)

	files, err := manifest.ExecuteLocalYAML(images, cfg)
	if err != nil {
		panic(err)
	}

	manifest.OutputYAML(os.Stdout, files)
}

Output:

apiVersion: eventing.knative.dev/v1
kind: Broker
metadata:
  name: foo
  namespace: bar
spec:
  delivery:
    retry: 42
    backoffPolicy: exponential
    backoffDelay: "2007-03-01T13:00:00Z/P1Y2M10DT2H30M"

Example (OnlyCount)

package main

import (
	"os"

	"knative.dev/eventing/test/rekt/resources/broker"
	"knative.dev/reconciler-test/pkg/manifest"
)

func main() {
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":      "foo",
		"namespace": "bar",
	}
	broker.WithRetry(42, nil, nil)(cfg)

	files, err := manifest.ExecuteLocalYAML(images, cfg)
	if err != nil {
		panic(err)
	}

	manifest.OutputYAML(os.Stdout, files)
}

Output:

apiVersion: eventing.knative.dev/v1
kind: Broker
metadata:
  name: foo
  namespace: bar
spec:
  delivery:
    retry: 42