Documentation history
The following describes the important updates to the SC//Reliant™ platform documentation. We occasionally make small updates to fix typos and address minor feedback that won't be displayed in the table.
To request additional documentation, send an email to documentation@scalecomputing.com.
Document history
| Change | Description | Date |
|---|---|---|
| Reorganized the user guide | Restructured the table of contents so that each resource and task has its own top-level chapter, renamed several chapters, added a chapter for the local node consoles (REdge and RLSI), merged the networking and firewall glossary into the main Glossary, and split long topics into smaller ones. Existing links continue to work. | October 15, 2026 |
| Updated the RVC reference for RVC 3.13.0 | Added the RVC 3.13.0 entry to the RVC changelog, documented the vTPM state and UEFI NVRAM now captured by a full KVM backup and what a restore from an older backup requires, and updated puppet.run with the post-run hooks and the refusal that now happens when the agent is disabled. For more information, see RVC changelog, Backing up and restoring your virtual machines, and puppet.run. | September 21, 2026 |
| Added drive and chassis replacement to node maintenance | Added a Replacing drives or the chassis section to Performing maintenance on a node, covering the slot order to use when carrying disks into a replacement chassis, the array checks to make before the node rejoins the cluster, and the full resync a node with replaced disks has to complete before the cluster is protected again. For more information, see Performing maintenance on a node. | September 19, 2026 |
| Added direct query examples for the audit trail index | Added a section to Integrating the audit trail with a SIEM covering how to query the audit trail Elasticsearch index directly with curl, including retrieving the most recent records, retrieving records in a time window, and filtering by object type or actor. For more information, see Integrating the audit trail with a SIEM. | September 9, 2026 |
| Added IPMI password rotation through the RPM API | Expanded the IPMI password rotation guidance to cover rotating my_ipmi_password programmatically, including how to choose between node group and node scope, the request and its body, a reference script, the signature details that cause most authentication failures, what the change looks like in the configuration run output, and how to verify a rotation. Related troubleshooting entries were added. For more information, see Configuring IPMI / BMC management. | August 25, 2026 |
| Added the SC//Reliant Local Status Indicator (RLSI) chapter | Added documentation for the RLSI web console, covering how to reach it in a browser, the properties that configure it, reading the Status tab, viewing and rebooting virtual machines, and backing them up and restoring them. Troubleshooting for the whole chapter is collected on a single page. For more information, see Using the SC//Reliant Local Status Indicator (RLSI). | August 7, 2026 |
| Added the node status summary API action | Added reference documentation for the api/nodes/status_summary action, which returns how many nodes and servers are reporting each kind of monitoring data rather than the status of each individual node. The page covers the response fields and how to use the counts when monitoring data is not reaching Platform Manager. For more information, see Retrieve the node status summary. | August 3, 2026 |
| Separated reference material from task guidance across the cluster health and troubleshooting pages | Reorganized so that factual material about tools and their output lives in reference pages, and the pages describing how to achieve a goal link to it rather than restating it. Added a Node diagnostic command reference for the read-only network and storage commands available on a node, and corrected the drbd check output in the Monitoring check reference. For more information, see Verifying cluster health, Node diagnostic command reference, and Monitoring check reference. | July 31, 2026 |
| Expanded Verifying cluster health and corrected the check output | Expanded the conditions for a healthy cluster to include quorum, fencing, and fully replicated data volumes, and added guidance for establishing each of them from a node using the cluster tools. Also corrected the documented OK output of the drbd service check and rewrote the API section to document the full response. For more information, see Verifying cluster health. | July 31, 2026 |
| Corrected node maintenance against a live cluster | Validated the node maintenance procedures against a running two-node cluster and corrected the claims that did not hold, including the CLI field names, the checks used to confirm fencing, and which resources each node runs. Standby procedures gained a completion signal, and guidance was added for staging a package version declared in Platform Manager. For more information, see Performing maintenance on a node, Updating system packages on a node, and Updating the cluster software, DRBD, and the kernel. | July 31, 2026 |
| Split node software maintenance into its own pages | Moved the software maintenance detail out of Performing maintenance on a node into two new child pages, leaving the parent to carry the maintenance procedure and a table routing each package to the page that covers it. One child page covers system packages, and the other covers the cluster software, DRBD, and the kernel, which each behave differently when interrupted. For more information, see Performing maintenance on a node, Updating system packages on a node, and Updating the cluster software, DRBD, and the kernel. | July 31, 2026 |
| Differentiated hardware and software maintenance on a node | Restructured Performing maintenance on a node around the difference between hardware and software maintenance, comparing the two across power state, Corosync membership, fencing, and replication. Added a Software maintenance considerations section, and documented connecting to a node including which node in the cluster each command has to be run from. For more information, see Performing maintenance on a node. | July 31, 2026 |
| Added Rebooting a virtual machine | Added documentation for rebooting a KVM virtual machine, covering the difference between a graceful and a forced reboot and how a reboot behaves on a cluster-managed VM. Both methods are documented end to end, one using the SC//Reliant Virtual Controller CLI and one using the API. For more information, see Rebooting a virtual machine. | July 31, 2026 |
| Added split-brain resolution procedure and corrected the DRBD status command | Added the resolution procedure to Detecting and resolving a split-brain condition, covering the prerequisites, the per-resource reconnect sequence, resync monitoring, and the cleanup that has to run before fencing is re-enabled. Also corrected the guidance for reading DRBD status, since the command available depends on the version of the node's DRBD utilities rather than its kernel module. For more information, see DRBD replication status reference. | July 30, 2026 |
| Restructured Using the audit trail and added SIEM integration | Restructured Using the audit trail into an overview page with a child page for each way the records can be consumed. Integrating the audit trail with a SIEM is new, and covers the dedicated read-only Elasticsearch index, an incremental ingestion pattern, and setup for the common SIEM platforms. For more information, see Using the audit trail, Viewing the audit trail in Platform Manager, and Integrating the audit trail with a SIEM. | July 30, 2026 |
| Restructured Cluster operations and expanded node maintenance | Restructured the Cluster operations page around the difference between maintenance mode and standby, adding a comparison of the two controls, how they interact, and the commands for setting each. Also expanded the node maintenance procedure with fencing guidance and a post-maintenance verification section. For more information, see Cluster operations and Performing maintenance on a node. | July 28, 2026 |
| Expanded Monitoring with software rollback and capacity management | Added two sections to the Monitoring page: automated software rollback, covering the health metrics compared against pre-update baselines and the mechanisms used for each workload type, and predictive capacity management. For more information, see Monitoring. | July 28, 2026 |
| Expanded KVM virtual machine deployment workflow | Expanded the deployment workflow with the gold image promotion pipeline, covering the lab and store environments, the DataSync settings for each, and the manual promotion step that releases an image to the stores. Added a synchronization diagram. For more information, see KVM virtual machine deployment workflow. | July 28, 2026 |
| Added Using the audit trail | Added documentation for the audit trail in SC//Reliant Platform Manager, covering how to access it, how to read the field-level change records, searching and filtering by timeframe, and what changes get audited. For more information, see Using the audit trail. | July 20, 2026 |
| Added Reading logs on a node | Added a guide to reading logs on a node, covering the local log paths, how to read and filter logs, the anatomy of a log line, and clearing the rsyslog spool when it fills a disk. For more information, see Reading logs on a node. | July 17, 2026 |
| Added DRBD replication status reference | Added reference documentation explaining how to read /proc/drbd output, including node roles, connection and disk states, how a resync works, and the live sync counters. For more information, see DRBD replication status reference. | July 17, 2026 |
| Restructured shell access documentation | Split shell access into its own child page covering SSH key generation, adding a public key as an administrator or as the account owner, and a reference table for each shell account setting. For more information, see Configuring shell access and Updating a user. | July 16, 2026 |
| Added PingFederate as an Identity Provider for SC//Reliant Platform Manager | Added documentation for using PingFederate as an Identity Provider for SC//Reliant Platform Manager access, and added PingFederate to the list of supported SAML 2.0 identity providers. For more information, see Using PingFederate as an identity provider. | July 13, 2026 |
| Expanded Using the Edge Install Monitor | Expanded the Edge Install Monitor documentation with how an edge install runs, the deployment script flow, and guidance on forwarding install logs to a SIEM. Added an Edge install API reference, and split the QR code batch-generation procedure into its own child page. For more information, see Using the Edge Install Monitor and Generating QR codes for new builds. | July 2, 2026 |
| Added Using the Edge Install Monitor | Added documentation for using and resetting the Edge Install Monitor on a node, including the installation URL and token lifecycle and the reset procedure. For more information, see Using the Edge Install Monitor. | July 1, 2026 |
| Added Anatomy of Sensu event data | Added reference documentation describing the structure of the Sensu event JSON payload, including the top-level event elements, the actionable check sub-elements, and the most useful fields for filtering in handler integrations and SIEM queries. For more information, see Anatomy of Sensu event data. | June 4, 2026 |
| Added Custom monitoring checks | Added documentation covering the custom check types available in the Custom Checks hash, including the Linux process, Windows process, and Sensu Go server status check types, their parameters, and example configurations. For more information, see Custom monitoring checks. | June 4, 2026 |
| Added Configuring monitoring handlers | Added documentation covering the monitoring handler configuration, including the event and output metric handler types and the configuration options for the PagerDuty, Elasticsearch, and Slack handlers. For more information, see Configuring monitoring handlers. | June 4, 2026 |
| Added Duo Single Sign-On as an Identity Provider for SC//Reliant Platform Manager | Added documentation for using Duo Single Sign-On as an Identity Provider for SC//Reliant Platform Manager access. For more information, see Using Duo Single Sign-On as an identity provider. | May 22, 2026 |
| Restructured container image management documentation | Restructured the Image management features page into a high-level overview with a child page for each container image management feature: image signing, image pruning, and image staging. For more information, see Image management features. | May 20, 2026 |
| Restructured SC//Reliant platform overview | Restructured the SC//Reliant platform overview into a parent page with a Platform architecture child page and ten component child pages, one for each platform component. The two-node cluster architecture diagram is retained on the parent page. For more information, see Platform architecture. | May 18, 2026 |
| Restructured Logging documentation | Restructured the Logging documentation into a parent page and four child pages covering log filters, configuring log forwarding, configuring local log storage, and deployment examples. For more information, see Logging. | May 18, 2026 |
| Added Puppet module to SC//Reliant Virtual Controller (RVC) 3.x Client Reference | Added documentation for the new puppet module in the RVC 3.x Client, including the puppet.run, puppet.stop, puppet.enable, puppet.disable, puppet.disabled, and puppet.version methods. This is a beta release and does not yet replace the Puppet Launcher. For more information, see rvc puppet. | May 7, 2026 |
| Updated SC//Reliant Virtual Controller (RVC) 3.x Client Reference | Updated documentation for the cluster module in the RVC 3.x Client to add support for the cluster.execute method, which executes an RVC command on the primary node, the secondary node, or both nodes in a cluster. For more information, see cluster.execute. | May 7, 2026 |
| Added Managing KVM Virtual Machines chapter | Added documentation covering KVM virtual machine deployment, configuration, management, backup and restore, and importing VMs in SC//Reliant Platform Manager. For more information, see Managing KVM Virtual Machines. | April 29, 2026 |
| Updated Jobs v1 API endpoint | Added reference documentation for the Puppet job sub-actions in the Jobs v1 API endpoint, including enable, disable, runonce, status, and last-run-summary. For more information, see Create a Puppet job. | April 7, 2026 |
| Updated SC//Reliant Virtual Controller (RVC) Jobs v2 API endpoint | Updated documentation for the kvm module for RVC Jobs v2 API endpoint to add support for the kvm.reboot method. For more information, see KVM Module. | April 1, 2026 |
| Added Data management property-reference use cases | Added two use-case topics describing how to use property references to control whether a KVM virtual machine gets built on a node and how to define the network configuration of your edge devices. For more information, see Data management. | March 23, 2026 |
| Added cluster maintenance mode commands to SC//Reliant Virtual Controller (RVC) 3.x Client Reference | Added documentation for the cluster.maintenance_mode, cluster.enable_maintenance_mode, and cluster.disable_maintenance_mode methods in the RVC 3.x Client. For more information, see rvc cluster. | January 22, 2026 |
| Added Managed Files Utility | Added documentation for using the Managed Files Utility in SC//Reliant Platform Manager. For more information, see Using the Managed Files Utility. | October 21, 2025 |
| Added container management in SC//Reliant Platform Manager | Added documentation for managing your container data in SC//Reliant Platform Manager. For more information, see Managing Containers. | October 21, 2025 |
| Monitoring check configuration | Added documentation covering the configuration of the Sensu Go monitoring checks. For more information, see Configuring monitoring checks. | September 22, 2025 |
| Added PowerShell module | Added documentation for using a PowerShell module to call the SC//Reliant API. For more information, see API examples using PowerShell. | September 19, 2025 |
| Monitoring check reference | Added reference documentation for all of the available Sensu Go monitoring checks. For more information, see Monitoring check reference. | September 11, 2025 |
| Updated Managing Locations doc | Updated documentation for managing Locations to reflect updated user experience in SC//Reliant Platform Manager. For more information, see Managing Locations. | August 8, 2025 |
| Updated SC//Reliant Virtual Controller (RVC) Jobs v2 API endpoint | Updated documentation for the docker module for RVC Jobs V2 API endpoint to add support for the docker.start and docker.stop methods. For more information, see Docker Module. | July 16, 2025 |
| Added SC//Reliant Virtual Controller (RVC) 3.x Client Reference | Added documentation for the SC//Reliant Virtual Controller client, including the cluster, docker, kvm, and sys modules for RVC client 3.x. For more information, see SC//Reliant Virtual Controller 3.x Client Reference. | July 8, 2025 |
| Added SC//Reliant platform Overview | We added an overview topic for the SC//Reliant platform, displaying a typical two-node architecture with component descriptions. For more information, see Platform architecture. | June 10, 2025 |
| Added Security and Compliance chapter | We added documentation for the Internal Vulnerability Scans application in AcuVigil for SC//Reliant platform edge devices. For more information, see Internal Vulnerability Scans. | May 28, 2025 |
| Updated SC//Reliant Virtual Controller (RVC) Jobs v2 API endpoint | Updated documentation for the sys module for RVC Jobs V2 API endpoint to add support for the sys.sensors and sys.cpu-load methods. For more information, see SYS Module. | May 5, 2025 |
| Data management in SC//Reliant Platform Manager | Added documentation providing a conceptual overview about data management in the SC//Reliant Platform Manager. For more information, see Data management. | April 24, 2025 |
| Updated user permissions | Added documentation for new SC//Reliant Platform Manager capabilities required to use the RVC Jobs v2 API endpoint. | April 23, 2025 |
| Added SC//Reliant Virtual Controller (RVC) Jobs v2 API endpoint | Added documentation for the RVC Jobs V2 API endpoint, which can be used to start new RVC jobs to retrieve details about your clusters, Docker containers, KVM virtual machines, and system hardware. For more information, see Jobs V2. | April 11, 2025 |
| Using Microsoft Entra as an Identity Provider for SC//Reliant Platform Manager | Added documentation for using Microsoft Entra as an Identity Provider for SC//Reliant Platform Manager access. For more information, see Using Microsoft Entra as an Identity Provider for SC//Reliant Platform Manager. | March 31, 2025 |
| Import Location added | SC//Reliant Platform Manager added support for importing Locations, which provides the ability to create new Locations as well as update existing Locations. For more information, see Managing Locations. | March 24, 2025 |
| Using Google as an Identity Provider for SC//Reliant Platform Manager | Added documentation for using Google as an Identity Provider for SC//Reliant Platform Manager access. For more information, see Using Google as an Identity Provider for SC//Reliant Platform Manager. | February 7, 2025 |
| SC//Reliant Platform Manager access and authentication | Documentation for accessing and authenticating to the SC//Reliant Platform Manager has been added. Pages for both Cisco Duo and the SAML 2.0 Identity Providers are included. For more information, see Access and Authentication. | January 22, 2025 |
| Bulk copy API added | The API actions for bulk copying property values from a node or node group to one or more target nodes or node groups were added to the API reference. | November 21, 2024 |
| Initial draft | The initial draft of the SC//Reliant platform user permissions document. | September 24, 2024 |