Skip to main content

Verify your installation

After installing Wave with any method, confirm the service is live and provisions containers. Run the liveness check first, then the functional checks for your configuration.

Check the service is live

Wave exposes /service-info. A healthy service returns its version and commit ID:

curl -s https://wave.example.com/service-info
{
"serviceInfo": {
"version": "<wave-version>",
"commitId": "<commit-id>"
}
}

If this returns a connection error, check that the service is running and that your ingress or load balancer routes to it. If it returns the wrong version, confirm the deployed image tag.

Install the Wave CLI

The functional checks use the Wave CLI.

# Homebrew
brew install seqeralabs/tap/wave-cli

# Or download a binary from the releases page
# https://github.com/seqeralabs/wave-cli/releases

Point the CLI at your service with the --wave-endpoint flag or the WAVE_ENDPOINT environment variable:

export WAVE_ENDPOINT=https://wave.example.com
note

If you disabled anonymous access in Configure Wave, every CLI check needs a Seqera Platform access token. Pass it with the --tower-token flag or the TOWER_ACCESS_TOKEN environment variable.

Functional checks

Wave Lite

Augment an existing image:

wave -i ubuntu:22.04

A successful augmentation prints a Wave image reference pointing at your service host.

Wave

In addition to the augmentation check, verify the build features you enabled.

Build a container from a Conda package:

wave --conda-package bcftools

Build from a Dockerfile and freeze it to a persistent repository. Any small Dockerfile works for this check:

echo "FROM ubuntu:22.04" > Dockerfile
wave --containerfile Dockerfile --freeze --build-repo <build-repo> --tower-token <platform-token>

A successful build returns a reference in your configured build repository.

If you enabled mirroring, copy an image into your build repository. --mirror requires a build repository and cannot be combined with --containerfile, --conda-package, or --freeze:

wave -i ubuntu:22.04 --mirror --build-repo <build-repo>

If you enabled scanning, request a build that must pass a scan before it is returned:

wave --conda-package bcftools --scan-mode required

A scan failure returns the vulnerabilities found rather than an image reference. Use --scan-level to set which severities to tolerate.

note

Freeze builds push to the repository you name. They always need a Platform access token, and the associated Platform workspace must hold registry credentials with push access to <build-repo>. See Freeze and user-supplied build repositories.

If a check fails

If a check does not pass, match the symptom to one of these common causes:

When the checks pass, continue to the production checklist to prepare the deployment for production.