NiFi connection reference

This reference helps you put together the Connection part of your CR YAML file, both for NiFi and NiFi Registry.

Connection

name string

Name of the Connection, will be appended to the CR name to form the related Service and Ingress/Route resource name.

type string

Connection type to create. Can be one of Service, Ingress, or Route.

annotations map[string]string [optional]

Annotation map to be applied to the created Service, Ingress, or Route.

labels map[string]string [optional]

Label map to be applied to the created Service, Ingress, or Route

ingressConfig IngressConfig [optional]

Further configuration for the Ingress type Connection.

routeConfig RouteConfig [optional]

Further configuration for the Route type Connection.

serviceConfig ServiceConfig [optional]

Further configuration for the Service type Connection. If Type is Route or Ingress, this configuration will be applied to the backend Service created for the Route or Ingress.

IngressConfig

hostname string [optional]

Hostname override for an Ingress Connection. If omitted, it will default to the spec.hostname value.

paths []IngressPathConfig

Array of path definitions.

ingressClassName string [optional]

The Ingress Class to use on this Connection.

ingressTLS []IngressTLS [optional]

Array of Ingress TLS configurations. Uses definition from Kubernetes as described here: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#ingresstls-v1-networking-k8s-io

IngressPathConfig

name string [optional]

Name of the Service port to target. Must be a valid DNS name.

protocol string [optional]

Defines the protocol to use for this port. Can be TCP, UDP, or SCTP. Defaults to TCP.

port int32

Port number for the backend Service.

targetPort IntOrString [optional]

Port name or number to target on the backend Pods.

RouteConfig

hostname string [optional]

Hostname override for this Route. Will default to the value of spec.hostname.

subdomain string [optional]

Subdomain passthrough. If set, the Route hostname will be unset to allow the subdomain to take effect. For more information, see https://docs.openshift.com/container-platform/4.14/networking/routes/route-configuration.html#nw-ingress-sharding-route-configuration_route-configuration

path string [optional]

Path for this Route.

port int32

Port to target on the backend Service.

tls TLSConfig [optional]

Route TLS configuration. Uses definition provided by OpenShift: https://docs.openshift.com/container-platform/4.14/rest_api/network_apis/route-route-openshift-io-v1.html#spec-tls

httpHeaderActions HTTPHeaderActions [optional]

Sets of edit actions to take against request or response headers passing through the Route.

HTTPHeaderActions

request []HTTPHeaderAction [optional]

List of actions to take against request headers.

response []HTTPHeaderAction [optional]

List of actions to take against response headers.

HTTPHeaderAction

name string

Name of the header to target.

action string

Action to take against the specified header. Can be Set or Delete. Set will create the header if it does not exist or update the value if it does.

value string [optional]