Vantage Studio

A web admin for Apache SkyWalking's runtime-rule hot-update system — browse, edit, and push MAL / LAL rules without restarting the OAP cluster.

What it is

Vantage Studio is an extension of Apache SkyWalking, not a fork. It runs as a separate process (Docker image) and talks to the OAP server's runtime-rule admin HTTP port (default 17128) plus the upstream status APIs on the query port (12800). It adds the things SkyWalking's runtime-rule receiver intentionally doesn't ship:

• A login + RBAC layer in front of an admin port that has none today.
• A pixel-careful UI for browsing rule catalogs (otel-rules, log-mal-rules, lal), editing YAML with Monaco + bundled MAL/LAL DSL grammar autocomplete, and pushing via addOrUpdate / inactivate / delete.
• Cluster status across every OAP node, dump (tar.gz) of the live ruleset, and the destructive-confirm gate for allowStorageChange and revertToBundled.

Quick start

git clone https://github.com/wu-sheng/vantage-studio
cd vantage-studio
make compose-up

Visit http://localhost:8080; login admin / vantage-changeme.

Replace the default password by editing the studio.yaml that lives in the studio-data volume — see docs/auth.md for the vsadmin:hash workflow. See docs/install.md for the OAP image build step needed until SWIP-13 lands in a tagged SkyWalking release.

Documentation

Get started

• docs/install.md — demo docker compose stack (Studio + OAP + BanyanDB) and the OAP module selectors Studio depends on.
• docs/compatibility.md — required SkyWalking version (10.5.0+) and the ports Studio talks to.

Configure

• docs/docker.md — running the image: env vars, volumes, override patterns (mount the file, point STUDIO_CONFIG elsewhere, layer secrets), Kubernetes manifests, reverse-proxy / TLS notes, reload + restart semantics.
• docs/configure.md — studio.yaml schema reference: every key, every default, every constraint.
• docs/auth.md — local auth, optional RBAC + verb table, audit log JSONL shape, deferred LDAP / OIDC plan.

Operate

• docs/operator-workflows.md — push a rule, recover from a broken push, inspect cluster convergence, take a dump, the inactivate / delete / revert-to-bundled semantics.

Reference

• CHANGELOG.md — release notes.
• branding/README.md — logo assets + how they're sized for app shell, favicon, and marketing.

Repository layout

vantage-studio/
├── apps/
│   ├── ui/                 # Vue 3 + Vite SPA
│   └── bff/                # Fastify TypeScript BFF
├── packages/
│   ├── api-client/         # typed wrappers for the OAP runtime-rule REST surface
│   └── design-tokens/      # rrDark + RR_FONT_* + spacing scale
├── deploy/
│   └── docker/             # Dockerfile + docker-compose.yml + studio.yaml.example
├── docs/                   # operator documentation
├── scripts/                # license-header check
├── Makefile                # make compose-up / make image / make check
└── .github/workflows/      # ci.yml + release.yml

Releases

Releases are cut by GitHub Actions, not by hand. Push a vX.Y.Z tag (or run the Release workflow manually) and the release.yml job builds the image, publishes ghcr.io/<repo>:<version> + :latest, signs both with cosign keyless, and attaches a CycloneDX SBOM attestation. Commit images for main are published by ci.yml under :sha-<short> / :main.

License

Apache License 2.0. See LICENSE and NOTICE.

Apache, Apache SkyWalking, and SkyWalking are trademarks of The Apache Software Foundation. Vantage Studio is an independent extension and is not endorsed by the ASF.