api

Documentation

Overview

Package api provides the API for mesh controller.

Index

• Constants
• type API
  • func New(superSpec *supervisor.Spec) *API
  • func (a *API) Close()

Constants

const (
	// MeshPrefix is the mesh prefix.
	MeshPrefix = "/mesh"

	// MeshTenantPrefix is the mesh tenant prefix.
	MeshTenantPrefix = "/mesh/tenants"

	// MeshTenantPath is the mesh tenant path.
	MeshTenantPath = "/mesh/tenants/{tenantName}"

	// MeshIngressPrefix is the mesh ingress prefix.
	MeshIngressPrefix = "/mesh/ingresses"

	// MeshIngressPath is the mesh ingress path.
	MeshIngressPath = "/mesh/ingresses/{ingressName}"

	// MeshServicePrefix is mesh service prefix.
	MeshServicePrefix = "/mesh/services"

	// MeshServicePath is the mesh service path.
	MeshServicePath = "/mesh/services/{serviceName}"

	// MeshServiceDeploySpecPath is the mesh service deployment spec path.
	MeshServiceDeploySpecPath = "/mesh/services/{serviceName}/deployment"

	// MeshServiceMockPath is the mesh service mock path.
	MeshServiceMockPath = "/mesh/services/{serviceName}/mock"

	// MeshServiceResiliencePath is the mesh service resilience path.
	MeshServiceResiliencePath = "/mesh/services/{serviceName}/resilience"

	// MeshServiceLoadBalancePath is the mesh service load balance path.
	MeshServiceLoadBalancePath = "/mesh/services/{serviceName}/loadbalance"

	// MeshServiceOutputServerPath is the mesh service output server path.
	MeshServiceOutputServerPath = "/mesh/services/{serviceName}/outputserver"

	// MeshServiceTracingsPath is the mesh service tracings path.
	MeshServiceTracingsPath = "/mesh/services/{serviceName}/tracings"

	// MeshServiceMetricsPath is the mesh service metrics path.
	MeshServiceMetricsPath = "/mesh/services/{serviceName}/metrics"

	// MeshServiceInstancePrefix is the mesh service prefix.
	MeshServiceInstancePrefix = "/mesh/serviceinstances"

	// MeshServiceInstancePath is the mesh service path.
	MeshServiceInstancePath = "/mesh/serviceinstances/{serviceName}/{instanceID}"

	// MeshHTTPRouteGroupPrefix is the mesh HTTP route groups prefix.
	MeshHTTPRouteGroupPrefix = "/mesh/httproutegroups"

	// MeshHTTPRouteGroupPath is the mesh HTTP route groups path.
	MeshHTTPRouteGroupPath = "/mesh/httproutegroups/{name}"

	// MeshTrafficTargetPrefix is the mesh traffic target prefix.
	MeshTrafficTargetPrefix = "/mesh/traffictargets"

	// MeshTrafficTargetPath is the mesh traffic target path.
	MeshTrafficTargetPath = "/mesh/traffictargets/{name}"

	// MeshCustomResourceKindPrefix is the mesh custom resource kind prefix.
	MeshCustomResourceKindPrefix = "/mesh/customresourcekinds"

	// MeshCustomResourceKind is the mesh custom resource kind
	MeshCustomResourceKind = "/mesh/customresourcekinds/{name}"

	// MeshAllCustomResourcePrefix is the mesh custom resource prefix
	MeshAllCustomResourcePrefix = "/mesh/customresources"

	// MeshCustomResourcePrefix is the mesh custom resource prefix of a specified kind
	MeshCustomResourcePrefix = "/mesh/customresources/{kind}"

	// MeshCustomResource is the mesh custom resource of a specified kind
	MeshCustomResource = "/mesh/customresources/{kind}/{name}"

	// MeshWatchCustomResource is the path to watch custom resources of a specified kind
	MeshWatchCustomResource = "/mesh/watchcustomresources/{kind}"

	// MeshServiceCanaryPrefix is the service canary prefix.
	MeshServiceCanaryPrefix = "/mesh/servicecanaries"

	// MeshServiceCanaryPath is the service canary path.
	MeshServiceCanaryPath = "/mesh/servicecanaries/{serviceCanaryName}"
)

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API is the struct with the service

func New

func New(superSpec *supervisor.Spec) *API

New creates a API

func (*API) Close

func (a *API) Close()

Close unregisters a API