admin¶
jmp-admin¶
Jumpstarter Kubernetes cluster admin CLI tool
jmp-admin [OPTIONS] COMMAND [ARGS]...
create¶
Create Jumpstarter Kubernetes objects
jmp-admin create [OPTIONS] COMMAND [ARGS]...
Options
- -l, --log-level <log_level>¶
Set the log level
- Options:
DEBUG | INFO | WARNING | ERROR | CRITICAL
client¶
Create a client object in the Kubernetes cluster
jmp-admin create client [OPTIONS] [NAME]
Options
- -s, --save¶
Save the config file for the created client.
- -a, --allow <allow>¶
A comma-separated list of driver client packages to load.
- --unsafe¶
Should all driver client packages be allowed to load (UNSAFE!).
- -o, --out <out>¶
Specify an output file for the client config.
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- -l, --label <labels>¶
Labels
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
- --oidc-username <oidc_username>¶
OIDC username
Arguments
- NAME¶
Optional argument
exporter¶
Create an exporter object in the Kubernetes cluster
jmp-admin create exporter [OPTIONS] [NAME]
Options
- -s, --save¶
Save the config file for the created exporter.
- -o, --out <out>¶
Specify an output file for the exporter config.
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- -l, --label <labels>¶
Labels
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
- --oidc-username <oidc_username>¶
OIDC username
Arguments
- NAME¶
Optional argument
delete¶
Create Jumpstarter Kubernetes objects
jmp-admin delete [OPTIONS] COMMAND [ARGS]...
Options
- -l, --log-level <log_level>¶
Set the log level
- Options:
DEBUG | INFO | WARNING | ERROR | CRITICAL
client¶
Delete a client object in the Kubernetes cluster
jmp-admin delete client [OPTIONS] [NAME]
Options
- -d, --delete¶
Delete the config file for the client.
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
Arguments
- NAME¶
Optional argument
exporter¶
Delete an exporter object in the Kubernetes cluster
jmp-admin delete exporter [OPTIONS] [NAME]
Options
- -d, --delete¶
Delete the config file for the exporter.
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
Arguments
- NAME¶
Optional argument
get¶
Get Jumpstarter Kubernetes objects
jmp-admin get [OPTIONS] COMMAND [ARGS]...
Options
- -l, --log-level <log_level>¶
Set the log level
- Options:
DEBUG | INFO | WARNING | ERROR | CRITICAL
client¶
Get the client objects in a Kubernetes cluster
jmp-admin get client [OPTIONS] [NAME]
Options
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
Arguments
- NAME¶
Optional argument
exporter¶
Get the exporter objects in a Kubernetes cluster
jmp-admin get exporter [OPTIONS] [NAME]
Options
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
- -d, --devices¶
Display the devices hosted by the exporter(s)
Arguments
- NAME¶
Optional argument
lease¶
Get the lease objects in a Kubernetes cluster
jmp-admin get lease [OPTIONS] [NAME]
Options
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
Arguments
- NAME¶
Optional argument
import¶
Import configs from a Kubernetes cluster
jmp-admin import [OPTIONS] COMMAND [ARGS]...
client¶
Import a client config from a Kubernetes cluster
jmp-admin import client [OPTIONS] NAME
Options
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
- -o, --out <out>¶
Specify an output file for the client config.
- -a, --allow <allow>¶
A comma-separated list of driver client packages to load.
- --unsafe¶
Should all driver client packages be allowed to load (UNSAFE!).
Arguments
- NAME¶
Required argument
exporter¶
Import an exporter config from a Kubernetes cluster
jmp-admin import exporter [OPTIONS] [NAME]
Options
- -o, --out <out>¶
Specify an output file for the exporter config.
- -n, --namespace <namespace>¶
Kubernetes namespace to use
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
Arguments
- NAME¶
Optional argument
install¶
Install the Jumpstarter service in a Kubernetes cluster
jmp-admin install [OPTIONS]
Options
- --helm <helm>¶
Path or name of a helm executable
- --name <name>¶
The name of the chart installation
- -c, --chart <chart>¶
The URL of a Jumpstarter helm chart to install
- -n, --namespace <namespace>¶
Namespace to install Jumpstarter components in
- -i, --ip <ip>¶
IP address of your host machine
- -b, --basedomain <basedomain>¶
Base domain of the Jumpstarter service
- -g, --grpc-endpoint <grpc_endpoint>¶
The gRPC endpoint to use for the Jumpstarter API
- -r, --router-endpoint <router_endpoint>¶
The gRPC endpoint to use for the router
- --nodeport¶
Use Nodeport routing (recommended)
- --ingress¶
Use a Kubernetes ingress
- --route¶
Use an OpenShift route
- -v, --version <version>¶
The version of the service to install
- --kubeconfig <kubeconfig>¶
path to the kubeconfig file
- --context <context>¶
Kubernetes context to use
version¶
Get the current Jumpstarter version
jmp-admin version [OPTIONS]