README

TAK-OS Replicated CSI documentation

TAK-OS Replicated CSI provides coordinated RWX and RWO filesystem volumes backed by local-CSI PVCs on multiple Kubernetes nodes. An elected replica coordinator orders operations; Kubernetes manages lifecycle without carrying ordinary file I/O. The driver does not discover or format raw disks.

Current release: 4.1.1, updating user and administrator documentation for the shared NODE runtime introduced in 4.1.0. Shared mode remains for staging evaluation and retains the credential-renewal fix under the scope introduced in 4.0.0. Release images build and publish through TLSPU CI. Historical runtime observations have their own source/image boundaries; they are not verification of a new floating dependency build.

Release 4.1.0 contains a shared NODE runtime that replaces generated controller/worker Pods. It requires the companion local CSI consumer extension in 2.1.0 and reviewed CRD/NODE/RBAC/mount configuration. See architecture and the transition procedure; this source has compilation evidence only and has not been rolled out or observed on a cluster.

User documentation

Start here if you run an application on an installed cluster.

  • User guide — choose RWX/RWO, request and mount a claim, initialize permissions, publish files, diagnose errors and handle backups or claim removal.
  • Supported capabilities and limits — suitable workloads, file operations, failure tolerance and excluded features.
  • Filesystem semantics — visibility, durability, application coordination and implementation ceilings.

Administrator documentation

Start here if you install the driver or operate storage for application teams.

  • Administrator guide — deployment planning, storage policy, inventory, monitoring, repair, maintenance, backup and retirement.
  • Getting started — prerequisites, GitOps installation order and StorageClass/PVC examples.
  • Configuration reference — CLI options, shared NODE setup, cluster DNS, credentials, ports and resource settings.
  • Operator runbook — incident diagnosis and guarded repair procedures for existing volumes.

The sections below provide detailed references and historical records for both audiences. Installation and maintenance examples require an explicitly selected, authorized cluster; reading these guides does not perform a rollout.

Architecture and filesystem behavior

Learn where authority lives and what an acknowledged operation means.

Operations and recovery

Operate existing volumes without substituting API object deletion for storage fencing or discarding original identity.

Builds and releases

Use the established shared CI process and publish explicit release notes.

  • Builds and OCI images — per-role Dockerfiles, floating inputs, image contents and template-only CI jobs.
  • Release policy and procedure — changelog-before-tag rule, versioning, release publication and operator authorization.
  • Changelog — versioned release history and unreleased changes.

Historical records

These pages describe earlier milestones rather than current installation or support requirements. Removed test tools are not pending operator tasks.

For current instructions, use the guides above. For source files and archived reports, follow their explicitly labelled source/history links. Private backups, credentials and workstation evidence are not part of this documentation site.