Register-ZrStore
Adopts an externally-run (attach-mode) store on the manager, recording its metadata and orchestrator-run node endpoints without creating or forking any processes.
Syntax
Register-ZrStore
-Name <string>
-Node <string[]>
[-ReplicationFactor <int>]
[-Partitions <int>]
[-Tls]
[-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>]
[-WhatIf] [-Confirm]
Description
Register-ZrStore is the attach-mode counterpart of New-ZrStore. In the attach model the orchestrator (docker compose / kubectl) owns the nodes' lifecycle; this cmdlet only tells the manager how to observe them. It records the store's metadata and the node endpoints on the manager without starting any processes.
Each -Node entry is [nodeId=]host:clientPort[:clusterPort], with nodeId defaulting to the host and clusterPort optional. The cmdlet requires a manager to talk to — an active workspace (create one with New-ZrWorkspace <name> @('host:7801') -Activate) or an explicit -Managers — and targets the first resolved manager.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
-Name | string | Yes | Name of the externally-run store to adopt. Position 0. |
-Node | string[] | Yes | Node endpoints, one per entry (comma/array): [nodeId=]host:clientPort[:clusterPort]. Position 1. |
-ReplicationFactor | int | No | Replication factor recorded for the store. Default 1. |
-Partitions | int | No | Partition count recorded for the store. Default 256. |
-Tls | switch | No | The store's data plane runs TLS, so the manager reaches its nodes over TLS when collecting diagnostics. |
-Managers | string[] | No | Management Service endpoints to target; when omitted the active workspace's managers are used. |
-Port | int | No | Management Service port for bare-host managers. Default 7801. |
-Token | string | No | Admin bearer token for authenticated control-plane calls. |
-TimeoutSec | int | No | Per-request timeout in seconds. Default 30. |
Supports -WhatIf and -Confirm.
Examples
Adopt an externally-run orders store made of two nodes reachable on client port 7861.
Register-ZrStore -Name orders -Node "orders-0:7861","orders-1:7861"
Adopt a store with explicit node IDs, cluster ports, a replication factor, and a TLS data plane.
Register-ZrStore -Name orders `
-Node "n0=orders-0:7861:7811","n1=orders-1:7861:7811" `
-ReplicationFactor 2 -Partitions 512 -Tls