Skip to content

Load Balancer: Listener

Manage OCI Load Balancer resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot

Field Value
Service loadbalancer
Resource Listener
API Version loadbalancer.oracle.com/v1beta1
Package Load Balancer
Support Status Preview
Latest Released Version v2.1.0-alpha
Install Namespace oci-service-operator-loadbalancer-system

Spec Fields

This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
connectionConfiguration ListenerConnectionConfiguration defines nested fields for Listener.ConnectionConfiguration. object No
defaultBackendSetName The name of the associated backend set. Example: example_backend_set string Yes
hostnameNames An array of hostname resource names. list[string] No
loadBalancerId The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer that owns this listener. string Yes
name A friendly name for the listener. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_listener string Yes
pathRouteSetName Deprecated. Please use routingPolicies instead. The name of the set of path-based routing rules, PathRouteSet, applied to this listener's traffic. Example: example_path_route_set string No
port The communication port for the listener. Example: 80 integer Yes
protocol The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP string Yes
routingPolicyName The name of the routing policy applied to this listener's traffic. Example: example_routing_policy string No
ruleSetNames The names of the RuleSet to apply to the listener. Example: ["example_rule_set"] list[string] No
sslConfiguration ListenerSslConfiguration defines nested fields for Listener.SslConfiguration. object No

Status Fields

This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.

Field Description Type Required
connectionConfiguration ListenerConnectionConfiguration defines nested fields for Listener.ConnectionConfiguration. object No
defaultBackendSetName The name of the associated backend set. Example: example_backend_set string No
hostnameNames An array of hostname resource names. list[string] No
loadBalancerId The bound load balancer OCID used to address this listener. string No
name A friendly name for the listener. It must be unique and it cannot be changed. Example: example_listener string No
pathRouteSetName Deprecated. Please use routingPolicies instead. The name of the set of path-based routing rules, PathRouteSet, applied to this listener's traffic. Example: example_path_route_set string No
port The communication port for the listener. Example: 80 integer No
protocol The protocol on which the listener accepts connection requests. To get a list of valid protocols, use the ListProtocols operation. Example: HTTP string No
routingPolicyName The name of the routing policy applied to this listener's traffic. Example: example_routing_policy_name string No
ruleSetNames The names of the RuleSet to apply to the listener. Example: ["example_rule_set"] list[string] No
sslConfiguration ListenerSslConfiguration defines nested fields for Listener.SslConfiguration. object No
status - object Yes

Sample Manifest

This example is generated from the checked-in sample manifest at config/samples/loadbalancer_v1beta1_listener.yaml. Replace placeholder values before applying it.

Open the rendered sample page

#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#

apiVersion: loadbalancer.oracle.com/v1beta1
kind: Listener
metadata:
  name: listener-sample
spec:
  loadBalancerId: ocid1.loadbalancer.oc1..<unique_ID>
  name: example_listener
  defaultBackendSetName: example_backend_set
  port: 80
  protocol: HTTP