broker

Documentation

Overview

Example (Full)

package main

import (
	"embed"
	"os"

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

//go:embed *.yaml
var yaml embed.FS

func main() {
	ctx := testlog.NewContext()
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":        "foo",
		"namespace":   "bar",
		"brokerClass": "a-broker-class",
		"config": map[string]interface{}{
			"kind":       "cfgkind",
			"name":       "cfgname",
			"apiVersion": "cfgapi",
		},
		"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.ExecuteYAML(ctx, yaml, 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
  annotations:
    eventing.knative.dev/broker.class: a-broker-class
spec:
  config:
    kind: cfgkind
    namespace: bar
    name: cfgname
    apiVersion: cfgapi
  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 (
	"embed"
	"os"

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

//go:embed *.yaml
var yaml embed.FS

func main() {
	ctx := testlog.NewContext()
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":       "foo",
		"namespace":  "bar",
		"brokerName": "baz",
	}

	files, err := manifest.ExecuteYAML(ctx, yaml, 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

• Variables
• func Address(ctx context.Context, name string, timings ...time.Duration) (*apis.URL, error)
• func GVR() schema.GroupVersionResource
• func Install(name string, opts ...manifest.CfgFn) feature.StepFn
• func IsAddressable(name string, timings ...time.Duration) feature.StepFn
• func IsReady(name string, timing ...time.Duration) feature.StepFn
• func WaitForCondition(name string, condition Condition, timing ...time.Duration) feature.StepFn
• func WithBrokerClass(class string) manifest.CfgFn
• func WithBrokerTemplateFiles(dir string) manifest.CfgFn
• func WithConfig(name string) manifest.CfgFn
• func WithEnvConfig() []manifest.CfgFn
• type Condition
  • func HasDelivery() Condition
  • func HasDeliveryBackoffDelay() Condition
  • func HasDeliveryBackoffPolicy() Condition
  • func HasDeliveryRetry() Condition
  • func (c Condition) And(other Condition) Condition
• type EnvConfig

Examples

• Package (Full)
• Package (Min)
• WithBrokerClass
• WithConfig

Variables

var WithDeadLetterSink = delivery.WithDeadLetterSink

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

var WithRetry = delivery.WithRetry

WithRetry adds the retry related config to a Broker spec.

var WithTimeout = delivery.WithTimeout

WithTimeout adds the timeout related config to the config.

Functions

func Address

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

Address returns a broker's address.

func GVR

func GVR() schema.GroupVersionResource

func Install

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

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

func IsAddressable

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

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

func IsReady

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

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

func WaitForCondition

func WaitForCondition(name string, condition Condition, timing ...time.Duration) feature.StepFn

func WithBrokerClass

func WithBrokerClass(class string) manifest.CfgFn

WithBrokerClass adds the broker class config to a Broker spec.

Example

package main

import (
	"embed"
	"os"

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

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

//go:embed *.yaml
var yaml embed.FS

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

	files, err := manifest.ExecuteYAML(ctx, yaml, 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
  annotations:
    eventing.knative.dev/broker.class: a-broker-class
spec:

func WithBrokerTemplateFiles

func WithBrokerTemplateFiles(dir string) manifest.CfgFn

func WithConfig

func WithConfig(name string) manifest.CfgFn

WithConfig adds the specified config map to the Broker spec.

Example

package main

import (
	"embed"
	"os"

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

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

//go:embed *.yaml
var yaml embed.FS

func main() {
	ctx := testlog.NewContext()
	images := map[string]string{}
	cfg := map[string]interface{}{
		"name":      "foo",
		"namespace": "bar",
	}
	broker.WithConfig("my-funky-config")(cfg)

	files, err := manifest.ExecuteYAML(ctx, yaml, 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:
  config:
    kind: ConfigMap
    namespace: bar
    name: my-funky-config
    apiVersion: v1

func WithEnvConfig

func WithEnvConfig() []manifest.CfgFn

Types

type Condition

type Condition struct {
	Name      string
	Condition func(br eventingv1.Broker) (bool, error)
}

func HasDelivery

func HasDelivery() Condition

func HasDeliveryBackoffDelay

func HasDeliveryBackoffDelay() Condition

func HasDeliveryBackoffPolicy

func HasDeliveryBackoffPolicy() Condition

func HasDeliveryRetry

func HasDeliveryRetry() Condition

func (Condition) And

func (c Condition) And(other Condition) Condition

type EnvConfig

type EnvConfig struct {
	BrokerClass        string `envconfig:"BROKER_CLASS" default:"MTChannelBasedBroker" required:"true"`
	BrokerTemplatesDir string `envconfig:"BROKER_TEMPLATES"`
}

var EnvCfg EnvConfig