This section describes how to edit workspace gateway settings.

Prerequisites

  • The KubeSphere Gateway extension must be installed and enabled on the KubeSphere platform.

  • You need to join a workspace and have the Workspace Gateway Management permission in the workspace. For more information, see Workspace Members and Workspace Roles.

Steps

  1. Log in to the KubeSphere web console with a user who has Workspace Gateway Management permissions and enter your workspace.

  2. Click Workspace Settings > Gateway Settings in the left navigation pane.

  3. On the right side of the page, select Manage > Edit.

  4. In the dialog box that appears, modify the gateway parameters, and then click OK.

    Parameter Description

    IngressClassName

    The name of the IngressClass.

    Pod Replicas

    The desired number of pod replicas. This value must be within the configured range of the minimum and maximum number of actually running pod replicas.

    Running Pod Replica Limits

    Limits the minimum and maximum number of actually running pod replicas to ensure gateway performance and prevent resource exhaustion.

    External Access Mode

    The external access mode for the gateway service.

    • NodePort: The system maps a node’s port to the service port, allowing access to the service via the node’s IP address and the node port.

    • LoadBalancer: The system allocates an external IP address for the service based on a NodePort 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, enabling access to the service via the external IP address. To achieve this functionality, a LoadBalancer type service requires support from a load balancer plugin and the underlying 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 feature, the KubeSphere Service Mesh extension must be installed and enabled on the KubeSphere platform.

    Load Balancer Provider

    The load balancer provider for the gateway. When the gateway’s external access mode is LoadBalancer, you need to set annotations for the gateway service according to the load balancer plugin and infrastructure environment to create the required load balancer. After selecting a load balancer provider, the system will provide annotation hints when setting gateway service annotations. Available only when the gateway service’s external access mode is LoadBalancer.

    Annotations

    Annotations for the gateway service. If a load balancer provider has been selected, the system will display annotation hints in a dropdown list when you click the Key text box. Available only when the gateway service’s external access mode is LoadBalancer. For more information, please contact your infrastructure environment provider.

    Configuration Options

    Configuration options for the gateway. KubeSphere’s gateway functionality is implemented based on the Nginx Ingress Controller. You can set gateway configuration options to control gateway behavior. For more information, please refer to the Nginx Ingress Controller official documentation.

    CPU Reservation

    The CPU resources reserved for each gateway container, in cores.

    CPU Limit

    The maximum CPU resources allowed for each gateway container, in cores.

    Memory Reservation

    The memory resources reserved for each gateway container, in MiB.

    Memory Limit

    The maximum memory resources allowed for each gateway container, in MiB.