Skip to content

Upgrading to 1.0.0

This page covers what you need to know when upgrading to Novelty 1.0.0.

What's New

  • API v2 is now the default — API v1 endpoints remain available but are planned for removal
  • RBAC via OIDC — role-based access control with OpenID Connect. See the OIDC Setup Guide for configuration. When RBAC is enabled, API v1 endpoints are disabled.
  • Docker base image updated to eclipse-temurin:21.0.10_7-jre-noble (Ubuntu 24.04 LTS)
  • Content Security Policy headers added by default
  • Credential redaction in API responses

For the full list of changes, see the Release Notes.

Metrics Prefix Changes

Starting with 1.0.0, all model-scoped metrics (shard, node, and ingest) are prefixed with the model name. For example, node.property-counts becomes my-model.node.property-counts and ingest.my-stream.count becomes my-model.ingest.my-stream.count.

Update your monitoring infrastructure (Grafana dashboards, InfluxDB queries, alerting rules) to include the model name prefix for all model-scoped metrics. Global metrics (persistor, shared valve) remain unchanged.

Updating Grafana Queries

The exact syntax depends on your metrics reporter.

InfluxDB example:

-- Previous query
SELECT mean("value") FROM "node_property_counts" WHERE $timeFilter

-- 1.0.0+ query
SELECT mean("value") FROM "my_model_node_property_counts" WHERE $timeFilter

Prometheus example:

# Previous query
rate(node_property_counts[5m])

# 1.0.0+ query
rate(my_model_node_property_counts[5m])

InfluxDB member_id Tag

When using InfluxDB as a metrics reporter, the member_id tag value differs by deployment:

Deployment member_id Value
Single node Cluster member address (e.g., 127.0.0.1:25520)
Cluster Each member's address (e.g., 10.0.0.1:25520)

Update any queries that filter by member_id to use the appropriate value for your deployment.

API v1 Deprecation

API v2 is now the default for all installations. API v1 remains available but is planned for deprecation and will be removed in a future release.

See Migrating from API v1 for the complete migration guide, including endpoint mappings, design changes, and a migration checklist.