OpenShift Container Platform provides methods for communicating from outside the cluster with services running in the cluster. This method uses an Ingress Controller.

Using Ingress Controllers and routes

The Ingress Operator manages Ingress Controllers and wildcard DNS.

Using an Ingress Controller is the most common way to allow external access to an OpenShift Container Platform cluster.

An Ingress Controller is configured to accept external requests and proxy them based on the configured routes. This is limited to HTTP, HTTPS using SNI, and TLS using SNI, which is sufficient for web applications and services that work over TLS with SNI.

Work with your administrator to configure an Ingress Controller to accept external requests and proxy them based on the configured routes.

The administrator can create a wildcard DNS entry and then set up an Ingress Controller. Then, you can work with the edge Ingress Controller without having to contact the administrators.

When a set of routes is created in various projects, the overall set of routes is available to the set of Ingress Controllers. Each Ingress Controller admits routes from the set of routes. By default, all Ingress Controllers admit all routes.

Ingress Controllers that have permission to view all of the labels in all projects can select routes to admit based on the labels. This is called Ingress Controller sharding. This is useful when balancing incoming traffic load among a set of Ingress Controllers and when isolating traffic to a specific Ingress Controller. For example, company A goes to one Ingress Controller and company B to another.

The Ingress Controller:

  • Has two replicas by default, which means it should be running on two worker nodes.

  • Can be scaled up to have more replicas on more nodes.

The procedures in this section require prerequisites performed by the cluster administrator.


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:

    oc adm policy add-cluster-role-to-user cluster-admin username
  • Have an OpenShift Container Platform 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.

Creating a project and service

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, go to the next step: Exposing the service to create a route.

  1. Log into OpenShift Container Platform.

  2. Create a new project for your service:

    $ oc new-project <project_name>

    For example:

    $ oc new-project <myproject>
  3. Use the oc new-app command to create a service:

    For example:

    $ oc new-app \
        -e MYSQL_USER=admin \
        -e MYSQL_PASSWORD=redhat \
        -e MYSQL_DATABASE=mysqldb \
  4. Run the following command to see that the new service is created:

    $ oc get svc -n openshift-ingress
    NAME                      TYPE           CLUSTER-IP      EXTERNAL-IP      PORT(S)                      AGE
    router-default            LoadBalancer   80:30745/TCP,443:32561/TCP   2d6h
    router-internal-default   ClusterIP   <none>           80/TCP,443/TCP,1936/TCP      2d6h

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

Exposing the service by creating a route

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

To expose the service:

  1. Log into OpenShift Container Platform.

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

    $ oc project project1
  3. Run the following command to expose the route:

    oc expose service <service-name>

    For example:

    oc expose service mysql-55-rhel7
    route "mysql-55-rhel7" exposed
  4. Use a tool, such as cURL, to make sure you can reach the service using the cluster IP address for the service:

    curl <pod-ip>:<port>

    For example:


    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 connected to the service.

    If you have a MySQL client, log in with the standard CLI command:

    $ mysql -h -u admin -p
    Enter password:
    Welcome to the MariaDB monitor.  Commands end with ; or \g.
    MySQL [(none)]>

Additional resources