You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 23, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: docs/source/getting-started/installation/service/service-local.md
+58-20Lines changed: 58 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,13 @@ Before installing locally, ensure you have:
13
13
14
14
## Install with Jumpstarter CLI
15
15
16
-
The Jumpstarter CLI provides the `jmp admin install` command to automatically
17
-
run Helm with the correct arguments, simplifying installation in your Kubernetes
18
-
cluster. This is the recommended approach for getting started quickly.
16
+
The Jumpstarter CLI provides convenient commands for local demo/test cluster management and Jumpstarter installation:
17
+
18
+
-`jmp admin create cluster` - Creates a local cluster and installs Jumpstarter (recommended for getting started quickly)
19
+
-`jmp admin delete cluster` - Deletes a local cluster completely
20
+
-`jmp admin get clusters` - Get local clusters from a Kubeconfig
21
+
-`jmp admin install` - Installs Jumpstarter on an existing cluster
22
+
-`jmp admin uninstall` - Removes Jumpstarter from a cluster (but keeps the cluster)
19
23
20
24
```{warning}
21
25
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.
@@ -27,44 +31,65 @@ If you want to test Jumpstarter locally with more control over the setup, you ca
27
31
28
32
[**kind**](https://kind.sigs.k8s.io/docs/user/quick-start/) (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.
29
33
30
-
[**minikube**](https://minikube.sigs.k8s.io/docs/start/) 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. It's particularly useful in environments requiring untrusted certificates.
34
+
[**minikube**](https://minikube.sigs.k8s.io/docs/start/) 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.
35
+
36
+
The admin CLI can automatically create a local cluster and install Jumpstarter with a single command:
37
+
38
+
By default, Jumpstarter will try to detect which local cluster tools are installed:
31
39
32
40
```{tip}
33
-
Consider minikube for environments requiring [untrusted certificates](https://minikube.sigs.k8s.io/docs/handbook/untrusted_certs/).
41
+
By default, Jumpstarter will use `kind` if available, use the `--minikube` argument to force Jumpstarter to use minikube instead.
34
42
```
35
43
36
-
The admin CLI can automatically create a local cluster and install Jumpstarter with a single command:
44
+
```{code-block} console
45
+
$ jmp admin create cluster
46
+
```
47
+
48
+
However, you can also explicitly specify a local cluster tool:
37
49
38
50
````{tab} kind
39
51
```{code-block} console
40
-
$ jmp admin install --kind --create-cluster
52
+
$ jmp admin create cluster --kind
41
53
```
54
+
55
+
Additional options for cluster creation:
56
+
57
+
- Custom cluster name: Specify as the first argument (default: `jumpstarter-lab`)
58
+
- `--kind <PATH>`: Path to the kind binary to use for cluster management
59
+
- `--helm <PATH>`: Path to the Helm binary to install the Jumpstarter service with
60
+
- `--force-recreate`: Force recreate the cluster if it already exists (destroys all data)
61
+
- `--kind-extra-args`: Pass additional arguments to kind cluster creation
62
+
- `--skip-install`: Create the cluster without installing Jumpstarter
63
+
- `--extra-certs <PATH>`: Path to custom CA certificate bundle file to inject into the cluster
42
64
````
43
65
44
66
````{tab} minikube
45
67
```{code-block} console
46
-
$ jmp admin install --minikube --create-cluster
68
+
$ jmp admin create cluster --minikube
47
69
```
48
-
````
49
70
50
71
Additional options for cluster creation:
51
72
52
-
-`--cluster-name`: Specify a custom cluster name (default: `jumpstarter-lab`)
53
-
-`--force-recreate-cluster`: Force recreate the cluster if it already exists (destroys all data)
54
-
-`--kind-extra-args`: Pass additional arguments to kind cluster creation
73
+
- Custom cluster name: Specify as the first argument (default: `jumpstarter-lab`)
74
+
- `--minikube <PATH>`: Path to the minikube binary to use for cluster management
75
+
- `--helm <PATH>`: Path to the Helm binary to install the Jumpstarter service with
76
+
- `--force-recreate`: Force recreate the cluster if it already exists (destroys all data)
55
77
- `--minikube-extra-args`: Pass additional arguments to minikube cluster creation
78
+
- `--skip-install`: Create the cluster without installing Jumpstarter
79
+
- `--extra-certs <PATH>`: Path to custom CA certificate bundle file to inject into the cluster
For complete documentation of the `jmp admin install` command and all available
114
-
options, see the [MAN pages](../../../reference/man-pages/jmp.md).
152
+
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](../../../reference/man-pages/jmp.md).
0 commit comments