OneKS References on

REST API Reference

Tue, 12 May 2026 00:00:00 +0000

The OpenNebula OneKS API is a RESTful service for managing Kubernetes infrastructure on OpenNebula. It allows users to create and manage Kubernetes Clusters, operate nodegroups, retrieve K8s Cluster information, and trigger lifecycle actions such as scaling and upgrades. All data is sent and received in JSON format.

This guide is intended for developers and integrators. For other purposes, OneKS is accessible via its own OneKS Command Line Interface.

API Authentication

User authentication is based on HTTP Basic access authentication. The required credentials are the username and password.

CLI Reference

Tue, 12 May 2026 00:00:00 +0000

The OneKS CLI is provided by the oneks binary.

General form:

oneks <command> <resource> [<args>] [<options>]

Product-facing resources are:

cluster: OneKS K8s Cluster resource.
nodegroup: Worker-capacity group attached to a K8s Cluster.

The CLI may also expose plural forms:

clusters: List or top K8s Cluster resources.
nodegroups: List or top node-group resources.

Important command naming note:

Some builds may expose node groups through the lower-level group resource in CLI help. Before publication, align this section with the exact shipped CLI behavior. If the shipped CLI uses group, the examples must use group consistently. If the product-facing resource is nodegroup, the CLI help should expose nodegroup consistently.

Service Architecture

Tue, 12 May 2026 00:00:00 +0000

This section describes the architecture of OneKS, the OpenNebula Kubernetes Service. OneKS provides a Kubernetes-as-a-Service layer on top of OpenNebula, enabling Kubernetes Clusters to be deployed and operated across cloud and edge environments.

OneKS simplifies the creation, operation, scaling, upgrade, recovery, and deprovisioning of Kubernetes Clusters in OpenNebula-based infrastructures. It exposes Kubernetes Clusters as high-level OpenNebula-managed resources, while infrastructure provisioning, dependency management, and lifecycle orchestration are handled by the service.