# This xconnect document or section is free-form YAML ; you can add keys on any level, except directly under "listen" and "connect".
# Fields that are not applicable can be ommitted.
xconnect:  
  meta:
    # name for discovery
    name: account-service
    # tagged version of the implementation
    version: v1.2.3
    # team that owns the code and operates it 
    opex: team-accounts@company.net
    tags:
      - account
      - registration
      - search
    # hint what kind of service this is for labelling
    kind: grpc-service

  # A listen entry is used to describe how consumers can connect to this service.
  # Fields that are not applicable can be ommitted.      
  listen:
    # this component identifier has local scope ; only for this service
    <id>:
      # if set to true, this deployment currently does not listen on this port. Default is false and field can be ommitted.
      disabled: false      
      host: account-service.net
      # the one exposed through ESP (if applicable) which is a sidecar
      port: 7070
      # one of [http2,http,grpc,tcp] not [https]
      protocol: http   
      secure: true
  
      kind: gcp.pubsub
      # other services can publish to this topic
      resource: account_topic
      # you can add extra fields and structures
      test:
        topic: account_test_topic

  # A connect entry represents an external service that is used by this service to get information from or put information to it.
  # Fields that are not applicable can be ommitted.
  connect:
    # this component identifier has local scope ; only for this service 
    <id>:
      # if set to true, this deployment currently does not use this connection. Default is false and field can be ommitted.
      disabled: false      
      host: there.com
      port: 443      
      # one of [http2,http,grpc,tcp,jdbc] not [https].
      protocol: grpc
      secure: true

      # if host and port is not applicable, the url can be used to specifiy a connection string.
      # then do not duplicate information into the scheme,tls,host or port fields.
      url: http://here.net:8080

      # hint what kind of service is being used for labelling or diagram generation
      # e.g. memorystore, postgres, bigquery,...
      kind: elastic