CLI Command Reference
This document provides a comprehensive reference for all available CLI commands and their options.
Usage: v8x [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --team <str> Team ID for multi-team namespace resolution on cluster │
│ commands. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ version Show version and exit. │
│ get-kubeconfig Fetch the kubeconfig for a cluster namespace. │
│ login Authenticate against the v8x by obtaining an authentication │
│ token. │
│ logout Log out of the v8x and clear saved user credentials. │
│ whoami Display information about the currently authenticated user. │
│ token Print the current access token to the terminal. │
│ app Manage applications │
│ cloud Manage cloud provider configurations and cloud accounts. │
│ cluster Manage Vantage compute clusters for high-performance │
│ computing workloads. │
│ config Manage v8x configuration and settings. │
│ job Manage computational jobs, scripts, submissions, and job │
│ templates for HPC workloads. │
│ license Manage software licenses, license servers, and licensing │
│ configurations. │
│ network Manage virtual networks, subnets, and network configurations │
│ for cloud infrastructure. │
│ profile Manage v8x profiles to work with different environments and │
│ configurations. │
│ storage Manage storage: PVCs, imports, exposes, and storage systems. │
│ support-ticket Manage support tickets │
│ team Manage teams and memberships │
│ vdeployer-web Trigger vdeployer-web operations on a cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Authentication Commands
Login
Usage: v8x login [OPTIONS]
Authenticate against the v8x by obtaining an authentication token.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --qr Show a scannable QR code │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Logout
Usage: v8x logout [OPTIONS]
Log out of the v8x and clear saved user credentials.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Whoami
Usage: v8x whoami [OPTIONS]
Display information about the currently authenticated user.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Version Information
Usage: v8x version [OPTIONS]
Show version and exit.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Token Management
Usage: v8x token [OPTIONS]
Print the current access token to the terminal.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --decode -d Decode and print the JWT token claims │
│ --id Print the ID token instead of the access token │
│ --refresh Use the refresh token to request a new token │
│ before printing │
│ --cluster -c <str> Get a cluster-scoped token instead of the user │
│ token │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
App Management
- 🔹 app
- list
- deployment
Usage: v8x app [OPTIONS] COMMAND [ARGS]...
Manage applications
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List available applications │
│ deployment Create and manage application deployments on Vantage compute │
│ clusters. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x app list [OPTIONS]
List available applications
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 deployment
- list
- get
- delete
Usage: v8x app deployment [OPTIONS] COMMAND [ARGS]...
Create and manage application deployments on Vantage compute clusters.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List all active deployments from ~/.v8x/deployments.yaml. │
│ get Get detailed information about a specific deployment. │
│ delete Delete a deployment and clean up associated resources │
│ (multipass instances, etc). │
│ cleanup-orphans Find and clean up deployments whose clusters no longer │
│ exist. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x app deployment list [OPTIONS]
List all active deployments from ~/.v8x/deployments.yaml.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cloud <str> Filter deployments by cloud type (e.g., localhost, │
│ aws, gcp) │
│ --status <str> Filter deployments by status (e.g., active, │
│ inactive) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x app deployment get [OPTIONS] {deployment_id}
Get detailed information about a specific deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * deployment_id <str> ID or name of the deployment to retrieve │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x app deployment delete [OPTIONS] {deployment_id}
Delete a deployment and clean up associated resources (multipass instances,
etc).
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * deployment_id <str> ID or name of the deployment to delete │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Cloud Management
- 🔹 cloud
- get
- list
- account
Usage: v8x cloud [OPTIONS] COMMAND [ARGS]...
Manage cloud provider configurations and cloud accounts.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ get Get detailed information about a specific cloud provider. │
│ list List all available cloud providers. │
│ account Manage cloud accounts (organization-level cloud provider │
│ registrations). │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cloud get [OPTIONS] {cloud_name}
Get detailed information about a specific cloud provider.
Displays comprehensive information about a cloud provider including its
Vantage provider label, supported substrates, and configuration details.
Args:
ctx: Typer context containing CLI configuration
cloud_name: Name of the cloud provider to retrieve
Examples:
Get AWS cloud details:
$ v8x cloud get aws
Get localhost cloud details:
$ v8x cloud get localhost
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cloud_name <str> Name of the cloud provider (e.g., 'aws', │
│ 'localhost', 'gcp') │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cloud list [OPTIONS]
List all available cloud providers.
Displays all cloud providers configured in the system, including their
Vantage provider labels and supported substrates (infrastructure types).
Examples:
List all clouds:
$ v8x cloud list
Using the alias:
$ v8x clouds
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 account
- create
- delete
- get
- list
Usage: v8x cloud account [OPTIONS] COMMAND [ARGS]...
Manage cloud accounts (organization-level cloud provider registrations).
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new cloud account. │
│ delete Delete a cloud account. │
│ get Get details of a specific cloud account. │
│ list List all cloud accounts registered in your organization. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cloud account create [OPTIONS] {name}
Create a new cloud account.
Cloud accounts are organization-level registrations of cloud provider
credentials. Each provider has different attribute requirements.
For LXD accounts, include 'lxd_server_url' and 'lxd_token' in attributes.
The CLI will automatically generate and register client certificates.
Examples:
# Create AWS account
v8x cloud account create my-aws --provider aws \
--attributes '{"role_arn":
"arn:aws:iam::123456789012:role/VantageRole", "region": "us-east-1"}'
# Create GCP account
v8x cloud account create my-gcp --provider gcp \
--attributes '{"project_id": "my-project", "region": "us-central1"}'
# Create LXD account (auto-generates and registers client certificate)
v8x cloud account create my-lxd --provider lxd \
--attributes '{"lxd_server_url": "https://192.168.0.55:8443",
"lxd_token": "<token>"}'
# Create on-prem account
v8x cloud account create my-onprem --provider on_prem
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name for the cloud account. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --provider <str> Cloud provider type. Valid options: aws, │
│ gcp, azure, on_prem, lxd, microk8s │
│ [required] │
│ --description -d <str> Description for the cloud account. │
│ --attributes -a <str> Provider attributes as JSON string. Fields │
│ depend on provider type. │
│ --assisted Create as a Vantage-assisted cloud account │
│ (AWS only). │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cloud account delete [OPTIONS] {account_id}
Delete a cloud account.
WARNING: Deleting a cloud account may affect clusters that use it.
Accounts that are in use cannot be deleted.
Examples:
v8x cloud account delete 1
v8x cloud account delete 1 --force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * account_id <int> ID of the cloud account to delete. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Skip confirmation prompt. │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cloud account get [OPTIONS] {account_id}
Get details of a specific cloud account.
Displays all information about a cloud account including its
provider-specific attributes.
Examples:
v8x cloud account get 1
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * account_id <int> ID of the cloud account to retrieve. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cloud account list [OPTIONS]
List all cloud accounts registered in your organization.
Cloud accounts are organization-level registrations of cloud provider
credentials (e.g., AWS IAM roles, GCP service accounts).
Examples:
v8x cloud account list
v8x cloud account list --provider aws
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --provider <str> Filter by cloud provider (e.g., aws, gcp, azure). │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Cluster Management
- 🔹 cluster
- create
- delete
- extend
- get
- list
- update
- blueprint
- checkpoint
- dataset
- dynamo
- federation
- kfp
- kserve
- namespace
- nemo
- network
- nim
- kubeflow
- ray
- secret
- service
- slurm
- trainjob
- workspace
Usage: v8x cluster [OPTIONS] COMMAND [ARGS]...
Manage Vantage compute clusters for high-performance computing workloads.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new Vantage cluster. │
│ delete Delete a Vantage cluster and optionally cleanup │
│ associated app deployments. │
│ extend Extend a Vantage cluster with bare-metal compute │
│ nodes. │
│ get Get details of a specific Vantage cluster. │
│ list List all Vantage clusters. │
│ update Update an existing Vantage cluster. │
│ blueprint Browse the curated NVIDIA AI Blueprint catalog. │
│ checkpoint List model checkpoints on a cluster. │
│ compute-pool Manage compute pools (autoscaler pools) within a │
│ Vantage K8s cluster. │
│ configuration-preset Manage configuration presets (kind-specific │
│ CR-assembly options; sizing lives in size-preset │
│ catalogs). │
│ dataset Manage data catalog datasets on a cluster. │
│ dynamo Manage NVIDIA Dynamo model deployments on a cluster. │
│ federation Manage Vantage compute federations for distributed │
│ workloads. │
│ inference-endpoint Manage inference endpoints (predictive & LLM) on a │
│ cluster. │
│ vantage-ingress-preset Manage ingress presets (reusable service exposure │
│ templates). │
│ kfp Manage Kubeflow Pipelines (pipelines, runs, │
│ experiments, artifacts). │
│ kserve Manage KServe resources within a Vantage K8s │
│ cluster. │
│ model-registry Manage models in the cluster model registry │
│ (onboard, list, version, delete). │
│ namespace Manage namespaces on a Vantage K8s cluster. │
│ nemo NeMo microservices catalogs and CRD-backed training │
│ resources. │
│ network Manage Multus networks on a Vantage K8s cluster. │
│ ngc-container Browse the curated NGC framework container catalog. │
│ nim Manage NVIDIA NIM deployments on a cluster. │
│ kubeflow Manage Kubeflow ML platform on a Vantage K8s │
│ cluster. │
│ object-storage Manage S3-compatible object storage buckets on a │
│ cluster. │
│ ray Manage Ray jobs and clusters (KubeRay) on a cluster. │
│ secret Manage secrets (HuggingFace tokens, S3 credentials) │
│ in your profile namespace. │
│ service Enable, disable, update, or manage user services on │
│ a Vantage cluster. │
│ size-preset Manage size presets (pod shapes: │
│ cpu/memory/gpu/compute pool) per workload catalog. │
│ slurm Manage Slurm clusters within a Vantage K8s cluster. │
│ trainjob Manage TrainJob resources within a Vantage K8s │
│ cluster. │
│ vantage-ingress Manage VantageIngress resources (service exposure │
│ and authentication). │
│ workspace Manage Kubeflow Workspaces on a cluster. │
│ workspace-kind Manage workspace kinds on a cluster. │
│ workspace-preset Manage workspace presets (WorkspaceKinds) that │
│ define IDE templates for Kubeflow workspaces. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster create [OPTIONS] {cluster_name}
Create a new Vantage cluster.
Use --cloud-account-id or --cloud-account to specify a cloud account created
with
'v8x cloud account create'. The cloud account contains the credentials and
configuration for the cloud provider.
Examples:
Create a cluster using a cloud account by ID:
$ v8x cluster create mycluster --cloud-account-id 16
Create a cluster using a cloud account by name:
$ v8x cluster create mycluster --cloud-account my-aws-account
Create a cluster with custom settings:
$ v8x cluster create mycluster --cloud-account-id 16 --settings
'{"kubeflow_enabled":true}'
Create a cluster with an app:
$ v8x cluster create mycluster --cloud-account-id 16 --app
slurm-lxd-localhost
Create a cluster with an app and custom config:
$ v8x cluster create mycluster --cloud-account-id 16 --app
slurm-lxd-localhost --app-config 'jupyterhub_enabled=false'
Create a cluster with settings from a YAML file:
$ v8x cluster create mycluster --cloud-account-id 16 --settings-file
cluster-settings.yaml
Create a cluster with config from a YAML file:
$ v8x cluster create mycluster --cloud-account-id 16 --config-file
cluster-config.yaml
Resume app deployment on an existing cluster:
$ v8x cluster create mycluster --cloud-account-id 16 --app
slurm-lxd-localhost --resume
Create a Multipass Slurm cluster with resource/image overrides:
$ v8x cluster create mycluster --cloud-account my-localhost --app
slurm-multipass --options operating_system=rockylinux9,cpu=4,mem=8,disk=128G
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name <str> Name of the cluster to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cloud-account-id -a <int> ID of the cloud account to │
│ use for deployment (from │
│ 'v8x cloud account list'). │
│ --cloud-account <str> Name of the cloud account │
│ to use for deployment │
│ (from 'v8x cloud account │
│ list'). Alternative to │
│ --cloud-account-id. │
│ --cluster-type -t <slurm|k8s> Type of cluster to create │
│ (slurm or k8s). │
│ [default: slurm] │
│ --settings -s <str> Cluster settings as JSON │
│ string (e.g., │
│ '{"kubeflow_enabled":true… │
│ --config -c <str> Cluster config as JSON │
│ string (e.g., │
│ '{"key":"value"}'). │
│ --settings-file <file> Path to a YAML file │
│ containing cluster │
│ settings. Merged with │
│ --settings (file values │
│ take precedence). │
│ --config-file <file> Path to a YAML file │
│ containing cluster config. │
│ Merged with --config (file │
│ values take precedence). │
│ --app <str> Deploy an application │
│ after cluster creation. │
│ --resume Resume app deployment on │
│ an existing cluster │
│ instead of creating a new │
│ one. │
│ --footprint <small|medium|large> Deployment footprint size │
│ for resource allocation │
│ (small, medium, large). │
│ [default: small] │
│ --create-team Create a team named after │
│ the cluster with the │
│ current user as owner and │
│ the cluster as a resource. │
│ --options <str> Comma-separated │
│ slurm-multipass overrides: │
│ operating_system choices , │
│ image_version (channel │
│ like latest/0.1 or exact │
│ version like 0.1.5), cpu, │
│ mem, disk. Example: │
│ operating_system=rockylin… │
│ For slurm-juju: │
│ controller, model (both │
│ required), e.g. │
│ controller=lxd-controller… │
│ --show-secret Show the full client │
│ secret in output instead │
│ of masking it. │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster delete [OPTIONS] {cluster_name}
Delete a Vantage cluster and optionally cleanup associated app deployments.
If --app is specified, --cluster-type is required for local deployment
cleanup.
Without --app, only the cluster record in the API will be deleted.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name <str> Name of the cluster to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cluster-type -c <str> Cluster type for deployment cleanup (e.g., │
│ k8s, slurm). Required if --app is specified. │
│ --app <str> Cleanup the specified app deployment (e.g., │
│ slurm-lxd-localhost, slurm-multipass, │
│ slurm-microk8s-localhost, juju-ext) │
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster extend [OPTIONS] {cluster_name}
Extend a Vantage cluster with bare-metal compute nodes.
Deploys vantage-slurmctld-proxy and vantage-slurmd charms on LXD machines
via Juju, connecting them to the K8s-based Slurm controller. The connection
details (slurmctld IP, auth key, TLS certs) are fetched automatically from
the vdeployer-web API.
Requires a cloud account with LXD credentials (lxd_server_url,
lxd_client_cert,
lxd_client_key).
Examples:
Extend a cluster with 3 bare-metal compute nodes:
$ v8x cluster extend mycluster --slurm-cluster default -n 3
--cloud-account-id 16
Extend using auto-detected cloud account:
$ v8x cluster extend mycluster --slurm-cluster default
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name <str> Name of the cluster to extend with bare-metal │
│ compute │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --slurm-cluster -s <str> Name of the Slurm cluster in vdeployer │
│ to connect to (default: uses first │
│ available) │
│ --num-workers -n <int> Number of bare-metal compute nodes to │
│ deploy │
│ [default: 1] │
│ --cloud-account-id -a <int> Cloud account ID with LXD credentials │
│ (auto-detected from cluster if omitted) │
│ --vdeployer-url <str> Override vdeployer-web URL (auto-derived │
│ from cluster if omitted) │
│ --settings-file <file> Path to YAML file with LXD connection │
│ settings │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster get [OPTIONS] {cluster_name}
Get details of a specific Vantage cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name <str> Name of the cluster to get details for │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --show-secret Show the full client secret in output instead │
│ of masking it. │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster list [OPTIONS]
List all Vantage clusters.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster update [OPTIONS] {cluster_name}
Update an existing Vantage cluster.
Update cluster properties such as description, status, settings, or config.
Only provided fields will be updated; others remain unchanged.
Examples:
# Update description
v8x cluster update my-cluster --description "New description"
# Update status
v8x cluster update my-cluster --status ready
# Replace all settings
v8x cluster update my-cluster --settings '{"kubeflow_enabled": true}'
# Merge new settings with existing settings
v8x cluster update my-cluster --settings '{"new_key": "value"}' --merge
# Update with settings from YAML file
v8x cluster update my-cluster --settings-file cluster-settings.yaml
# Update config
v8x cluster update my-cluster --config '{"jupyterhub": {"enabled": true}}'
# Update config from YAML file
v8x cluster update my-cluster --config-file cluster-config.yaml
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name <str> Name of the cluster to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description -d <str> New description for the cluster │
│ --status -s <str> New status for the cluster │
│ --settings <str> Settings as JSON string (e.g., '{"key": │
│ "value"}') │
│ --settings-file <file> Path to a YAML file containing cluster │
│ settings. Merged with --settings (file │
│ values take precedence). │
│ --config -c <str> Cluster config as JSON string (e.g., │
│ '{"key": "value"}'). │
│ --config-file <file> Path to a YAML file containing cluster │
│ config. Merged with --config (file values │
│ take precedence). │
│ --merge -m Merge new settings with existing settings │
│ instead of replacing them │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 blueprint
- list
- get
Usage: v8x cluster blueprint [OPTIONS] COMMAND [ARGS]...
Browse the curated NVIDIA AI Blueprint catalog.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List curated NVIDIA AI Blueprints. │
│ get Get one curated NVIDIA AI Blueprint. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster blueprint list [OPTIONS]
List curated NVIDIA AI Blueprints.
Examples:
v8x cluster blueprint list -c my-cluster --status available
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --status -s <str> Filter: available, roadmap │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster blueprint get [OPTIONS] {blueprint_id}
Get one curated NVIDIA AI Blueprint.
Examples:
v8x cluster blueprint get nvidia-rag -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * blueprint_id <str> Blueprint ID (e.g. nvidia-rag) [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 checkpoint
- list
Usage: v8x cluster checkpoint [OPTIONS] COMMAND [ARGS]...
List model checkpoints on a cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List checkpoints for a model. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster checkpoint list [OPTIONS]
List checkpoints for a model.
Examples:
v8x cluster checkpoint list -c my-cluster --model-id my-model
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --model-id -m <str> Model ID [required] │
│ * --cluster -c <str> Cluster name [required] │
│ --page-size <int> Page size │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 dataset
- create
- list
- get
- update
- delete
Usage: v8x cluster dataset [OPTIONS] COMMAND [ARGS]...
Manage data catalog datasets on a cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a data catalog dataset. │
│ list List data catalog datasets. │
│ get Get details for a data catalog dataset. │
│ update Update a data catalog dataset. │
│ delete Delete a data catalog dataset. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dataset create [OPTIONS] {name}
Create a data catalog dataset.
Examples:
v8x cluster dataset create my-dataset -c my-cluster --version v1 --source-type
s3 --source-uri s3://bucket/path
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Dataset name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --version <str> Dataset version [required] │
│ * --source-type <str> Source type [required] │
│ * --source-uri <str> Source URI [required] │
│ --format <str> Dataset format │
│ --description <str> Dataset description │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dataset list [OPTIONS]
List data catalog datasets.
Examples:
v8x cluster dataset list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --page-size <int> Page size │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dataset get [OPTIONS] {dataset_id}
Get details for a data catalog dataset.
Examples:
v8x cluster dataset get my-dataset-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * dataset_id <str> Dataset ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dataset update [OPTIONS] {dataset_id}
Update a data catalog dataset.
Examples:
v8x cluster dataset update my-dataset-id -c my-cluster --description "Updated
notes"
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * dataset_id <str> Dataset ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --description <str> Dataset description │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dataset delete [OPTIONS] {dataset_id}
Delete a data catalog dataset.
Examples:
v8x cluster dataset delete my-dataset-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * dataset_id <str> Dataset ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 dynamo
- status
- create
- list
- get
- delete
Usage: v8x cluster dynamo [OPTIONS] COMMAND [ARGS]...
Manage NVIDIA Dynamo model deployments on a cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ status Show Dynamo platform status on a cluster. │
│ create Create a Dynamo model deployment (deploy-by-intent). │
│ list List Dynamo deployments. │
│ get Get a Dynamo deployment. │
│ delete Delete a Dynamo deployment (DGDR + generated DGD). │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dynamo status [OPTIONS]
Show Dynamo platform status on a cluster.
Examples:
v8x cluster dynamo status -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dynamo create [OPTIONS] {name}
Create a Dynamo model deployment (deploy-by-intent).
Examples:
v8x cluster dynamo create my-qwen -c my-cluster -m Qwen/Qwen3-0.6B \\
--compute-pool dynamo-gpu --frontend-compute-pool dynamo-cpu
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Deployment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --model -m <str> Hugging Face model ID (e.g. │
│ Qwen/Qwen3-0.6B) │
│ [required] │
│ --namespace -n <str> Target namespace (default: your │
│ profile ns) │
│ --backend -b <str> Engine backend: auto, vllm, │
│ sglang, trtllm │
│ [default: auto] │
│ --search-strategy <str> rapid (~30s modeled profiling) │
│ or thorough (real-GPU sweeps) │
│ [default: rapid] │
│ --no-auto-apply Profile only; do not deploy the │
│ recommended config │
│ automatically │
│ --ttft <float> SLA time-to-first-token target │
│ (ms) │
│ --itl <float> SLA inter-token latency target │
│ (ms) │
│ --isl <int> Expected input sequence length │
│ (tokens) │
│ --osl <int> Expected output sequence length │
│ (tokens) │
│ --request-rate <float> Expected requests per second │
│ --concurrency <int> Expected concurrent requests │
│ --configuration-preset -C <str> Dynamo configuration preset; │
│ explicit flags win over preset │
│ values │
│ --compute-pool -p <str> dynamo-worker (GPU) compute │
│ pool for the engine pods │
│ --frontend-compute-pool <str> dynamo-frontend (CPU) compute │
│ pool for frontend/router pods │
│ --router-mode <str> Routing mode: round-robin, kv, │
│ least-loaded, random │
│ --planner-json <str> PlannerConfig JSON (SLA-driven │
│ autoscaling) │
│ --dgd-overrides-json <str> Partial DynamoGraphDeployment │
│ JSON merged into the generated │
│ DGD │
│ --vantage-ingress <str> Ingress preset name to create a │
│ VantageIngress for this │
│ deployment (e.g. │
│ public-api-key, │
│ public-user-auth, metallb-open) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dynamo list [OPTIONS]
List Dynamo deployments.
Examples:
v8x cluster dynamo list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dynamo get [OPTIONS] {name}
Get a Dynamo deployment.
Examples:
v8x cluster dynamo get my-qwen -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Deployment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster dynamo delete [OPTIONS] {name}
Delete a Dynamo deployment (DGDR + generated DGD).
Examples:
v8x cluster dynamo delete my-qwen -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Deployment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 federation
- create
- delete
- get
- list
- update
Usage: v8x cluster federation [OPTIONS] COMMAND [ARGS]...
Manage Vantage compute federations for distributed workloads.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new Vantage federation. │
│ delete Delete a Vantage federation. │
│ get Get details of a specific Vantage federation. │
│ list List all Vantage federations. │
│ update Update a Vantage federation. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster federation create [OPTIONS] {name}
Create a new Vantage federation.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the federation to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description -d <str> Description of the federation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster federation delete [OPTIONS] {name}
Delete a Vantage federation.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the federation to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Force deletion without confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster federation get [OPTIONS] {name}
Get details of a specific Vantage federation.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the federation to retrieve [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster federation list [OPTIONS]
List all Vantage federations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster federation update [OPTIONS] {name}
Update a Vantage federation.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the federation to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description -d <str> New description for the federation │
│ --add-cluster <str> Add a cluster to the federation │
│ --remove-cluster <str> Remove a cluster from the federation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 kfp
- pipeline
- run
- experiment
- artifact
Usage: v8x cluster kfp [OPTIONS] COMMAND [ARGS]...
Manage Kubeflow Pipelines (pipelines, runs, experiments, artifacts).
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ pipeline Manage KFP pipelines. │
│ run Manage KFP pipeline runs. │
│ recurring-run Manage KFP recurring (scheduled) runs. │
│ experiment Manage KFP experiments. │
│ artifact Browse KFP artifacts. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 pipeline
- create
- list
- get
- delete
- versions
Usage: v8x cluster kfp pipeline [OPTIONS] COMMAND [ARGS]...
Manage KFP pipelines.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a KFP pipeline. │
│ list List KFP pipelines. │
│ get Get details for a KFP pipeline. │
│ delete Delete a KFP pipeline. │
│ versions List versions of a KFP pipeline. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp pipeline create [OPTIONS] {display_name}
Create a KFP pipeline.
Examples:
v8x cluster kfp pipeline create my-pipeline -c my-cluster \\
--pipeline-spec '{"pipelineInfo": {"name": "my-pipeline"}}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * display_name <str> Pipeline display name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --description <str> Pipeline description │
│ --pipeline-spec <str> Pipeline spec as a JSON string │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp pipeline list [OPTIONS]
List KFP pipelines.
Examples:
v8x cluster kfp pipeline list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --page-size <int> Page size │
│ --sort-by <str> Sort field │
│ --filter <str> Filter expression │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp pipeline get [OPTIONS] {pipeline_id}
Get details for a KFP pipeline.
Examples:
v8x cluster kfp pipeline get my-pipeline-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * pipeline_id <str> Pipeline ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp pipeline delete [OPTIONS] {pipeline_id}
Delete a KFP pipeline.
Examples:
v8x cluster kfp pipeline delete my-pipeline-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * pipeline_id <str> Pipeline ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp pipeline versions [OPTIONS]
List versions of a KFP pipeline.
Examples:
v8x cluster kfp pipeline versions -c my-cluster --pipeline-id my-pipeline-id
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --pipeline-id <str> Pipeline ID [required] │
│ --page-size <int> Page size │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 run
- create
- list
- get
- delete
- terminate
- retry
Usage: v8x cluster kfp run [OPTIONS] COMMAND [ARGS]...
Manage KFP pipeline runs.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a KFP pipeline run. │
│ list List KFP pipeline runs. │
│ get Get details for a KFP run. │
│ delete Delete a KFP pipeline run. │
│ terminate Terminate a running KFP pipeline run. │
│ retry Retry a failed KFP pipeline run. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp run create [OPTIONS] {display_name}
Create a KFP pipeline run.
Examples:
v8x cluster kfp run create my-run -c my-cluster \\
--experiment-id my-experiment-id \\
--pipeline-version-reference '{"pipeline_id": "my-pipeline-id"}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * display_name <str> Run display name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --experiment-id <str> Experiment ID │
│ --pipeline-version-reference <str> Pipeline version reference │
│ as a JSON string │
│ --runtime-config <str> Runtime config as a JSON │
│ string │
│ --description <str> Run description │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp run list [OPTIONS]
List KFP pipeline runs.
Examples:
v8x cluster kfp run list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --page-size <int> Page size │
│ --sort-by <str> Sort field │
│ --filter <str> Filter expression │
│ --experiment-id <str> Filter by experiment ID │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp run get [OPTIONS] {run_id}
Get details for a KFP run.
Examples:
v8x cluster kfp run get my-run-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * run_id <str> Run ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp run delete [OPTIONS] {run_id}
Delete a KFP pipeline run.
Examples:
v8x cluster kfp run delete my-run-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * run_id <str> Run ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp run terminate [OPTIONS] {run_id}
Terminate a running KFP pipeline run.
Examples:
v8x cluster kfp run terminate my-run-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * run_id <str> Run ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp run retry [OPTIONS] {run_id}
Retry a failed KFP pipeline run.
Examples:
v8x cluster kfp run retry my-run-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * run_id <str> Run ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 experiment
- create
- list
- get
- archive
- unarchive
Usage: v8x cluster kfp experiment [OPTIONS] COMMAND [ARGS]...
Manage KFP experiments.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a KFP experiment. │
│ list List KFP experiments. │
│ get Get details for a KFP experiment. │
│ archive Archive a KFP experiment. │
│ unarchive Unarchive a KFP experiment. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp experiment create [OPTIONS]
{display_name}
Create a KFP experiment.
Examples:
v8x cluster kfp experiment create my-experiment -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * display_name <str> Experiment display name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --description <str> Experiment description │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp experiment list [OPTIONS]
List KFP experiments.
Examples:
v8x cluster kfp experiment list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --page-size <int> Page size │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp experiment get [OPTIONS] {experiment_id}
Get details for a KFP experiment.
Examples:
v8x cluster kfp experiment get my-experiment-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * experiment_id <str> Experiment ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp experiment archive [OPTIONS]
{experiment_id}
Archive a KFP experiment.
Examples:
v8x cluster kfp experiment archive my-experiment-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * experiment_id <str> Experiment ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp experiment unarchive
[OPTIONS] {experiment_id}
Unarchive a KFP experiment.
Examples:
v8x cluster kfp experiment unarchive my-experiment-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * experiment_id <str> Experiment ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 artifact
- list
- get
Usage: v8x cluster kfp artifact [OPTIONS] COMMAND [ARGS]...
Browse KFP artifacts.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List KFP artifacts. │
│ get Get details for a KFP artifact. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp artifact list [OPTIONS]
List KFP artifacts.
Examples:
v8x cluster kfp artifact list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --page-size <int> Page size │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kfp artifact get [OPTIONS] {artifact_id}
Get details for a KFP artifact.
Examples:
v8x cluster kfp artifact get my-artifact-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * artifact_id <str> Artifact ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 kserve
- runtime
Usage: v8x cluster kserve [OPTIONS] COMMAND [ARGS]...
Manage KServe resources within a Vantage K8s cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ runtime Manage KServe serving runtimes. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 runtime
- create
Usage: v8x cluster kserve runtime [OPTIONS] COMMAND [ARGS]...
Manage KServe serving runtimes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Clone a ClusterServingRuntime into the caller's profile namespace. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kserve runtime create [OPTIONS] {name}
Clone a ClusterServingRuntime into the caller's profile namespace.
The namespaced copy shadows the cluster-scoped runtime when KServe
resolves runtimes for InferenceServices in that namespace.
Examples:
v8x cluster kserve runtime create kserve-vllm --from-runtime kserve-vllm
-c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name for the namespaced ServingRuntime [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --from-runtime -f <str> Name of the ClusterServingRuntime to clone │
│ [required] │
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 namespace
- create
- delete
- get
- list
Usage: v8x cluster namespace [OPTIONS] COMMAND [ARGS]...
Manage namespaces on a Vantage K8s cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a namespace on a Vantage cluster. │
│ delete Delete a namespace from a Vantage cluster. │
│ get Get details of a specific namespace. │
│ list List namespaces on a Vantage cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster namespace create [OPTIONS] {name}
Create a namespace on a Vantage cluster.
Examples:
v8x cluster namespace create my-namespace -c my-cluster
v8x cluster namespace create my-namespace -c my-cluster --labels
'{"env":"dev"}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Namespace name to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --labels <str> Labels as JSON (e.g. '{"env": "dev"}') │
│ [default: {}] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster namespace delete [OPTIONS] {name}
Delete a namespace from a Vantage cluster.
Examples:
v8x cluster namespace delete my-namespace -c my-cluster
v8x cluster namespace delete my-namespace -c my-cluster --force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Namespace name to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster namespace get [OPTIONS] {name}
Get details of a specific namespace.
Examples:
v8x cluster namespace get vantage-kubeflow-james -c my-cluster
v8x cluster namespace get vantage-kubeflow-james -c my-cluster --json
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Namespace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster namespace list [OPTIONS]
List namespaces on a Vantage cluster.
Examples:
v8x cluster namespace list -c my-cluster
v8x cluster namespace list -c my-cluster --json
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 nemo
- model
- dataset
- checkpoint
- strategy
- recipe
- training
- experiment
Usage: v8x cluster nemo [OPTIONS] COMMAND [ARGS]...
NeMo microservices catalogs and CRD-backed training resources.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ customization-configs List NeMo Customizer fine-tuning recipes (model x │
│ technique). │
│ customization-targets List NeMo Customizer fine-tunable base models. │
│ evaluation-configs List NeMo Evaluator configs. │
│ model Manage NeMo CRD-backed models. │
│ dataset Manage NeMo CRD-backed datasets. │
│ checkpoint Browse NeMo CRD-backed checkpoints. │
│ compute-profile Manage NeMo compute profiles. │
│ strategy Manage NeMo distributed training strategies. │
│ recipe Manage NeMo training recipes. │
│ training Submit, monitor, and manage NeMo training runs. │
│ experiment Manage NeMo experiments. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 model
- list
- get
- register
Usage: v8x cluster nemo model [OPTIONS] COMMAND [ARGS]...
Manage NeMo CRD-backed models.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List NeMo CRD-backed models. │
│ get Get details for a NeMo CRD-backed model. │
│ register Register a NeMo CRD-backed model. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo model list [OPTIONS]
List NeMo CRD-backed models.
Examples:
v8x cluster nemo model list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo model get [OPTIONS] {namespace}
{model_name}
Get details for a NeMo CRD-backed model.
Examples:
v8x cluster nemo model get my-namespace my-model -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * namespace <str> Model namespace [required] │
│ * model_name <str> Model name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo model register [OPTIONS] {name}
{namespace}
Register a NeMo CRD-backed model.
Examples:
v8x cluster nemo model register my-model my-namespace -c my-cluster \\
--training-methods lora --training-methods sft --precision bf16
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Model name [required] │
│ * namespace <str> Model namespace [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --training-methods <str> Supported training methods │
│ (repeatable) │
│ [required] │
│ * --precision <str> Supported precision types │
│ (repeatable) │
│ [required] │
│ --family <str> Model family │
│ --source <str> Model source │
│ --architecture-size <str> Architecture size │
│ --tokenizer <str> Tokenizer │
│ --revision <str> Model revision │
│ --license-info <str> License information │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 dataset
- list
- get
- register
- delete
Usage: v8x cluster nemo dataset [OPTIONS] COMMAND [ARGS]...
Manage NeMo CRD-backed datasets.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List NeMo CRD-backed datasets. │
│ get Get details for a NeMo CRD-backed dataset. │
│ register Register a NeMo CRD-backed dataset. │
│ delete Delete a NeMo CRD-backed dataset. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo dataset list [OPTIONS]
List NeMo CRD-backed datasets.
Examples:
v8x cluster nemo dataset list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo dataset get [OPTIONS] {namespace}
{dataset_name}
Get details for a NeMo CRD-backed dataset.
Examples:
v8x cluster nemo dataset get my-namespace my-dataset -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * namespace <str> Dataset namespace [required] │
│ * dataset_name <str> Dataset name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo dataset register [OPTIONS] {name}
{namespace}
Register a NeMo CRD-backed dataset.
Examples:
v8x cluster nemo dataset register my-dataset my-namespace -c my-cluster \\
--modality text --files-url s3://bucket/path --splits train --splits val
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Dataset name [required] │
│ * namespace <str> Dataset namespace [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --modality <str> Dataset modality [required] │
│ * --files-url <str> Dataset files URL [required] │
│ --format <str> Dataset format │
│ --splits <str> Dataset splits (repeatable) │
│ --num-samples <int> Number of samples │
│ --schema-preview <str> Schema preview as a JSON string │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo dataset delete [OPTIONS] {namespace}
{dataset_name}
Delete a NeMo CRD-backed dataset.
Examples:
v8x cluster nemo dataset delete my-namespace my-dataset -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * namespace <str> Dataset namespace [required] │
│ * dataset_name <str> Dataset name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 checkpoint
- list
- get
Usage: v8x cluster nemo checkpoint [OPTIONS] COMMAND [ARGS]...
Browse NeMo CRD-backed checkpoints.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List NeMo CRD-backed checkpoints. │
│ get Get details for a NeMo CRD-backed checkpoint. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo checkpoint list [OPTIONS]
List NeMo CRD-backed checkpoints.
Examples:
v8x cluster nemo checkpoint list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo checkpoint get [OPTIONS] {namespace}
{checkpoint_name}
Get details for a NeMo CRD-backed checkpoint.
Examples:
v8x cluster nemo checkpoint get my-namespace my-checkpoint -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * namespace <str> Checkpoint namespace [required] │
│ * checkpoint_name <str> Checkpoint name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 strategy
- create
- list
- get
- update
- delete
Usage: v8x cluster nemo strategy [OPTIONS] COMMAND [ARGS]...
Manage NeMo distributed training strategies.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a NeMo distributed training strategy. │
│ list List NeMo distributed training strategies. │
│ get Get details for a NeMo distributed strategy. │
│ update Update a NeMo distributed training strategy. │
│ delete Delete a NeMo distributed training strategy. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo strategy create [OPTIONS] {name}
Create a NeMo distributed training strategy.
Examples:
v8x cluster nemo strategy create my-strategy -c my-cluster \\
--tensor-parallelism 2 --pipeline-parallelism 1 --context-parallelism 1 \\
--expert-parallelism 1 --sequence-parallelism --micro-batch-size 1 \\
--distributed-optimizer
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Strategy name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name │
│ [required] │
│ * --tensor-parallel… <int> Tensor parallelism │
│ degree │
│ [required] │
│ * --pipeline-parall… <int> Pipeline parallelism │
│ degree │
│ [required] │
│ * --context-paralle… <int> Context parallelism │
│ degree │
│ [required] │
│ * --expert-parallel… <int> Expert parallelism │
│ degree │
│ [required] │
│ * --sequence-parall… --no-sequence-par… Enable sequence │
│ parallelism │
│ [required] │
│ * --micro-batch-size <int> Micro batch size │
│ [required] │
│ * --distributed-opt… --no-distributed-… Enable distributed │
│ optimizer │
│ [required] │
│ --data-parallelism <int> Data parallelism │
│ degree │
│ --global-batch-si… <int> Global batch size │
│ --gradient-accumu… <int> Gradient │
│ accumulation steps │
│ --sequence-length <int> Sequence length │
│ --activation-reco… <str> Activation │
│ recomputation mode │
│ --json -j Output in JSON │
│ format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message │
│ and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo strategy list [OPTIONS]
List NeMo distributed training strategies.
Examples:
v8x cluster nemo strategy list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo strategy get [OPTIONS] {name}
Get details for a NeMo distributed strategy.
Examples:
v8x cluster nemo strategy get my-strategy -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Strategy name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo strategy update [OPTIONS] {name}
Update a NeMo distributed training strategy.
Examples:
v8x cluster nemo strategy update my-strategy -c my-cluster \\
--body-json '{"micro_batch_size": 2}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Strategy name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --body-json <str> Fields to update as a JSON string [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo strategy delete [OPTIONS] {name}
Delete a NeMo distributed training strategy.
Examples:
v8x cluster nemo strategy delete my-strategy -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Strategy name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 recipe
- create
- list
- get
- update
- delete
- configs
- targets
Usage: v8x cluster nemo recipe [OPTIONS] COMMAND [ARGS]...
Manage NeMo training recipes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a NeMo training recipe. │
│ list List NeMo training recipes. │
│ get Get details for a NeMo training recipe. │
│ update Update a NeMo training recipe. │
│ delete Delete a NeMo training recipe. │
│ configs List NeMo recipe training configs. │
│ targets List NeMo recipe model targets. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo recipe create [OPTIONS] {name}
Create a NeMo training recipe.
Examples:
v8x cluster nemo recipe create my-recipe -c my-cluster \\
--recipe-type fine-tuning --training-config '{"epochs": 3}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Recipe name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --recipe-type <str> Recipe type [required] │
│ * --training-config <str> Training config as a JSON string │
│ [required] │
│ --model-architecture <str> Model architecture │
│ --runtime-image <str> Runtime container image │
│ --resource-requirements <str> Resource requirements as a JSON │
│ string │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo recipe list [OPTIONS]
List NeMo training recipes.
Examples:
v8x cluster nemo recipe list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo recipe get [OPTIONS] {name}
Get details for a NeMo training recipe.
Examples:
v8x cluster nemo recipe get my-recipe -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Recipe name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo recipe update [OPTIONS] {name}
Update a NeMo training recipe.
Examples:
v8x cluster nemo recipe update my-recipe -c my-cluster \\
--body-json '{"runtime_image": "nemo:24.09"}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Recipe name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --body-json <str> Fields to update as a JSON string [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo recipe delete [OPTIONS] {name}
Delete a NeMo training recipe.
Examples:
v8x cluster nemo recipe delete my-recipe -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Recipe name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo recipe configs [OPTIONS]
List NeMo recipe training configs.
Examples:
v8x cluster nemo recipe configs -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo recipe targets [OPTIONS]
List NeMo recipe model targets.
Examples:
v8x cluster nemo recipe targets -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 training
- submit
- list
- get
- status
- logs
- results
- cancel
- delete
Usage: v8x cluster nemo training [OPTIONS] COMMAND [ARGS]...
Submit, monitor, and manage NeMo training runs.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ submit Submit a NeMo training run. │
│ list List NeMo training runs. │
│ get Get details for a NeMo training run. │
│ status Get status for a NeMo training run. │
│ logs Get logs for a NeMo training run. │
│ results Get results for a NeMo training run. │
│ cancel Cancel a running NeMo training run. │
│ delete Delete a NeMo training run. │
│ execution-profiles List NeMo training execution profiles. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training submit [OPTIONS]
Submit a NeMo training run.
Examples:
v8x cluster nemo training submit -c my-cluster \\
--recipe-name my-recipe --model-id my-model --dataset-ids my-dataset
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --recipe-name <str> Recipe name [required] │
│ * --model-id <str> Model ID [required] │
│ * --dataset-ids <str> Dataset IDs (repeatable) │
│ [required] │
│ --compute-profile-name <str> Compute profile name │
│ --distributed-strategy-name <str> Distributed strategy name │
│ --experiment-name <str> Experiment name │
│ --overrides <str> Training overrides as a JSON │
│ string │
│ --execution-profile <str> Execution profile │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training list [OPTIONS]
List NeMo training runs.
Examples:
v8x cluster nemo training list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training get [OPTIONS] {job_id}
Get details for a NeMo training run.
Examples:
v8x cluster nemo training get my-job-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * job_id <str> Training job ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training status [OPTIONS] {job_id}
Get status for a NeMo training run.
Examples:
v8x cluster nemo training status my-job-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * job_id <str> Training job ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training logs [OPTIONS] {job_id}
Get logs for a NeMo training run.
Examples:
v8x cluster nemo training logs my-job-id -c my-cluster --lines 500
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * job_id <str> Training job ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --lines <int> Number of log lines to fetch [default: 200] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training results [OPTIONS] {job_id}
Get results for a NeMo training run.
Examples:
v8x cluster nemo training results my-job-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * job_id <str> Training job ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training cancel [OPTIONS] {job_id}
Cancel a running NeMo training run.
Examples:
v8x cluster nemo training cancel my-job-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * job_id <str> Training job ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo training delete [OPTIONS] {job_id}
Delete a NeMo training run.
Examples:
v8x cluster nemo training delete my-job-id -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * job_id <str> Training job ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 experiment
- create
- list
- get
- update
- delete
Usage: v8x cluster nemo experiment [OPTIONS] COMMAND [ARGS]...
Manage NeMo experiments.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a NeMo experiment. │
│ list List NeMo experiments. │
│ get Get details for a NeMo experiment. │
│ update Update a NeMo experiment. │
│ delete Delete a NeMo experiment. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo experiment create [OPTIONS] {name}
Create a NeMo experiment.
Examples:
v8x cluster nemo experiment create my-experiment -c my-cluster \\
--objective "maximize accuracy" --base-recipe-name my-recipe --tags nlp
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Experiment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --objective <str> Experiment objective │
│ --base-recipe-name <str> Base recipe name │
│ --tags <str> Experiment tags (repeatable) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo experiment list [OPTIONS]
List NeMo experiments.
Examples:
v8x cluster nemo experiment list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo experiment get [OPTIONS] {name}
Get details for a NeMo experiment.
Examples:
v8x cluster nemo experiment get my-experiment -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Experiment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo experiment update [OPTIONS] {name}
Update a NeMo experiment.
Examples:
v8x cluster nemo experiment update my-experiment -c my-cluster \\
--body-json '{"objective": "minimize loss"}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Experiment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --body-json <str> Fields to update as a JSON string [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nemo experiment delete [OPTIONS] {name}
Delete a NeMo experiment.
Examples:
v8x cluster nemo experiment delete my-experiment -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Experiment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 network
- create
- delete
- get
- list
- update
Usage: v8x cluster network [OPTIONS] COMMAND [ARGS]...
Manage Multus networks on a Vantage K8s cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a Multus network on a Vantage cluster. │
│ delete Delete a Multus network from a Vantage cluster. │
│ get Get details for a Multus network. │
│ list List Multus networks on a Vantage cluster. │
│ update Update a Multus network on a Vantage cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network create [OPTIONS] {name}
Create a Multus network on a Vantage cluster.
Attaches a secondary pod network using one of the supported CNI types
(macvlan, ipvlan, or host-device) with NV-IPAM address management.
Pods requesting the network get an additional interface with an IP
allocated from the configured range.
CNI types:
macvlan — virtual MACs on a parent interface (mode: bridge). Default.
ipvlan — shared MAC, isolated L2 (mode: l2). Needs --vlan or --bridge.
host-device — moves an entire host interface into the pod namespace.
IPAM is optional (the device may carry its own addressing).
Examples:
# Basic macvlan with gateway:
v8x cluster network create data-net my-cluster --ip-range
10.20.0.0/24 --gateway 10.20.0.1
# Macvlan on a specific bridge, excluding a reserved sub-range:
v8x cluster network create mgmt-net my-cluster --bridge br0
--ip-range 192.168.1.0/24 --gateway 192.168.1.1 --exclude
192.168.1.0/28
# Macvlan with multiple exclusions and custom MTU:
v8x cluster network create storage-net my-cluster --bridge br-stor
--ip-range 10.50.0.0/16 --exclude 10.50.0.0/24 --exclude
10.50.255.0/24 --mtu 9000
# IPvlan on a VLAN trunk:
v8x cluster network create vlan120 my-cluster --network-type ipvlan
--vlan 120 --ip-range 10.120.0.0/24 --gateway 10.120.0.1
# IPvlan with a per-node block size (controls NV-IPAM allocation
granularity):
v8x cluster network create hpc-net my-cluster --network-type ipvlan
--bridge bond0 --ip-range 10.80.0.0/20 --per-node-block-size 64
# Host-device passthrough (no IPAM — device has its own addressing):
v8x cluster network create passthru my-cluster --network-type
host-device
# Host-device with IPAM and a default route:
v8x cluster network create wan-net my-cluster --network-type
host-device --ip-range 203.0.113.0/28 --gateway 203.0.113.1
--route '{"dst":"0.0.0.0/0"}'
# Default route + specific subnet route:
v8x cluster network create multi-route my-cluster --ip-range
10.30.0.0/24 --gateway 10.30.0.1 --route '{"dst":"0.0.0.0/0"}'
--route '{"dst":"172.16.0.0/12"}'
# Route to a specific CIDR (e.g. storage network behind a different hop):
v8x cluster network create stor-net my-cluster --ip-range
10.40.0.0/24 --gateway 10.40.0.1 --route '{"dst":"10.99.0.0/16"}'
# Custom in-pod interface name:
v8x cluster network create data-net my-cluster --ip-range
10.20.0.0/24 --iface-name data0
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Network name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster │
│ [required] │
│ --type -t <str> CNI type: macvlan, ipvlan, │
│ host-device, or sriov │
│ [default: macvlan] │
│ --iface-name <str> Interface name inside pods │
│ --bridge <str> Host interface or bridge to attach │
│ --vlan <int> VLAN ID │
│ --mtu <int> MTU, or 0 for plugin default │
│ [default: 0] │
│ --ipam-type <str> IPAM type: nv-ipam │
│ [default: nv-ipam] │
│ --ip-range <str> IPAM CIDR │
│ --gateway <str> IPAM gateway IP │
│ --exclude <str> CIDR to exclude from NV-IPAM │
│ --per-node-block-size <int> NV-IPAM IPPool addresses allocated │
│ per node │
│ --route <str> Route JSON, e.g. │
│ '{"dst":"0.0.0.0/0"}' │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network delete [OPTIONS] {name}
Delete a Multus network from a Vantage cluster.
Examples:
v8x cluster network delete data-net -c my-cluster
v8x cluster network delete data-net -c my-cluster --force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Network name to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network get [OPTIONS] {name}
Get details for a Multus network.
Examples:
v8x cluster network get data-net -c my-cluster
v8x cluster network get data-net -c my-cluster --json
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Network name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network list [OPTIONS]
List Multus networks on a Vantage cluster.
Examples:
v8x cluster network list -c my-cluster
v8x cluster network list -c my-cluster --json
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network update [OPTIONS] {name}
Update a Multus network on a Vantage cluster.
Examples:
v8x cluster network update data-net -c my-cluster --mtu 9000
v8x cluster network update data-net -c my-cluster --ip-range 10.20.0.0/24
--gateway 10.20.0.1
v8x cluster network update vlan10 -c my-cluster --ip-range 192.168.10.0/24
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Network name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster │
│ [required] │
│ --type -t <str> CNI type: macvlan, ipvlan, │
│ host-device, or sriov │
│ --iface-name <str> Interface name inside pods │
│ --bridge <str> Host interface or bridge to attach │
│ --vlan <int> VLAN ID │
│ --mtu <int> MTU │
│ --ipam-type <str> IPAM type: nv-ipam │
│ --ip-range <str> IPAM CIDR │
│ --gateway <str> IPAM gateway IP │
│ --exclude <str> CIDR to exclude from NV-IPAM │
│ --per-node-block-size <int> NV-IPAM IPPool addresses allocated │
│ per node │
│ --route <str> Route JSON, e.g. │
│ '{"dst":"0.0.0.0/0"}' │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 nim
- catalog
- versions
- create
- list
- get
- delete
Usage: v8x cluster nim [OPTIONS] COMMAND [ARGS]...
Manage NVIDIA NIM deployments on a cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ catalog List NIM catalog entries. │
│ versions List approved/blocked versions for a NIM catalog entry. │
│ create Deploy a NIM from the catalog. │
│ list List NIM deployments. │
│ get Get a NIM deployment. │
│ delete Delete a NIM deployment. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nim catalog [OPTIONS]
List NIM catalog entries.
Examples:
v8x cluster nim catalog -c my-cluster --task text-generation
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --task <str> Filter by task (e.g. text-generation) │
│ --publisher <str> Filter by publisher (e.g. meta) │
│ --query -q <str> Free-text filter │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nim versions [OPTIONS] {catalog_id}
List approved/blocked versions for a NIM catalog entry.
Examples:
v8x cluster nim versions meta/llama-3.1-8b-instruct -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * catalog_id <str> Catalog id, e.g. meta/llama-3.1-8b-instruct │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nim create [OPTIONS] {name}
Deploy a NIM from the catalog.
Examples:
v8x cluster nim create my-llama -c my-cluster \\
-i meta/llama-3.1-8b-instruct -v 1.8.6 \\
--compute-pool gpu-pool --ingress public --ingress-auth user
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Deployment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --catalog-id -i <str> Catalog id, e.g. │
│ meta/llama-3.1-8b-instruct │
│ [required] │
│ * --version -v <str> Approved release tag, e.g. 1.8.6 │
│ [required] │
│ --namespace -n <str> Target namespace (default: your profile │
│ ns) │
│ --profile <str> NIM resource profile name │
│ --platform <str> Serving platform: standalone, kserve, │
│ serverless │
│ [default: standalone] │
│ --precache Pre-pull model engines via a NIMCache │
│ --replicas-min <int> Minimum replicas (0 only for serverless) │
│ [default: 1] │
│ --replicas-max <int> Maximum replicas (> min enables HPA) │
│ [default: 1] │
│ --cache-size <str> Model cache PVC size, e.g. 50Gi │
│ --storage-class <str> StorageClass for the cache PVC │
│ --ingress <str> Ingress type: public (gateway + JWT), │
│ private (cluster-internal only), metallb │
│ (L4 LoadBalancer VIP, no JWT) │
│ [default: public] │
│ --ingress-auth <str> Public-ingress authorization: user │
│ (creator-only), org (any Vantage JWT), │
│ unauthenticated (no JWT check) │
│ [default: user] │
│ --env -e <str> Extra env var KEY=VALUE (repeatable) │
│ --compute-pool -p <str> GPU compute pool for the NIM pods │
│ --pin-digest Record the resolved image digest │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nim list [OPTIONS]
List NIM deployments.
Examples:
v8x cluster nim list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nim get [OPTIONS] {name}
Get a NIM deployment.
Examples:
v8x cluster nim get my-llama -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Deployment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster nim delete [OPTIONS] {name}
Delete a NIM deployment.
Examples:
v8x cluster nim delete my-llama -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Deployment name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 kubeflow
- create
- get
- delete
Usage: v8x cluster kubeflow [OPTIONS] COMMAND [ARGS]...
Manage Kubeflow ML platform on a Vantage K8s cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Deploy Kubeflow on a Vantage K8s cluster. │
│ get Get the status of Kubeflow on a Vantage K8s cluster. │
│ delete Remove Kubeflow from a Vantage K8s cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kubeflow create [OPTIONS]
Deploy Kubeflow on a Vantage K8s cluster.
Triggers the Kubeflow deployment via vdeployer-web. This is a background
operation — use 'v8x cluster kubeflow get' to check status.
Examples:
v8x cluster kubeflow create --cluster my-cluster
v8x cluster kubeflow create --cluster my-cluster --admin-compute-pool
kubeflow-admin
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster │
│ [required] │
│ --admin-compute-pool <str> Compute pool for Kubeflow │
│ infrastructure pods (controllers, │
│ dashboard). If not set, pods run on │
│ control-plane nodes. │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kubeflow get [OPTIONS]
Get the status of Kubeflow on a Vantage K8s cluster.
Examples:
v8x cluster kubeflow get --cluster my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kubeflow delete [OPTIONS]
Remove Kubeflow from a Vantage K8s cluster.
This removes all Kubeflow components and namespaces. This is a background
operation — use 'v8x cluster kubeflow get' to check status.
Examples:
v8x cluster kubeflow delete --cluster my-cluster
v8x cluster kubeflow delete -c my-cluster --yes
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 ray
- create
- list
- get
- delete
- clusters
Usage: v8x cluster ray [OPTIONS] COMMAND [ARGS]...
Manage Ray jobs and clusters (KubeRay) on a cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Submit a Ray job (KubeRay RayJob). │
│ list List Ray jobs. │
│ get Get a Ray job. │
│ delete Delete a Ray job (KubeRay tears down the associated RayCluster). │
│ clusters List Ray clusters, or show one by name. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster ray create [OPTIONS] {name}
Submit a Ray job (KubeRay RayJob).
Examples:
v8x cluster ray create train-1 -c my-cluster -e "python train.py" \\
-C ray-md --overrides-json '{"workers": 3}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> RayJob name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --entrypoint -e <str> Ray job entrypoint (e.g. 'python │
│ train.py') │
│ [required] │
│ --namespace -n <str> Target namespace (default: your │
│ profile ns) │
│ --configuration-preset -C <str> ray configuration preset; │
│ overrides win over preset values │
│ --size-preset -p <str> ray size preset for the worker pod │
│ shape (overrides the preset's │
│ bundle) │
│ --overrides-json <str> Options JSON merged over the │
│ preset (image, workers, │
│ runtime_env, env, model_endpoints, │
│ ...) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster ray list [OPTIONS]
List Ray jobs.
Examples:
v8x cluster ray list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster ray get [OPTIONS] {name}
Get a Ray job.
Examples:
v8x cluster ray get train-1 -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> RayJob name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster ray delete [OPTIONS] {name}
Delete a Ray job (KubeRay tears down the associated RayCluster).
Examples:
v8x cluster ray delete train-1 -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> RayJob name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster ray clusters [OPTIONS] [name]
List Ray clusters, or show one by name.
Examples:
v8x cluster ray clusters -c my-cluster
v8x cluster ray clusters train-1-raycluster -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ name <str> RayCluster name (omit to list all) │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 secret
- create
- list
- get
- delete
- test
Usage: v8x cluster secret [OPTIONS] COMMAND [ARGS]...
Manage secrets (HuggingFace tokens, S3 credentials) in your profile namespace.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a secret (HuggingFace token or S3 credentials) in your │
│ profile namespace. │
│ list List secrets in your profile namespace. │
│ get Get details of a secret (value is never returned). │
│ delete Delete a secret. │
│ test Test S3 secret connectivity (ListBuckets dry-run). │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret create [OPTIONS] {name}
Create a secret (HuggingFace token or S3 credentials) in your profile
namespace.
Examples:
v8x cluster secret create hf-token -c my-cluster --type huggingface --value
hf_xxxxx
v8x cluster secret create my-s3 -c my-cluster --type s3 \\
--access-key-id AKIA... --secret-access-key xxx --region us-east-1
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Secret name (lowercase RFC-1123, max 40 chars) │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --type -t <str> Secret type: huggingface or s3 │
│ [default: huggingface] │
│ --value -v <str> Secret value (HF token string) │
│ --access-key-id <str> S3 access key ID │
│ --secret-access-key <str> S3 secret access key │
│ --region <str> S3 region (e.g. us-east-1) │
│ --endpoint-url <str> S3 endpoint URL (non-AWS) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret list [OPTIONS]
List secrets in your profile namespace.
Examples:
v8x cluster secret list -c my-cluster
v8x cluster secret list -c my-cluster --type huggingface
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --type -t <str> Filter: huggingface or s3 │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret get [OPTIONS] {name}
Get details of a secret (value is never returned).
Examples:
v8x cluster secret get hf-token -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Secret name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret delete [OPTIONS] {name}
Delete a secret.
Examples:
v8x cluster secret delete hf-token -c my-cluster
v8x cluster secret delete my-s3 -c my-cluster --force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Secret name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret test [OPTIONS] {name}
Test S3 secret connectivity (ListBuckets dry-run).
Examples:
v8x cluster secret test my-s3 -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Secret name to test [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 service
- enable
- disable
- update
- create
- delete
- get
- list
Usage: v8x cluster service [OPTIONS] COMMAND [ARGS]...
Enable, disable, update, or manage user services on a Vantage cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ enable Enable a service on a Vantage cluster. │
│ disable Disable a service on a Vantage cluster. │
│ update Update/reconcile a service on a Vantage cluster. │
│ create Create a user service on a Vantage cluster. │
│ delete Delete a user service from a Vantage cluster. │
│ get Get details of a specific user service. │
│ list List user services on a Vantage cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service enable [OPTIONS] {service}
Enable a service on a Vantage cluster.
This command updates the cluster settings to enable the specified service
and triggers vdeployer to reconcile the cluster state.
Examples:
# Enable JupyterHub on a cluster
v8x cluster service enable jupyterhub --cluster my-cluster
# Enable Slurm
v8x cluster service enable slurm -c my-cluster
# Enable MLflow
v8x cluster service enable mlflow --cluster my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * service <str> Service to enable. Valid services: jupyterhub, │
│ kubeflow, mlflow, ray, slurm │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the cluster to update [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service disable [OPTIONS] {service}
Disable a service on a Vantage cluster.
This command updates the cluster settings to disable the specified service
and triggers vdeployer to reconcile the cluster state, removing the service
components from the cluster.
Use --force to completely wipe the service namespace when the service is in
a broken state and normal disable doesn't work.
Examples:
# Disable JupyterHub on a cluster
v8x cluster service disable jupyterhub --cluster my-cluster
# Disable Slurm
v8x cluster service disable slurm -c my-cluster
# Disable MLflow
v8x cluster service disable mlflow --cluster my-cluster
# Force delete SLURM when it's broken
v8x cluster service disable slurm --cluster my-cluster --force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * service <str> Service to disable. Valid services: jupyterhub, │
│ kubeflow, mlflow, ray, slurm │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the cluster to update [required] │
│ --force -f Force delete the service namespace and all │
│ resources. Use when service is in a broken │
│ state. │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service update [OPTIONS] {service}
Update/reconcile a service on a Vantage cluster.
This command triggers vdeployer to reconcile the specified service
without changing any cluster settings. Use this to apply configuration
changes or re-sync a service to its desired state.
Examples:
# Update JupyterHub configuration
v8x cluster service update jupyterhub --cluster my-cluster
# Reconcile Slurm
v8x cluster service update slurm -c my-cluster
# Re-sync MLflow
v8x cluster service update mlflow --cluster my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * service <str> Service to update. Valid services: jupyterhub, │
│ kubeflow, mlflow, ray, slurm │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the cluster to update [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service create [OPTIONS] {workload}
Create a user service on a Vantage cluster.
Creates a user-specific service like PVC viewer, cloud shell, or remote
desktop.
The username is automatically determined from your authenticated identity, and
sizing/scheduling comes from the size preset bundled in the configuration
preset.
Examples:
# Create a PVC viewer with workload defaults
v8x cluster service create pvc-viewer --cluster my-cluster
# Create a cloud shell from a configuration preset
v8x cluster service create cloud-shell -c my-cluster \\
--configuration-preset shell-sm
# Create a remote desktop with a resolution override
v8x cluster service create remote-desktop -c my-cluster \\
-C desktop-md -r 2560x1440
# Create a cloud shell with a specific image tag
v8x cluster service create cloud-shell -c my-cluster --image resolute-0.2
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * workload <str> Workload to create. Valid workloads: cloud-shell, │
│ pvc-viewer, remote-desktop │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the cluster [required] │
│ --name <str> Optional custom service name │
│ (auto-generated when omitted). │
│ --configuration-preset -C <str> Configuration preset name │
│ supplying image version, Slurm │
│ attachment, extra labels, and the │
│ bundled size preset (see 'v8x │
│ cluster configuration-preset list │
│ --kind user-service'). │
│ --image <str> Image override: a bare tag │
│ replaces the version on the │
│ workload's default registry image; │
│ a value containing '/' or ':' is │
│ used as a full reference. │
│ --resolution -r <str> Desktop resolution for │
│ remote-desktop (e.g., 1920x1080). │
│ --vantage-ingress <str> Ingress preset name to create a │
│ VantageIngress for this service │
│ (e.g. public-api-key, │
│ public-user-auth, metallb-open) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service delete [OPTIONS] {workload}
{service_id}
Delete a user service from a Vantage cluster.
Removes the deployment, service, and associated resources.
Examples:
# Delete a PVC viewer
v8x cluster service delete pvc-viewer abc12345-... --cluster my-cluster
# Delete a cloud shell without confirmation
v8x cluster service delete cloud-shell def67890-... -c my-cluster --force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * workload <str> Workload. Valid workloads: cloud-shell, │
│ pvc-viewer, remote-desktop │
│ [required] │
│ * service_id <str> UUID identifier of the service to delete │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the cluster [required] │
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service get [OPTIONS] {workload}
{service_id}
Get details of a specific user service.
Examples:
# Get details of a specific PVC viewer
v8x cluster service get pvc-viewer abc12345-... --cluster my-cluster
# Get details of a cloud shell
v8x cluster service get cloud-shell def67890-... -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * workload <str> Workload. Valid workloads: cloud-shell, │
│ pvc-viewer, remote-desktop │
│ [required] │
│ * service_id <str> UUID identifier of the service [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service list [OPTIONS]
List user services on a Vantage cluster.
Lists user-specific services like PVC viewers, cloud shells, and remote
desktops.
By default, shows only your own services.
Examples:
# List your services
v8x cluster service list --cluster my-cluster
# List only your cloud shells
v8x cluster service list -c my-cluster --workload cloud-shell
# List services for a specific user (admin)
v8x cluster service list -c my-cluster --username alice
# List all users' services (admin)
v8x cluster service list -c my-cluster --all
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the cluster [required] │
│ --workload,--type -w,-t <str> Filter by workload: cloud-shell, │
│ pvc-viewer, remote-desktop │
│ --username -u <str> Filter by username (defaults to │
│ current user) │
│ --all -a Show services for all users (admin │
│ only) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 slurm
- create
- delete
- get
- list
- update
Usage: v8x cluster slurm [OPTIONS] COMMAND [ARGS]...
Manage Slurm clusters within a Vantage K8s cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create and deploy a Slurm cluster within a Vantage K8s cluster. │
│ delete Remove a Slurm cluster and all its resources. │
│ get Get the status of a specific Slurm cluster. │
│ list List all Slurm clusters deployed within a Vantage K8s cluster. │
│ update Update settings for an existing Slurm cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm create [OPTIONS] {name}
Create and deploy a Slurm cluster within a Vantage K8s cluster.
Registers the Slurm cluster via the API (creates Keycloak client and DB
record),
then triggers deployment via vdeployer-web (operator, slurmdbd, slurmctld,
etc.).
This is a background operation — use 'v8x cluster slurm get' to check status.
Examples:
v8x cluster slurm create hpc-prod -c my-cluster \\
--control-compute-pool slurm-admin \\
--partition cpu:slurm-compute:default \\
--exposed --profiling \\
--slurmctld-lb-ip 192.168.8.221 \\
--slurmdbd-lb-ip 192.168.8.220 \\
--slurmrestd-lb-ip 192.168.8.222
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name for the Slurm cluster (DNS-safe, e.g. 'hpc-prod') │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s │
│ cluster │
│ [required] │
│ * --control-compute-p… <str> Compute pool name for │
│ the slurmctld │
│ controller │
│ [required] │
│ * --partition <str> Partition spec as │
│ 'name:compute_pool' or │
│ 'name:compute_pool:de… │
│ Repeatable. │
│ [required] │
│ --exposed --no-exposed Expose SLURM services │
│ via NodePort │
│ [default: no-exposed] │
│ --tls --no-tls Enable TLS for │
│ internal SLURM │
│ communication │
│ [default: tls] │
│ --profiling --no-profiling Enable InfluxDB for │
│ SLURM job profiling │
│ [default: profiling] │
│ --bridge --no-bridge Enable slurm-bridge │
│ for K8s scheduler │
│ integration │
│ [default: bridge] │
│ --slurmctld-lb-ip <str> Optionally pin the │
│ MetalLB LoadBalancer │
│ IP for slurmctld. When │
│ unset, MetalLB │
│ allocates from its │
│ pool. Pin only when │
│ off-cluster clients │
│ need a stable address │
│ (e.g. for /etc/hosts │
│ mapping). Example: │
│ 192.168.8.221 │
│ --slurmdbd-lb-ip <str> Optionally pin the │
│ MetalLB LoadBalancer │
│ IP for slurmdbd │
│ (auto-allocated when │
│ unset). │
│ --slurmrestd-lb-ip <str> Optionally pin the │
│ MetalLB LoadBalancer │
│ IP for slurmrestd │
│ (auto-allocated when │
│ unset). │
│ --influxdb-lb-ip <str> Optionally pin the │
│ MetalLB LoadBalancer │
│ IP for InfluxDB. When │
│ unset, MetalLB │
│ allocates from its │
│ pool. Pin when │
│ off-cluster slurmd │
│ pushes job profiling │
│ metrics here AND needs │
│ the IP in the InfluxDB │
│ TLS cert SAN. │
│ --show-secret Show the full client │
│ secret in output │
│ instead of masking it. │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm delete [OPTIONS] {name}
Remove a Slurm cluster and all its resources.
This deletes the Slurm cluster namespace and all components deployed within
it.
This is a background operation — the namespace will be removed asynchronously.
Examples:
v8x cluster slurm delete hpc-prod --cluster my-cluster
v8x cluster slurm delete ml-dev -c my-cluster --yes
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the Slurm cluster to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm get [OPTIONS] {name}
Get the status of a specific Slurm cluster.
Examples:
v8x cluster slurm get hpc-prod --cluster my-cluster
v8x cluster slurm get ml-dev -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the Slurm cluster [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm list [OPTIONS]
List all Slurm clusters deployed within a Vantage K8s cluster.
Examples:
v8x cluster slurm list --cluster my-cluster
v8x cluster slurm list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm update [OPTIONS] {name}
Update settings for an existing Slurm cluster.
Only provided flags are changed — omitted flags keep their current values.
This is a background operation — the cluster will be redeployed
asynchronously.
Examples:
v8x cluster slurm update hpc-prod --cluster my-cluster --profiling
v8x cluster slurm update ml-dev -c my-cluster --no-bridge
v8x cluster slurm update research -c my-cluster --exposed --no-tls
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the Slurm cluster to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Name of the parent K8s cluster │
│ [required] │
│ --exposed --no-exposed Expose SLURM services via │
│ NodePort │
│ --tls --no-tls Enable TLS for internal SLURM │
│ communication │
│ --profiling --no-profiling Enable InfluxDB for SLURM job │
│ profiling │
│ --bridge --no-bridge Enable slurm-bridge for K8s │
│ scheduler integration │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 trainjob
- runtime
Usage: v8x cluster trainjob [OPTIONS] COMMAND [ARGS]...
Manage TrainJob resources within a Vantage K8s cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ runtime Manage TrainJob training runtimes. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 runtime
- create
Usage: v8x cluster trainjob runtime [OPTIONS] COMMAND [ARGS]...
Manage TrainJob training runtimes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Clone a ClusterTrainingRuntime into the caller's profile namespace. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster trainjob runtime create [OPTIONS] {name}
Clone a ClusterTrainingRuntime into the caller's profile namespace.
Examples:
v8x cluster trainjob runtime create torch-distributed --from-runtime
torch-distributed -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name for the namespaced TrainingRuntime [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --from-runtime -f <str> Name of the ClusterTrainingRuntime to │
│ clone │
│ [required] │
│ * --cluster -c <str> Name of the parent K8s cluster [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 workspace
- create
- list
- get
- delete
- pause
- resume
- logs
- events
- pvcs
Usage: v8x cluster workspace [OPTIONS] COMMAND [ARGS]...
Manage Kubeflow Workspaces on a cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a Kubeflow Workspace on a cluster. │
│ list List Kubeflow Workspaces on a cluster. │
│ get Get details for a Kubeflow Workspace. │
│ delete Delete a Kubeflow Workspace. │
│ pause Pause a Kubeflow Workspace. │
│ resume Resume a paused Kubeflow Workspace. │
│ logs Tail logs from a Kubeflow Workspace pod. │
│ events List recent Kubernetes events for a Kubeflow Workspace. │
│ pvcs List PVCs available for mounting into Kubeflow Workspaces. │
│ pod-defaults List PodDefaults injectable into Kubeflow Workspaces. │
│ compute-pools List compute pools available for Kubeflow Workspace │
│ scheduling. │
│ admin-list List all Kubeflow Workspaces on a cluster, across all users │
│ (admin only). │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace create [OPTIONS] {name}
Create a Kubeflow Workspace on a cluster.
Examples:
v8x cluster workspace create my-ws -c my-cluster --kind jupyterlab \\
--image-config '{"id":"jupyterlab_scipy"}' --pod-config
'{"id":"cpu-small"}'
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Workspace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --kind <str> WorkspaceKind name [required] │
│ * --image-config <str> Image config as a JSON object │
│ [required] │
│ * --pod-config <str> Pod config as a JSON object │
│ [required] │
│ --paused --running Create the workspace paused │
│ [default: running] │
│ --namespace <str> Target namespace │
│ --home-pvc <str> Home PVC override │
│ --slurm-cluster <str> Slurm cluster to attach │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace list [OPTIONS]
List Kubeflow Workspaces on a cluster.
Examples:
v8x cluster workspace list -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace get [OPTIONS] {name}
Get details for a Kubeflow Workspace.
Examples:
v8x cluster workspace get my-ws -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Workspace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace delete [OPTIONS] {name}
Delete a Kubeflow Workspace.
Examples:
v8x cluster workspace delete my-ws -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Workspace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace pause [OPTIONS] {name}
Pause a Kubeflow Workspace.
Examples:
v8x cluster workspace pause my-ws -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Workspace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace resume [OPTIONS] {name}
Resume a paused Kubeflow Workspace.
Examples:
v8x cluster workspace resume my-ws -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Workspace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace logs [OPTIONS] {name}
Tail logs from a Kubeflow Workspace pod.
Examples:
v8x cluster workspace logs my-ws -c my-cluster
v8x cluster workspace logs my-ws -c my-cluster -n 500
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Workspace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --lines -n <int> Number of log lines [default: 200] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace events [OPTIONS] {name}
List recent Kubernetes events for a Kubeflow Workspace.
Examples:
v8x cluster workspace events my-ws -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Workspace name [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster workspace pvcs [OPTIONS]
List PVCs available for mounting into Kubeflow Workspaces.
Examples:
v8x cluster workspace pvcs -c my-cluster
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Job Management
- 🔹 job
- script
- submission
- template
Usage: v8x job [OPTIONS] COMMAND [ARGS]...
Manage computational jobs, scripts, submissions, and job templates for HPC
workloads.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ script Manage job scripts for computational workloads and batch │
│ processing. │
│ submission Manage job submissions │
│ template Manage job templates │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 script
- create
- delete
- get
- list
- update
Usage: v8x job script [OPTIONS] COMMAND [ARGS]...
Manage job scripts for computational workloads and batch processing.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new job script. │
│ delete Delete a job script. │
│ get Get details of a specific job script. │
│ list List all job scripts. │
│ update Update a job script. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job script create [OPTIONS] {name}
Create a new job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the job script to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --type -t <str> Script type (bash, python, sbatch) │
│ [default: bash] │
│ --description -d <str> Description of the job script │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job script delete [OPTIONS] {script_id}
Delete a job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * script_id <int> ID of the job script to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job script get [OPTIONS] {script_id}
Get details of a specific job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * script_id <int> ID of the job script to retrieve [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job script list [OPTIONS]
List all job scripts.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --from-template-id <int> Filter by job script │
│ template ID │
│ --search -s <str> Search job scripts │
│ --sort-field <str> Field to sort by │
│ --sort-ascending --sort-descending Sort order │
│ [default: │
│ sort-ascending] │
│ --user-only Show only user's job │
│ scripts │
│ --include-archived Include archived job │
│ scripts │
│ --limit -l <int> Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o <int> Number of results to │
│ skip │
│ [default: 0] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job script update [OPTIONS] {script_id}
Update a job script.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * script_id <int> ID of the job script to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the job script │
│ --description -d <str> New description for the job │
│ script │
│ --archived --not-archived Archive or unarchive the job │
│ script │
│ --json-file -f <path> Path to JSON file containing │
│ update data │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 submission
- create
- delete
- get
- list
- update
Usage: v8x job submission [OPTIONS] COMMAND [ARGS]...
Manage job submissions
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new job submission │
│ delete Delete a job submission │
│ get Get details of a specific job submission │
│ list List all job submissions │
│ update Update a job submission │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job submission create [OPTIONS]
Create a new job submission
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --name -n <str> Name of the job submission │
│ [required] │
│ * --job-script-id <int> ID of the job script to use │
│ [required] │
│ --description -d <str> Description of the job submission │
│ --client-id <str> Client ID of the cluster where job │
│ should execute │
│ --execution-directory <str> Directory on cluster where job │
│ should execute │
│ --slurm-job-id <int> SLURM job ID (if already known) │
│ --sbatch-arg <str> SBATCH arguments (can be used │
│ multiple times) │
│ --json-file -f <path> Path to JSON file containing job │
│ submission data │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job submission delete [OPTIONS] {submission_id}
Delete a job submission
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * submission_id <int> ID of the job submission to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job submission get [OPTIONS] {submission_id}
Get details of a specific job submission
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * submission_id <int> ID of the job submission to retrieve │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job submission list [OPTIONS]
List all job submissions
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --slurm-job-ids <str> Comma-separated list of │
│ SLURM job IDs to filter │
│ by │
│ --submit-status <str> Filter by submission │
│ status (CREATED, │
│ SUBMITTED, REJECTED, │
│ DONE, ABORTED) │
│ --from-script-id <int> Filter by job script ID │
│ --search -s <str> Search job submissions │
│ --sort-field <str> Field to sort by │
│ --sort-ascending --sort-descending Sort order │
│ [default: │
│ sort-ascending] │
│ --user-only Show only user's job │
│ submissions │
│ --include-archived Include archived job │
│ submissions │
│ --limit -l <int> Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o <int> Number of results to │
│ skip │
│ [default: 0] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job submission update [OPTIONS] {submission_id}
Update a job submission
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * submission_id <int> ID of the job submission to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the job submission │
│ --description -d <str> New description for the job │
│ submission │
│ --execution-directory <str> New execution directory │
│ --status <str> New status (CREATED, SUBMITTED, │
│ REJECTED, DONE, ABORTED) │
│ --json-file -f <path> Path to JSON file containing update │
│ data │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 template
- create
- delete
- get
- list
- update
Usage: v8x job template [OPTIONS] COMMAND [ARGS]...
Manage job templates
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new job template │
│ delete Delete a job template │
│ get Get details of a specific job template │
│ list List all job templates │
│ update Update a job template │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job template create [OPTIONS]
Create a new job template
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --name -n <str> Name of the job template [required] │
│ --description -d <str> Description of the job template │
│ --identifier -i <str> Human-friendly identifier for the job │
│ template │
│ --json-file -f <path> Path to JSON file containing job template │
│ data │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job template delete [OPTIONS] {template_id}
Delete a job template
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * template_id <str> ID or identifier of the job template to delete │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job template get [OPTIONS] {template_id}
Get details of a specific job template
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * template_id <str> ID or identifier of the job template to │
│ retrieve │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job template list [OPTIONS]
List all job templates
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s <str> Search job templates │
│ --sort-field <str> Field to sort by │
│ --sort-ascending --sort-descending Sort order │
│ [default: │
│ sort-ascending] │
│ --user-only Show only user's job │
│ templates │
│ --include-archived Include archived job │
│ templates │
│ --limit -l <int> Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o <int> Number of results to │
│ skip │
│ [default: 0] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job template update [OPTIONS] {template_id}
Update a job template
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * template_id <str> ID or identifier of the job template to update │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the job template │
│ --description -d <str> New description for the job │
│ template │
│ --identifier -i <str> New identifier for the job │
│ template │
│ --archived --not-archived Archive or unarchive the job │
│ template │
│ --json-file -f <path> Path to JSON file containing │
│ update data │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
License Management
- 🔹 license
- booking
- server
- product
- configuration
- deployment
- feature
Usage: v8x license [OPTIONS] COMMAND [ARGS]...
Manage software licenses, license servers, and licensing configurations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ booking License booking management commands │
│ server Manage license servers for software licensing and compliance. │
│ product Manage license products and software licensing definitions. │
│ configuration Manage license configurations and policy settings. │
│ deployment Manage license deployments for software distribution and │
│ activation. │
│ feature Feature management commands │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 booking
- list
- get
- create
- delete
Usage: v8x license booking [OPTIONS] COMMAND [ARGS]...
License booking management commands
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List all license bookings │
│ get Get a specific license booking by ID │
│ create Create a new license booking │
│ delete Delete a license booking │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license booking list [OPTIONS]
List all license bookings
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s <str> Search bookings by name or id │
│ --sort <str> Sort by field (name, id, created_at) │
│ --limit -l <int> Maximum number of bookings to return │
│ --offset -o <int> Number of bookings to skip │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license booking get [OPTIONS] {booking_id}
Get a specific license booking by ID
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * booking_id <str> Booking ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license booking create [OPTIONS]
Create a new license booking
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> Booking name │
│ --description -d <str> Booking description │
│ --json-file -f <path> JSON file with booking data │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license booking delete [OPTIONS] {booking_id}
Delete a license booking
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * booking_id <str> Booking ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 server
- create
- delete
- get
- list
- update
Usage: v8x license server [OPTIONS] COMMAND [ARGS]...
Manage license servers for software licensing and compliance.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new license server. │
│ delete Delete a license server. │
│ get Get details of a specific license server. │
│ list List all license servers. │
│ update Update an existing license server. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license server create [OPTIONS] {name}
Create a new license server.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the license server to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --host -h <str> Server hostname or IP address [required] │
│ --port -p <int> Server port number [default: 27000] │
│ --description -d <str> Description of the license server │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license server delete [OPTIONS] {server_id}
Delete a license server.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * server_id <str> ID of the license server to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Force delete without confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license server get [OPTIONS] {server_id}
Get details of a specific license server.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * server_id <str> ID of the license server to get [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license server list [OPTIONS]
List all license servers.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s <str> Search term for filtering servers │
│ --sort <str> Sort field for ordering results │
│ --limit -l <int> Maximum number of results to return │
│ --offset -o <int> Number of results to skip │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license server update [OPTIONS] {server_id}
Update an existing license server.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * server_id <str> ID of the license server to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the license server │
│ --host -h <str> New hostname or IP address │
│ --port -p <int> New port number │
│ --description -d <str> New description │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 product
- create
- delete
- get
- list
- update
Usage: v8x license product [OPTIONS] COMMAND [ARGS]...
Manage license products and software licensing definitions.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new license product. │
│ delete Delete a license product. │
│ get Get details of a specific license product. │
│ list List all license products. │
│ update Update an existing license product. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license product create [OPTIONS] {name}
Create a new license product.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the license product to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --version -v <str> Product version [required] │
│ --description -d <str> Description of the license product │
│ --type -t <str> Type of license (concurrent, node-locked, │
│ etc.) │
│ [default: concurrent] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license product delete [OPTIONS] {product_id}
Delete a license product.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * product_id <str> ID of the license product to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Force delete without confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license product get [OPTIONS] {product_id}
Get details of a specific license product.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * product_id <str> ID of the license product to get [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license product list [OPTIONS]
List all license products.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s <str> Search term for filtering products │
│ --sort <str> Sort field for ordering results │
│ --limit -l <int> Maximum number of results to return │
│ --offset -o <int> Number of results to skip │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license product update [OPTIONS] {product_id}
Update an existing license product.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * product_id <str> ID of the license product to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the license product │
│ --version -v <str> New version │
│ --description -d <str> New description │
│ --type -t <str> New license type │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 configuration
- create
- delete
- get
- list
- update
Usage: v8x license configuration [OPTIONS] COMMAND [ARGS]...
Manage license configurations and policy settings.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new license configuration. │
│ delete Delete a license configuration. │
│ get Get details of a specific license configuration. │
│ list List all license configurations. │
│ update Update an existing license configuration. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license configuration create [OPTIONS] {name}
Create a new license configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the license configuration to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --type -t <str> Type of license (concurrent, node-locked, │
│ etc.) │
│ [required] │
│ --max-users -m <int> Maximum number of users │
│ --description -d <str> Description of the license configuration │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license configuration delete [OPTIONS] {config_id}
Delete a license configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * config_id <str> ID of the license configuration to delete │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Force delete without confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license configuration get [OPTIONS] {config_id}
Get details of a specific license configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * config_id <str> ID of the license configuration to get [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license configuration list [OPTIONS]
List all license configurations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s <str> Search configurations by name or id │
│ --sort <str> Sort by field (name, id, created_at) │
│ --limit -l <int> Maximum number of configurations to return │
│ --offset -o <int> Number of configurations to skip │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license configuration update [OPTIONS] {config_id}
Update an existing license configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * config_id <str> ID of the license configuration to update │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the license configuration │
│ --type -t <str> New license type │
│ --max-users -m <int> New maximum number of users │
│ --description -d <str> New description │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 deployment
- create
- delete
- get
- list
- update
Usage: v8x license deployment [OPTIONS] COMMAND [ARGS]...
Manage license deployments for software distribution and activation.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new license deployment. │
│ delete Delete a license deployment. │
│ get Get details of a specific license deployment. │
│ list List all license deployments. │
│ update Update a license deployment. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license deployment create [OPTIONS] {name}
Create a new license deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the license deployment to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --product-id -p <str> Product ID for the deployment [required] │
│ --environment -e <str> Deployment environment (dev, test, prod) │
│ [default: dev] │
│ --nodes -n <int> Number of nodes in the deployment │
│ [default: 1] │
│ --description -d <str> Description of the license deployment │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license deployment delete [OPTIONS] {deployment_id}
Delete a license deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * deployment_id <str> ID of the license deployment to delete │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license deployment get [OPTIONS] {deployment_id}
Get details of a specific license deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * deployment_id <str> ID of the license deployment to retrieve │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license deployment list [OPTIONS]
List all license deployments.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --environment -e <str> Filter by environment │
│ --status -s <str> Filter by status │
│ --limit -l <int> Maximum number of deployments to return │
│ [default: 10] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license deployment update [OPTIONS] {deployment_id}
Update a license deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * deployment_id <str> ID of the license deployment to update │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the deployment │
│ --environment -e <str> New environment for the deployment │
│ --nodes <int> New number of nodes │
│ --description -d <str> New description │
│ --status -s <str> New status (active, inactive, suspended) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 feature
- list
- get
- create
- update
- delete
Usage: v8x license feature [OPTIONS] COMMAND [ARGS]...
Feature management commands
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ list List all license features. │
│ get Get details of a specific license feature. │
│ create Create a new license feature. │
│ update Update an existing license feature. │
│ delete Delete a license feature. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license feature list [OPTIONS]
List all license features.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s <str> Search features by name or id │
│ --sort <str> Sort by field (name, id, created_at) │
│ --limit -l <int> Maximum number of features to return │
│ --offset -o <int> Number of features to skip │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license feature get [OPTIONS] {feature_id}
Get details of a specific license feature.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * feature_id <str> ID of the license feature to get [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license feature create [OPTIONS]
Create a new license feature.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> Feature name │
│ --description -d <str> Feature description │
│ --json-file -f <path> JSON file with feature data │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license feature update [OPTIONS] {feature_id}
Update an existing license feature.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * feature_id <str> ID of the license feature to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New feature name │
│ --description -d <str> New feature description │
│ --json-file -f <path> JSON file with feature data │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license feature delete [OPTIONS] {feature_id}
Delete a license feature.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * feature_id <str> ID of the license feature to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Force delete without confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Network Management
- 🔹 network
- attach
- create
- delete
- detach
- get
- list
- update
Usage: v8x network [OPTIONS] COMMAND [ARGS]...
Manage virtual networks, subnets, and network configurations for cloud
infrastructure.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ attach Attach a network interface to an instance. │
│ create Create a new virtual network. │
│ delete Delete a virtual network. │
│ detach Detach a network interface from an instance. │
│ get Get details of a specific virtual network. │
│ list List all virtual networks. │
│ update Update a virtual network configuration. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network attach [OPTIONS] {network_id} {instance_id}
Attach a network interface to an instance.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * network_id <str> ID of the network to attach [required] │
│ * instance_id <str> ID of the instance to attach network to │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --subnet-id -s <str> Specific subnet ID to attach │
│ --assign-public-ip Assign a public IP address │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network create [OPTIONS] {name}
Create a new virtual network.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the network to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cidr -c <str> CIDR block for the network │
│ [default: 10.0.0.0/16] │
│ --region -r <str> Region for the network │
│ --enable-dns Enable DNS resolution [default: True] │
│ --description -d <str> Description of the network │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network delete [OPTIONS] {network_id}
Delete a virtual network.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * network_id <str> ID of the network to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network detach [OPTIONS] {network_id} {instance_id}
Detach a network interface from an instance.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * network_id <str> ID of the network to detach [required] │
│ * instance_id <str> ID of the instance to detach network from │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Force detachment without graceful shutdown │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network get [OPTIONS] {network_id}
Get details of a specific virtual network.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * network_id <str> ID of the network to retrieve [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network list [OPTIONS]
List all virtual networks.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --region -r <str> Filter by region │
│ --status -s <str> Filter by status │
│ --limit -l <int> Maximum number of networks to return [default: 10] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network update [OPTIONS] {network_id}
Update a virtual network configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * network_id <str> ID of the network to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n <str> New name for the network │
│ --description -d <str> New description │
│ --enable-dns --disable-dns Enable or disable DNS resolution │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Profile Management
- 🔹 profile
- create
- delete
- get
- list
- use
Usage: v8x profile [OPTIONS] COMMAND [ARGS]...
Manage v8x profiles to work with different environments and configurations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new v8x profile. │
│ delete Delete a v8x profile. │
│ get Get details of a specific v8x profile. │
│ list List all v8x profiles. │
│ use Activate a profile for use in the current session. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x profile create [OPTIONS] {profile_name}
Create a new v8x profile.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name <str> Name of the profile to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --vantage-url <str> Vantage Platform URL │
│ [default: https://app.vantagecompute.ai] │
│ --client-id <str> OIDC client ID [default: default] │
│ --max-poll-time <int> OIDC max poll time in seconds [default: 300] │
│ --force -f Overwrite existing profile │
│ --activate Activate this profile after creation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x profile delete [OPTIONS] {profile_name}
Delete a v8x profile.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name <str> Name of the profile to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x profile get [OPTIONS] {profile_name}
Get details of a specific v8x profile.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name <str> Name of the profile to get [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x profile list [OPTIONS]
List all v8x profiles.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x profile use [OPTIONS] {profile_name}
Activate a profile for use in the current session.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name <str> Name of the profile to activate [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Storage Management
- 🔹 storage
- create
- delete
- get
- list
- system
- expose
- import
Usage: v8x storage [OPTIONS] COMMAND [ARGS]...
Manage storage: PVCs, imports, exposes, and storage systems.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a PersistentVolumeClaim in a cluster namespace. │
│ delete Delete a PersistentVolumeClaim. │
│ get Get details of a specific PersistentVolumeClaim. │
│ list List PersistentVolumeClaims in a namespace. │
│ list-available List available StorageClasses on the cluster. │
│ system Manage storage system deployments (CephFS, CephNFS, etc.). │
│ expose Expose cluster storage to external clients. │
│ import Import storage into cluster namespaces. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage create [OPTIONS] {name}
Create a PersistentVolumeClaim in a cluster namespace.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the PVC to create [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Target namespace (default: derived from │
│ username) │
│ --size -s <str> Storage size (e.g. 10Gi) [default: 10Gi] │
│ --storage-class <str> StorageClass name (cluster default if │
│ omitted) │
│ --access-mode <str> Access mode (ReadWriteOnce, │
│ ReadWriteMany, ReadOnlyMany) │
│ [default: ReadWriteOnce] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage delete [OPTIONS] {name}
Delete a PersistentVolumeClaim.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the PVC to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace of the PVC (default: derived from │
│ username) │
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage get [OPTIONS] {name}
Get details of a specific PersistentVolumeClaim.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the PVC to retrieve [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace of the PVC (default: derived from │
│ username) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage list [OPTIONS]
List PersistentVolumeClaims in a namespace.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace to list PVCs from (default: derived │
│ from username) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 system
- create
- get
- list
- delete
- update
Usage: v8x storage system [OPTIONS] COMMAND [ARGS]...
Manage storage system deployments (CephFS, CephNFS, etc.).
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new storage system registration. │
│ get Get details of a storage system. │
│ list List all registered storage systems. │
│ delete Delete a storage system registration. │
│ update Update a storage system's configuration. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system create [OPTIONS] {name}
Create a new storage system registration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Unique name for the storage system [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --type -t <str> Storage system type (e.g. cephfs, │
│ cephnfs) │
│ [required] │
│ * --storage-class <str> Kubernetes StorageClass name for this │
│ system │
│ [required] │
│ --namespace -n <str> Namespace for system resources │
│ [default: vantage-rook-ceph] │
│ --description <str> Human-readable description │
│ --config <str> JSON string with extra configuration │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system get [OPTIONS] {name}
Get details of a storage system.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the storage system [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace for system resources │
│ [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system list [OPTIONS]
List all registered storage systems.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system delete [OPTIONS] {name}
Delete a storage system registration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the storage system to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace for system resources │
│ [default: vantage-rook-ceph] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system update [OPTIONS] {name}
Update a storage system's configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the storage system to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace for system resources │
│ [default: vantage-rook-ceph] │
│ --storage-class <str> New StorageClass name │
│ --config <str> JSON string with updated configuration │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 expose
- cephfs
- nfs
Usage: v8x storage expose [OPTIONS] COMMAND [ARGS]...
Expose cluster storage to external clients.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ cephfs CephFS external expose operations. │
│ nfs NFS external expose operations. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 cephfs
- create
- get
- list
- delete
- credentials
- status
Usage: v8x storage expose cephfs [OPTIONS] COMMAND [ARGS]...
CephFS external expose operations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Expose CephFS storage to clients outside the cluster. │
│ get Get details of a CephFS external expose. │
│ list List all external exposes. │
│ delete Delete a CephFS external expose. │
│ mount-commands Get mount commands for a CephFS external expose. │
│ credentials Get CephFS credentials for an external expose. │
│ status Get status of a CephFS external expose. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs create [OPTIONS] {name}
Expose CephFS storage to clients outside the cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Unique name for this external expose [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name │
│ [required] │
│ --ceph-client-name <str> Ceph client name │
│ [default: │
│ external-cephfs] │
│ --ceph-mds-path <str> MDS permission path │
│ [default: │
│ /volumes/csi] │
│ --ceph-osd-pool <str> OSD pool name │
│ [default: │
│ vantage-cephfs-data] │
│ --expose-monitors --no-expose-monit… Expose Ceph monitors │
│ [default: │
│ expose-monitors] │
│ --monitor-service… <str> NodePort or │
│ LoadBalancer │
│ [default: NodePort] │
│ --msgr2-node-port <int> NodePort for msgr2 │
│ [default: 30300] │
│ --msgr1-node-port <int> NodePort for msgr1 │
│ [default: 30789] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: │
│ vantage-rook-ceph] │
│ --json -j Output in JSON │
│ format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message │
│ and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs get [OPTIONS] {name}
Get details of a CephFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the external expose [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs list [OPTIONS]
List all external exposes.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs delete [OPTIONS] {name}
Delete a CephFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the external expose to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs credentials
[OPTIONS] {name}
Get CephFS credentials for an external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the external expose [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs status [OPTIONS] {name}
Get status of a CephFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the external expose [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 nfs
- create
- get
- delete
Usage: v8x storage expose nfs [OPTIONS] COMMAND [ARGS]...
NFS external expose operations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Expose NFS-backed PVC storage to clients outside the cluster. │
│ get Get details of an NFS external expose. │
│ delete Delete an NFS external expose. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose nfs create [OPTIONS] {name}
Expose NFS-backed PVC storage to clients outside the cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Unique name for this external expose [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --source-pvc <str> Source PVC name [required] │
│ * --source-namespace <str> Source PVC namespace [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose nfs get [OPTIONS] {name}
Get details of an NFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the external expose [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose nfs delete [OPTIONS] {name}
Delete an NFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the external expose to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --rook-namespace <str> Rook-Ceph namespace │
│ [default: vantage-rook-ceph] │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 import
- get
- list
- delete
- internal
- cephfs
- nfs
Usage: v8x storage import [OPTIONS] COMMAND [ARGS]...
Import storage into cluster namespaces.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ get Get details of a specific storage import. │
│ list List all storage imports in a namespace. │
│ delete Delete an imported storage PVC and its backing PV. │
│ get-external Get details of a specific external import. │
│ list-external List all external imports. │
│ delete-external Delete an external import (PV, PVC, and credentials). │
│ external-status Get PV/PVC binding status of an external import. │
│ external-mount-info Get mount information for an external import (NFS │
│ only). │
│ external-config Get the full configuration of an external import as │
│ reusable JSON (CephFS only). │
│ internal Import storage across namespaces within the cluster. │
│ cephfs CephFS storage import operations. │
│ nfs NFS storage import operations. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import get [OPTIONS] {name}
Get details of a specific storage import.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the imported PVC [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --type -t <str> Storage type: 'nfs' or 'cephfs' │
│ [default: nfs] │
│ --namespace -n <str> Namespace (default: derived from username) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import list [OPTIONS]
List all storage imports in a namespace.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --type -t <str> Storage type: 'nfs' or 'cephfs' │
│ [default: nfs] │
│ --namespace -n <str> Namespace (default: derived from username) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import delete [OPTIONS] {name}
Delete an imported storage PVC and its backing PV.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the imported PVC to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --type -t <str> Storage type: 'nfs' or 'cephfs' │
│ [default: nfs] │
│ --namespace -n <str> Namespace (default: derived from username) │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 internal
- create
- get
- list
- delete
Usage: v8x storage import internal [OPTIONS] COMMAND [ARGS]...
Import storage across namespaces within the cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Import existing PVC from another namespace into the target │
│ namespace. │
│ get Get details of a cross-namespace storage import. │
│ list List all cross-namespace storage imports in a namespace. │
│ delete Delete a cross-namespace storage import and its backing PV. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import internal create [OPTIONS] {name}
Import existing PVC from another namespace into the target namespace.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name for the imported PVC in the target namespace │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --source-pvc <str> Source PVC name [required] │
│ * --source-namespace <str> Source PVC namespace [required] │
│ --namespace -n <str> Target namespace (default: derived │
│ from username) │
│ --capacity <str> Storage capacity [default: 100Gi] │
│ --access-mode <str> Access mode (ReadWriteMany, │
│ ReadOnlyMany, ReadWriteOnce) │
│ [default: ReadWriteMany] │
│ --read-only Mount as read-only │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import internal get [OPTIONS] {name}
Get details of a cross-namespace storage import.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the imported PVC [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace (default: derived from username) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import internal list [OPTIONS]
List all cross-namespace storage imports in a namespace.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace (default: derived from username) │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import internal delete [OPTIONS] {name}
Delete a cross-namespace storage import and its backing PV.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the imported PVC to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ --namespace -n <str> Namespace (default: derived from username) │
│ --force -f Skip confirmation │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 cephfs
- create
Usage: v8x storage import cephfs [OPTIONS] COMMAND [ARGS]...
CephFS storage import operations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Import CephFS storage from another PVC in the cluster. │
│ create-external Import CephFS storage from outside the cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import cephfs create [OPTIONS] {name}
Import CephFS storage from another PVC in the cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name for the imported PVC [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --source-pvc <str> Source CephFS PVC name [required] │
│ * --source-namespace <str> Source CephFS PVC namespace [required] │
│ --namespace -n <str> Target namespace (default: derived │
│ from username) │
│ --capacity <str> Storage capacity [default: 100Gi] │
│ --access-mode <str> Access mode (ReadWriteMany, │
│ ReadOnlyMany, ReadWriteOnce) │
│ [default: ReadWriteMany] │
│ --read-only Mount as read-only │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 nfs
- create
Usage: v8x storage import nfs [OPTIONS] COMMAND [ARGS]...
NFS storage import operations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Import NFS storage as a PVC in a cluster namespace. │
│ create-external Import external NFS storage into the cluster as PV + PVC. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import nfs create [OPTIONS] {name}
Import NFS storage as a PVC in a cluster namespace.
Example:
v8x storage import nfs create my-nfs -c mycluster \
--nfs-server 10.0.0.5 --nfs-share /exports/data
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name for the imported PVC [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --cluster -c <str> Cluster name [required] │
│ * --nfs-server <str> NFS server hostname or IP [required] │
│ * --nfs-share <str> NFS share/export path [required] │
│ --namespace -n <str> Target namespace (default: derived from │
│ username) │
│ --capacity <str> Storage capacity [default: 100Gi] │
│ --access-mode <str> Access mode (ReadWriteMany, ReadOnlyMany, │
│ ReadWriteOnce) │
│ [default: ReadWriteMany] │
│ --read-only Mount as read-only │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Team Management
- 🔹 team
- create
- delete
- get
- list
- update
Usage: v8x team [OPTIONS] COMMAND [ARGS]...
Manage teams and memberships
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create a new team │
│ delete Delete a team │
│ get Get details of a specific team │
│ list List all teams │
│ update Update team settings │
│ add-member Add a member to a team │
│ add-resource Add a resource (cluster) to a team │
│ remove-member Remove a member from a team │
│ list-members List all team members │
│ set-role Set member role in team │
│ set-roles Set team-level roles (kubeflow-admin, etc.) │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team create [OPTIONS] {name}
Create a new team
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name <str> Name of the team [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description -d <str> Team description │
│ --sudo --no-sudo Enable sudo for team members │
│ [default: no-sudo] │
│ --role -r <str> Roles to assign (repeatable). │
│ Default: kubeflow-admin │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team delete [OPTIONS] {team_id}
Delete a team
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * team_id <str> ID of the team to delete [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team get [OPTIONS] {team}
Get details of a specific team
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * team <str> Team name or ID to retrieve [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team list [OPTIONS]
List all teams
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team update [OPTIONS] {team_id}
Update team settings
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * team_id <str> ID of the team to update [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name <str> New name of the team │
│ --description <str> New description of the team │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Configuration Management
- 🔹 config
- clear
Usage: v8x config [OPTIONS] COMMAND [ARGS]...
Manage v8x configuration and settings.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ clear Clear all user tokens and configuration. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x config clear [OPTIONS]
Clear all user tokens and configuration.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force -f Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p <str> Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯