Service description

Detailed examples referenceherearrow-up-right

asjard:
  service:
    ## Project Name
    ## A project can contain multiple different microservices
    # app: asjard

    ## Current Deployment Environment
    ## For example: dev (development), sit (integration testing), uat (user acceptance testing), rc (release candidate), pro (production)
    ## If connected to a registry, this environment identifier is usually used to isolate service instances from different stages
    # environment: "dev"

    ## Deployment Region
    ## For example: cn-shanghai (East China), cn-beijing (North China)
    ## Represents geographic isolation; networks between different regions usually do not communicate internally and require public network connections
    # region: "default"

    ## Availability Zone
    ## For example: az-1, az-2
    ## Refers to different data centers within the same region; devices communicate internally and are used to achieve same-city disaster recovery
    # avaliablezone: "default"

    # website: "https://github.com/${asjard.service.app}/${asjard.service.instance.name}"
    # favicon: "favicon.ico"

    ## Service Description
    ## Supports Markdown format, used to display service details in the management console
    desc: |
      Here is the service description, supports Markdown format

    instance:
      ## System Unique Identifier
      ## Numeric format (100-999), commonly used to generate internal global error codes
      # systemCode: 100

      ## Whether it can be shared across organizations
      ## When set to true, it indicates the service can be discovered and invoked by different organizational units or services across AZs
      # shareable: false

      ## Instance Name
      ## Refers to the specific deployment entry name (e.g. "svc-example-api", "svc-example-openapi")
      ## Used to implement fine-grained traffic routing and service discovery
      name: svc-example-api

      ## Service Group / Logical Service
      ## Identifies the logical service entity (e.g. "svc-example")
      ## Multiple different entry Names can share the same Group, indicating they belong to the same codebase and business scope
      group: svc-example

      ## Service Version
      ## It is recommended to follow semantic versioning (e.g. "1.2.3")
      # version: 1.0.0

      ## Custom Metadata
      ## Used to store additional key-value information, supports custom service discovery filtering logic
      # metadata:

Last updated