For collaboration and for running automated tests, you can use Preview Endpoints to access your sandboxed versions of services. Preview Endpoints provide an authenticated URL that points to a service accessible from your Kubernetes cluster.
Preview Endpoints automatically set the routing-key header context on every request made through them, so they will automatically follow the correct routing within the cluster as long as header propagation is implemented. All preview endpoints are authenticated and require a Signadot API Key or cookie-based authentication to access.
Preview Endpoint Targets
- name: frontend-endpoint
Similarly, endpoints can also be specified in a standalone Route
Group. Preview Endpoints accept a
target refers to some in-cluster location that the URL
Preview URLs associated with a Sandbox / Route Group call the target as
specified, except that they set different routing key
headers on each
request made via the URL automatically. For example, if the
target for an
frontend.hotrod.svc:8080 as shown above, any call that we make to
the corresponding generated Preview URL will directly send its request to that
URL, with additional headers set for the "routing key".
For this request to be re-routed to use sandboxed versions of services as it traverses different microservices in your cluster, in-cluster routing must be set up, for the appropriate local routing decision to be taken to a sandboxed workload. In the absence of a valid in-cluster routing setup, the requests may be set to the baseline service.
Accessing a Preview URL
Preview URLs are hosted by the Signadot Control Plane and are authenticated and secured using SSL. To access a preview URL, you can do one of the following:
Access using a browser
If you're logged into app.signadot.com, preview URLs are automatically also authorized and you can access them via the browser. This is most convenient when previewing a frontend or HTTP microservice.
Access programmatically / using cURL or equivalent
To access in these ways, you must set an authentication header. This header is a
special one called
signadot-api-key and its value must be set to a valid API
key that is generated using app.signadot.com. An example cURL request looks like
curl -H 'signadot-api-key: ...'
Note that you can also access the equivalent gRPC URL as well, by specifying the same header as header metadata.