Skip to content

Commit 426fb9e

Browse files
committed
Parameterize python and controller version separately
1 parent 3fda23f commit 426fb9e

File tree

10 files changed

+25
-16
lines changed

10 files changed

+25
-16
lines changed

docs/source/cli/getting-started.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ configurations, and run transient or persistent exporter instances.
1212

1313
The `jmp` and `jmp-exporter` CLI tools are available as part of the `jumpstarter` Python package.
1414
You can learn how to install this package [here](../installation/python-package.md),
15-
but it is also available as a container image `quay.io/jumpstarter/jumpstarter:main`.
15+
but it is also available as a container image
16+
```{code-block}
17+
:substitutions:
18+
quay.io/jumpstarter/jumpstarter:{{version}}
19+
```
1620

1721
To check if you have the client CLI installed, run:
1822

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,6 @@
4646
]
4747
myst_substitutions = {
4848
"requires_python": ">=3.11",
49-
"version": "0.5.0rc2",
49+
"version": "0.5.0",
50+
"controller_version": "0.5.0",
5051
}

docs/source/config.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,11 +240,12 @@ the network.
240240

241241
To run the exporter container on a test runner using Podman:
242242

243-
```bash
243+
```{code-block} bash
244+
:substitutions:
244245
$ sudo podman run --rm -ti --name my-exporter --net=host --privileged \
245246
-e JUMPSTARTER_GRPC_INSECURE=1 \
246247
-v /run/udev:/run/udev -v /dev:/dev -v /etc/jumpstarter:/etc/jumpstarter \
247-
quay.io/jumpstarter-dev/jumpstarter:main \
248+
quay.io/jumpstarter-dev/jumpstarter:{{version}} \
248249
jmp-exporter run my-exporter
249250
250251
INFO:jumpstarter.exporter.exporter:Registering exporter with controller
@@ -265,15 +266,16 @@ To run the exporter as a service podman-systemd is recommended, by using podman-
265266
you can simply create a systemd service file at `/etc/containers/systemd/my-exporter.container` with
266267
the following content:
267268

268-
```ini
269+
```{code-block} ini
270+
:substitutions:
269271
[Unit]
270272
Description=My exporter
271273
272274
[Container]
273275
ContainerName=my-exporter
274276
Environment=JUMPSTARTER_GRPC_INSECURE=1
275277
Exec=jmp-exporter run my-exporter
276-
Image=quay.io/jumpstarter-dev/jumpstarter:main
278+
Image=quay.io/jumpstarter-dev/jumpstarter:{{version}}
277279
Network=host
278280
PodmanArgs=--privileged
279281
Volume=/run/udev:/run/udev

docs/source/installation/container-jmp.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ packages locally, you can create an alias to run the `jmp` client in a container
77
It is recommended to add the alias to your shell profile.
88
```
99

10-
```bash
10+
```{code-block} bash
11+
:substitutions:
1112
$ alias jmp='podman run --rm -it -e JUMPSTARTER_GRPC_INSECURE=1 \
1213
-v "${HOME}/.config/jumpstarter/:/root/.config/jumpstarter" \
13-
quay.io/jumpstarter-dev/jumpstarter:main jmp'
14+
quay.io/jumpstarter-dev/jumpstarter:{{version}} jmp'
1415
```
1516

1617
Then you can try:
@@ -30,13 +31,14 @@ to mount access to devices into the container, provide host network access,
3031
and run the container in privileged mode, this probably needs to be run as **root**.
3132

3233

33-
```bash
34+
```{code-block} bash
35+
:substitutions:
3436
$ mkdir -p "${HOME}/.config/jumpstarter/" /etc/jumpstarter
3537
3638
# you may want to add this alias to the profile
3739
$ alias jmp-exporter='podman run --rm -it -e JUMPSTARTER_GRPC_INSECURE=1 \
3840
-v "${HOME}/.config/jumpstarter/:/root/.config/jumpstarter" \
3941
--net=host --privileged \
4042
-v /run/udev:/run/udev -v /dev:/dev -v /etc/jumpstarter:/etc/jumpstarter \
41-
quay.io/jumpstarter-dev/jumpstarter:main jmp-exporter'
43+
quay.io/jumpstarter-dev/jumpstarter:{{version}} jmp-exporter'
4244
```

docs/source/installation/service-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ the latest release.
99
## Installing the CLI
1010
```{code-block} bash
1111
:substitutions:
12-
export VERSION={{version}}
12+
export VERSION={{controller_version}}
1313
export ARCH=amd64 # or arm64
1414
1515
curl -L https://github.com/jumpstarter-dev/jumpstarter-controller/releases/download/${VERSION}/jmpctl_${VERSION}_linux_${ARCH} \

docs/source/installation/service/kind-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,5 @@ helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarte
7272
--set global.metrics.enabled=false \
7373
--set jumpstarter-controller.grpc.nodeport.enabled=true \
7474
--set jumpstarter-controller.grpc.mode=nodeport \
75-
--version={{version}}
75+
--version={{controller_version}}
7676
```

docs/source/installation/service/kubernetes-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@ helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarte
1818
--set global.baseDomain=jumpstarter.example.com \
1919
--set global.metrics.enabled=true `# disable if metrics not available` \
2020
--set jumpstarter-controller.grpc.mode=ingress \
21-
--version={{version}}
21+
--version={{controller_version}}
2222
```

docs/source/installation/service/minikube-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,5 @@ helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarte
4343
--set global.metrics.enabled=false \
4444
--set jumpstarter-controller.grpc.nodeport.enabled=true \
4545
--set jumpstarter-controller.grpc.mode=nodeport \
46-
--version={{version}}
46+
--version={{controller_version}}
4747
```

docs/source/installation/service/openshift-argocd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,6 @@ spec:
9090
- name: jumpstarter-controller.grpc.mode
9191
value: "route"
9292
repoURL: quay.io/jumpstarter-dev/helm
93-
targetRevision: "{{version}}"
93+
targetRevision: "{{controller_version}}"
9494
```
9595

docs/source/installation/service/openshift-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ helm upgrade jumpstarter --install oci://quay.io/jumpstarter-dev/helm/jumpstarte
1919
--set global.baseDomain=jumpstarter.example.com \
2020
--set global.metrics.enabled=true \
2121
--set jumpstarter-controller.grpc.mode=route \
22-
--version={{version}}
22+
--version={{controller_version}}
2323
```
2424

2525

0 commit comments

Comments
 (0)