Search the docs

About the Knowledge Base

The Hammerspace Knowledge Base collects short, self-contained answers to specific questions: how to carry out one task, why a particular alert appears, what a message means, or what to check when something does not behave as expected. Each article stands on its own. You are meant to arrive at one of them, get your answer, and leave.

That makes the Knowledge Base different from the guides in the rest of this documentation set. A guide is written to be read in order, and it assumes you are working through a whole subject — deploying a cluster, configuring storage, administering the system day to day. A Knowledge Base article assumes you already have a running system and one question about it.

Every article is filed under one of six topics, which match the topics used on the Hammerspace Support Hub: Getting Started, for first tasks after a cluster is up and the tools that go with them; Data Management, for shares, access control, versioning, snapshots, and audit data; Storage Management, for storage volumes and the nodes that serve them; System Management, for cluster lifecycle, licensing, networking, and directory services; Troubleshooting, for symptoms, causes, and fixes, along with explanations of alerts that are safe to ignore; and Cloud, for running Hammerspace on cloud platforms.

Every article also carries two labels that tell you what kind of answer to expect before you open it. The first is a content type — a step-by-step procedure, a conceptual explanation, planning guidance, a runbook, a troubleshooting fix, or a note about an alert. The second is a version note, giving the earliest Hammerspace release the article applies to, shown as "Applies to: Hammerspace 5.2 and later." Articles are not rewritten per release, so if your cluster is newer than the version shown, the article still applies.

The Knowledge Base page lists every article as a card and lets you narrow the list by topic, by content type, and by the release you are running. The search box at the top of any page searches article text along with the rest of the documentation.

Some of this content also exists on the Hammerspace Support Hub in its original form. Where the two differ, the version here is the current one.