Last updated:

Edit Project Gateway Settings

This section introduces how to edit project gateway settings.

Prerequisites

KubeSphere Gateway should have been installed and enabled.
You should join a project and have the Project Gateway Management permission within the project. For more information, refer to "Project Members" and "Project Roles".

Steps

Log in to the KubeSphere web console with a user who has the Project Gateway Management permission, and access your project.
Click Project Settings > Gateway Settings in the left navigation pane.
On the right side of the page, select Manage > Edit.

In the pop-up dialog box, modify the parameters of the gateway, and then click OK.

Parameter	Description
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, KubeSphere Service Mesh 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.

Parameter

Description

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, KubeSphere Service Mesh 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 : View Project Gateway Details Next : Disable Project Gateway

What’s on this Page