Skip to main content

83 docs tagged with "Administrator guide"

Docs in the Administrator Guide section — setup, configuration, and maintenance for platform teams.

View all tags

Add hard disks

Add a new hard disk to a CubeCOS storage pool, either individually or all at once, and verify the cluster provisions OSDs onto it.

Change Ceph data replication

Change the Ceph data replication factor for a CubeCOS storage pool to adjust the balance between fault tolerance and available capacity.

Check OSD status

Check the status of Ceph OSDs in a CubeCOS storage cluster, including power-on time, usage, and disk health details.

Cluster startup

Start up a CubeCOS single-node or multi-node cluster, including bootstrapping behaviour and monitoring guidance.

Configure external storage integrations

Configure external SAN and NAS storage integration in CubeCOS to host VM disks and images, optimize internal SDS usage, and support hybrid storage architectures.

Control node replacement guide

Remove a failed control node from a CubeCOS cluster, prepare a replacement node, and rejoin it to restore cluster services.

Create a CubeCOS snapshot

Create a CubeCOS snapshot to back up configurations or capture the current state of the platform for recovery, troubleshooting, or audit purposes.

Create a host aggregate

Group compute hosts with shared characteristics to enable targeted scheduling, resource segmentation, and metadata-based policies.

Create local users on CubeCOS

Create users in CubeCOS using the local identity service. Applicable to environments without external identity providers or when local control over user accounts is required.

Create single sign-on (SSO) users on CubeCOS

Create users in CubeCOS through Single Sign-On (SSO) using Keycloak as the identity provider. This approach enables centralized authentication and seamless access across integrated systems.

CubeCOS deployment models

CubeCOS delivers flexible deployments with a modular, node-based architecture—allowing you to assign compute, storage, and control roles based on your infrastructure needs.

CubeCOS installation overview

CubeCOS supports flexible deployment options ranging from single-node setups to multi-node high-availability clusters, making it suitable for testing, development, and production environments.

CubeCOS node roles

Learn the responsibilities and functions of each CubeCOS node role within the cluster architecture.

CubeCOS platform overview

CubeCOS is a self-hosted private cloud platform that delivers full public cloud capabilities, enterprise-grade data center orchestration, and a flexible foundation for VDI, edge computing, AI, and beyond.

External storage requirements

Review the prerequisites for external SAN and NAS storage integration in CubeCOS. Meeting them lets you host VM disks and images, optimize internal SDS usage, and support hybrid storage architectures.

Firmware swapping and backup

Swap the active firmware partition or back up the active firmware to the inactive partition using the CubeCOS CLI.

Install a compute (HCI) node

Install CubeCOS on a compute (HCI) node, which contributes CPU and memory to the cluster and can add local SSD/HDD drives to the storage pool.

Install a control node

Install CubeCOS on a dedicated control node, which manages cluster services and requires at least one compute node and an optional storage node.

Install a control-converged node

Install CubeCOS on a single node that combines the control, compute, network, and storage roles for testing, evaluation, or small-scale deployments.

Install a moderator node

Install CubeCOS on a moderator node, which pairs with an edge-core node to provide control and optional storage for quorum.

Install a storage (SDS) node

Install CubeCOS on a dedicated storage (SDS) node, which contributes SSD and HDD drives to the cluster's software-defined storage pool.

Install an edge-core node

Install CubeCOS on an edge-core node, an all-in-one role that combines control, compute, network, and storage for edge computing deployments.

Install CubeCOS

Install CubeCOS for both small-scale and large-scale cluster deployments, from single-node setups to enterprise-grade infrastructure.

Install the QEMU agent

Install the QEMU guest agent to enable IP reporting, guided shutdown, and file-system freezes for backups.

Log analysis in CubeCOS

Perform log analysis in CubeCOS to diagnose issues, monitor system behavior, and gain visibility into infrastructure events using integrated OpenSearch dashboards.

Manage external storage

Manage external storage models and vendor drivers in CubeCOS, and troubleshoot connectivity and configuration issues.

Manage triggers

Use Trigger Management to automate responses to system events — send email or Slack notifications and run custom scripts based on filtered conditions.

One-click upgrade overview

Complete CubeCOS upgrade guide covering firmware upgrades, fixpack updates, prerequisites, and rolling upgrade workflows. One-click automation for production environments.

Perform manual upgrades via the CLI

Use the CLI to manually upgrade CubeCOS firmware and fix packs. This includes prerequisite checks, step-by-step commands and verification procedures.

Pre-installation check tools for CubeCOS

Verify your network environment before deploying CubeCOS with built-in pre-installation check tools and the network preset CLI to ensure connectivity and reduce deployment issues.

Reference architecture

A reference for how CubeCOS clusters scale compute, storage, and control resources across AIO, HCI, and web scale deployments.

Remove a compute node (HCI)

Disable and remove a compute node from a hyper-converged infrastructure (HCI) cluster, then verify the removal from the CLI and the management UI.

Remove a storage node

Remove a storage node from a CubeCOS cluster and verify that Ceph recovers its data replication afterward.

Remove hard disks

Identify a failed physical disk in a CubeCOS storage pool and safely remove it from the cluster using safe or force mode.

Repurpose a CubeCOS node

Retire a compute node with outdated specs and convert it into a storage node, either by migrating workloads only or by fully rebuilding the node.

Resource monitoring overview

Monitor resource usage across your CubeCOS cluster, including compute hosts, virtual instances, and storage components.

Syslog export overview

CubeCOS centralizes logs from system components and forwards them to an external syslog server for monitoring and analysis.

Troubleshoot instance issues

Diagnose and resolve common CubeCOS instance problems, including launch failures, stuck states, console access, and resize or migration errors.

Troubleshoot network issues

Diagnose and resolve common CubeCOS networking problems, including connectivity, floating IPs, routers, DNS, and load balancers.

Troubleshoot storage issues

Diagnose and resolve common CubeCOS storage problems, including Ceph cluster health, OSD failures, volume attachment, and object or file storage errors.

Troubleshooting overview

Start here to triage a CubeCOS issue before moving to instance, network, or storage specific troubleshooting steps.

Utilize external storage

This guide covers how to utilize external storage in CubeCOS, including attaching volumes, verifying connections, and troubleshooting multipath storage across FC, iSCSI, and NFS.