Skip to content

Commit 09b9154

Browse files
committed
docs(sim): rename SITL container image from px4-sitl-sih to px4-sitl
The Docker image previously published as px4io/px4-sitl-sih is renamed to px4io/px4-sitl. The Gazebo image remains px4io/px4-sitl-gazebo. Signed-off-by: Ramon Roche <mrpollo@gmail.com>
1 parent d83b657 commit 09b9154

6 files changed

Lines changed: 25 additions & 23 deletions

File tree

.github/workflows/build_deb_package.yml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,10 @@ jobs:
126126
fail-fast: false
127127
matrix:
128128
include:
129-
- { image: sih, target: sih, arch: amd64, runner: x64, platform: "linux/amd64", dockerfile: Dockerfile.sih }
130-
- { image: sih, target: sih, arch: arm64, runner: arm64, platform: "linux/arm64", dockerfile: Dockerfile.sih }
131-
- { image: gazebo, target: default, arch: amd64, runner: x64, platform: "linux/amd64", dockerfile: Dockerfile.gazebo }
132-
- { image: gazebo, target: default, arch: arm64, runner: arm64, platform: "linux/arm64", dockerfile: Dockerfile.gazebo }
129+
- { image: sih, image_name: px4-sitl, target: sih, arch: amd64, runner: x64, platform: "linux/amd64", dockerfile: Dockerfile.sih }
130+
- { image: sih, image_name: px4-sitl, target: sih, arch: arm64, runner: arm64, platform: "linux/arm64", dockerfile: Dockerfile.sih }
131+
- { image: gazebo, image_name: px4-sitl-gazebo, target: default, arch: amd64, runner: x64, platform: "linux/amd64", dockerfile: Dockerfile.gazebo }
132+
- { image: gazebo, image_name: px4-sitl-gazebo, target: default, arch: arm64, runner: arm64, platform: "linux/arm64", dockerfile: Dockerfile.gazebo }
133133
steps:
134134
- uses: runs-on/action@v2
135135
- uses: actions/checkout@v6
@@ -164,10 +164,10 @@ jobs:
164164
context: docker-context
165165
file: Tools/packaging/${{ matrix.dockerfile }}
166166
tags: |
167-
px4io/px4-sitl-${{ matrix.image }}:${{ needs.setup.outputs.px4_version }}-${{ matrix.arch }}
168-
px4io/px4-sitl-${{ matrix.image }}:latest-${{ matrix.arch }}
169-
ghcr.io/px4/px4-sitl-${{ matrix.image }}:${{ needs.setup.outputs.px4_version }}-${{ matrix.arch }}
170-
ghcr.io/px4/px4-sitl-${{ matrix.image }}:latest-${{ matrix.arch }}
167+
px4io/${{ matrix.image_name }}:${{ needs.setup.outputs.px4_version }}-${{ matrix.arch }}
168+
px4io/${{ matrix.image_name }}:latest-${{ matrix.arch }}
169+
ghcr.io/px4/${{ matrix.image_name }}:${{ needs.setup.outputs.px4_version }}-${{ matrix.arch }}
170+
ghcr.io/px4/${{ matrix.image_name }}:latest-${{ matrix.arch }}
171171
platforms: ${{ matrix.platform }}
172172
load: false
173173
push: ${{ needs.setup.outputs.should_push == 'true' }}
@@ -185,7 +185,9 @@ jobs:
185185
runs-on: [runs-on,"runner=1cpu-linux-x64","image=ubuntu24-full-x64","run-id=${{ github.run_id }}",extras=s3-cache,spot=false]
186186
strategy:
187187
matrix:
188-
image: [sih, gazebo]
188+
include:
189+
- { image: sih, image_name: px4-sitl }
190+
- { image: gazebo, image_name: px4-sitl-gazebo }
189191
steps:
190192
- uses: runs-on/action@v2
191193

@@ -199,7 +201,7 @@ jobs:
199201
VERSION="${{ needs.setup.outputs.px4_version }}"
200202
201203
for REGISTRY in px4io ghcr.io/px4; do
202-
IMAGE="${REGISTRY}/px4-sitl-${{ matrix.image }}"
204+
IMAGE="${REGISTRY}/${{ matrix.image_name }}"
203205
204206
for TAG in ${VERSION} latest; do
205207
docker manifest create ${IMAGE}:${TAG} \

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ PX4 is an open-source autopilot stack for drones and unmanned vehicles. It suppo
7070
Run PX4 in simulation with a single command. No build tools, no dependencies beyond Docker:
7171

7272
```bash
73-
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
73+
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl:latest
7474
```
7575

7676
Open [QGroundControl](https://qgroundcontrol.com) and fly. See [Try PX4 Simulation](https://docs.px4.io/main/en/dev_setup/try_px4) for more options.

Tools/packaging/Dockerfile.sih

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
#
55
# Build:
66
# make px4_sitl_sih && cd build/px4_sitl_sih && cpack -G DEB && cd ../..
7-
# docker build -f Tools/packaging/Dockerfile.sih -t px4io/px4-sitl-sih:v1.17.0 build/px4_sitl_sih/
7+
# docker build -f Tools/packaging/Dockerfile.sih -t px4io/px4-sitl:v1.17.0 build/px4_sitl_sih/
88
#
99
# Run (Linux):
10-
# docker run --rm -it --network host px4io/px4-sitl-sih:v1.17.0
10+
# docker run --rm -it --network host px4io/px4-sitl:v1.17.0
1111
#
1212
# Run (macOS / Windows):
13-
# docker run --rm -it -p 14550:14550/udp -p 14540:14540/udp -p 19410:19410/udp -p 8888:8888/udp px4io/px4-sitl-sih:v1.17.0
13+
# docker run --rm -it -p 14550:14550/udp -p 14540:14540/udp -p 19410:19410/udp -p 8888:8888/udp px4io/px4-sitl:v1.17.0
1414

1515
FROM ubuntu:24.04 AS build
1616
COPY px4_*.deb /tmp/

Tools/packaging/test_sih_mission.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
88
Prerequisites:
99
- Docker container running:
10-
docker run --rm --network host px4io/px4-sitl-sih:v1.17.0-alpha1
10+
docker run --rm --network host px4io/px4-sitl:v1.17.0-alpha1
1111
- pip install mavsdk
1212
- mavsim-viewer running (optional):
1313
/path/to/mavsim-viewer -n 1

docs/en/dev_setup/try_px4.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ PX4 runs a full autopilot in simulation, on your laptop, with nothing to install
44
One command and you have a flying vehicle ready for QGroundControl, MAVSDK, or ROS 2.
55

66
```sh
7-
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
7+
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl:latest
88
```
99

1010
That's it.
@@ -32,7 +32,7 @@ Just install [Docker](https://docs.docker.com/get-docker/) (a free tool that run
3232
This command then works on Linux, macOS, and Windows:
3333

3434
```sh
35-
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
35+
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl:latest
3636
```
3737

3838
PX4 starts a simulated quadcopter.

docs/en/simulation/px4_sitl.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Two simulators are packaged, each available as a `.deb` package (Ubuntu) or a Do
1212
| Simulator | Format | Package / Image | Size |
1313
| -------------------------------------------- | --------- | ----------------------- | ------- |
1414
| [SIH](../sim_sih/index.md) | .deb | `px4` | ~10 MB |
15-
| | container | `px4io/px4-sitl-sih` | ~100 MB |
15+
| | container | `px4io/px4-sitl` | ~100 MB |
1616
| [Gazebo Harmonic](../sim_gazebo_gz/index.md) | .deb | `px4-gazebo` | ~30 MB |
1717
| | container | `px4io/px4-sitl-gazebo` | ~2 GB |
1818

@@ -74,7 +74,7 @@ You will need to [install Docker](https://docs.docker.com/get-docker/).
7474

7575
| Image | Simulator |
7676
| ----------------------------- | --------------- |
77-
| `px4io/px4-sitl-sih:<tag>` | SIH (headless) |
77+
| `px4io/px4-sitl:<tag>` | SIH (headless) |
7878
| `px4io/px4-sitl-gazebo:<tag>` | Gazebo Harmonic |
7979

8080
Tags follow PX4 versions (e.g. `v1.17.0`).
@@ -83,7 +83,7 @@ Tags follow PX4 versions (e.g. `v1.17.0`).
8383

8484
```bash
8585
# SIH
86-
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
86+
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl:latest
8787

8888
# Gazebo
8989
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-gazebo:latest
@@ -94,7 +94,7 @@ Pass environment variables with `-e`:
9494
```bash
9595
docker run --rm -it -p 14550:14550/udp \
9696
-e PX4_SIM_MODEL=sihsim_airplane \
97-
px4io/px4-sitl-sih:latest
97+
px4io/px4-sitl:latest
9898
```
9999

100100
The quick-start command above only exposes the QGroundControl port.
@@ -106,7 +106,7 @@ docker run --rm -it \
106106
-p 14540:14540/udp \
107107
-p 8888:8888/udp \
108108
-p 19410:19410/udp \
109-
px4io/px4-sitl-sih:latest
109+
px4io/px4-sitl:latest
110110
```
111111

112112
| Port | Protocol | Used by |
@@ -119,7 +119,7 @@ docker run --rm -it \
119119
On Linux, you can skip individual port flags and use `--network host` instead:
120120

121121
```bash
122-
docker run --rm -it --network host px4io/px4-sitl-sih:latest
122+
docker run --rm -it --network host px4io/px4-sitl:latest
123123
```
124124

125125
## Configuration

0 commit comments

Comments
 (0)