Skip to content

docs(ansible): migrate role READMEs to install_dev_env + --tags #7060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xmfcx merged 2 commits into from
Apr 24, 2026
Merged

docs(ansible): migrate role READMEs to install_dev_env + --tags #7060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
167677a
docs(ansible): point role READMEs at install_dev_env + --tags
xmfcx Apr 24, 2026
010eab8
docs(ansible): drop lingering setup-dev-env.sh and universe.yaml refs
xmfcx Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ansible/roles/acados/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ ansible-galaxy collection install -f -r "ansible-galaxy-requirements.yaml"
This step should be repeated when the ansible directory is updated.

```bash
ansible-playbook autoware.dev_env.setup_acados --ask-become-pass
ansible-playbook autoware.dev_env.install_dev_env --tags acados --ask-become-pass
```

## Directory layout
Expand Down
4 changes: 2 additions & 2 deletions ansible/roles/artifacts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Autoware artifacts

The Autoware perception stack uses models for inference. These models are automatically downloaded as part of the `setup-dev-env.sh` script.
The Autoware perception stack uses models for inference. These models are downloaded by running `ansible-playbook autoware.dev_env.install_dev_env --tags artifacts`.

The models are hosted by Web.Auto.

Expand Down Expand Up @@ -65,7 +65,7 @@ This step should be repeated when a new playbook is added.
#### Run the playbook

```bash
ansible-playbook autoware.dev_env.download_artifacts -e "data_dir=$HOME/autoware_data" --ask-become-pass
ansible-playbook autoware.dev_env.install_dev_env --tags artifacts -e "data_dir=$HOME/autoware_data" --ask-become-pass
```

This will download and extract the artifacts to the specified directory and validate the checksums.
2 changes: 1 addition & 1 deletion ansible/roles/qt5ct_setup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Follow the instructions below to **install** or **update** the custom theme for
```bash
cd ~/autoware # The root directory of the cloned repository
ansible-galaxy collection install -f -r "ansible-galaxy-requirements.yaml"
ansible-playbook autoware.dev_env.install_rviz_theme --ask-become-pass
ansible-playbook autoware.dev_env.install_dev_env --tags qt5ct_setup --ask-become-pass
```

## How to use the custom theme in RViz2
Expand Down
2 changes: 1 addition & 1 deletion ansible/roles/ros2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The `ros2_installation_type` variable can also be found in:
[./defaults/main.yaml](./defaults/main.yaml)

For Universe, the `rosdistro` variable can also be found in:
[../../playbooks/universe.yaml](../../playbooks/universe.yaml)
[../../playbooks/install_dev_env.yaml](../../playbooks/install_dev_env.yaml)

```bash
# Choose your ROS distribution
Expand Down
4 changes: 2 additions & 2 deletions ansible/roles/spconv/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ The following command will install a particular version of the packages using an
```bash
export SPCONV_CUMM_VERSION=0.5.3
export SPCONV_VERSION=2.3.8
ansible-playbook autoware.dev_env.install_spconv.yaml -e spconv_cumm_version=${SPCONV_CUMM_VERSION} -e spconv_version=${SPCONV_VERSION} --ask-become-pass
ansible-playbook autoware.dev_env.install_dev_env --tags spconv -e spconv_cumm_version=${SPCONV_CUMM_VERSION} -e spconv_version=${SPCONV_VERSION} --ask-become-pass
```

### Installation for NVIDIA Jetson platforms

```bash
export SPCONV_CUMM_VERSION=0.5.3
export SPCONV_VERSION=2.3.8
ansible-playbook autoware.dev_env.install_spconv.yaml -e spconv_cumm_version=${SPCONV_CUMM_VERSION} -e spconv_version=${SPCONV_VERSION} -e spconv_is_jetson=true --ask-become-pass
ansible-playbook autoware.dev_env.install_dev_env --tags spconv -e spconv_cumm_version=${SPCONV_CUMM_VERSION} -e spconv_version=${SPCONV_VERSION} -e spconv_is_jetson=true --ask-become-pass
```
Loading