API docs by Redocly

Signadot Routes API (1.0.0)

Download OpenAPI specification:Download

URL: https://github.com/signadot/routesapi License: Apache 2.0

The Routes API provides access to in-cluster routing configuration set up by the Signadot Operator.

RoutesService

GetWorkloadRoutingRules

GetWorkloadRoutingRules returns a set of WorkloadRoutingRules, keyed by baseline workload and routing key, each of which contains a destinationSandbox and mappings for each port. Each request query parameter represents a different filter on the set of returned routing rules.

In the response, for each returned WorkloadRoutingRule, the destinationSandbox represents the override destination to which traffic will be routed in the presence of the associated routing key (https://www.signadot.com/docs/context-propagation). Message queue consumers may use this field to discover if a message is intended for their consumption.

mappings provide the association between baseline workload ports and corresponding TCP addresses belonging to the destinationSandbox. The mappings are used by the DevMesh sidecar (https://www.signadot.com/docs/request-routing/devmesh) to implement "Destination Routing", and may not be relevant to clients unless they are implementing request routing in the application layer.

query Parameters
baselineKind
string
Example: baselineKind=Deployment

Baseline workload kind (e.g. Deployment, ArgoRollout)

baselineNamespace
string

Baseline workload namespace

baselineName
string

Baseline workload name

routingKey
string

The routing key associated with the request

destinationSandboxName
string

The sandbox associated with the destination sandboxed workloads

enableVirtualWorkloads
bool

Responses

Response samples

Content type
application/json
{
  • "routingRules": [
    ]
}