All Products
Search
Document Center

Microservices Engine:Add a service source

Last Updated:Mar 10, 2026

A cloud-native gateway routes traffic to backend services by discovering them through service sources. A service source is a service registry or container cluster where your backend services are registered or deployed. After you add a service source, the gateway automatically discovers all services within it and makes them available for route configuration.

Supported source types

Source typeDescription
Container ServiceACK or ACK Serverless cluster where backend services run as pods
MSE NacosMSE-managed Nacos instance for service discovery
MSE ZooKeeperMSE-managed ZooKeeper instance for service discovery. Supported only by standard gateway instances.
SAE Built-in RegistryBuilt-in service registry in Serverless App Engine (SAE)
SAE KubernetesSAE Kubernetes namespace for service discovery
EDAS Built-in RegistryBuilt-in service registry in Enterprise Distributed Application Service (EDAS)

To add a DNS domain name or a fixed address as a service without a service source, see Create a service.

Before you begin

  • Delete any service source that becomes invalid. An invalid source can prevent service information from syncing correctly from other sources.

  • If you add an ACK or ACK Serverless cluster as a service source, the gateway monitors the cluster's services and endpoints. If HTTPS routes are configured based on Kubernetes Ingress resources, the gateway also monitors cluster secrets to retrieve HTTPS certificates.

  • If an access control policy is configured for the API server in the ACK cluster, make sure the gateway can access the API server.

  • If your gateway does not support Kubernetes Ingress monitoring, upgrade the gateway. For more information, see Upgrade an MSE cloud-native gateway.

Add a service source

  1. Log on to the MSE console. In the top navigation bar, select a region.

  2. In the left-side navigation pane, choose Cloud-native Gateway > Gateways. On the Gateways page, click the ID of the gateway.

  3. In the left-side navigation pane, click Routes. Then, click the Source tab.

  4. On the Source tab, click Add Source. In the Add Source panel, select a Source Type and configure the required parameters. Then, click OK.

    The following sections describe the parameters for each source type.

    Container Service

    Select this source type to connect the gateway to an ACK or ACK Serverless cluster.

    Parameter

    Description

    Default

    Required

    ACK/ACK Serverless Cluster

    The cluster where your backend service is deployed. Only clusters in the same VPC as the gateway are listed. When you create a gateway, select the VPC where the cluster is deployed so the cluster appears here automatically.

    --

    Yes

    Listen to Kubernetes Ingress

    Whether the gateway monitors changes to Ingress resources in the cluster. When turned on, the gateway syncs domain name and route configurations from Ingress resources. When turned off, previously synced Ingress-based configurations become invalid.

    Important

    Domain names and routes configured manually in the MSE console take priority over those from Ingress resources.

    Off

    No

    Ingress Class

    The Ingress class to filter which Ingress resources the gateway monitors. If left blank, the gateway monitors all Ingress resources in the cluster. If set to a specific value (for example, nginx), the gateway monitors Ingress resources whose class annotation or Spec.IngressClassName matches the value, plus Ingress resources not associated with any Ingress class. Only a single value is supported.

    Blank (all Ingress resources)

    No

    Namespace

    The Kubernetes namespace to monitor for Ingress resources. If left blank, the gateway monitors all namespaces. Only a single namespace is supported.

    Blank (all namespaces)

    No

    Update Ingress Status

    When set to Open, the gateway updates the IP address of monitored Ingress resources to the IP address of the Server Load Balancer (SLB) instance associated with the gateway. Requires gateway version 1.2.9 or later.

    --

    No

    Security Group Rules

    Security groups are configured in the node pool of the container cluster. To allow the gateway to access cluster services, open the required ports in the security group. For more information, see Configure security group rules.

    --

    --

    MSE Nacos

    Select this source type to connect the gateway to an MSE-managed Nacos instance.

    Parameter

    Description

    Default

    Required

    Nacos Instance

    The MSE Nacos instance to use. Only instances with MCPEnabled set to true appear in the list. To change this setting, go to the Parameter Settings page of the MSE Nacos instance.

    --

    Yes

    MSE ZooKeeper

    Select this source type to connect the gateway to an MSE-managed ZooKeeper instance.

    Note

    This source type is supported only by standard cloud-native gateway instances. Serverless instances do not support MSE ZooKeeper as a service source.

    Parameter

    Description

    Default

    Required

    Cluster Name

    The MSE ZooKeeper instance to use.

    --

    Yes

    SAE Built-in Registry

    Select this source type to connect the gateway to the built-in registry in SAE.

    Parameter

    Description

    Default

    Required

    Namespace

    The namespace of the SAE registry where the service is deployed.

    --

    Yes

    Service Group

    The service group for the service. Click Add Service Group to specify a group if one is configured for your service.

    --

    No

    EDAS Built-in Registry

    Select this source type to connect the gateway to the built-in registry in EDAS.

    Parameter

    Description

    Default

    Required

    Microservices Space

    The microservice space of the EDAS registry where the service is deployed.

    --

    Yes

    Service Group

    The service group for the service. Click Add Service Group to specify a group if one is configured for your service.

    --

    No

    SAE Kubernetes

    Select this source type to connect the gateway to a SAE Kubernetes namespace.

    Parameter

    Description

    Default

    Required

    Namespace

    The namespace of the SAE Kubernetes environment where the service is deployed.

    --

    Yes

Verify the result

Return to the Source tab on the Routes page. If the service source you added appears in the list, the source was added successfully.

What's next