Skip to content

Getting started

Launch VictoriaMetrics single-node in your AWS account, connect privately and verify the result of your first task.

1. Launch and wait for startup

Use the Software Sushi Marketplace version described on this page, Ubuntu 24.04 x86_64, and at least t3.small / 2 GiB RAM with 24 GiB encrypted gp3 root storage. Keep IMDSv2 enabled. These are minimum starting sizes, not throughput benchmarks. Inbound application ports must remain closed.

For Session Manager, attach a customer-owned instance role with the required Systems Manager permissions and provide outbound HTTPS/DNS connectivity to the relevant endpoints. Your workstation needs AWS CLI, the Session Manager Plugin and permission to start sessions. SSH is an alternative when TCP 22 is restricted to your administrative CIDR. The application itself does not need a model-provider key.

Connect to your instance, then run the following. The second command starts a login shell as ubuntu; run the remaining commands inside that shell.

sudo cloud-init status --wait
sudo -iu ubuntu
umask 077
sudo systemctl is-active victoriametrics.service sushi-victoriametrics-api.service
bash /opt/sushi/docs/demo.sh

Wait for cloud-init to finish and every listed service to report active. The demo checks the installed service; it does not validate your own data or workload. A failed service needs diagnosis before you submit work. Do not recreate the instance identity or run a second server to bypass a startup failure.

2. Use the private connection

First boot creates a unique TLS identity and ~/.config/sushi/victoriametrics/access.json for the ubuntu account, with mode 0600. The matching server.crt sits beside it. The installed sushi-victoriametrics-api helper reads these files and verifies TLS without printing credentials. Run it on the instance as ubuntu.

To reach port 8443 from your own workstation, open a separate terminal and replace the placeholders below with your customer profile, Region and instance ID:

aws --profile <customer-profile> --region <region> ssm start-session \
  --target <instance-id> \
  --document-name AWS-StartPortForwardingSession \
  --parameters '{"portNumber":["8443"],"localPortNumber":["8443"]}'

Keep that terminal open. Forwarding a port does not install the API helper on your workstation or copy its identity files. For a workstation client, transfer only the required certificate and private client file through an authenticated channel, retain private permissions and configure the client to read credentials from that file. Do not put credentials in URLs, command arguments, user data or support logs. Do not disable certificate verification.

3. Ingest a sample and query it

The example writes one uniquely named synthetic metric and preserves its timestamp. Normal ingestion can take a few seconds. Repeat the same GET for a bounded wait if the first result is empty; inspect the returned timestamp and value rather than assuming that a successful import proves readback.

Run in a new private working directory as ubuntu. The commands write requests and responses there; retain or securely remove them according to your data policy.

python3 - <<'PYMETRIC'
import json, time, uuid
from pathlib import Path
from urllib.parse import urlencode
sample = {'metric': {'__name__': 'customer_temperature_' + uuid.uuid4().hex},
          'values': [23.5], 'timestamps': [int(time.time() * 1000)]}
Path('sample.jsonl').write_text(json.dumps(sample) + '\n')
Path('query.txt').write_text('/api/v1/query?' + urlencode({
    'query': sample['metric']['__name__'], 'time': sample['timestamps'][0] / 1000,
    'latency_offset': '1ms', 'nocache': 1}))
PYMETRIC
sushi-victoriametrics-api POST /api/v1/import --input sample.jsonl
sushi-victoriametrics-api GET "$(cat query.txt)" > readback.json
python3 -m json.tool readback.json

Expect a successful query with one result and value 23.5. Keep the sample and query files to repeat the exact readback after a normal reboot, without importing again. Metrics older than the retention window are removed by the server; a live root volume is not a backup.

Package limits. Single node with one-month retention. No cluster, tenant isolation, enterprise feature set, Grafana or Prometheus agent is included. The native server port stays on loopback. Provision additional storage for your ingestion volume and retention needs.

The fuller walkthrough and installed operating notes are in /opt/sushi/docs/DEMO.md and /opt/sushi/docs/README.md. These describe this package’s API and defaults. General upstream examples may use different endpoints or include features outside this package.

Last updated October 17, 2026 · Suggest an improvement