Event Endpoint Management continues to be enhanced

Event Endpoint Management continues to be available and enhanced as part of IBM's integration platforms.

End of Marketing announcement for IBM Event Automation

Event Streams and Event Processing are deprecated and no enhancements will be provided. Support and security fixes will be provided in line with published support lifecycle policies. Future event-driven solutions that make use of Apache Kafka and Apache Flink will be delivered by IBM Confluent.

For more information, see the support lifecycle transition and software ordering completion announcement.

Event Gateway Custom Resource reference

Find out more about the Event Gateway custom resource properties.

Note: This reference page includes only the Event Gateway custom resource properties that you might want to view or update. Do not edit any custom resource properties that are not listed on this page.

spec

Field Type Description  
deployNetworkPolicies boolean Control the deployment of NetworkPolicies that are used by the instance. (default: true)  
endpoints []endpoint Deprecated: List of endpoint configurations. Use `spec.listener.{0}.groups.{0}.endpoint instead.  
fips fips Object containing Federal Information Processing Standard (FIPS) configuration.  
gatewayGroupName string The name of the gateway group to which this gateway is to be added.  
gatewayID string The identifier of the gateway group to which this gateway is to be added.  
gatewayContact string The contact information of the gateway administrator.  
license license Object containing product licensing details.  
listeners []listener Configure event gateway listeners.  
manager manager Configure Event Manager instance to register the gateway.  
managerEndpoint string Deprecated: The endpoint address for an Event Manager instance. Use spec.manager.endpoint instead.  
maxNumKafkaBrokers integer Deprecated: The maximum number of Kafka brokers your Event Gateway can connect to. Default is 20. Use spec.listener.{0}.groups.{0}.maxNumKafkaBrokers instead.  
openTelemetry openTelemetry Configuration for OpenTelemetry  
replicas integer The number of replicas for the gateway deployment  
security security Object containing security configuration.  
template template Object containing Kubernetes resource overrides.  
traceSpec string Dynamically configurable trace specification.  

spec.fips

Field Type Description
mode string The value for Federal Information Processing Standard (FIPS) mode. Valid value is ‘wall’.

spec.license

For more information about licensing, see the licensing reference.

Field Type Description
accept boolean Setting to true declares that you accept the license terms and conditions. (default: false)
license string The license to be used for this product instance.
metric string The license metric used for your product license.
use string The usage of the license with which you are installing the product.

spec.template

Field Type Description
annotations object Annotations that are added to all Kubernetes resources used by the instance. Any annotations that are added to the template object and subsequently deleted are not automatically removed from resources that are already instantiated. These annotations need to be manually removed from the existing resources.
labels object Labels that are added to all Kubernetes resources used by the instance.
pod pod Object containing pod override configuration.

spec.template.pod

Field Type Description
spec podSpec Kubernetes pod spec overrides.

spec.security

Field Type Description
connection connection Object containing connection options.
authentication authentication Object containing authentication options.
request request Object containing request options.

spec.security.authentication

Field Type Description
maxRetries integer The maximum number of failed authentication attempts after which further attempts are blocked. Default is -1 (no limit).
retryBackoffMs integer The backoff time in milliseconds between consecutive failed authentication attempts. Default is 0.
lockoutPeriod integer The duration in seconds while the account is locked after an unsuccessful authentication attempt. Default is 0.

spec.security.connection

Field Type Description
closeDelayMs integer The minimum delay in milliseconds after you close a connection. This property can reduce spam. Default is 8000.
closeJitterMs integer Additional delay in milliseconds after you close a connection. This property can prevent attacks. Default is 4000.
perSubLimit integer The maximum allowed TCP connections for each subscription. Default is -1 (no limit).
spec.security.connection.request
Field Type Description
maxSizeBytes integer The maximum size allowed for the request payload in bytes. Default is -1 (no limit).

spec.tls

Note: The spec.tls property is deprecated. Configure TLS in spec.listeners.tls.

Field Type Description
caCertificate string The key in the secret that holds the value of the CA certificate.
caSecretName string The name of a secret that contains the root CA certificate that the product uses when it creates additional certificates.
key string The key in the secret that holds the value of the private key.
secretName string The name of a secret containing certificates for securing component communications.
serverCertificate string The key in the secret that holds the value of the server certificate.
trustedCertificate array[trustedCertificate] A set of secrets that contain the certificates that the Event Gateway trusts when it communicates with other services, such as gateways or OIDC providers.

spec.openTelemetry

Field Type Description
endpoint string The endpoint to send the OpenTelemetry metrics. Must include protocol http:// or https://
protocol string The transport protocol to use, grpc (default) or http/protobuf.
interval integer The interval between reporting of metrics in milliseconds. Default is 30000.
tls otelTLS The configuration of SSL Certificates for mTLS and a trusted certificate for endpoint server validation.
instrumentations []instrumentation A list of instrumentations to enable, in addition to the instrumentations for the Event Manager and Event Gateway.
metricsEnablement []instrumentation Configure Event Gateway OpenTelemetry metrics enablement.
tracesEnablement []instrumentation Configure Event Gateway OpenTelemetry trace enablement.

spec.openTelemetry.tls

Field Type Description
clientCertificate string The key in the secret that holds the value of the PKCS8 encoded client certificate to use for mutualTLS (mTLS).
clientKey string The key in the secret that holds the value of the PKCS8 encoded private key certificate to use for mutualTLS (mTLS).
secretName string The name of a secret containing certificates for securing component communications for mutualTLS (mTLS).
trustedCertificate [] Configuration of a secret that contains a TLS certificate to trust to validate the endpoint server’s identity.

spec.openTelemetry.instrumentations

Field Type Description
name string The instrumentation name.
enabled boolean Whether to enable or disabled the specified instrumentation.

Important:

  • The name must be the instrumentation shortname. The supplied shortname is then automatically configured as an environment variable in the relevant pod as OTEL_INSTRUMENTATION_<name>_ENABLED=<enabled>.

spec.listeners

Field Type Description
groups []listenerGroup Groups of the listener.
name string Name of the listener.
port integer Port number of the listener.
tls listenerTLS Configure TLS for the Event Gateway listener.

spec.listeners.groups

Field Type Description
endpoint listenerEndpoint Object containing endpoint configuration for the listener group. Set this property to configure ingress and custom hosts.
maxNumKafkaBrokers integer The maximum number of Kafka brokers your Event Gateway can connect to. Default is 20. (minimum: 1, maximum: 50)
name string Name of the group in the listener.
type string Type of the group: ‘EXPLICIT’ or ‘WILDCARD’. Default is ‘EXPLICIT’.
spec.listeners.groups.endpoint
Field Type Description
annotations map[string] Annotations for ingress resources.
class string The ingress class name.
host string The host to set on the endpoint resource.

spec.listeners.tls

Field Type Description
caCertificate string The key in the secret that holds the value of the CA certificate.
caSecret caSecret The details of the root CA certificate that the product uses when it creates additional certificates.
certificateType string The type of certificate to generate: ‘wildcard’ for a single wildcard certificate (*.example.com), or ‘explicit’ for a single certificate with explicit hostnames as SANs. Defaults to ‘explicit’.
key string The key in the secret that holds the value of the private key.
secretName string The name of a secret containing certificates for securing component communications.
serverCertificate string The key in the secret that holds the value of the server certificate.
spec.listeners.tls.caSecret
Field Type Description
secretName string The name of a secret that contains a root CA certificate that the product uses when it creates additional certificates.

spec.manager

Field Type Description
apiKey managerApiKey Manager API key
endpoint string Manager endpoint
trustedCertificate trustedCertificate Manager endpoint certificate.

spec.manager.apiKey

Field Type Description
key string The key in the secret that holds the value of the API key.
secretName string The name of a secret containing API key for authenticating with the manager.

status

Important: Status field is used to display specific information about the instance. Do not edit the status field manually.

Field Type Description
conditions array[condition] A list of conditions that represent the state of the custom resource.
versions versions Object containing versioning information.
endpoints array[endpoint] A list of endpoints exposed by the instance.
phase string A value that represents the phase in which the instance is operating. One of Running, Failed, or Pending.

status.versions

Field Type Description
reconciled string The reconciled version of the instance
available available Object containing available versions.

status.versions.available

Field Type Description
versions array[version] A list of the available versions.
channels array[channel] A list of the available channels.
status.versions.available.versions
Field Type Description
name string The semantic version number.
licenses array[] A list of available licenses.
status.versions.available.channels
Field Type Description
name string The semantic version number.
licenses array[availableLicense] A list of available licenses.
status.versions.available.channels.licences
Field Type Description
name string The semantic version number.
displayName string Optional display name for the license.
link string Link to the license content.
matchesCurrentType boolean True if the license matches the type of license that is used by the current operand.

status.conditions

Field Type Description
lastTransitionTime string The time when the condition was applied.
message string Human-readable message that provides details about the condition.
reason string Machine-readable, UpperCamelCase text that indicates the reason for the condition.
status string Indicates whether that condition is applicable. One of True, False, or Unknown.

status.endpoints

Field Type Description
name string Unique name for the endpoint.
type string Type of service the endpoint exposes. For example, UI or API.
uri string The URI of the endpoint.