spec

type Admin struct {
	// HeartbeatInterval is the interval for one service instance reporting its heartbeat.
	HeartbeatInterval string `yaml:"heartbeatInterval" jsonschema:"required,format=duration"`
	// RegistryTime indicates which protocol the registry center accepts.
	RegistryType string `yaml:"registryType" jsonschema:"required"`

	// APIPort is the port for worker's API server
	APIPort int `yaml:"apiPort" jsonschema:"required"`

	// IngressPort is the port for http server in mesh ingress
	IngressPort int `yaml:"ingressPort" jsonschema:"required"`

	ExternalServiceRegistry string `yaml:"externalServiceRegistry" jsonschema:"omitempty"`
}

type Canary struct {
	CanaryRules []*CanaryRule `yaml:"canaryRules" jsonschema:"omitempty"`
}

type CanaryRule struct {
	ServiceInstanceLabels map[string]string               `yaml:"serviceInstanceLabels" jsonschema:"required"`
	Headers               map[string]*urlrule.StringMatch `yaml:"headers" jsonschema:"required"`
	URLs                  []*urlrule.URLRule              `yaml:"urls" jsonschema:"required"`
}

type CustomResource map[string]interface{}

type CustomResourceKind struct {
	Name       string `yaml:"name" jsonschema:"required"`
	JSONSchema string `yaml:"jsonSchema" jsonschema:"omitempty"`
}

type GlobalCanaryHeaders struct {
	ServiceHeaders map[string][]string `yaml:"serviceHeaders" jsonschema:"omitempty"`
}

type Ingress struct {
	Name  string         `yaml:"name" jsonschema:"required"`
	Rules []*IngressRule `yaml:"rules" jsonschema:"required"`
}

type IngressPath struct {
	Path          string `yaml:"path" jsonschema:"required"`
	RewriteTarget string `yaml:"rewriteTarget" jsonschema:"omitempty"`
	Backend       string `yaml:"backend" jsonschema:"required"`
}

type IngressRule struct {
	Host  string         `yaml:"host" jsonschema:"omitempty"`
	Paths []*IngressPath `yaml:"paths" jsonschema:"required"`
}

type LoadBalance = proxy.LoadBalance

type Mock struct {
	// Enable is the mocking switch for this service.
	Enabled bool `yaml:"enabled" jsonschema:"required"`

	// Rules are the mocking matching and responding configurations.
	Rules []*mock.Rule `yaml:"rules" jsonschema:"omitempty"`
}

type Observability struct {
	OutputServer *ObservabilityOutputServer `yaml:"outputServer" jsonschema:"omitempty"`
	Tracings     *ObservabilityTracings     `yaml:"tracings" jsonschema:"omitempty"`
	Metrics      *ObservabilityMetrics      `yaml:"metrics" jsonschema:"omitempty"`
}

type ObservabilityMetrics struct {
	Enabled        bool                       `yaml:"enabled" jsonschema:"required"`
	Access         ObservabilityMetricsDetail `yaml:"access" jsonschema:"required"`
	Request        ObservabilityMetricsDetail `yaml:"request" jsonschema:"required"`
	JdbcStatement  ObservabilityMetricsDetail `yaml:"jdbcStatement" jsonschema:"required"`
	JdbcConnection ObservabilityMetricsDetail `yaml:"jdbcConnection" jsonschema:"required"`
	Rabbit         ObservabilityMetricsDetail `yaml:"rabbit" jsonschema:"required"`
	Kafka          ObservabilityMetricsDetail `yaml:"kafka" jsonschema:"required"`
	Redis          ObservabilityMetricsDetail `yaml:"redis" jsonschema:"required"`
	JvmGC          ObservabilityMetricsDetail `yaml:"jvmGc" jsonschema:"required"`
	JvmMemory      ObservabilityMetricsDetail `yaml:"jvmMemory" jsonschema:"required"`
	Md5Dictionary  ObservabilityMetricsDetail `yaml:"md5Dictionary" jsonschema:"required"`
}

type ObservabilityMetricsDetail struct {
	Enabled  bool   `yaml:"enabled" jsonschema:"required"`
	Interval int    `yaml:"interval" jsonschema:"required"`
	Topic    string `yaml:"topic" jsonschema:"required"`
}

type ObservabilityOutputServer struct {
	Enabled         bool   `yaml:"enabled" jsonschema:"required"`
	BootstrapServer string `yaml:"bootstrapServer" jsonschema:"required"`
	Timeout         int    `yaml:"timeout" jsonschema:"required"`
}

type ObservabilityTracings struct {
	Enabled     bool                              `yaml:"enabled" jsonschema:"required"`
	SampleByQPS int                               `yaml:"sampleByQPS" jsonschema:"required"`
	Output      ObservabilityTracingsOutputConfig `yaml:"output" jsonschema:"required"`

	Request      ObservabilityTracingsDetail `yaml:"request" jsonschema:"required"`
	RemoteInvoke ObservabilityTracingsDetail `yaml:"remoteInvoke" jsonschema:"required"`
	Kafka        ObservabilityTracingsDetail `yaml:"kafka" jsonschema:"required"`
	Jdbc         ObservabilityTracingsDetail `yaml:"jdbc" jsonschema:"required"`
	Redis        ObservabilityTracingsDetail `yaml:"redis" jsonschema:"required"`
	Rabbit       ObservabilityTracingsDetail `yaml:"rabbit" jsonschema:"required"`
}

type ObservabilityTracingsDetail struct {
	Enabled       bool   `yaml:"enabled" jsonschema:"required"`
	ServicePrefix string `yaml:"servicePrefix" jsonschema:"required"`
}

type ObservabilityTracingsOutputConfig struct {
	Enabled         bool   `yaml:"enabled" jsonschema:"required"`
	ReportThread    int    `yaml:"reportThread" jsonschema:"required"`
	Topic           string `yaml:"topic" jsonschema:"required"`
	MessageMaxBytes int    `yaml:"messageMaxBytes" jsonschema:"required"`
	QueuedMaxSpans  int    `yaml:"queuedMaxSpans" jsonschema:"required"`
	QueuedMaxSize   int    `yaml:"queuedMaxSize" jsonschema:"required"`
	MessageTimeout  int    `yaml:"messageTimeout" jsonschema:"required"`
}

type Resilience struct {
	RateLimiter    *ratelimiter.Spec    `yaml:"rateLimiter" jsonschema:"omitempty"`
	CircuitBreaker *circuitbreaker.Spec `yaml:"circuitBreaker" jsonschema:"omitempty"`
	Retryer        *retryer.Spec        `yaml:"retryer" jsonschema:"omitempty"`
	TimeLimiter    *timelimiter.Spec    `yaml:"timeLimiter" jsonschema:"omitempty"`
}

type Service struct {
	// Empty means mesh registry itself.
	RegistryName   string `yaml:"registryName" jsonschema:"omitempty"`
	Name           string `yaml:"name" jsonschema:"required"`
	RegisterTenant string `yaml:"registerTenant" jsonschema:"required"`

	Sidecar       *Sidecar       `yaml:"sidecar" jsonschema:"required"`
	Mock          *Mock          `yaml:"mock" jsonschema:"omitempty"`
	Resilience    *Resilience    `yaml:"resilience" jsonschema:"omitempty"`
	Canary        *Canary        `yaml:"canary" jsonschema:"omitempty"`
	LoadBalance   *LoadBalance   `yaml:"loadBalance" jsonschema:"omitempty"`
	Observability *Observability `yaml:"observability" jsonschema:"omitempty"`
}

type ServiceInstanceSpec struct {
	RegistryName string `yaml:"registryName" jsonschema:"required"`
	// Provide by registry client
	ServiceName  string            `yaml:"serviceName" jsonschema:"required"`
	InstanceID   string            `yaml:"instanceID" jsonschema:"required"`
	IP           string            `yaml:"ip" jsonschema:"required"`
	Port         uint32            `yaml:"port" jsonschema:"required"`
	RegistryTime string            `yaml:"registryTime" jsonschema:"omitempty"`
	Labels       map[string]string `yaml:"labels" jsonschema:"omitempty"`

	// Set by heartbeat timer event or API
	Status string `yaml:"status" jsonschema:"omitempty"`
}

type ServiceInstanceStatus struct {
	ServiceName string `yaml:"serviceName" jsonschema:"required"`
	InstanceID  string `yaml:"instanceID" jsonschema:"required"`
	// RFC3339 format
	LastHeartbeatTime string `yaml:"lastHeartbeatTime" jsonschema:"required,format=timerfc3339"`
}

type Sidecar struct {
	DiscoveryType   string `yaml:"discoveryType" jsonschema:"required"`
	Address         string `yaml:"address" jsonschema:"required"`
	IngressPort     int    `yaml:"ingressPort" jsonschema:"required"`
	IngressProtocol string `yaml:"ingressProtocol" jsonschema:"required"`
	EgressPort      int    `yaml:"egressPort" jsonschema:"required"`
	EgressProtocol  string `yaml:"egressProtocol" jsonschema:"required"`
}

type Tenant struct {
	Name string `yaml:"name"`

	Services []string `yaml:"services" jsonschema:"omitempty"`
	// Format: RFC3339
	CreatedAt   string `yaml:"createdAt" jsonschema:"omitempty"`
	Description string `yaml:"description"`
}