Load Balancer: BackendSet¶
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 | BackendSet |
| 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 |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/loadbalancer_v1beta1_backendset.yaml)
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 |
|---|---|---|---|
backendMaxConnections |
The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. If setting backendMaxConnections to some value other than 0 then that value must be greater or equal to 256. Example: 300 |
integer |
No |
backends |
- | list[object] |
No |
healthChecker |
BackendSetHealthChecker defines nested fields for BackendSet.HealthChecker. | object |
Yes |
lbCookieSessionPersistenceConfiguration |
BackendSetLbCookieSessionPersistenceConfiguration defines nested fields for BackendSet.LbCookieSessionPersistenceConfiguration. | object |
No |
loadBalancerId |
The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer that owns this backend set. | string |
Yes |
name |
A friendly name for the backend set. It must be unique and it cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. Example: example_backend_set |
string |
Yes |
policy |
The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS |
string |
Yes |
sessionPersistenceConfiguration |
BackendSetSessionPersistenceConfiguration defines nested fields for BackendSet.SessionPersistenceConfiguration. | object |
No |
sslConfiguration |
BackendSetSslConfiguration defines nested fields for BackendSet.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 |
|---|---|---|---|
backendMaxConnections |
The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting. If this is not set or set to 0 then the number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting is unlimited. Example: 300 |
integer |
No |
backends |
- | list[object] |
No |
healthChecker |
BackendSetHealthChecker defines nested fields for BackendSet.HealthChecker. | object |
No |
lbCookieSessionPersistenceConfiguration |
BackendSetLbCookieSessionPersistenceConfiguration defines nested fields for BackendSet.LbCookieSessionPersistenceConfiguration. | object |
No |
loadBalancerId |
The bound load balancer OCID used to address this backend set. | string |
No |
name |
A friendly name for the backend set. It must be unique and it cannot be changed. Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information. Example: example_backend_set |
string |
No |
policy |
The load balancer policy for the backend set. To get a list of available policies, use the ListPolicies operation. Example: LEAST_CONNECTIONS |
string |
No |
sessionPersistenceConfiguration |
BackendSetSessionPersistenceConfiguration defines nested fields for BackendSet.SessionPersistenceConfiguration. | object |
No |
sslConfiguration |
BackendSetSslConfiguration defines nested fields for BackendSet.SslConfiguration. | object |
No |
status |
- | object |
Yes |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/loadbalancer_v1beta1_backendset.yaml. Replace placeholder values before applying it.
#
# 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: BackendSet
metadata:
name: backendset-sample
spec:
loadBalancerId: ocid1.loadbalancer.oc1..<unique_ID>
name: example_backend_set
policy: ROUND_ROBIN
healthChecker:
protocol: HTTP
urlPath: /healthz
port: 8080
returnCode: 200