CLI Reference

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.
  • group: Worker-capacity group attached to a K8s Cluster.
  • app: Public catalog application. For installed applications, cluster-scoped commands use the release name.

The CLI may also expose plural forms:

  • clusters: List or top K8s Cluster resources.
  • groups: List or top node-group resources.
  • apps: List public application catalog entries.

Common commands

  • oneks list clusters: List K8s Clusters.
  • oneks list groups: List node groups.
  • oneks list apps: List public application catalog entries.
  • oneks top clusters: Continuously display K8s Cluster status.
  • oneks top groups: Continuously display node-group status.
  • oneks show cluster <cluster_id>: Show detailed K8s Cluster information.
  • oneks show cluster <cluster_id> --app <release_name>: Show an installed application and its managed dependencies.
  • oneks show group <group_id>: Show detailed node-group information.
  • oneks show app <application_id>: Show a complete catalog application definition.
  • oneks create cluster: Create a cluster.
  • oneks create group --cluster-id <cluster_id>: Create a node group.
  • oneks install app <application_id> --cluster-id <cluster_id>: Install a catalog application.
  • oneks recover cluster <cluster_id>: Recover a K8s Cluster from selected failure states.
  • oneks recover group <group_id>: Recover a node group from selected failure states.
  • oneks check cluster <cluster_id>: Run the OneKS readiness check using the deployment placement from an existing K8s Cluster.
  • oneks delete cluster <cluster_id>: Delete a K8s Cluster.
  • oneks delete group <group_id>: Delete a node group.
  • oneks delete app <release_name> --cluster-id <cluster_id>: Delete an installed application release.
  • oneks logs cluster <cluster_id>: Show K8s Cluster logs.
  • oneks upgrade cluster <cluster_id> --k8s-version <version>: Upgrade a K8s Cluster version.
  • oneks scale group <group_id> --target <count>: Scale a node group.
  • oneks chgrp cluster <cluster_id> <group_id>: Change K8s Cluster group ownership.
  • oneks chown cluster <cluster_id> <user_id> <group_id>: Change K8s Cluster owner and group.
  • oneks chmod cluster <cluster_id> <octet>: Change K8s Cluster permissions.

Common Examples

Create and access a K8s Cluster:

oneks create cluster --wait
oneks create cluster --file spec.json --wait
oneks show cluster 42 --kubeconfig > kubeconfig
KUBECONFIG=./kubeconfig kubectl get nodes

List and inspect resources:

oneks list clusters
oneks top clusters
oneks show cluster 42
oneks list groups
oneks show group 7

Manage worker capacity:

oneks create group --cluster-id 42
oneks scale group 7 --target 3

Upgrade a K8s Cluster:

oneks upgrade cluster 42 --k8s-version v1.32.9

Recover a K8s Cluster or node group:

oneks recover cluster 42
oneks recover group 7

Browse and manage applications:

oneks list apps
oneks show app <application_id>
oneks install app <application_id> --cluster-id 42
oneks show cluster 42 --app <release_name>
oneks delete app <release_name> --cluster-id 42

For a non-interactive installation, pass a JSON file containing release_name, target_namespace, create_namespace, and user_input_values:

oneks install app <application_id> --cluster-id 42 --file install.json

Run OneKS readiness checks:

oneks check cluster 42
oneks check --opennebula-cluster 0 --public-network 105 --private-network 106

Inspect logs:

oneks logs cluster 42
oneks logs cluster 42 --follow

Delete a K8s Cluster:

oneks delete cluster 42
oneks delete cluster 42 --force

Administrative K8s Cluster operations:

oneks rename cluster 42 new-name
oneks chgrp cluster 42 100
oneks chown cluster 42 10 100
oneks chmod cluster 42 640