CLI Command Reference
This document provides a comprehensive reference for all available CLI commands and their options.
Usage: v8x [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --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 TEXT 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 TEXT 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 TEXT 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 TEXT 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 │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT 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 TEXT │
│ --status TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT 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 TEXT 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 TEXT 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 TEXT Name for the cloud account. [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --provider TEXT Cloud provider type. Valid options: aws, │
│ gcp, azure, on_prem, lxd, microk8s │
│ [required] │
│ --description -d TEXT Description for the cloud account. │
│ --attributes -a TEXT 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 TEXT 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 INTEGER 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 TEXT 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 INTEGER ID of the cloud account to retrieve. │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT Filter by cloud provider (e.g., aws, gcp, azure). │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Cluster Management
- 🔹 cluster
- create
- delete
- extend
- get
- list
- update
- federation
- preset
- namespace
- network
- kubeflow
- secret
- service
- slurm
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. │
│ compute-pool Manage compute pools (autoscaler pools) within a Vantage │
│ K8s cluster. │
│ federation Manage Vantage compute federations for distributed │
│ workloads. │
│ preset Manage inference presets within a Vantage K8s cluster. │
│ inference-endpoint Manage inference endpoints (predictive & LLM) on a │
│ cluster. │
│ model-registry Manage models in the cluster model registry (onboard, │
│ list, version, delete). │
│ namespace Manage namespaces on a Vantage K8s cluster. │
│ network Manage Multus networks on a Vantage K8s cluster. │
│ kubeflow Manage Kubeflow ML platform on a Vantage K8s cluster. │
│ secret Manage secrets (HuggingFace tokens, S3 credentials) in │
│ your profile namespace. │
│ service Enable, disable, update, or manage user services on a │
│ Vantage cluster. │
│ slurm Manage Slurm clusters within a Vantage K8s 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
'{"autoscaler_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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cloud-account-… -a INTEGER ID of the cloud │
│ account to use │
│ for deployment │
│ (from 'v8x cloud │
│ account list'). │
│ --cloud-account-… TEXT │
│ --cluster-type [slurm|k8s] [default: slurm] │
│ --settings TEXT │
│ --config TEXT │
│ --settings-file PATH │
│ --config-file PATH │
│ --app TEXT │
│ --resume --no-resume [default: │
│ no-resume] │
│ --footprint [small|medium|la [default: small] │
│ rge] │
│ --create-team --no-create-te… [default: │
│ no-create-team] │
│ --options TEXT │
│ --json -j Output in JSON │
│ format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cluster-type TEXT │
│ --app TEXT │
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --slurm-cluster TEXT │
│ --num-workers INTEGER [default: 1] │
│ --cloud-account-id INTEGER │
│ --vdeployer-url TEXT │
│ --settings-file PATH │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT 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 '{"autoscaler_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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description TEXT │
│ --status TEXT │
│ --settings TEXT │
│ --settings-file PATH │
│ --config TEXT │
│ --config-file PATH │
│ --merge --no-merge [default: no-merge] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster federation delete [OPTIONS] NAME
Delete a Vantage federation.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster federation update [OPTIONS] NAME
Update a Vantage federation.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description TEXT │
│ --add-cluster TEXT │
│ --remove-cluster TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
- 🔹 preset
- create
- delete
- get
- list
Usage: v8x cluster preset [OPTIONS] COMMAND [ARGS]...
Manage inference presets within a Vantage K8s cluster.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ create Create an inference preset on a Vantage cluster. │
│ delete Delete an inference preset from a Vantage cluster. │
│ get Get details of a specific inference preset. │
│ list List all inference presets on a Vantage cluster. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster preset create [OPTIONS] NAME CLUSTER_NAME
COMPUTE_POOL RUNTIMES...
Create an inference preset on a Vantage cluster.
Presets are reusable sizing templates that pre-fill the inference creation
form. They are advisory — callers merge values into their own request body.
Examples:
v8x cluster preset create cpu-small -c my-cluster -p inference-cpu
--runtime kserve-sklearn
v8x cluster preset create gpu-vllm -c my-cluster -p inference-gpu
--runtime vllm \\
--cpu 4 --memory 16Gi --gpu-count 1 --max-replicas 3
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
│ * compute_pool TEXT [required] │
│ * runtimes RUNTIMES... [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cpu TEXT [default: 2] │
│ --memory TEXT [default: 8Gi] │
│ --gpu-count INTEGER [default: 0] │
│ --min-replicas INTEGER [default: 1] │
│ --max-replicas INTEGER [default: 1] │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster preset delete [OPTIONS] NAME CLUSTER_NAME
Delete an inference preset from a Vantage cluster.
Examples:
v8x cluster preset delete cpu-small --cluster my-cluster
v8x cluster preset delete gpu-vllm -c my-cluster --force
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster preset get [OPTIONS] NAME CLUSTER_NAME
Get details of a specific inference preset.
Examples:
v8x cluster preset get cpu-small --cluster my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster preset list [OPTIONS] CLUSTER_NAME
List all inference presets on a Vantage cluster.
Examples:
v8x cluster preset list --cluster my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --labels-json TEXT [default: {}] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster namespace delete [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster namespace get [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster namespace list [OPTIONS] CLUSTER_NAME
List namespaces on a Vantage cluster.
Examples:
v8x cluster namespace list -c my-cluster
v8x cluster namespace list -c my-cluster --json
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --network-type TEXT [default: macvlan] │
│ --iface-name TEXT │
│ --bridge TEXT │
│ --vlan INTEGER │
│ --mtu INTEGER [default: 0] │
│ --ipam-type TEXT [default: nv-ipam] │
│ --ip-range TEXT │
│ --gateway TEXT │
│ --exclude TEXT │
│ --per-node-block-size INTEGER │
│ --route TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network delete [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network get [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network list [OPTIONS] CLUSTER_NAME
List Multus networks on a Vantage cluster.
Examples:
v8x cluster network list -c my-cluster
v8x cluster network list -c my-cluster --json
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster network update [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --network-type TEXT │
│ --iface-name TEXT │
│ --bridge TEXT │
│ --vlan INTEGER │
│ --mtu INTEGER │
│ --ipam-type TEXT │
│ --ip-range TEXT │
│ --gateway TEXT │
│ --exclude TEXT │
│ --per-node-block-size INTEGER │
│ --route TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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] CLUSTER_NAME
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-node-group
kubeflow-admin
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --admin-node-group TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kubeflow get [OPTIONS] CLUSTER_NAME
Get the status of Kubeflow on a Vantage K8s cluster.
Examples:
v8x cluster kubeflow get --cluster my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster kubeflow delete [OPTIONS] CLUSTER_NAME
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
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes --no-yes [default: no-yes] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --secret-type TEXT [default: huggingface] │
│ --value TEXT │
│ --access-key-id TEXT │
│ --secret-access-key TEXT │
│ --region TEXT │
│ --endpoint-url TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret list [OPTIONS] CLUSTER_NAME
List secrets in your profile namespace.
Examples:
v8x cluster secret list -c my-cluster
v8x cluster secret list -c my-cluster --type huggingface
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --secret-type TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret get [OPTIONS] NAME CLUSTER_NAME
Get details of a secret (value is never returned).
Examples:
v8x cluster secret get hf-token -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret delete [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster secret test [OPTIONS] NAME CLUSTER_NAME
Test S3 secret connectivity (ListBuckets dry-run).
Examples:
v8x cluster secret test my-s3 -c my-cluster
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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
CLUSTER_NAME
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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service disable [OPTIONS] SERVICE
CLUSTER_NAME
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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service update [OPTIONS] SERVICE
CLUSTER_NAME
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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service create [OPTIONS] SERVICE_TYPE
CLUSTER_NAME
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.
Examples:
# Create a PVC viewer
v8x cluster service create pvc-viewer --cluster my-cluster
# Create a cloud shell
v8x cluster service create cloud-shell -c my-cluster
# Create a remote desktop with specific resolution
v8x cluster service create remote-desktop -c my-cluster -r 2560x1440
# Create a remote desktop on a GPU node
v8x cluster service create remote-desktop -c my-cluster -i gpu
# Create a remote desktop with a specific image version
v8x cluster service create remote-desktop -c my-cluster --image-version
1.2.3
# Create a cloud shell with a specific image version
v8x cluster service create cloud-shell -c my-cluster --image-version 0.9.0
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * service_type TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --resolution TEXT [default: 1920x1080] │
│ --source-namespace TEXT [default: vantage-rook-ceph] │
│ --source-pvc-name TEXT [default: cephfs-user-homes] │
│ --node-group TEXT │
│ --instance-type TEXT │
│ --image-version TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service delete [OPTIONS] SERVICE_TYPE
SERVICE_ID CLUSTER_NAME
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 ──────────────────────────────────────────────────────────────────╮
│ * service_type TEXT [required] │
│ * service_id TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service get [OPTIONS] SERVICE_TYPE
SERVICE_ID CLUSTER_NAME
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 ──────────────────────────────────────────────────────────────────╮
│ * service_type TEXT [required] │
│ * service_id TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster service list [OPTIONS] CLUSTER_NAME
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 --type 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
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --service-type TEXT │
│ --username TEXT │
│ --all-users --no-all-users [default: no-all-users] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 CLUSTER_NAME
CONTROL_NODE_GROUP PARTITION...
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-node-group 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 TEXT [required] │
│ * cluster_name TEXT [required] │
│ * control_node_group TEXT [required] │
│ * partition PARTITION... [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --exposed --no-exposed [default: no-exposed] │
│ --tls-enabled --no-tls-enabled [default: tls-enabled] │
│ --profiling --no-profiling [default: profiling] │
│ --bridge --no-bridge [default: bridge] │
│ --slurmctld-lb-ip TEXT │
│ --slurmdbd-lb-ip TEXT │
│ --slurmrestd-lb-ip TEXT │
│ --influxdb-lb-ip TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm delete [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes --no-yes [default: no-yes] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm get [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm list [OPTIONS] CLUSTER_NAME
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
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x cluster slurm update [OPTIONS] NAME CLUSTER_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 TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --exposed --no-exposed │
│ --tls-enabled --no-tls-enabled │
│ --profiling --no-profiling │
│ --bridge --no-bridge │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --script-type TEXT [default: bash] │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job script list [OPTIONS]
List all job scripts.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --from-template-id INTEGER Filter by job script │
│ template ID │
│ --search -s TEXT Search job scripts │
│ --sort-field TEXT 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 INTEGER Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o INTEGER Number of results to │
│ skip │
│ [default: 0] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p TEXT 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 INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the job script │
│ --description -d TEXT 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 TEXT 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 TEXT Name of the job submission │
│ [required] │
│ * --job-script-id INTEGER ID of the job script to use │
│ [required] │
│ --description -d TEXT Description of the job submission │
│ --client-id TEXT Client ID of the cluster where │
│ job should execute │
│ --execution-directory TEXT Directory on cluster where job │
│ should execute │
│ --slurm-job-id INTEGER SLURM job ID (if already known) │
│ --sbatch-arg TEXT 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 TEXT 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 INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job submission list [OPTIONS]
List all job submissions
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --slurm-job-ids TEXT Comma-separated list │
│ of SLURM job IDs to │
│ filter by │
│ --submit-status TEXT Filter by submission │
│ status (CREATED, │
│ SUBMITTED, REJECTED, │
│ DONE, ABORTED) │
│ --from-script-id INTEGER Filter by job script │
│ ID │
│ --search -s TEXT Search job submissions │
│ --sort-field TEXT 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 INTEGER Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o INTEGER Number of results to │
│ skip │
│ [default: 0] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p TEXT 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 INTEGER [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the job submission │
│ --description -d TEXT New description for the job submission │
│ --execution-directory TEXT New execution directory │
│ --status TEXT 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 TEXT 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 TEXT Name of the job template [required] │
│ --description -d TEXT Description of the job template │
│ --identifier -i TEXT 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 TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --yes -y Skip confirmation prompt │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x job template list [OPTIONS]
List all job templates
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search -s TEXT Search job templates │
│ --sort-field TEXT 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 INTEGER Maximum number of │
│ results │
│ [default: 50] │
│ --offset -o INTEGER Number of results to │
│ skip │
│ [default: 0] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT New name for the job template │
│ --description -d TEXT New description for the job │
│ template │
│ --identifier -i TEXT 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 TEXT 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 TEXT Search bookings by name or id │
│ --sort TEXT Sort by field (name, id, created_at) │
│ --limit -l INTEGER Maximum number of bookings to return │
│ --offset -o INTEGER 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 TEXT Booking ID [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license booking create [OPTIONS]
Create a new license booking
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name -n TEXT Booking name │
│ --description -d TEXT 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 TEXT 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 HOST
Create a new license server.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * host TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --port INTEGER [default: 27000] │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license server list [OPTIONS]
List all license servers.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search TEXT │
│ --sort TEXT │
│ --limit INTEGER │
│ --offset INTEGER │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --host TEXT │
│ --port INTEGER │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 VERSION
Create a new license product.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * version TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description TEXT │
│ --license-type TEXT [default: concurrent] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license product list [OPTIONS]
List all license products.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search TEXT │
│ --sort TEXT │
│ --limit INTEGER │
│ --offset INTEGER │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --version TEXT │
│ --description TEXT │
│ --license-type TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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
LICENSE_TYPE
Create a new license configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * license_type TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --max-users INTEGER │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license configuration list [OPTIONS]
List all license configurations.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --search TEXT │
│ --sort TEXT │
│ --limit INTEGER │
│ --offset INTEGER │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --license-type TEXT │
│ --max-users INTEGER │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 PRODUCT_ID
Create a new license deployment.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * product_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --environment TEXT [default: dev] │
│ --nodes INTEGER [default: 1] │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license deployment list [OPTIONS]
List all license deployments.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --environment TEXT │
│ --status TEXT │
│ --limit INTEGER [default: 10] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --environment TEXT │
│ --nodes INTEGER │
│ --description TEXT │
│ --status TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT │
│ --sort TEXT │
│ --limit INTEGER │
│ --offset INTEGER │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x license feature create [OPTIONS]
Create a new license feature.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --description TEXT │
│ --json-file PATH │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --description TEXT │
│ --json-file PATH │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
│ * instance_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --subnet-id TEXT │
│ --assign-public-ip --no-assign-public-ip [default: │
│ no-assign-public-ip] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network create [OPTIONS] NAME
Create a new virtual network.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --cidr TEXT [default: 10.0.0.0/16] │
│ --region TEXT │
│ --enable-dns --no-enable-dns [default: enable-dns] │
│ --description TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network delete [OPTIONS] NETWORK_ID
Delete a virtual network.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * network_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
│ * instance_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x network list [OPTIONS]
List all virtual networks.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --region TEXT │
│ --status TEXT │
│ --limit INTEGER [default: 10] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT │
│ --description TEXT │
│ --enable-dns --no-enable-dns │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --vantage-url TEXT [default: │
│ https://app.vantagecomp… │
│ --oidc-client-id TEXT [default: default] │
│ --oidc-max-poll-time INTEGER [default: 300] │
│ --force --no-force [default: no-force] │
│ --activate --no-activate [default: no-activate] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x profile delete [OPTIONS] PROFILE_NAME
Delete a v8x profile.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * profile_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 CLUSTER_NAME
Create a PersistentVolumeClaim in a cluster namespace.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --size TEXT [default: 10Gi] │
│ --storage-class TEXT │
│ --access-mode TEXT [default: ReadWriteOnce] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage delete [OPTIONS] NAME CLUSTER_NAME
Delete a PersistentVolumeClaim.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage get [OPTIONS] NAME CLUSTER_NAME
Get details of a specific PersistentVolumeClaim.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage list [OPTIONS] CLUSTER_NAME
List PersistentVolumeClaims in a namespace.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 CLUSTER_NAME
SYSTEM_TYPE STORAGE_CLASS_NAME
Create a new storage system registration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
│ * system_type TEXT [required] │
│ * storage_class_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT [default: vantage-rook-ceph] │
│ --description TEXT │
│ --config-json TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system get [OPTIONS] NAME CLUSTER_NAME
Get details of a storage system.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system list [OPTIONS] CLUSTER_NAME
List all registered storage systems.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system delete [OPTIONS] NAME CLUSTER_NAME
Delete a storage system registration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT [default: vantage-rook-ceph] │
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage system update [OPTIONS] NAME CLUSTER_NAME
Update a storage system's configuration.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT [default: vantage-rook-ceph] │
│ --storage-class-name TEXT │
│ --config-json TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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
CLUSTER_NAME
Expose CephFS storage to clients outside the cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --ceph-client-name TEXT [default: │
│ external-cephfs] │
│ --ceph-mds-path TEXT [default: │
│ /volumes/csi] │
│ --ceph-osd-pool TEXT [default: │
│ vantage-cephfs-data] │
│ --expose-monitors --no-expose-monit… [default: │
│ expose-monitors] │
│ --monitor-service-… TEXT [default: NodePort] │
│ --msgr2-node-port INTEGER [default: 30300] │
│ --msgr1-node-port INTEGER [default: 30789] │
│ --rook-namespace TEXT [default: │
│ vantage-rook-ceph] │
│ --json -j Output in JSON │
│ format │
│ --verbose -v Enable verbose │
│ terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message │
│ and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs get [OPTIONS] NAME
CLUSTER_NAME
Get details of a CephFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs list [OPTIONS] CLUSTER_NAME
List all external exposes.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs delete [OPTIONS] NAME
CLUSTER_NAME
Delete a CephFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs credentials
[OPTIONS] NAME CLUSTER_NAME
Get CephFS credentials for an external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose cephfs status [OPTIONS] NAME
CLUSTER_NAME
Get status of a CephFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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
CLUSTER_NAME SOURCE_PVC
SOURCE_NAMESPACE
Expose NFS-backed PVC storage to clients outside the cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
│ * source_pvc TEXT [required] │
│ * source_namespace TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose nfs get [OPTIONS] NAME CLUSTER_NAME
Get details of an NFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage expose nfs delete [OPTIONS] NAME
CLUSTER_NAME
Delete an NFS external expose.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rook-namespace TEXT [default: vantage-rook-ceph] │
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 CLUSTER_NAME
Get details of a specific storage import.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --storage-type TEXT [default: nfs] │
│ --namespace TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import list [OPTIONS] CLUSTER_NAME
List all storage imports in a namespace.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --storage-type TEXT [default: nfs] │
│ --namespace TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import delete [OPTIONS] NAME CLUSTER_NAME
Delete an imported storage PVC and its backing PV.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --storage-type TEXT [default: nfs] │
│ --namespace TEXT │
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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
CLUSTER_NAME
SOURCE_PVC
SOURCE_NAMESPACE
Import existing PVC from another namespace into the target namespace.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
│ * source_pvc TEXT [required] │
│ * source_namespace TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --capacity TEXT [default: 100Gi] │
│ --access-mode TEXT [default: ReadWriteMany] │
│ --read-only --no-read-only [default: no-read-only] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import internal get [OPTIONS] NAME
CLUSTER_NAME
Get details of a cross-namespace storage import.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import internal list [OPTIONS] CLUSTER_NAME
List all cross-namespace storage imports in a namespace.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x storage import internal delete [OPTIONS] NAME
CLUSTER_NAME
Delete a cross-namespace storage import and its backing PV.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --force --no-force [default: no-force] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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
CLUSTER_NAME SOURCE_PVC
SOURCE_NAMESPACE
Import CephFS storage from another PVC in the cluster.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * name TEXT [required] │
│ * cluster_name TEXT [required] │
│ * source_pvc TEXT [required] │
│ * source_namespace TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --capacity TEXT [default: 100Gi] │
│ --access-mode TEXT [default: ReadWriteMany] │
│ --read-only --no-read-only [default: no-read-only] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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
CLUSTER_NAME NFS_SERVER
NFS_SHARE
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 TEXT [required] │
│ * cluster_name TEXT [required] │
│ * nfs_server TEXT [required] │
│ * nfs_share TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --namespace TEXT │
│ --capacity TEXT [default: 100Gi] │
│ --access-mode TEXT [default: ReadWriteMany] │
│ --read-only --no-read-only [default: no-read-only] │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --description TEXT │
│ --sudo-enabled --no-sudo-enabled [default: no-sudo-enabled] │
│ --roles TEXT │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal │
│ output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team delete [OPTIONS] TEAM_ID
Delete a team
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * team_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team get [OPTIONS] TEAM
Get details of a specific team
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * team TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Usage: v8x team update [OPTIONS] TEAM_ID
Update team settings
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * team_id TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --name TEXT New name of the team │
│ --description TEXT New description of the team │
│ --json -j Output in JSON format │
│ --verbose -v Enable verbose terminal output │
│ --profile -p TEXT 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 TEXT Profile name to use │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯