Load Balancer: Backend¶
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 | Backend |
| 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_backend.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 |
|---|---|---|---|
backendSetName |
The name of the backend set associated with the backend server. Example: example_backend_set |
string |
Yes |
backup |
Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy. Example: false |
boolean |
No |
drain |
Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false |
boolean |
No |
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
Yes |
loadBalancerId |
The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer associated with the backend set and server. | string |
Yes |
maxConnections |
The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. Example: 300 |
integer |
No |
offline |
Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No |
port |
The communication port for the backend server. Example: 8080 |
integer |
Yes |
weight |
The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work (https://docs.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: 3 |
integer |
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 |
|---|---|---|---|
backendSetName |
The bound backend set name used to address this backend. | string |
No |
backup |
Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy. Example: false |
boolean |
No |
drain |
Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false |
boolean |
No |
ipAddress |
The IP address of the backend server. Example: 10.0.0.3 |
string |
No |
loadBalancerId |
The bound load balancer OCID used to address this backend. | string |
No |
maxConnections |
The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. Example: 300 |
integer |
No |
name |
A read-only field showing the IP address and port that uniquely identify this backend server in the backend set. Example: 10.0.0.3:8080 |
string |
No |
offline |
Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false |
boolean |
No |
port |
The communication port for the backend server. Example: 8080 |
integer |
No |
status |
- | object |
Yes |
weight |
The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work (https://docs.oracle.com/iaas/Content/Balance/Reference/lbpolicies.htm). Example: 3 |
integer |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/loadbalancer_v1beta1_backend.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: Backend
metadata:
name: backend-sample
spec:
loadBalancerId: ocid1.loadbalancer.oc1..<unique_ID>
backendSetName: example_backend_set
ipAddress: "10.0.0.3"
port: 8080
weight: 1
backup: false
drain: false
offline: false