For local development and testing, you can install Jumpstarter on local Kubernetes clusters using tools like kind or minikube. This is ideal for learning about the distributed service quickly or for creating CI/CD pipelines to validate your own Jumpstarter drivers.
Before installing locally, ensure you have:
- Docker or Podman installed (for kind)
kubectlinstalled and configured to access your cluster- Administrator access to your cluster (required for CRD installation)
The Jumpstarter CLI provides convenient commands for local demo/test cluster management and Jumpstarter installation:
jmp admin create cluster- Creates a local cluster and installs Jumpstarter (recommended for getting started quickly)jmp admin delete cluster- Deletes a local cluster completelyjmp admin get clusters- Get local clusters from a Kubeconfigjmp admin install- Installs Jumpstarter on an existing clusterjmp admin uninstall- Removes Jumpstarter from a cluster (but keeps the cluster)
Sometimes the automatic IP address detection for will not work correctly, to check if Jumpstarter can determine your IP address, run `jmp admin ip`. If the IP address cannot be determined, use the `--ip` argument to manually set your IP address.
If you want to test Jumpstarter locally with more control over the setup, you can create a local cluster using tools such as minikube and kind.
kind (Kubernetes in Docker) is a tool for running local Kubernetes clusters using Docker or Podman containerized "nodes". It's lightweight and fast to start, making it excellent for CI/CD pipelines and quick local testing.
minikube runs local Kubernetes clusters using VMs or container "nodes". It works across several platforms and supports different hypervisors, making it ideal for local development and testing. Minikube works better if you don't have a local Docker/Podman installation.
The admin CLI can automatically create a local cluster and install Jumpstarter with a single command:
By default, Jumpstarter will try to detect which local cluster tools are installed:
By default, Jumpstarter will use `kind` if available, use the `--minikube` argument to force Jumpstarter to use minikube instead.
$ jmp admin create cluster
However, you can also explicitly specify a local cluster tool:
```{code-block} console
$ jmp admin create cluster --kind
```
Additional options for cluster creation:
- Custom cluster name: Specify as the first argument (default: `jumpstarter-lab`)
- `--kind <PATH>`: Path to the kind binary to use for cluster management
- `--force-recreate`: Force recreate the cluster if it already exists (destroys all data)
- `--kind-extra-args`: Pass additional arguments to kind cluster creation
- `--skip-install`: Create the cluster without installing Jumpstarter
- `--extra-certs <PATH>`: Path to custom CA certificate bundle file to inject into the cluster
```{code-block} console
$ jmp admin create cluster --minikube
```
Additional options for cluster creation:
- Custom cluster name: Specify as the first argument (default: `jumpstarter-lab`)
- `--minikube <PATH>`: Path to the minikube binary to use for cluster management
- `--force-recreate`: Force recreate the cluster if it already exists (destroys all data)
- `--minikube-extra-args`: Pass additional arguments to minikube cluster creation
- `--skip-install`: Create the cluster without installing Jumpstarter
- `--extra-certs <PATH>`: Path to custom CA certificate bundle file to inject into the cluster
To set a custom cluster name:
```{code-block} console
$ jmp admin create cluster my-jumpstarter-cluster --kind
```
```{code-block} console
$ jmp admin create cluster my-jumpstarter-cluster --minikube
```
Jumpstarter requires specific `NodePort` configurations, it is recommended to create a new cluster for Jumpstarter or use the automatic creation above.
If you already have a local cluster, install Jumpstarter with default options for your local cluster tool:
```{code-block} console
$ jmp admin install --kind
```
```{code-block} console
$ jmp admin install --minikube
```
Uninstall Jumpstarter from the cluster with the CLI:
$ jmp admin uninstall
To delete the local cluster completely, use the cluster delete command:
```{code-block} console
$ jmp admin delete cluster --kind
```
```{code-block} console
$ jmp admin delete cluster --minikube
```
To delete a cluster with a custom name:
```{code-block} console
$ jmp admin delete cluster my-jumpstarter-cluster --kind
```
```{code-block} console
$ jmp admin delete cluster my-jumpstarter-cluster --minikube
```
For complete documentation of the jmp admin create cluster, jmp admin delete cluster, jmp admin get clusters, and jmp admin install commands and all available options, see the MAN pages.
If you want to customize the local cluster further, you can create the cluster yourself.
#### Create a kind cluster
First, create a kind cluster config that enables nodeports to host the Services.
Save this as `kind_config.yaml`:
```{code-block} yaml
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
kubeadmConfigPatches:
- |
kind: ClusterConfiguration
apiServer:
extraArgs:
"service-node-port-range": "3000-32767"
- |
kind: InitConfiguration
nodeRegistration:
kubeletExtraArgs:
node-labels: "ingress-ready=true"
nodes:
- role: control-plane
extraPortMappings:
- containerPort: 80
hostPort: 5080
protocol: TCP
- containerPort: 30010
hostPort: 8082
protocol: TCP
- containerPort: 30011
hostPort: 8083
protocol: TCP
- containerPort: 443
hostPort: 5443
protocol: TCP
```
Next, create a kind cluster using the config you created:
```{code-block} console
$ kind create cluster --config kind_config.yaml
```
#### Create a minikube cluster
Expand the default NodePort range to include the Jumpstarter ports:
```{code-block} console
$ minikube start --extra-config=apiserver.service-node-port-range=8000-9000
```
For manual installation after creating the local cluster, follow Install with Operator. Use a baseDomain and endpoint addresses appropriate for your local environment (for example, nip.io based hostnames), then apply your Jumpstarter CR.
To check the status of the installation, run:
$ kubectl get pods -n jumpstarter-lab --watch