Enable Workspace Gateway
This section introduces how to enable workspace gateways.
Prerequisites
KubeSphere Gateway should have been installed and enabled.
You should join a workspace and have the Workspace Gateway Management permission within the workspace. For more information, refer to "Workspace Members" and "Workspace Roles".
Steps
Log in to the KubeSphere web console with a user who has the Workspace Gateway Management permission, and access your workspace.
Click Workspace Settings > Gateway Settings in the left navigation pane.
On the right side of the Gateway Settings page, click Enable Gateway.
Note Enabling project gateways on the workspace’s Gateway Settings page is not supported. If you need to enable a project gateway, please go to the corresponding project.
In the pop-up Enable Gateway dialog box, set the parameters for the gateway, and then click OK.
Parameter Description Nginx Ingress Version
The version of Nginx Ingress. The KubeSphere Gateway extension provides gateway management based on Nginx Ingress.
IngressClassName
The name of the IngressClass.
Pod Replicas
The desired number of pod replicas.
Access Mode
The external access mode of the gateway service.
NodePort: The system maps the ports of nodes to the service ports, and the service can be accessed through the node IP address and node port.
LoadBalancer: On the basis of a NodePort service, the system assigns an external IP address to the service and binds the external IP address to an external load balancer. The external load balancer listens on the node port corresponding to the service, allowing access to the service through the external IP address. To achieve this, LoadBalancer-type services need support from load balancer plugins and the infrastructure environment, and relevant annotations need to be set. For more information, please contact your infrastructure environment provider.
Tracing
Whether to enable tracing for the gateway. To use the tracing function, the KubeSphere Service Mesh extension should be installed and enabled.
Configuration Options
The configuration options for the gateway. The gateway functionality of KubeSphere is based on Nginx Ingress Controller. You can set the configuration options for the gateway to control its behavior. For more information, please refer to the Nginx Ingress Controller Documentation.
Load Balancer Provider
The load balancer provider for the gateway. When the external access mode of the gateway service is LoadBalancer, you need to set the annotations of the gateway service according to the load balancer plugin and infrastructure environment to create the required load balancer. After selecting the load balancer provider, the system will provide annotation hints when setting the gateway service annotations. Only available when the external access mode of the gateway service is LoadBalancer.
Annotations
The annotations of the gateway service. If a load balancer provider has been selected, the system will display annotation hints in the dropdown list when clicking the Key text box. Only available when the external access mode of the gateway service is LoadBalancer. For more information, please contact your infrastructure environment provider.
Feedback
Was this page Helpful?
Receive the latest news, articles and updates from KubeSphere
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.
Previous
What’s on this Page