This section goes through deploying a squid to Aquarium -- a cloud API service provided by Subsquid.
The deployment is managed by the file
squid.yaml in the root folder of the squid and defines:
- the squid name and version
- what services should be deployed for the squid (e.g. postgres, processor, api)
- how the squid should be scaled up if it grows bigger
Yarn is not supported. Use
npm to install Squid CLI and manage your squid's dependencies.
0. Setup and install Squid CLI
If Squid CLI is not installed, follow this guide
The manifest-based deployment flow below was introduced in
Follow the migration guide to upgrade from older versions of
1. Inspect and deploy using the manifest
Navigate to the squid folder and make sure
squid.yaml is present in the root. See the Deploy Manifest page for a full reference.
To deploy a new version or update the existing one (define in the manifest), run
sqd deploy .
For a full list of available deploy options, inspect
sqd deploy help.
By default your squid will be deployed as collocated. Collocated squids are intended for development and prototyping only. They share resources with each other and may have stability issues. For production we strongly recommend to deploy your squids as dedicated instead.
2. Monitor Squid logs
Once the squid is deployed, the GraphQL endpoint is available straight away. Normally one should wait until the squid has processed all historical blocks and is fully in sync.
To inspect the squid logs run
sqd logs my-new-squid@v0 -f
or navigate to the squid page in Aquarium. See the logging page for more details on how to inspect logs.