Skip to main content

Windows install

The Windows package installs everything you need to run and administer a Zaris cluster in the supervisor model: the Management Service and Web Console as Windows services, the AdminShell and ClientShell PowerShell modules, and the node runtime the manager uses to create stores.

Prerequisites​

Confirm the following before you install:

  • Windows with administrator rights. The installer registers Windows services, so it must run elevated.
  • PowerShell 7 or later for the AdminShell and ClientShell modules.
  • Inbound access to the management port (7801) and console port (7810), plus each store's node ports, on the hosts that need them.

Install​

  1. Download clustron-zaris-<version>-win-x64.zip from the Releases page.

  2. Extract the archive.

  3. From an elevated PowerShell session, run the bundled installer:

    install.cmd

    install.cmd verifies it is running elevated before it does anything, so it fails fast with a clear message rather than part-way through if you forget to run as Administrator.

The installer copies the runtime, Web Console, and PowerShell modules to C:\Program Files\Clustron; registers and starts the Management Service and Web Console Windows services; adds the PowerShell modules to your module path; and opens the required firewall rules.

When it finishes, the Console is available at http://localhost:7810. Open it to confirm the services are up.

warning

Open a new PowerShell terminal after installing. The AdminShell and ClientShell modules are added to the module path during installation, and an already-open session will not see them.

Create your first cluster​

From a new PowerShell session, create a workspace (the manager connection), then create and start a store.

# Point at the manager. Use the machine's real address, not 127.0.0.1, for multi-host clusters.
New-ZrWorkspace 'prod' @("10.0.0.10:7801") -Force -Activate

# Create a store: 2 partitions per node, replication factor 2, then start it.
New-ZrStore -Name orders -PartitionsPerNode 2 -ReplicationFactor 2 `
            -BaseClusterPort 7811 -BaseClientPort 7861
Start-ZrStore orders

# Verify: the store should report Running, and each node should be listed.
Get-ZrStore
Get-ZrNode -StoreName orders

A healthy result shows the store Running with every node present. Then connect a client and run an operation to confirm the data plane works:

Connect-ZrStore -ConnectionString "zaris://10.0.0.10:7861/orders"
Set-ZrItem -Key "hello" -Value "world"
Get-ZrItem -Key "hello"   # → world

For the full administrative workflow, see the Admin guide. For the client API, see the Developer guide.

Secure the cluster​

A fresh install runs without TLS or authentication, which is convenient for a first look but not for production. To encrypt a store:

Enable-ZrStoreTls -Store orders -Restart          # encrypt the store; auto-generates the cluster CA
Get-ZrStoreTlsStatus -Store orders -ShowCertificates

Then initialize and enable authentication from the Console's Security settings. The complete path — TLS modes, tokens, and RBAC — is in the Security section.

Upgrade​

Re-run install.cmd from a newer package. The installer stops the services, replaces the binaries, and restarts them. Store data under ProgramData is preserved across an in-place upgrade.

tip

If an upgrade reports that a file is in use, stop the Management Service, the Web Console, and any node processes started from the install root first. The installer stops the services for you, but a node you launched manually can hold a binary open.

Uninstall​

Run the bundled uninstall.cmd from an elevated PowerShell session — it stops and removes the Clustron.Zaris.ManagementService and Clustron.Zaris.WebConsole services and deletes C:\Program Files\Clustron. (To do it by hand, stop and remove those two services, then delete C:\Program Files\Clustron.) To start from a completely clean slate, also remove the store data under ProgramData\Clustron.

Next steps​