Using Preview URLs

Types of Previews

You have different types of Previews based on the type of Service in a Workspace and where the Preview URL points to.

Preview Type

Service in Workspace

Preview URL Points To

Access Previews using

Pre-Requisites

Frontend Previews

Frontend Service E.g Web UI

A frontend service

A Web Browser

None

Service Previews

Backend Service exposing http or gRPC API

A backend service

API tools like curl, postman or BloomRPC

None

Full stack Previews

Backend Service

A frontend service

A Web Browser

Header Propagation

All generated preview URLs are authenticated. You will need to pass in an API Key as explained below.

Using Preview URLs pointing to frontend Services

If the preview URL is pointing to a frontend Web Application, you can load it up in your web browser and authenticate to it just as you log into the Signadot Dashboard and gain access to your service in the workspace.

Using Preview URLs pointing to backend Services using http

You can also access backend URLs over http(s) using cURL or Postman for manual testing. This requires that you provision an API key from the Signadot Dashboard, and then issue a request with the signadot-api-key header as shown below.

curl -H "signadot-api-key: <api-key-here>" https://<preview-endpoint>--<workspace-name>.preview.signadot.com

Using Preview URLs pointing to backend Services using gRPC

For gRPC requests, the service running within the cluster must be accessible without encryption or authentication. The gRPC preview endpoint itself is secured using TLS and can be connected to at <full-preview-url>:443 with the server authentication using SSL/TLS. The certificate issued to the preview URL is authenticated by a public CA, so, it can be validated using default CA certificates included in your system. gRPC requests also require a Signadot API key to invoke. An example request using grpcurl is shown below.

grpcurl -vv \
    -H 'signadot-api-key: ...' \
    -d '{"context_words": ["cookware"]}' \
    <preview-endpoint>--<workspace-name>.preview.signadot.com:443 service.someService/Method

Did this page help you?