Meta tags:
description=Oxia: Scalable Metadata and Index storage;

Headings (most frequently used words):

configuration, server, schema, reference, cluster, coordinator, data, tls, options, hot, reload, source, of, truth, namespace, anti, affinity, policy, antiaffinities, servermetadata, loadbalancer, example, metadata, provider, authentication,

Text of the page (most frequently used words):
#server (33), oxia (30), the (26), coordinator (23), for (19), tls (17), default (16), configuration (14), #metadata (14), cluster (13), schema (13), string (13), config (12), internal (11), and (10), file (10), purpose (9), svc (9), data (8), field (8), public (8), storage (8), namespace (8), bind (7), type (7), list (6), example (6), address (6), namespaces (6), architecture (6), see (5), process (5), sconfig (5), replication (5), observability (5), 6649 (5), raft (5), kubernetes (5), admin (5), keys (5), required (5), reference (5), policy (4), policies (4), grpc (4), option (4), when (4), security (4), bool (4), key (4), client (4), log (4), notifications (4), 6648 (4), node (4), provider (4), how (4), name (4), shard (4), loadbalancer (4), labels (4), anti (4), affinity (4), servermetadata (4), from (4), protocol (4), api (3), cli (3), oxiad (3), model (3), level (3), what (3), json (3), started (3), with (3), addresses (3), only (3), true (3), authentication (3), auth (3), traffic (3), via (3), per (3), metrics (3), local (3), servers (3), hierarchical (3), optional (3), antiaffinities (3), sorting (3), one (3), this (3), documentation (3), 2026 (2), use (2), other (2), below (2), are (2), create (2), source (2), truth (2), fields (2), restart (2), require (2), hot (2), reload (2), end (2), outbound (2), disable (2), certificate (2), production (2), allowed (2), uint16 (2), certfile (2), set (2), enabled (2), any (2), same (2), controller (2), options (2), metric (2), check (2), scheduler (2), retention (2), database (2), dir (2), wal (2), section (2), passed (2), settings (2), restarts (2), configmap (2), path (2), status (2), info (2), service (2), keysorting (2), replicationfactor (2), initialshardcount (2), duration (2), often (2), balancer (2), referenced (2), replicas (2), zone (2), map (2), host (2), port (2), unique (2), identifier (2), placement (2), uint32 (2), tuning (2), least (2), most (2), each (2), consumer (2), page (2), light (2), consensus (2), maelstrom (2), tla (2), safety (2), correctness (2), physical (2), logical (2), design (2), goals (2), operations (2), bare (2), metal (2), resources (2), helm (2), deployment (2), python (2), java (2), sdks (2), versioning (2), sequence (2), secondary (2), indexes (2), partition (2), ephemerals (2), consistency (2), features (2), migrating (2), etcd (2), getting (2), blog (2), ctrl (2), copyright, 2023, series, projects, llc, website, terms, trademark, project, please, https, lfprojects, org, last, updated, july, cluster_config, dataserver, structs, canonical, definition, descriptions, live, there, tags, exposes, jsonschema, description, watched, parsed, modification, applicable, take, effect, without, startup, still, restarting, examples, sni, override, connections, servername, verification, avoid, insecureskipverify, cipher, suites, ciphersuites, versions, maxversion, minversion, mtls, clientauth, trusted, bundle, trustedcafile, private, keyfile, explicit, off, auto, detected, every, block, shares, configures, currently, oidc, supported, out, box, full, worked, shape, periodic, integrity, checksum, interval, notification, pebble, 100, readcachesizemb, write, ahead, sync, peer, self, managed, built, group, bootstrapnodes, datadir, survives, configmapname, single, development, tests, state, lost, memory, case, extra, selects, persisted, across, providername, error, warn, debug, prometheus, endpoint, 8080, persists, calls, 6651, oxiaadmin, described, above, configpath, long, recently, moved, ineligible, further, moves, quarantinetime, scans, shards, move, scheduleinterval, free, form, placing, west, rpcs, advertised, defaults, fails, ensemble, selection, constraint, cannot, met, proceeds, anyway, relaxed, strict, mode, label, compare, against, rules, aware, byte, wise, natural, enable, feed, notificationsenabled, must, number, count, creation, rebalancing, used, availability, tag, nodes, available, declared, wide, consumed, operator, visible, edited, adding, pipe, output, into, validator, before, deploying, authoritative, surface, can, generated, running, binary, paths, load, cconfig, contents, flag, uses, three, yaml, surfaces, its, own, scroll, top, edit, github, question, give, feedback, store, coordination, system, skip, content,

Text of the page (random words):
configuration schema reference oxia skip to content oxia metadata store and coordination system documentation blog ctrl k ctrl k documentation what is oxia getting started migrating from zk etcd features consistency model ephemerals namespaces notifications key sorting partition keys secondary indexes sequence keys versioning client sdks go java node js python deployment kubernetes helm resources bare metal security admin operations reference cli configuration schema grpc api metrics architecture design goals logical architecture physical architecture correctness protocol safety tla maelstrom consensus coordinator oxia replication protocol storage blog light what is oxia getting started migrating from zk etcd features consistency model ephemerals namespaces notifications key sorting partition keys secondary indexes sequence keys versioning client sdks go java node js python deployment kubernetes helm resources bare metal security admin operations reference cli configuration schema grpc api metrics architecture design goals logical architecture physical architecture correctness protocol safety tla maelstrom consensus coordinator oxia replication protocol storage light on this page cluster configuration namespace anti affinity policy antiaffinities server servermetadata loadbalancer example coordinator server configuration metadata provider data server configuration authentication tls options hot reload source of truth question give us feedback edit this page on github scroll to top documentation reference configuration schema configuration schema reference oxia uses three yaml configuration surfaces each with its own schema and consumer file flag s consumer contents cluster config cconfig on oxia coordinator or referenced from the coordinator server config coordinator namespaces server list server metadata load balancer tuning coordinator server config sconfig on oxia coordinator coordinator process admin internal bind addresses tls metadata provider observability data server config sconfig on oxia server data server process public internal bind addresses auth tls storage paths scheduler observability the authoritative json schema for each surface can be generated from a running binary oxia config create schema pipe the output into any json schema validator to check a config file before deploying it cluster configuration cluster wide configuration consumed by the coordinator this is the most operator visible file and the one most often edited in production for example when adding a namespace field type purpose namespaces list namespace declared namespaces at least one is required servers list server storage nodes available to the cluster at least one is required servermetadata map name servermetadata optional per server labels used by placement policies for example an availability zone tag loadbalancer loadbalancer shard rebalancing tuning namespace field type default purpose name string required unique namespace identifier initialshardcount uint32 required shard count at namespace creation 1 replicationfactor uint32 required must be 1 and the number of servers notificationsenabled bool true enable the notifications feed for the namespace keysorting string hierarchical hierarchical default aware or natural byte wise see key sorting policy antiaffinities list optional placement anti affinity rules anti affinity policy antiaffinities field type purpose labels list string server metadata label keys to compare replicas against mode string strict fails ensemble selection if the constraint cannot be met relaxed proceeds anyway server field type purpose name string optional unique identifier defaults to internal address public string advertised host port for client traffic internal string host port for coordinator server and server server rpcs servermetadata field type purpose labels map string string free form labels for example zone eu west 1a referenced by anti affinity policies when placing shard replicas loadbalancer field type purpose scheduleinterval duration how often the balancer scans for shards to move quarantinetime duration how long a recently moved shard is ineligible for further moves example namespaces name default initialshardcount 3 replicationfactor 3 keysorting hierarchical servers public oxia 0 oxia svc oxia svc cluster local 6648 internal oxia 0 oxia svc 6649 public oxia 1 oxia svc oxia svc cluster local 6648 internal oxia 1 oxia svc 6649 public oxia 2 oxia svc oxia svc cluster local 6648 internal oxia 2 oxia svc 6649 coordinator server configuration passed via oxia coordinator sconfig per process settings for the coordinator section purpose cluster configpath path to the cluster config file described above server admin bind address tls for the admin grpc service oxiaadmin default 0 0 0 0 6651 server internal bind address tls for the internal service coordinator server traffic default 0 0 0 0 6649 controller tls tls for outbound coordinator server calls metadata how the coordinator persists cluster status see below observability metric prometheus metrics endpoint default enabled 0 0 0 0 8080 observability log level log level debug info warn error default info metadata provider metadata providername selects how the coordinator s cluster status is persisted across restarts provider extra configuration use case memory tests only state is lost on restart file metadata file path single node or development configmap metadata kubernetes namespace metadata kubernetes configmapname kubernetes survives restarts via a configmap raft metadata raft address metadata raft datadir metadata raft bootstrapnodes self managed ha coordinator with a built in raft group data server configuration passed via oxia server sconfig per process settings for a storage node section purpose server public public bind address default 0 0 0 0 6648 auth tls server internal internal bind address default 0 0 0 0 6649 tls replication tls tls for peer replication traffic storage wal write ahead log dir default data wal sync default true retention default 1h storage database pebble database dir default data db readcachesizemb default 100 storage notification notifications retention default 1h scheduler checksum interval periodic db integrity check default 5m set to 0s to disable observability same shape as on the coordinator metric log authentication server public auth configures client authentication currently only oidc is supported out of the box see security for the full schema and a worked example tls options every tls block in any config file server tls replication tls controller tls shares the same schema field type purpose enabled bool explicit on off auto detected as true when certfile is set certfile string server certificate file keyfile string server private key file trustedcafile string trusted ca bundle clientauth bool require mtls minversion maxversion uint16 allowed tls versions ciphersuites list uint16 allowed cipher suites insecureskipverify bool disable certificate verification avoid in production servername string sni override for outbound connections see security for end to end examples hot reload when a data server is started with sconfig the file is watched and re parsed on modification applicable fields take effect without a restart bind addresses and other startup only fields still require restarting the process source of truth the go structs below are the canonical definition field level descriptions live there as jsonschema description tags and are what oxia config create schema exposes as json schema oxiad coordinator option option go coordinator server config oxiad dataserver option option go data server config oxiad coordinator model cluster_config go cluster config last updated on july 8 2026 cli grpc api copyright 2023 2026 oxia a series of lf projects llc for website terms of use trademark policy and other project policies please see https lfprojects org policies