Creating a Load Balancer

• Console
• CLI
• API

• On the list page, select Create load balancer. If you need help finding the list page, see Listing Load Balancers.

  1. Add Details

  Enter the following basic information:

  • Load balancer name: Accept the default name or enter a friendly name for the load balancer. The name doesn't have to be unique, but it can't be changed in the Console. You can, however, change it with the API.

  • Choose visibility type: Select one of the following options:

    • Public: Create a public load balancer. You can use the assigned public IP address as a front end for incoming traffic and to balance that traffic across all backend servers. When you select the public IP address option, you're also prompted to select and complete the public IP address type.

    • Private: Create a private load balancer. You can use the assigned private IP address as a front end for incoming internal VCN traffic and to balance that traffic across all backend servers.

  • Assign a public IP address: When you choose to create a public load balancer, select one of the following options. For more information, see Public IP Addresses.

    • Ephemeral IP address: Let Oracle specify an ephemeral IP address for you from the Oracle IP pool. This option is the default.

    • Reserved IP address: Specify an existing reserved IP address by name, or create a new reserved IP address by assigning a name and selecting a source IP pool for the address. If you don't select a user-created pool, the default Oracle IP pool is used.

  Bandwidth

  For the load balancer's bandwidth, select Flexible shapes. Dynamic shapes are deprecated and we don't recommend using them.

  • Minimum bandwidth and Maximum bandwidth: Select values to create an upper and lower size range for the load balancer's bandwidth shape. Possible sizes range from 10 Mbps to 8,000 Mbps.

    • The minimum bandwidth reflects the amount of bandwidth that's always available to provide instant readiness for the workloads.

    • The maximum bandwidth is the upper amount of bandwidth the load balancer supports during time of peak workload.

    To specify a fixed shape size, for example 500 Mbps, set the minimum and maximum sliders to the same value.

    If you're creating the load balancer as a paid account user, you can create various shape options based on your limits and later adjust the bandwidth by changing the shape after the load balancer has been created. You can view your service limits and quotas in the Console by navigating to Governance & Administration > Limits, Quotas and Usage. Select "LbaaS" from the Service list. The bandwidth size options are listed. See Service Limits.

    Billing is per minute for your load balancer base instance, plus a bandwidth usage fee.

    • If the actual usage is less than or equal to your specified minimum bandwidth, you're billed for the minimum bandwidth.

    • If actual usage exceeds the minimum bandwidth, you're billed for the actual bandwidth used for that minute.

    The Always Free option is incorporated into your paid account in your home region. The first 10 Mbps of your bandwidth is free, and is indicated as such on your bill.

    Note
    
    

    Government accounts using prepaid dynamic (fixed) shape sizes run the risk of overage charges when flexible bandwidth shapes exceed the predetermined size. Update government accounts to the flexible load balancer SKU, with the appropriate bandwidth quantity, in their contract before using the flexible load balancer feature.

    If you're using non-universal credit SKUs, ensure that your contract includes the shape you're updating to so you can prevent incurring overage charges.

    You can adjust the bandwidth shape to a different size after you have completed creating the load balancer. See Changing a Load Balancer's Bandwidth Shape.

  • Enable IPv6 address assignment: Select this checkbox if the load balancer supports IPv6 addresses for incoming requests. For more information about Oracle Cloud Infrastructure's IPv6 implementation, see IPv6 Addresses.

    When you create a load balancer, you can optionally choose to have an IPv4/IPv6 dual-stack configuration. When you choose the IPv6 option, the Load Balancing service assigns both an IPv4 and an IPv6 address to the load balancer. The load balancer receives client traffic sent to the assigned IPv6 address. The load balancer uses only IPv4 addresses to communicate with backend servers. The load balancer and the backend servers don't use IPv6 communication.

    IPv6 address assignment occurs only at load balancer creation. You can't assign an IPv6 address to an existing load balancer.

  Networking

  If the current compartment contains at least one VCN, the Console provides a list of VCNs from which to select. Change the compartment as needed to find the VCN that you want to use.

  • Virtual cloud network compartment: Select the compartment that contains the VCN that you want to use for the load balancer.

  • Virtual cloud network: Select the VCN that you want to use for the load balancer.

  • Subnet compartment: Select an available subnet. For a public load balancer, it must be a public subnet. In addition to public or private, subnets can be either regional or AD-specific. We recommend using regional subnets. See Overview of VCNs and Subnets.

  • Subnet (2 of 2): Required for a public load balancer when you specify an AD-specific subnet for Subnet and the region that you're working in contains more than one Availability domain. Select a second public subnet. The second subnet must reside in a separate Availability domain from the first subnet.

    Note
    
    

    To create a VCN in a compartment that doesn't already contain on, the system offers to create a VCN for you. You can optionally enter a friendly name for the new VCN. It doesn't have to be unique, and it can't be changed later in the Console (but you can change it with the API). If you don't specify a name for the new VCN, the system generates a name for you.

  • Use network security groups to control traffic: Select to add your load balancer to a network security group (NSG). See Network Security Groups. By default, the Console shows a list of NSGs in the compartment you're working in. Change compartments to select an NSG from a different compartment. Then, select the NSG. You can select more than one NSG. You can change the NSGs that your load balancer belongs to after you create it.

  Security

  Enter the following information:

  • Use a web application firewall policy to protect against layer 7 attacks: Select to apply web application firewall policies to the load balancer as a safeguard against attack.

  • Assign in region web application firewall policy: Select a web application firewall policy available in the current compartment from the list. Change compartments to access the web application firewall policies in a different compartment.

  For more information about web application firewall policies, see Overview of Web Application Firewall.

  Acceleration

  Enter the following information:

  • Use a web application acceleration policy to speed up your performance: Select to apply web application acceleration policies to speed up your performance.

  • Assign a web application acceleration policy: Select a web application firewall policy available in the current compartment from the list. Change compartments to access the web application acceleration policies in a different compartment.

  For more information about web application acceleration policies, see Overview of Web Application Acceleration.

  Management

  Enter the following information.

  • Create in compartment: Select the compartment for the load balancer.

  • Prevent deletion of the load balancer, listeners and backends when they are still active: Select this checkbox to avoid accidentally deleting a load balancer, or a listener or backend server contained in a load balancer, when they're configured to accept traffic.

    • Load balancers are configured to accept traffic when they contain listeners that are configured to accept traffic.

    • Listeners are configured to accept traffic when they reference a backend set with backend servers that are configured to accept traffic.

    • Backend servers are configured to accept traffic when they're in a backend set referenced by a listener and the backend server is neither drained nor offline.

  Tagging

  If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.

  Dynamic Shapes (deprecated)

  The following describes the Dynamic Shapes feature, which is only available to certain legacy customer accounts:

  Dynamic shapes: Select one of the following predefined shape sizes:

  • 10 Mbps

  • 100 Mbps

  • 400 Mbps

  • 8,000 Mbps

  If you're creating the load balancer as a paid account user, you can create various shape options based on your limits and later adjust the bandwidth by changing the shape after the load balancer has been created. You can view your service limits and quotas in the Console by navigating to Governance & Administration > Limits, Quotas and Usage. Select LbaaS from the Service list. Your bandwidth size options are listed. See Service Limits.

  You can adjust the bandwidth shape to a different size after you have completed creating the load balancer. See Changing a Load Balancer's Bandwidth Shape.

  If you adjust a dynamic size value to a flexible size using the sliders, you can't revert to a dynamic shape of any size. You can achieve the effect of having a dynamic (fixed) size by setting the minimum and maximum sliders to the same size.

  Select Next to advance to the next step.

  2. Choose Backend Servers

  A load balancer distributes traffic to backend servers within a backend set. A backend set is a logical entity defined by a load balancing policy, a list of backend servers (compute instances), and a health check policy. The load balancer creation workflow creates one backend set for your load balancer. Optionally, you can add backend sets and backend servers after you create the load balancer.

  Load Balancing Policy

  Select the load balancer policy to use for the backend set:

  • Weighted round robin: (Default) Distributes incoming traffic sequentially to each server in a backend set list. After each server has received a connection, the load balancer repeats the list in the same order. Round robin is a basic load balancing algorithm. It works best when all the backend servers have similar capacity and the processing load required by each request doesn't vary much.

  • IP hash: Ensures that requests from a particular client are always directed to the same backend server. The load balancer routes requests from the same client to the same backend server as long as that server is available. This policy honors server weight settings when establishing the initial connection. You can't add a backend server marked as Backup to a backend set that uses the IP hash policy.

  • Least connections: Routes incoming request traffic to the backend server with the fewest active connections. This policy helps you maintain an equal distribution of active connections with backend servers. As with the round robin policy, you can assign a weight to each backend server and further control traffic distribution.

  For more information on these policies, see Load Balancer Policies.

  Backend Servers

  Specify one or more backend servers to use for the load balancer. You can add more after you create the load balancer, if needed.

  1. Select the compartment that contains the compute instance that you want to use as a backend server. You can select instances from only one compartment at a time.
  2. Select Add instance.
  3. In the Add backends panel, select the instances that you want to include in the load balancer's backend set. You can't add a backend server marked as Backup to a backend set that uses the IP hash policy.
  4. Select Add instances.
  5. To add instances from another compartment, select that compartment and repeat the preceding steps.

  After you add instances to the backend set, they appear in the Select backend servers table. You can perform the following actions:

  • Specify the server port to which the load balancer must direct traffic. The default is port 80.

  • From the Action menu for a server, select Delete to remove it from the backend set.

  Health Check Policy

  Specify the test parameters that confirm the health of your backend servers:

  • Protocol: Specify the protocol to use for health check queries, either HTTP or TCP. Configure your health check protocol to match your application or service. See Health Check Policies for Load Balancers.

  • Port: Specify the backend server port against which to run the health check. You can enter the value "0" to have the health check use the backend server's traffic port.

  • Force plaintext health checks: (HTTP only) Select to send the health check to the backend server without SSL. This option is only available when the backend server has its protocol is set to HTTP. It has no effect when the backend server doesn't have SSL enabled. When SSL is disabled, health checks are always plaintext.

  • Interval in ms: Specify how often to run the health check, in milliseconds. The default is 10000 (10 seconds).

  • Timeout in ms: Specify the maximum time in milliseconds to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. The default is 3000 (3 seconds).

  • Number of retries: Specify the number of retries before a backend server is considered "unhealthy." This number also applies when recovering a server to the "healthy" state. The default is 3.

  • Status code: (HTTP only) Specify the status code a healthy backend server must return.

  • URL path (URI): (HTTP only) Specify a URL endpoint against which to run the health check.

  • Response body regex: (HTTP only) Provide a regular expression for parsing the response body from the backend server.

  SSL

  Select to apply SSL to the load balancer backend. If you select this option, complete the following. If the best security is required, it's your responsibility to always use HTTPS for traffic between the load balancer and the backend set. Enter the following information:

  • Certificate resource: Select one of these options from the list:

    • Load balancer service managed certificate: Select the CA bundle or Certificate authority option, and then select your choice from the associated list. Click Change compartment to select a different compartment from which to select the CA bundle or certificate authority.

    • Load balancer management certificate: Select one of the following:

      • Choose SSL certificate file: Drag the certificate file into the SSL certificate field. You can also click Select Files and navigate your system to where you can select the certificate file for upload. Certificate files must be in PEM format and must have the .pem, .cer, or .crt file extensions.

        If you submit a self-signed certificate for backend SSL, you must submit the same certificate in the corresponding CA Certificate field.

      • Paste SSL certificate: Copy and paste a certificate directly into this field.

  • Specify CA certificate: (Recommended for backend SSL termination configurations.) Select to provide a CA certificate. See Load Balancer- Managed SSL Certificates.

  • Choose private key file: Drag the private key, in PEM format, into the Private key field. You can also select the Paste private key option to paste a private key directly into this field.

  • Enter private key passphrase: Specify the private key passphrase.

  Backend Set

  Enter a name for the backend set. It must be unique within the load balancer, and it can't be changed. If you don't specify a name, the Load Balancer service creates one for you. Use only alphanumeric characters, dashes ("-"), and underscores ("_") for backend set names. Backend set names can't contain spaces.

  Max Backend Connections

  Enter the following information:

  • Set limit: Toggle to set a limit to the number of active backend connections at a time. Setting a limit on the maximum number of backend server connections for this backend set specifies the default maximum connections value for all backend servers in the backend set. Individual backend servers in the backend set can have their own maximum connections value which overrides this default value. See Editing a Backend Set for more information.

  • Max backend connections: Specify the maximum number of connections in the box. You must specify value within the range of 256–65535 connections.

  Security List

  Select whether to manually configure subnet security list rules to allow the intended traffic, or to allow the system to create security list rules for you. To learn more about these rules, see Parts of a Security Rule.

  • Manually configure security list rules after the backend servers are added: When you select this option, you must configure security list rules after you add the backend servers.

  • Automatically add security list rules: When you select this option, the Load Balancer service creates security list rules for you. The system displays a table for the Egress security list and the Ingress security list. Each table lets you select the security list that applies to the relevant subnet. You can select whether to apply the proposed rules for each affected subnet.

  Session Persistence

  Specify how the load balancer manages session persistence. See Load Balancer Session Persistence for important information on configuring these settings.

  • Disable session persistence: Select this option to disable cookie-based session persistence.

  • Enable application cookie persistence: Select this option to enable persistent sessions from a single logical client when the backend application server response includes a Set-cookie header with the cookie name you specify.

    • Cookie name: The cookie name used to enable session persistence. Specify * to match any cookie name.

    • Disable fallback: Select to disable fallback when the original server is unavailable.

  • Enable load balancer cookie persistence: Select this option to enable persistent sessions based on a cookie inserted by the load balancer.

    • Cookie name: Specify the name of the cookie used to enable session persistence. If blank, the default cookie name is X-Oracle-BMC-LBS-Route. Ensure that any cookie names used at the backend application servers are different from the cookie name used at the load balancer.

    • Disable fallback: Select to disable fallback when the original server is unavailable.

    • Domain name: Specify the domain in which the cookie is valid. This attribute has no default value. If you don't specify a value, the load balancer doesn't insert the domain attribute into the Set-cookie header.

    • Path: Optional. Specify the path in which the cookie is valid. The default value is /.

    • Expiration period in seconds: Specify the amount of time the cookie remains valid. If blank, the cookie expires at the end of the client session.

    • Secure: Specify whether the Set-cookie header must contain the Secure attribute. If selected, the client sends the cookie only using a secure protocol. If you enable this setting, you can't associate the corresponding backend set with an HTTP listener.

    • HTTP only: Specify whether the Set-cookie header must contain the HttpOnly attribute. If selected, the cookie is limited to HTTP requests. The client omits the cookie when providing access to cookies through non HTTP APIs such as JavaScript channels.

  Select Next to advance to the next step.

  3. Configure Listener

  Enter the following basic information:

  • Listener name: Enter a name for the listener. The name must be unique, and can't be changed. If you don't specify a name, the Load Balancer service creates one for you.

  • Specify the type of traffic your listener handles: Select the type of traffic your listener handles from the list: HTTPS, HTTP, HTTP/2, , and TCP

  • Specify the port your listener monitors for ingress traffic: Specify the port your listener monitors for ingress traffic. Following are the default values:

    • 443 for HTTPS

    • 80 for HTTP

    • 443 for HTTP/2

    • 22 for TCP

  SSL Certificate

  If you chose the HTTPS or HTTP/2 protocols, or if you chose the TCP protocol and selected Use SSL, specify certificate information. If best security is required, it's your responsibility to always use HTTPS for traffic between the load balancer and the backend set.

  Select one of the following options for Certificate resource:

  • Certificate service managed certificate: Select the CA bundle or Certificate authority option, and then select your choice from the associated list.

  • Load balancer management certificate: Select or paste the certificate. Certificate files must be in PEM format and must have the .pem, .cer, or .crt file extensions. If you submit a self-signed certificate for backend SSL, you must submit the same certificate in the corresponding CA certificate field.

    • Choose SSL certificate file: Drag the certificate file into the SSL certificate field. You can also click Select Files and navigate your system to where you can select the certificate file for upload. Certificate files must be in PEM format and must have the .pem, .cer, or .crt file extensions.

      If you submit a self-signed certificate for backend SSL, you must submit the same certificate in the corresponding CA Certificate field.

    • Paste SSL certificate: Copy and paste a certificate directly into this field.

    • Specify CA certificate: (Recommended for backend SSL termination configurations.) Select to provide a CA certificate. See Load Balancer- Managed SSL Certificates.

    • Choose private key file: Drag the private key, in PEM format, into the Private key field. You can also select the Paste private key option to paste a private key directly into this field.

    • Enter private key passphrase: Specify the private key passphrase.

  • Enable session resumption: Select to resume the previous encryption session rather than complete a new SSL connection before each request. Enabling session resumption improves performance but provides a lower level of security. Deselect the feature to force a new SSL connection before each request. Disabling session resumption improves security but reduces performance.

  SSL Policy

  (HTTPS and HTTP/2 only) Specify the type of cipher suite to use. Enter the following information:

  • TLS version: Specify the Transport Layer Security (TLS) versions: 1.0, 1.1, 1.2, 1.3

    We recommend 1.2. You can select any combination of versions. The HTTP/2 protocol only supports TLS 1.2 and TLS 1.3.

  • Select cipher suite: To use a predefined set of cipher suites, select this option and then select the cipher suite to use. All listed cipher suites have at least one cipher from each of the TLS versions you selected. The HTTP/2 protocol only supports a default cipher. You can't change it.

  • Create custom cipher suite: To add ciphers to a new suite, select this options and perform the following steps:

    1. Enter the name of the customer cipher suite in the Suite name field.

    2. Select the Select ciphers button.

    3. In the Select ciphers panel, select each cipher that you want to include in the suite. The TLS versions associated with each cipher are listed in the Version column. Ensure that any cipher you select is compatible with the TLS versions you previously chose. Assign at least one cipher to a cipher suite you create. You can't create a cipher suite that contains no ciphers.

    4. Deselect any ciphers you want to exclude.

    5. Select the Select ciphers button.

  • Show cipher suite details: Select to display what ciphers the selected cipher suite contains.

  • Server order preference: Enable to give preference to the server ciphers over the client.

  Advanced SSL

  (HTTP and TCP only) Select a CA bundle or Certificate Authority for use with the listener. Then select CA bundle or Certificate Authority from the corresponding list. Change compartments if you can't find the item you want in your current compartment.

  Timeout

  Specify the maximum idle time in seconds. The maximum value is 7200 seconds. See Load Balancer Timeout Connection Settings

  Proxy Protocol

  Enable and configure proxy protocol on the load balancer. See Proxy Protocol for more information on this feature.

  1. Select Enable Proxy Protocol.
  2. Select which proxy protocol version you want to use:

     • Version 1: Supports a human-readable header (text) format and is typically a single line of a log entry. Use this option for debugging during the early adoption stage when few implementations exist.

     • Version 2: Combines support for the human-readable header from Version 1 with a binary encoding of the header for greater efficiency in producing and parsing. Use this option for IPv6 addresses, which are difficult to generate and parse in ASCII form. Version 2 also better supports custom extensions. By default, PP2 Type Authority is selected as the only Version 2 option available.

  Select Next to advance to the next step.

  4. Manage Logging

  Enabling error and access logs are optional, but recommended. Reviewing these logs can help you with diagnosing and fixing issues with your backend servers. Standard limits, restrictions, and rates apply when enabling the logging feature. See Logging for Load Balancers for general information on how the Load Balancer service uses logging. For more information on log and log groups, including naming syntax guidelines, see Logs and Log Groups.

  Note
  
  

  Error logging is enabled by default. Disable this feature if you don't want to pay the associated fees.

  • Error logs
    • Enable: Toggle to enable logging. Logging is enabled by default.

    • Compartment: Select the compartment within which the log file resides from the list.

    • Log group: Select an existing log group from the list or click Create New Group where you can enter the name and description of a new logging group within which your log resides.

    • Log name: Enter the name of the log.

    • Log retention: Select the time period in months each error logging entry is to be retained from the list.

  • Access logs
    • Enable: Toggle to enable logging. Access logging is disabled by default.

    • Compartment: Select the compartment within which the log file resides from the list.

    • Log group: Select an existing log group from the list or click Create New Group where you can enter the name and description of a new logging group within which your log resides.

    • Log name: Enter the name of the log.

    • Log retention: Select the time period in months each error logging entry is to be retained from the list.

  • Request ID

    The Request ID can help you with tracking and managing a request by providing a unique request identifier exposed in HTTP request and response headers.

    To use a request ID, switch the toggle to Enabled. The default header name X-Request-Id is included in the HTTP request header from the load balancer to the backend and HTTP header responses. If not enabled, the load balancer won't add this unique request ID header to the request passed through to the load balancer backend or to the response returned. You can enter a different header name instead of using the default. Any custom header name must start with "X-".

    See Load Balancer Headers for more information.

  Select Next to advance to the next step.

  5. Review and Create

  Click Submit. The Review and create page appears.

  Review the complete load balancer configuration before you submit it for creation. To change your load balancer setup, click Previous until you reach the page where you can make your updates.

  After the system provisions the load balancer, details appear in the list in the Load balancer page. To view more details, click the load balancer name.

• Use the oci lb load-balancer create command and required parameters to create a load balancer:

  oci lb load-balancer create --compartment-id compartment_id --display-name display_name --shape-name shape_name --subnet-id subnet_id [OPTIONS]

  For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

• Run the CreateLoadBalancer operation to create a load balancer.