Warning

This documentation is actively being updated as the project evolves and may not be complete in all areas.

jmp-cli-reference¶

jmp¶

The Jumpstarter CLI

jmp [OPTIONS] COMMAND [ARGS]...

Options

--log-level <log_level>¶

Set the log level

Options:: DEBUG | INFO | WARNING | ERROR | CRITICAL

admin¶

Jumpstarter Kubernetes cluster admin CLI tool

jmp admin [OPTIONS] COMMAND [ARGS]...

create¶

Create Jumpstarter Kubernetes objects

jmp admin create [OPTIONS] COMMAND [ARGS]...

Options

--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!).

--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

--nointeractive¶: Disable interactive prompts (for use in scripts).

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

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.

--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

--nointeractive¶: Disable interactive prompts (for use in scripts).

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

Arguments

NAME¶: Optional argument

delete¶

Create Jumpstarter Kubernetes objects

jmp admin delete [OPTIONS] COMMAND [ARGS]...

Options

--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

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: name

--nointeractive¶: Disable interactive prompts (for use in scripts).

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

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: name

--nointeractive¶: Disable interactive prompts (for use in scripts).

Arguments

NAME¶: Optional argument

get¶

Get Jumpstarter Kubernetes objects

jmp admin get [OPTIONS] COMMAND [ARGS]...

Options

--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

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

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

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

-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

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

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

--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!).

-n, --namespace <namespace>¶: Kubernetes namespace to use

--kubeconfig <kubeconfig>¶: path to the kubeconfig file

--context <context>¶: Kubernetes context to use

-o, --output <output>¶

Output mode. Use “-o path” for shorter output (file/path).

Options:: path

--nointeractive¶: Disable interactive prompts (for use in scripts).

Arguments

NAME¶: Required argument

exporter¶

Import an exporter config from a Kubernetes cluster

jmp admin import exporter [OPTIONS] [NAME]

Options

--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

-o, --output <output>¶

Output mode. Use “-o path” for shorter output (file/path).

Options:: path

--nointeractive¶: Disable interactive prompts (for use in scripts).

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]

Options

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

config¶

jmp config [OPTIONS] COMMAND [ARGS]...

client¶

Modify jumpstarter client config files

jmp config client [OPTIONS] COMMAND [ARGS]...

create¶

Create a Jumpstarter client configuration.

jmp config client create [OPTIONS] ALIAS

Options

--out <out>¶: Specify an output file for the client config.

--namespace <namespace>¶: Enter the Jumpstarter client namespace.

--name <name>¶: Enter the Jumpstarter client name.

-e, --endpoint <endpoint>¶: Enter the Jumpstarter service endpoint.

-t, --token <token>¶: A valid Jumpstarter auth token generated by the Jumpstarter service.

-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, --output <output>¶

Output mode. Use “-o path” for shorter output (file/path).

Options:: path

Arguments

ALIAS¶: Required argument

delete¶

Delete a Jumpstarter client configuration.

jmp config client delete [OPTIONS] NAME

Options

-o, --output <output>¶

Output mode. Use “-o path” for shorter output (file/path).

Options:: path

Arguments

NAME¶: Required argument

list¶

List available client configurations.

jmp config client list [OPTIONS]

Options

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

use¶

Select the current Jumpstarter client configuration to use.

jmp config client use [OPTIONS] NAME

Options

-o, --output <output>¶

Output mode. Use “-o path” for shorter output (file/path).

Options:: path

Arguments

NAME¶: Required argument

exporter¶

Modify jumpstarter exporter config files

jmp config exporter [OPTIONS] COMMAND [ARGS]...

create¶

Create an exporter config.

jmp config exporter create [OPTIONS] [ALIAS]

Options

--namespace <namespace>¶

--name <name>¶

--endpoint <endpoint>¶

--token <token>¶

-o, --output <output>¶

Output mode. Use “-o path” for shorter output (file/path).

Options:: path

Arguments

ALIAS¶: Optional argument

delete¶

Delete an exporter config.

jmp config exporter delete [OPTIONS] [ALIAS]

Options

-o, --output <output>¶

Output mode. Use “-o path” for shorter output (file/path).

Options:: path

Arguments

ALIAS¶: Optional argument

edit¶

Edit an exporter config.

jmp config exporter edit [OPTIONS] [ALIAS]

Arguments

ALIAS¶: Optional argument

list¶

List exporter configs.

jmp config exporter list [OPTIONS]

Options

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

create¶

Create a resource

jmp create [OPTIONS] COMMAND [ARGS]...

lease¶

Create a lease

Request an exporter lease from the jumpstarter controller.

The result of this command will be a lease ID that can be used to connect to the remote exporter.

This is useful for multi-step workflows where you want to hold a lease for a specific exporter while performing multiple operations, or for CI environments where one step will request the lease and other steps will perform operations on the leased exporter.

Example:

$ JMP_LEASE=$(jmp create lease -l foo=bar --duration 1d --output name)
$ jmp shell
$$ j --help
$$ exit
$ jmp delete lease "${JMP_LEASE}"

jmp create lease [OPTIONS]

Options

--client-config <client_config>¶: Path to client config

--client <client>¶: Alias of client config

-l, --selector <selector>¶: Selector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’ (e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.

--duration <duration>¶

Required Accepted duration formats:

PnYnMnDTnHnMnS - ISO 8601 duration format
HH:MM:SS - time in hours, minutes, seconds
D days, HH:MM:SS - time prefixed by X days
D d, HH:MM:SS - time prefixed by X d

See https://docs.rs/speedate/latest/speedate/ for details

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

delete¶

Delete resources

jmp delete [OPTIONS] COMMAND [ARGS]...

leases¶

Delete leases

jmp delete leases [OPTIONS] [NAME]

Options

--client-config <client_config>¶: Path to client config

--client <client>¶: Alias of client config

-l, --selector <selector>¶: Selector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’ (e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.

--all¶

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: name

Arguments

NAME¶: Optional argument

driver¶

Jumpstarter driver CLI tool

jmp driver [OPTIONS] COMMAND [ARGS]...

Options

--log-level <log_level>¶

Set the log level

Options:: DEBUG | INFO | WARNING | ERROR | CRITICAL

list¶

jmp driver list [OPTIONS]

version¶

Get the current Jumpstarter version

jmp driver version [OPTIONS]

Options

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

get¶

Display one or many resources

jmp get [OPTIONS] COMMAND [ARGS]...

exporters¶

Display one or many exporters

jmp get exporters [OPTIONS]

Options

--client-config <client_config>¶: Path to client config

--client <client>¶: Alias of client config

-l, --selector <selector>¶: Selector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’ (e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

leases¶

Display one or many leases

jmp get leases [OPTIONS]

Options

--client-config <client_config>¶: Path to client config

--client <client>¶: Alias of client config

-l, --selector <selector>¶: Selector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’ (e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

login¶

jmp login [OPTIONS]

Options

-e, --endpoint <endpoint>¶: Enter the Jumpstarter service endpoint.

--namespace <namespace>¶: Enter the Jumpstarter exporter namespace.

--name <name>¶: Enter the Jumpstarter exporter name.

--issuer <issuer>¶: OIDC issuer

--client-id <client_id>¶: OIDC client id

--token <token>¶: OIDC access token

--username <username>¶: OIDC username

--password <password>¶: OIDC password

--connector-id <connector_id>¶: OIDC token exchange connector id (Dex specific)

--allow <allow>¶: A comma-separated list of driver client packages to load.

--unsafe¶: Should all driver client packages be allowed to load (UNSAFE!).

--exporter-config <exporter_config>¶: Path of exporter config

--exporter <exporter>¶: Alias of exporter config

--client-config <client_config>¶: Path to client config

--client <client>¶: Alias of client config

run¶

Run an exporter locally.

jmp run [OPTIONS]

Options

--exporter-config <exporter_config>¶: Path of exporter config

--exporter <exporter>¶: Alias of exporter config

shell¶

Spawns a shell (or custom command) connecting to a local or remote exporter

COMMAND is the custom command to run instead of shell.

Example:

$ jmp shell --exporter foo -- python bar.py

jmp shell [OPTIONS] [COMMAND]...

Options

--exporter-config <exporter_config>¶: Path of exporter config

--exporter <exporter>¶: Alias of exporter config

--client-config <client_config>¶: Path to client config

--client <client>¶: Alias of client config

--lease <lease_name>¶

-l, --selector <selector>¶: Selector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’ (e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.

--duration <duration>¶

Accepted duration formats:

PnYnMnDTnHnMnS - ISO 8601 duration format
HH:MM:SS - time in hours, minutes, seconds
D days, HH:MM:SS - time prefixed by X days
D d, HH:MM:SS - time prefixed by X d

See https://docs.rs/speedate/latest/speedate/ for details

Default:: '00:30:00'

Arguments

COMMAND¶: Optional argument(s)

update¶

Update a resource

jmp update [OPTIONS] COMMAND [ARGS]...

lease¶

Update a lease

jmp update lease [OPTIONS] NAME

Options

--client-config <client_config>¶: Path to client config

--client <client>¶: Alias of client config

--duration <duration>¶

Required Accepted duration formats:

PnYnMnDTnHnMnS - ISO 8601 duration format
HH:MM:SS - time in hours, minutes, seconds
D days, HH:MM:SS - time prefixed by X days
D d, HH:MM:SS - time prefixed by X d

See https://docs.rs/speedate/latest/speedate/ for details

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name

Arguments

NAME¶: Required argument

version¶

Get the current Jumpstarter version

jmp version [OPTIONS]

Options

-o, --output <output>¶

Output mode. Use “-o name” for shorter output (resource/name).

Options:: json | yaml | name