All Products
Search
Document Center

Microservices Engine:Add a service source

Last Updated:Jul 17, 2026

Add container services (ACK and ACK Serverless Cluster), EDAS Built-in Registry, SAE Built-in Registry, SAE Kubernetes, MSE ZooKeeper (standard gateway instances only), or MSE Nacos as service sources for your Cloud Native Gateway.

Usage notes

  • If a configured service source becomes invalid, remove it manually. Otherwise, you may experience stability issues, such as failures to synchronize service information from other sources.

  • You can add services with DNS domains or fixed IP addresses without configuring a service source. For more information, see Create a service.

  • If your gateway instance does not support listening to Kubernetes Ingress, you must upgrade the gateway. For more information, see Upgrade a Cloud Native Gateway.

  • When you add an ACK container service, the gateway listens to the cluster's Service and Endpoints resources for service discovery. If you configure HTTPS through Kubernetes Ingress, the gateway also listens to Secret resources to obtain certificate information.

  • If you have configured access control policies for the API Server in your ACK cluster, ensure that the gateway has permission to access the API Server.

Procedure

  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. Click Add Source. In the Add Source panel, configure the parameters and click OK.

    The supported service sources are Container Service, MSE Nacos, MSE ZooKeeper (only for standard gateway instances), SAE Built-in Registry, and EDAS Built-in Registry.

    Container Service

    Parameter

    Description

    ACK/ACK Serverless Cluster

    Select the cluster where your backend service is deployed.

    Note

    Create the gateway in the same VPC as your backend cluster so that the gateway can automatically discover clusters within that VPC when you add a service source.

    Important

    The ACK cluster version must be 1.18 or later. If the cluster version is earlier than 1.18, upgrade the cluster before associating it as a service source. Version 1.28 or later is recommended.

    Listen to Kubernetes Ingress

    • If you enable this option, the gateway automatically monitors Ingress resources and applies the corresponding domain and route configurations.

    • If you disable this option, the gateway stops monitoring Ingress resources, and all previously applied configurations from Ingress become invalid. Use this option with caution.

    Important

    Domain and route configurations that you set manually on the console take priority over those from Ingress resources.

    Ingress Class

    The IngressClass that the gateway uses to filter Ingress resources.

    • If you leave this field blank, the gateway listens to all Ingress resources in the cluster.

    • If you specify a value, the gateway listens to Ingress resources where the value of the kubernetes.io/ingress.class annotation or the spec.ingressClassName field matches the specified value. Only a single value is supported. For example, if you set this parameter to nginx, the gateway monitors Ingress resources whose IngressClass is nginx or is unspecified.

    Namespace

    The namespace in which the gateway listens for Ingress resources.

    • If you leave this field blank, the gateway listens to Ingress resources in all namespaces.

    • If you specify a value, the gateway listens to Ingress resources only in that specific namespace. Only a single value is supported.

    Update Ingress Status

    If you enable this option, the gateway updates the status field of the monitored Ingress resources with the IP address of the SLB instance associated with the Cloud Native Gateway.

    Note

    This feature is available only for gateway instances of version 1.2.9 or later.

    Security Group Authorization

    The container cluster's node pool is protected by a security group. To allow external components to access services in the cluster, open the required service ports in the security group rules.

    You can modify the security group rules. For more information, see Set security group rules.

    MSE Nacos

    Parameter

    Description

    Nacos Instance

    Select an instance.

    Note

    Only MSE Nacos instances with MCPEnabled set to true are displayed. You can change this in your MSE Nacos instance's parameter settings.

    MSE ZooKeeper

    Note

    MSE ZooKeeper is supported only as a service source for standard Cloud Native Gateway instances, not serverless instances.

    Parameter

    Description

    Cluster Name

    Select a cluster.

    SAE Built-in Registry

    Parameter

    Description

    Namespace

    Select the namespace where the service is deployed in SAE.

    Service Group

    If your service uses a specific service group, click Add Service Group to add it.

    EDAS Built-in Registry

    Parameter

    Description

    Microservices Space

    Select the microservice space where the service is deployed in EDAS.

    Service Group

    If your service uses a specific service group, click Add Service Group to add it.

    SAE Kubernetes

    Parameter

    Description

    Namespace

    Select the namespace where the service is deployed in SAE Kubernetes.

Verify the result

Go back to the Routes page and select the Source tab. Verify that your new service source appears in the list.