A gateway in a KubeSphere project is an NGINX Ingress controller. KubeSphere has a built‑in configuration for HTTP load balancing, called Routes. A Route defines rules for external connections to Services within a cluster. Users who need to provide external access to their Services create a Route resource that defines rules, including the URI path, backing service name, and other information.
In KubeSphere 3.0, a project gateway works independently for itself. In other words, every project has its own Ingress controller. In the next release, KubeSphere will provide a cluster-scope gateway in addition to the project-scope gateway, allowing all projects to share the same gateway.
This tutorial demonstrates how to set a gateway in KubeSphere for the external access to Services and Routes.
You need to create a workspace, a project and an account (
project-admin). The account must be invited to the project with the role of
admin at the project level. For more information, see Create Workspaces, Projects, Accounts and Roles.
Set a Gateway
Log in to the KubeSphere web console as
project-adminand go to your project. In Project Settings from the navigation bar, select Advanced Settings and click Set Gateway.
In the pop-up window, you can select two access modes for the gateway.
NodePort: You can access Services with corresponding node ports through the gateway.
LoadBalancer: You can access Services with a single IP address through the gateway.
You can also enable Application Governance on the Set Gateway page. You need to enable Application Governance so that you can use the Tracing feature and use different grayscale release strategies. Once it is enabled, check whether an annotation (for example,
nginx.ingress.kubernetes.io/service-upstream: true) is added for your route (Ingress) if the route is inaccessible.
After you select an access method, click Save.
If you select NodePort, KubeSphere will set a port for http and https requests respectively. You can access your Service at
For example, to access your Service with an elastic IP address (EIP), visit:
When you create a Route (Ingress), you can customize a host name to access your Service. For example, to access your Service with the host name set in your Route, visit:
You may need to open ports in your security groups and configure relevant port forwarding rules depending on your environment.
If you access your Service using the host name, make sure the domain name you set can be resolved to the IP address.
NodePort is not recommended for a production environment. You can use LoadBalancer instead.
You must configure a load balancer in advance before you select LoadBalancer. The IP address of the load balancer will be bound to the gateway to provide access to internal Services and Routes.
Was this page Helpful?
Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.