Configuring ingress cluster traffic using a load balancer

    If you do not need a specific external IP address, you can configure a load balancer service to allow external access to an OKD cluster.

    A load balancer service allocates a unique IP. The load balancer has a single edge router IP, which can be a virtual IP (VIP), but is still a single machine for initial load balancing.

    Before starting the following procedures, the administrator must:

    • Set up the external port to the cluster networking environment so that requests can reach the cluster.

    • Make sure there is at least one user with cluster admin role. To add this role to a user, run the following command:

    • Have an OKD cluster with at least one master and at least one node and a system outside the cluster that has network access to the cluster. This procedure assumes that the external system is on the same subnet as the cluster. The additional networking required for external systems on a different subnet is out-of-scope for this topic.

    If the project and service that you want to expose do not exist, first create the project, then the service.

    If the project and service already exist, skip to the procedure on exposing the service to create a route.

    Prerequisites

    • Install the CLI and log in as a cluster administrator.

    Procedure

    1. Create a new project for your service by running the oc new-project command:

      1. $ oc new-project myproject
    2. Use the oc new-app command to create your service:

      1. $ oc new-app nodejs:12~https://github.com/sclorg/nodejs-ex.git
    3. To verify that the service was created, run the following command:

      1. $ oc get svc -n myproject
      1. NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
      2. nodejs-ex ClusterIP 172.30.197.157 <none> 8080/TCP 70s

      By default, the new service does not have an external IP address.

    You can expose the service as a route by using the oc expose command.

    Procedure

    To expose the service:

    1. Log in to OKD.

    2. Log in to the project where the service you want to expose is located:

      1. $ oc project myproject
    3. To verify that the service is exposed, you can use a tool, such as cURL, to make sure the service is accessible from outside the cluster.

      1. Use the oc get route command to find the route’s host name:

        1. $ oc get route

        Example output

        1. NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
      2. Use cURL to check that the host responds to a GET request:

        1. $ curl --head nodejs-ex-myproject.example.com

        Example output

        1. HTTP/1.1 200 OK
        2. ...

    Use the following procedure to create a load balancer service.

    Prerequisites

    • Make sure that the project and service you want to expose exist.

    To create a load balancer service:

    1. Log in to OKD.

    2. Load the project where the service you want to expose is located.

      1. $ oc project project1
    3. Open a text file on the control plane node and paste the following text, editing the file as needed:

      Sample load balancer configuration file

      1. apiVersion: v1
      2. kind: Service
      3. metadata:
      4. name: egress-2 (1)
      5. spec:
      6. - name: db
      7. port: 3306 (2)
      8. loadBalancerIP:
      9. loadBalancerSourceRanges: (3)
      10. - 192.168.0.0/16
      11. type: LoadBalancer (4)
      12. selector:
      13. name: mysql (5)
    4. Save and exit the file.

    5. Run the following command to create the service:

      For example:

      1. $ oc create -f mysql-lb.yaml
    6. Execute the following command to view the new service:

      1. $ oc get svc

      Example output

      1. NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
      2. egress-2 LoadBalancer 172.30.22.226 ad42f5d8b303045-487804948.example.com 3306:30357/TCP 15m

      The service has an external IP address automatically assigned if there is a cloud provider enabled.

    7. On the master, use a tool, such as cURL, to make sure you can reach the service using the public IP address:

      1. $ curl <public-ip>:<port>

      For example:

      1. $ curl 172.29.121.74:3306

      The examples in this section use a MySQL service, which requires a client application. If you get a string of characters with the Got packets out of order message, you are connecting with the service:

      Example output